コマンド構文
オプションと引数
コマンドオプションと引数は、メソッドパラメーターを使用して定義できます。
class Example2 {
@Command(name = "hi", description = "Say hi to a given name", group = "greetings",
help = "A command that greets the user with 'Hi ${name}!' with a configurable suffix. Example usage: hi -s=! John")
public void sayHi(
@Argument(index = 0, description = "the name of the person to greet",
defaultValue = "world") String name,
@Option(shortName = 's', longName = "suffix", description = "the suffix of the greeting message",
defaultValue = "!") char suffix) {
System.out.println("Hi " + name + suffix);
}
} オプションは @Option アノテーションを使用して定義され、引数は @Argument アノテーションを使用して定義されます。オプションは名前付きで、引数は位置指定です。オプションには、短い名前（1 文字）と長い名前（複数文字）があります。
オプションは、メソッドパラメーターに検証アノテーションを追加することで、Bean 検証 API を使用して検証できます。詳細については、コマンドオプションの検証セクションを参照してください。
解析ルール
Spring Shell は Spring Boot と同じ解析規則に従いますが、POSIX スタイルに準拠した拡張機能を備えています。オプションは、--key=value または --key value の長い形式だけでなく、-k=value または -k value の短い形式でも指定できます。オプションと引数は任意の順序で指定できます。引数は他の引数と 0 から始まるインデックスで示されます。
CommandSyntax ::= CommandName [SubCommandName]* [Option | Argument]*
CommandName ::= String
SubCommandName ::= String
Option ::= ShortOption | LongOption
ShortOption ::= '-' Char ['='|' ']? String
LongOption ::= '--' String ['='|' ']? String
Argument ::= String例:
$>mycommand mysubcommand --optionA=value1 arg1 -b=value2 arg2 --optionC value3 -d value4 オプションが指定された場合、たとえそれがブール値であっても、常にそのオプションの値を持つことが想定されます。これは、オプションの値と引数を区別するために必要です。また、短いオプションはグループ化できません（例: -abc はサポートされていません）。 |
コマンドにオプションがない場合は、引数とサブコマンド間の曖昧さを避けるために、引数を "--" （POSIX スタイル）で区切る必要があります。
$>mycommand -- arg1 arg2同様に、コマンドがオプションなしで使用されるサブコマンドを定義する場合、引数とサブコマンド間の曖昧さを避けるために、引数も "--" (POSIX スタイル) を使用して区切る必要があります。
$>mycommand mysubcommand -- arg1 arg2| 曖昧さを避けるために、特にサブコマンドが関係する場合は、可能な限り位置引数よりも名前付きオプションを優先する必要があります ( コマンドラインインターフェースガイドライン (英語) を参照)。 |
