通过Spring Shell 开发 Java 命令行应用

提到 Java，大家都会想到 Java 在服务器端应用开发中的使用。实际上，Java 在命令行应用的开发中也有一席之地。在很多情况下，相对于图形用户界面来说，命令行界面响应速度快，所占用的系统资源少。在与用户进行交互的场景比较单一时，命令行界面是更好的选择。命令行界面有其固定的交互模式。通常是由用户输入一系列的参数，在执行之后把相应的结果在控制台输出。命令行应用通常需要处理输入参数的传递和验证、输出结果的格式化等任务。Spring Shell 可以帮助简化这些常见的任务，让开发人员专注于实现应用的业务逻辑。本文对 Spring Shell 进行详细的介绍。

Spring Shell 入门

最简单的创建 Spring Shell 应用的方式是使用 Spring Boot。从 Spring Initializr 网站（http://start.spring.io/）上创建一个新的基于 Apache Maven 的 Spring Boot 应用，然后添加 Spring Shell 相关的依赖即可。本文介绍的是 Spring Shell 2.0.0.M2 版本，目前还只是 Milestone 版本，因此需要在 pom.xml 中添加 Spring 提供的包含 Milestone 版本工件的 Maven 仓库，如代码清单 1 所示。否则的话，Maven 会无法找到相应的工件。

清单 1. 添加 Spring Shell 的 Maven 仓库

<repositories> <repository> <id>spring-milestone</id> <name>Spring Repository</name> <url>https://repo.spring.io/milestone</url> </repository></repositories>

在添加了 Spring Shell 的 Maven 仓库之后，可以在 Spring Boot 项目中添加对于spring-shell-starter 的依赖，如代码清单 2 所示。

清单 2. 添加 Spring Shell 所需 Maven 依赖

<dependency> <groupId>org.springframework.shell</groupId> <artifactId>spring-shell-starter</artifactId> <version>2.0.0.M2</version></dependency>

我们接着可以创建第一个基于 Spring Shell 的命令行应用。该应用根据输入的参数来输出相应的问候语，完整的代码如清单 3 所示。从代码清单 3 中可以看到，在 Spring Shell 的帮助下，完整的实现代码非常简单。代码的核心是两个注解：@ShellComponent 声明类GreetingApp 是一个 Spring Shell 的组件；@ShellMethod 表示方法 sayHi 是可以在命令行运行的命令。该方法的参数 name 是命令行的输入参数，而其返回值是命令行执行的结果。

清单 3. 输出问候语的命令行应用

<dependency> <groupId>org.springframework.shell</groupId> <artifactId>spring-shell-starter</artifactId> <version>2.0.0.M2</version></dependency>

接下来我们运行该应用。运行起来之后，该应用直接进入命令行提示界面，我们可以输入 help 来输出使用帮助。help 是 Spring Shell 提供的众多内置命令之一，在列出的命令中，可以看到我们创建的 say-hi 命令。我们输入"say-hi Alex"来运行该命令，可以看到输出的结果"Hi Alex"。如果我们直接输入"say-hi"，会看到输出的错误信息，告诉我们参数"--name"是必须的。从上面的例子可以看出，在 Spring Shell 的帮助下，创建一个命令行应用是非常简单的。很多实用功能都已经默认提供了。在使用 Spring Initializr 创建的 Spring Boot 项目中，默认提供了一个单元测试用例。这个默认的单元测试用例与 Spring Shell 在使用时存在冲突。在进行代码清单 3 中的项目的 Maven 构建时，该测试用例需要被禁用，否则构建过程会卡住。