TOC

Springシェルを使ったCLI

Spring Shellを使用したCLI

1. 概要

簡単に言えば、Spring Shellprojectは、コマンドを処理し、Springプログラミングモデルを使用してフル機能のCLIを構築するための対話型シェルを提供します。

この記事では、その機能、キークラス、アノテーションについて説明し、いくつかのカスタムコマンドとカスタマイズを実装します。

2. メーベン依存

まず、spring-shellの依存関係をpom.xmlに追加する必要があります。 


    org.springframework.shell
    spring-shell
    1.2.0.RELEASE

このアーティファクトの最新バージョンはhereにあります。

3. シェルへのアクセス

アプリケーションでシェルにアクセスするには、主に2つの方法があります。

1つ目は、アプリケーションのエントリポイントでシェルをブートストラップし、ユーザーがコマンドを入力できるようにすることです。 

public static void main(String[] args) throws IOException {
    Bootstrap.main(args);
}

2つ目は、JLineShellComponentを取得し、プログラムでコマンドを実行することです。 

Bootstrap bootstrap = new Bootstrap();
JLineShellComponent shell = bootstrap.getJLineShellComponent();
shell.executeCommand("help");

この記事の例に最も適しているため、最初のアプローチを使用しますが、ソースコードには、2番目の形式を使用するテストケースがあります。

4. コマンド

シェルには、clear、help、exitなど、すべてのCLIの標準機能を提供する組み込みコマンドがすでにいくつかあります。

カスタムコマンドは、CommandMarkerインターフェイスを実装するSpringコンポーネント内に@CliCommandアノテーションでマークされたメソッドを追加することで公開できます。

そのメソッドのすべての引数は、@CliOptionアノテーションでマークする必要があります。これを怠ると、コマンドを実行しようとしたときにいくつかのエラーが発生します。

4.1. シェルへのコマンドの追加

まず、コマンドがどこにあるかをシェルに知らせる必要があります。 このためには、ファイルMETA-INF/spring/spring-shell-plugin.xmlがプロジェクトに存在する必要があります。そこで、Springのコンポーネントスキャン機能を使用できます。

コンポーネントは春で登録してインスタンス化されると、それらはシェルのパーザに登録されており、その注釈が処理されます。

2つの簡単なコマンドを作成しましょう。1つはURLのコンテンツを取得して表示するコマンドで、もう1つはそれらのコンテンツをファイルに保存するコマンドです。 

@Component
public class SimpleCLI implements CommandMarker {

    @CliCommand(value = { "web-get", "wg" })
    public String webGet(
      @CliOption(key = "url") String url) {
        return getContentsOfUrlAsString(url);
    }

    @CliCommand(value = { "web-save", "ws" })
    public String webSave(
      @CliOption(key = "url") String url,
      @CliOption(key = { "out", "file" }) String file) {
        String contents = getContentsOfUrlAsString(url);
        try (PrintWriter out = new PrintWriter(file)) {
            out.write(contents);
        }
        return "Done.";
    }
}

それぞれ@CliCommandと@CliOptionのvalue属性とkey属性に複数の文字列を渡すことができることに注意してください。これにより、同じように動作する複数のコマンドと引数を公開できます。 。

それでは、すべてが期待どおりに機能しているかどうかを確認しましょう。 

spring-shell>web-get --url https://www.google.com
web-save --url https://www.google.com --out contents.txt
Done.

4.2. コマンドの可用性

booleanを返すメソッドで@CliAvailabilityIndicatorアノテーションを使用して、実行時にコマンドをシェルに公開する必要があるかどうかを変更できます。

まず、web-saveコマンドの可用性を変更するメソッドを作成しましょう。 

private boolean adminEnableExecuted = false;

@CliAvailabilityIndicator(value = "web-save")
public boolean isAdminEnabled() {
    return adminEnableExecuted;
}

それでは、adminEnableExecuted変数を変更するコマンドを作成しましょう。 

@CliCommand(value = "admin-enable")
public String adminEnable() {
    adminEnableExecuted = true;
    return "Admin commands enabled.";
}

最後に、それを確認しましょう。 

spring-shell>web-save --url https://www.google.com --out contents.txt
Command 'web-save --url https://www.google.com --out contents.txt'
  was found but is not currently available
  (type 'help' then ENTER to learn about this command)
spring-shell>admin-enable
Admin commands enabled.
spring-shell>web-save --url https://www.google.com --out contents.txt
Done.

4.3. 必須の引数

デフォルトでは、すべてのコマンド引数はオプションです。 ただし、@CliOptionアノテーションのmandatory属性を使用してそれらを必須にすることができます。 

@CliOption(key = { "out", "file" }, mandatory = true)

これで、導入しないとエラーが発生することをテストできます。 

spring-shell>web-save --url https://www.google.com
You should specify option (--out) for this command

4.4. デフォルトの引数

@CliOptionのkey値が空の場合、その引数がデフォルトになります。 そこで、名前付き引数の一部ではない、シェルで導入された値を受け取ります。 

@CliOption(key = { "", "url" })

それでは、期待どおりに機能することを確認しましょう。 

spring-shell>web-get https://www.google.com

4.5. ユーザーを支援する

@CliCommandおよび@CliOptionアノテーションは、help属性を提供します。これにより、組み込みのhelpコマンドを使用するとき、またはタブを押してオートコンプリートを取得するときに、ユーザーをガイドできます。

web-getを変更して、カスタムヘルプメッセージを追加しましょう。 

@CliCommand(
  // ...
  help = "Displays the contents of an URL")
public String webGet(
  @CliOption(
    // ...
    help = "URL whose contents will be displayed."
  ) String url) {
    // ...
}

これで、ユーザーはコマンドの実行内容を正確に知ることができます。 

spring-shell>help web-get
Keyword:                    web-get
Keyword:                    wg
Description:                Displays the contents of a URL.
  Keyword:                  ** default **
  Keyword:                  url
    Help:                   URL whose contents will be displayed.
    Mandatory:              false
    Default if specified:   '__NULL__'
    Default if unspecified: '__NULL__'

* web-get - Displays the contents of a URL.
* wg - Displays the contents of a URL.

5. カスタマイズ

BannerProvider、PromptProvider、およびHistoryFileNameProviderインターフェースを実装してシェルをカスタマイズするには、3つの方法があります。これらはすべて、デフォルトの実装がすでに提供されています。

また、@Orderアノテーションを使用して、プロバイダーがこれらの実装よりも優先されるようにする必要があります。

新しいバナーを作成して、カスタマイズを開始しましょう。 

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class SimpleBannerProvider extends DefaultBannerProvider {

    public String getBanner() {
        StringBuffer buf = new StringBuffer();
        buf.append("=======================================")
            .append(OsUtils.LINE_SEPARATOR);
        buf.append("*          example Shell             *")
            .append(OsUtils.LINE_SEPARATOR);
        buf.append("=======================================")
            .append(OsUtils.LINE_SEPARATOR);
        buf.append("Version:")
            .append(this.getVersion());
        return buf.toString();
    }

    public String getVersion() {
        return "1.0.1";
    }

    public String getWelcomeMessage() {
        return "Welcome to example CLI";
    }

    public String getProviderName() {
        return "example Banner";
    }
}

バージョン番号とウェルカムメッセージも変更できることに注意してください。

それでは、プロンプトを変更しましょう。 

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class SimplePromptProvider extends DefaultPromptProvider {

    public String getPrompt() {
        return "example-shell";
    }

    public String getProviderName() {
        return "example Prompt";
    }
}

最後に、履歴ファイルの名前を変更しましょう。 

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class SimpleHistoryFileNameProvider
  extends DefaultHistoryFileNameProvider {

    public String getHistoryFileName() {
        return "example-shell.log";
    }

    public String getProviderName() {
        return "example History";
    }

}

履歴ファイルは、シェルで実行されたすべてのコマンドを記録し、アプリケーションと一緒に配置されます。

すべてが整ったら、シェルを呼び出して動作を確認できます。 

=======================================
*          example Shell             *
=======================================
Version:1.0.1
Welcome to example CLI
example-shell>

6. コンバーター

これまで、コマンドの引数として単純な型のみを使用してきました。 Integer、Date、Enum、Fileなどの一般的なタイプには、デフォルトのコンバーターがすでに登録されています。

Converterインターフェースを実装することにより、カスタムオブジェクトを受信するためのコンバーターを追加することもできます。

StringをURLに変換できるコンバーターを作成しましょう。 

@Component
public class SimpleURLConverter implements Converter {

    public URL convertFromText(
      String value, Class requiredType, String optionContext) {
        return new URL(value);
    }

    public boolean getAllPossibleValues(
      List completions,
      Class requiredType,
      String existingData,
      String optionContext,
      MethodTarget target) {
        return false;
    }

    public boolean supports(Class requiredType, String optionContext) {
        return URL.class.isAssignableFrom(requiredType);
    }
}

最後に、web-getコマンドとweb-saveコマンドを変更しましょう。 

public String webSave(... URL url) {
    // ...
}

public String webSave(... URL url) {
    // ...
}

ご想像のとおり、コマンドの動作は同じです。

7. 結論

この記事では、Spring Shellプロジェクトのコア機能について簡単に説明しました。 コマンドを提供し、プロバイダーでシェルをカスタマイズし、実行時のさまざまな条件に応じてコマンドの可用性を変更し、単純な型コンバーターを作成しました。

この記事の完全なソースコードはover on GitHubにあります。

Related