Go の活用方法: コマンドラインフラグ

コマンドラインフラグは、コマンドラインプログラムのオプションを指定する一般的な方法です。たとえば、wc -l において -l はコマンドラインフラグです。

 
package main

Go には、基本的なコマンドラインフラグの構文解析に対応する flag パッケージが用意されています。このパッケージを使用して、例となるコマンドラインプログラムを実装します。

 
import (
    "flag"
    "fmt"
)
 
func main() {

文字列、整数、boolean オプションには、基本的なフラグ宣言を使用できます。ここでは、"foo" の既定値と簡単な説明を含む文字列フラグの word を宣言しています。この flag.String 関数は、（文字列の値ではなく）文字列ポインタを返します。後ほどこのポインタを使用する方法を説明します。

 
    wordPtr := flag.String("word", "foo", "a string")

これは word フラグと同様のアプローチを使用して、numb および fork フラグを宣言しています。

 
    numbPtr := flag.Int("numb", 42, "an int")
    forkPtr := flag.Bool("fork", false, "a bool")

また、プログラムの別の場所で宣言されている既存の変数を使用するオプションを宣言することもできます。フラグ宣言関数にはポインタを渡す必要があることに注意してください。

 
    var svar string
    flag.StringVar(&svar, "svar", "bar", "a string var")

すべてのフラグが宣言されたら、flag.Parse() を呼び出してコマンドライン解析を実行します。

 
    flag.Parse()

ここでは、構文解析されたオプションと、残りの位置指定引数をダンプするだけです。たとえば、*wordPtr でポインタの参照解除が必要になり、実際のオプション値を取得することに注意してください。

 
    fmt.Println("word:", *wordPtr)
    fmt.Println("numb:", *numbPtr)
    fmt.Println("fork:", *forkPtr)
    fmt.Println("svar:", svar)
    fmt.Println("tail:", flag.Args())
}

コマンドラインフラグプログラムを試すには、最初にコンパイルして、その後、結果のバイナリを直接実行するのが最善です。

 
$ go build command-line-flags.go

まず、すべてのフラグに値を与えることで、作成したプログラムを試します。

 
$ ./command-line-flags -word=opt -numb=7 -fork -svar=flag
word: opt
numb: 7
fork: true
svar: flag
tail: []

フラグを省略すると、フラグが自動的に既定値になることに注意してください。

 
$ ./command-line-flags -word=opt
word: opt
numb: 42
fork: false
svar: bar
tail: []

残りの位置指定引数は、フラグの後に指定できます。

 
$ ./command-line-flags -word=opt a1 a2 a3
word: opt
...
tail: [a1 a2 a3]

flag パッケージでは、フラグを位置指定引数の前に表示する必要があることに注意してください（それ以外の場合、フラグは位置指定引数として解釈されます）。

 
$ ./command-line-flags -word=opt a1 a2 a3 -numb=7
word: opt
numb: 42
fork: false
svar: bar
tail: [a1 a2 a3 -numb=7]

-h または --help フラグを使用して、コマンドラインプログラムの自動生成ヘルプテキストを取得します。

 
$ ./command-line-flags -h
Usage of ./command-line-flags:
  -fork=false: a bool
  -numb=42: an int
  -svar="bar": a string var
  -word="foo": a string

flag パッケージに指定されなかったフラグを指定すると、プログラムはエラーメッセージを出力し、ヘルプテキストを再度表示します。

 
$ ./command-line-flags -wat
flag provided but not defined: -wat
Usage of ./command-line-flags:
...

次の例: コマンドラインサブコマンド。

Mark McGranaghan および Eli Bendersky | ソース | ライセンス