Bash コマンドライン引数解析の代替方法と詳細解説

2024-08-19

Bash でのコマンドライン引数の解析

Bashスクリプトでは、スクリプト実行時に渡される引数をコマンドライン引数と呼びます。これらの引数を解析し、スクリプト内で適切に処理することが重要です。

位置引数

最も基本的な方法は、位置引数を使うことです。スクリプトの実行時に渡された引数は、変数 $1, $2, $3, ... に順に格納されます。

#!/bin/bash

echo "最初の引数: $1"
echo "二番目の引数: $2"
echo "すべての引数: $*"

$1, $2, $3: それぞれ最初の、二番目の、三番目の引数
$*: 全ての引数をスペースで区切って一つの文字列として
$@: 全ての引数を個別の文字列として (引用符を保持)

引数の個数

$# 変数には、渡された引数の個数が格納されます。

#!/bin/bash

if [ $# -eq 0 ]; then
  echo "引数がありません"
elif [ $# -eq 1 ]; then
  echo "一つの引数が渡されました: $1"
else
  echo "複数の引数が渡されました"
fi

オプションの処理

より複雑なオプション処理には、getopt や getopts コマンドが使用できます。

getopts

getopts は、短いオプション（一つの文字）を処理するのに適しています。

#!/bin/bash

while getopts ":ab:" opt; do
  case $opt in
    a)
      echo "オプション -a が指定されました"
      ;;
    b)
      echo "オプション -b の値: $OPTARG"
      ;;
    \?)
      echo "不正なオプション: -$OPTARG"
      exit 1
      ;;
    :)
      echo "オプション -$OPTARG に値が必要です"
      exit 1
      ;;
  esac
done

shift $(expr $OPTIND - 1)

# 残りの位置引数を処理

-a: オプション -a が指定された場合
-b: オプション -b が指定された場合、値は $OPTARG に格納される
\?: 不明なオプション
:: オプションに値が必要だが指定されていない

getopt は、長いオプションや複数の文字からなるオプションを処理するのに適しています。

#!/bin/bash

options=$(getopt -o ab: -l help,file:,version -- "$@")
if [ $? != 0 ]; then
  echo "不正なオプション"
  exit 1
fi

eval set -- "$options"

while true; do
  case "$1" in
    -a)
      echo "オプション -a が指定されました"
      ;;
    -b)
      echo "オプション -b の値: $2"
      shift
      ;;
    --help)
      echo "ヘルプを表示します"
      exit 0
      ;;
    --file)
      echo "ファイル名: $2"
      shift
      ;;
    --version)
      echo "バージョン情報"
      exit 0
      ;;
    --)
      shift
      break
      ;;
    *)
      echo "不正なオプション"
      exit 1
      ;;
  esac
  shift
done

# 残りの位置引数を処理

重要なポイント

引数の検証を行うことで、スクリプトの堅牢性を向上させることができます。
適切なエラーメッセージを表示することで、ユーザーの使い勝手を向上させることができます。
getopt や getopts を使いこなすことで、複雑なオプション処理が可能になります。

Bashのマニュアルページ (man bash)
getopt と getopts のマニュアルページ

Bash コマンドライン引数解析入門：コード例解説

Bashスクリプトでコマンドライン引数を解析することは、スクリプトの柔軟性と使いやすさを向上させる上で非常に重要です。ここでは、様々なケースに対応できるよう、具体的なコード例と解説を交えて、コマンドライン引数の解析方法を詳しく見ていきましょう。

基本的な位置引数の使い方

#!/bin/bash

echo "最初の引数: $1"
echo "二番目の引数: $2"
echo "すべての引数: $*"
echo "すべての引数 (個別に): $@"
echo "引数の個数: $#"

$1, $2, 3,...:∗∗それぞれ、コマンドラインから渡された1番目、2番目、3番目の引数です。∗∗∗:* 全ての引数を1つの文字列として扱います。
@:∗∗全ての引数を個別の文字列として扱います。∗∗∗#: 渡された引数の数を表します。

オプションの処理 (getopts)

短いオプション（-a, -bなど）を処理する場合は、getopts コマンドが便利です。

#!/bin/bash

while getopts ":ab:" opt; do
  case $opt in
    a)
      echo "オプション -a が指定されました"
      ;;
    b)
      echo "オプション -b の値: $OPTARG"
      ;;
    \?)
      echo "不正なオプション: -$OPTARG"
      exit 1
      ;;
    :)
      echo "オプション -$OPTARG に値が必要です"
      exit 1
      ;;
  esac
done

# 残りの位置引数を処理

長いオプションや複数の文字からなるオプションを処理する場合は、getopt コマンドが便利です。

#!/bin/bash

options=$(getopt -o ab: -l help,file:,version -- "$@")
if [ $? != 0 ]; then
  echo "不正なオプション"
  exit 1
fi

eval set -- "$options"

while true; do
  case "$1" in
    -a)
      echo "オプション -a が指定されました"
      ;;
    -b)
      echo "オプション -b の値: $2"
      shift
      ;;
    --help)
      echo "ヘルプを表示します"
      exit 0
      ;;
    --file)
      echo "ファイル名: $2"
      shift
      ;;
    --version)
      echo "バージョン情報"
      exit 0
      ;;
    --)
      shift
      break
      ;;
    *)
      echo "不正なオプション"
      exit 1
      ;;
  esac
  shift
done

# 残りの位置引数を処理

具体的な使用例

# ファイルのコピー
#!/bin/bash

while getopts "f:" opt; do
  case $opt in
    f)
      file="$OPTARG"
      ;;
    \?)
      echo "不正なオプション: -$OPTARG"
      exit 1
      ;;
    :)
      echo "オプション -f に値が必要です"
      exit 1
      ;;
  esac
done

shift $(expr $OPTIND - 1)

if [ -z "$file" ]; then
  echo "コピー先のファイル名を指定してください"
  exit 1
fi

cp "$1" "$file"

位置引数: $1, $2, ... を使って、順に渡された引数にアクセスします。
オプション: getopts や getopt を使って、短いオプションや長いオプションを処理します。
エラー処理: 不正なオプションや引数が渡された場合、適切なエラーメッセージを表示し、スクリプトを終了させます。
柔軟性: さまざまなオプションや引数の組み合わせに対応できるよう、スクリプトを設計します。

さらに詳しく

複合オプション: getopt を使うと、複数の文字からなるオプションを定義できます。
必須オプション: オプションの値が必須の場合、getopts や getopt のオプション文字に : を追加します。
デフォルト値: オプションの値が指定されていない場合に、デフォルト値を設定できます。
正規表現: case 文の中で正規表現を使って、より複雑なパターンマッチングを行うことができます。