向shell提供命令非常簡單，需要學(xué)習(xí)的注解很少。該命令的實(shí)現(xiàn)風(fēng)格與使用依賴注入的應(yīng)用程序的開發(fā)類相同，您可以利用Spring容器的所有特性來實(shí)現(xiàn)您的命令類。

　　spring-shell官網(wǎng)地址：https://projects.spring.io/spring-shell/

 標(biāo)記接口

　　創(chuàng)建命令的第一步是實(shí)現(xiàn)標(biāo)記接口CommandMarker，并使用Spring的@Component注解對(duì)類進(jìn)行注解(注意一個(gè)JIRA問題：提供@CliCommand元注解避免使用標(biāo)記接口)。使用helloworld示例應(yīng)用程序中的代碼為例，HelloWorldCommands類的代碼如下所示：

@Component
public class HelloWorldCommands implements CommandMarker {
 // use any Spring annotations for Dependency Injection or other Spring interfaces
 // as required.
 // methods with @Cli annotations go here
}

日志

　　目前，日志記錄是使用JDK日志記錄的。由于控制臺(tái)、JLine和Ansi處理的復(fù)雜性，一般都建議將消息作為返回值的方式顯示在shell窗口。但是，當(dāng)需要進(jìn)行日志記錄時(shí)，典型的JDK logger聲明就足夠了。

@Component
public class HelloWorldCommands implements CommandMarker {

 protected final Logger LOG = Logger.getLogger(getClass().getName());

 // methods with @Cli annotations go here

}

　　注意：一般開發(fā)人員的職責(zé)是為第三方庫處理日志，應(yīng)當(dāng)要減少日志級(jí)別，這樣控制臺(tái)或者shell窗口就不會(huì)受到日志消息的影響。

 CLI注解

　　在方法和方法參數(shù)上使用了三個(gè)注釋，這些注釋定義了與shell交互的主要契約，分別是:

• CliAvailabilityIndicator - 放在一個(gè)方法前返回一個(gè)布爾值，表示在shell中是否可以執(zhí)行一個(gè)特定的命令。這個(gè)決定通常基于之前執(zhí)行的命令的歷史。它可以防止在滿足某些先決條件時(shí)出現(xiàn)外部命令，例如執(zhí)行'configuration'命令。
• CliCommand - 放置在向shell提供命令的方法上。它的值提供了一個(gè)或多個(gè)字符串，這些字符串作為特定命令名的開始。在整個(gè)應(yīng)用程序中，包括所有的插件中這些必須是唯一的。
• CliOption - 放置在命令方法的參數(shù)中，允許它默認(rèn)值聲明參數(shù)值為必填的或可選的。

　　下面是在命令類中使用這些注解的簡單用法

@Component
public class HelloWorldCommands implements CommandMarker {

 @CliAvailabilityIndicator({"hw simple"})
 public boolean isCommandAvailable() {
  return true;
 }

 @CliCommand(value = "hw simple", help = "Print a simple hello world message")
 public String simple(
  @CliOption(key = { "message" }, mandatory = true, help = "The hello world message")
  final String message,

  @CliOption(key = { "location" }, mandatory = false,
        help = "Where you are saying hello", specifiedDefaultValue="At work")
  final String location) {

  return "Message = [" + message + "] Location = [" + location + "]";

 }
}

注解@CliAvailabilityIndicator方法返回true，這是這個(gè)類中暴露給shell調(diào)用的唯一的命令。如果類中有更多的命令，則將它們作為逗號(hào)分隔值列出。

　　@CliCommand注解是創(chuàng)建shell命令'hw simple'。幫助消息是如果您使用幫助命令'help'將會(huì)打印什么內(nèi)容。這里定義方法名是“simple”，但它可以是任何自定義的名稱。

　　@CliOption注解在每個(gè)命令的參數(shù)。您需要決定哪些參數(shù)是必需的，哪些是可選的，如果它們是可選的，則有一個(gè)默認(rèn)值。在本例中，該命令有兩個(gè)參數(shù)：消息'message'和位置'location'。需要使用消息選項(xiàng)，并提供一個(gè)幫助消息，以便在為該命令完成任務(wù)時(shí)為用戶提供指導(dǎo)。

　　“simple”方法的實(shí)現(xiàn)很簡單，只是一個(gè)日志語句，但這是通常調(diào)用的其他對(duì)象，這些對(duì)象是通過Spring注入到類中的，然后可以實(shí)現(xiàn)復(fù)雜的功能。

　　本例中的方法參數(shù)類型是String，它不會(huì)出現(xiàn)類型轉(zhuǎn)換的任何問題。您可以指定任何的對(duì)象類型以及基本數(shù)據(jù)類型,如int, float等。對(duì)所有類型以外由默認(rèn)shell(基本數(shù)據(jù)類型, Date, File)需要在您的插件中與容器的轉(zhuǎn)換器接口org.springframework.shell.core.Converter 注冊(cè)它的轉(zhuǎn)換。

　　注意，方法返回參數(shù)可以是非void，在我們的示例中，它是我們想要顯示的實(shí)際消息。返回非void類型時(shí)，shell將顯示為它的toString()字符。

測試shell命令

　　執(zhí)行測試的shell命令，您可以實(shí)例化shell在一個(gè)測試用例中執(zhí)行命令，然后在返回值CommandResult執(zhí)行斷言。一個(gè)簡單的基類設(shè)置如下所示：

public abstract class AbstractShellIntegrationTest {

 private static JLineShellComponent shell;

 @BeforeClass
 public static void startUp() throws InterruptedException {
 Bootstrap bootstrap = new Bootstrap();
 shell = bootstrap.getJLineShellComponent();
 }

 @AfterClass
 public static void shutdown() {
 shell.stop();
 }

 public static JLineShellComponent getShell() {
 return shell;
 }

}

　　這里有一個(gè)測試日期命令的例子：

public class BuiltInCommandTests extends AbstractShellIntegrationTest {

 @Test
 public void dateTest() throws ParseException {

 //Execute command
 CommandResult cr = getShell().executeCommand("date");

 //Get result
 DateFormat df = DateFormat.getDateTimeInstance(DateFormat.FULL, DateFormat.FULL,Locale.US);
 Date result = df.parse(cr.getResult().toString());

 //Make assertions - DateMaters is an external dependency not shown here.
 Date now = new Date();
 MatcherAssert.assertThat(now, DateMatchers.within(5, TimeUnit.SECONDS, result));
 }
}

　　CommandResult的getResult方法返回的 java.lang.Class將匹配與@CliCommand注解方法的返回值。您應(yīng)該向適當(dāng)?shù)念愋娃D(zhuǎn)換，以幫助執(zhí)行您的斷言。

構(gòu)建和運(yùn)行shell

　　在我們看來，構(gòu)建和執(zhí)行shell最簡單的方法是剪切和粘貼腳本。這將使來自于分級(jí)的應(yīng)用程序插件創(chuàng)建一個(gè)bin目錄，該目錄帶有用于windows和Unix的啟動(dòng)腳本，并將所有依賴jar放在lib目錄中。Maven有一個(gè)類似的插件——AppAssembler插件。

　　shell的主類是org.springframework.shell.Bootstrap的。只要您在類路徑上放置其他的插件，或者是獨(dú)立開發(fā)的，引導(dǎo)類就會(huì)將它們合并到shell中。

以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論