Go で CLI を使用するにはどうすればよいですか?

Go 言語では CLI (コマンドライン インターフェイス) を使用するのが非常に一般的です。これを使用すると、小さなコマンドライン ツールをすばやく作成し、ユーザーと対話できるためです。この記事では、Go で CLI を使用する方法を詳しく説明し、いくつかの実用的なヒントとアドバイスを提供します。

1. CLI フレームワーク

CLI の作成を開始する前に、CLI フレームワークを選択する必要があります。これらのフレームワークを使用すると、CLI をすばやく作成し、さまざまな機能とオプションを提供できるからです。一般的に使用される Go CLI フレームワークの一部を以下に示します。

• Cobra: CLI アプリケーションを簡単に作成するのに役立ち、さまざまな機能とオプションを提供する、非常に人気のある強力なフレームワークです。
• Kingpin: エレガントな構文とオプション解析を提供するもう 1 つの人気のあるフレームワーク。
• Cli: 小さな CLI アプリケーションの作成に役立つ、非常にシンプルですが便利なフレームワークです。

プロジェクトのニーズと複雑さに基づいて、適切な CLI フレームワークを選択できます。

2. コマンドの作成

CLI フレームワークを選択したら、コマンドの作成を開始できます。コマンドは CLI アプリケーションの主要コンポーネントであり、アプリケーションの動作と機能を定義します。コマンドの例をいくつか示します。

$ mycli ls
$ mycli mkdir /path/to/directory
$ mycli cat /path/to/file.txt

Cobra では、次のようなコードを使用してコマンドを作成できます。

var listCmd = &cobra.Command{
    Use:   "list",
    Short: "List all the items",
    Long:  `List all the items in a given directory`,
    Run: func(cmd *cobra.Command, args []string) {
        // command logic goes here
    },
}

上記のコードは、「list」というコマンドを作成します。その簡単な説明は次のとおりです。 「すべてのアイテムをリストする」であり、その詳細な説明は「指定されたディレクトリ内のすべてのアイテムをリストする」です。

このフレームワークを使用および変更して、一般的に使用されるコマンドを簡単に作成し、必要に応じてカスタム オプションを追加できます。

3. コマンド オプション

コマンド オプションは、必要に応じてコマンドに渡すことができる CLI アプリケーションのオプションのパラメーターです。これらのオプションは 2 つの方法で作成できます。フレームワークによって提供されるフラグ パッケージを使用する方法と、pflag や cli などのサードパーティ ライブラリを使用する方法です。

コマンド オプションの例をいくつか示します:

$ mycli list -a -l
$ mycli cat /path/to/file --verbose=false

Cobra では、次のコードのようなものを使用してオプションを追加できます:

var listCmd = &cobra.Command{
    Use:   "list",
    Short: "List all the items",
    Long:  `List all the items in a given directory`,
    Run: func(cmd *cobra.Command, args []string) {
        // command logic goes here
    },
}

func init() {
    listCmd.PersistentFlags().BoolVarP(&showAll, "all", "a", false, "Show all files")
    listCmd.PersistentFlags().BoolVarP(&longFormat, "long", "l", false, "Use long listing format")
    rootCmd.AddCommand(listCmd)
}

上記のコードは 2 つのフラグを追加します。 「all」と「long」を追加し、「list」コマンドに追加します。

4. 操作コマンド ライン パラメーター

Go では、os パッケージと flag パッケージを使用してコマンド ライン パラメーターを操作できます。 os.Args 変数には、アプリケーションの実行時に渡されるコマンド ライン引数が含まれます。 flag パッケージを使用すると、これらのパラメータを簡単に解析してアクセスできます。

次は、フラグ パッケージを使用してコマンド ライン パラメーターを解析する方法を示す例です。

func main() {
    // Define flags
    url := flag.String("url", "https://www.example.com", "URL to fetch")
    timeout := flag.Duration("timeout", time.Second * 5, "Timeout for HTTP request")

    flag.Parse()

    // Use flags
    fmt.Printf("Fetching %s with timeout %v...", *url, *timeout)
}

上記のコードは、「url」と「timeout」という 2 つのフラグを作成し、解析します。それらを使用します。

5. コマンド対話

ユーザーと対話することで、より複雑で便利な CLI アプリケーションを作成できます。 Go には、cli、term、その他のライブラリなど、対話の実現に役立つライブラリが多数あります。

以下は、cli ライブラリを使用した例です:

func main() {
    app := cli.NewApp()
    app.Name = "myapp"
    app.Usage = "An example CLI application"

    // Define commands
    app.Commands = []cli.Command{
        {
            Name:    "greet",
            Aliases: []string{"g"},
            Usage:   "Greet the user",
            Action: func(c *cli.Context) error {
                fmt.Println("Hello!")
                return nil
            },
        },
        // Add more commands here
    }

    app.Run(os.Args)
}

上記のコードは、「Hello!」を出力してプログラムを終了する「greet」という名前のコマンドを定義しています。必要に応じて、さらにカスタム コマンドやインタラクションを追加できます。

6. CLI アプリケーションのテスト

最後に、CLI アプリケーションをテストして、期待どおりに動作することを確認する必要があります。 Go 標準ライブラリのテスト パッケージと、Testify、GoConvey などのテスト用のサードパーティ ツールを使用できます。

以下はサンプル テスト コードです:

func TestListCmd(t *testing.T) {
    cmd := exec.Command("mycli", "list", "-a", "-l")
    bytes, err := cmd.CombinedOutput()
    output := string(bytes)
    if err != nil {
        t.Errorf("Command failed: %v", err)
    }
    if !strings.Contains(output, "testFile") {
        t.Errorf("Expected output to contain 'testFile', got '%s'", output)
    }
}

上記のコードは、「list」という名前のコマンドをテストして、ファイル リストが正しく表示されることを確認します。

概要

この記事では、Go で CLI アプリケーションを作成する方法について説明しました。 CLI フレームワークの選択、コマンドの作成、コマンド オプションの使用、コマンド ライン引数の操作、CLI アプリケーションの操作とテストのプロセスについて学びました。この情報が役に立ち、CLI アプリケーションにさらに便利な機能を実装できることを願っています。

以上がGo で CLI を使用するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。