2 开发Spring Shell应用程序

  向shell提供命令非常简单,需要学习的注解很少。该命令的实现风格与使用依赖注入的应用程序的开发类相同,您可以利用Spring容器的所有特性来实现您的命令类。

2.1 标记接口

  创建命令的第一步是实现标记接口CommandMarker,并使用Spring的@Component注解对类进行注解(注意一个JIRA问题:提供@CliCommand元注解避免使用标记接口)。使用helloworld示例应用程序中的代码为例,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 }

2.2 日志

  目前,日志记录是使用JDK日志记录的。由于控制台、JLine和Ansi处理的复杂性,一般都建议将消息作为返回值的方式显示在shell窗口。但是,当需要进行日志记录时,典型的JDK logger声明就足够了。

 @Component
public class HelloWorldCommands implements CommandMarker { protected final Logger LOG = Logger.getLogger(getClass().getName()); // methods with @Cli annotations go here }

  注意:一般开发人员的职责是为第三方库处理日志,应当要减少日志级别,这样控制台或者shell窗口就不会受到日志消息的影响。

2.3 CLI注解

  在方法和方法参数上使用了三个注释,这些注释定义了与shell交互的主要契约,分别是:

  • CliAvailabilityIndicator - 放在一个方法前返回一个布尔值,表示在shell中是否可以执行一个特定的命令。这个决定通常基于之前执行的命令的历史。它可以防止在满足某些先决条件时出现外部命令,例如执行'configuration'命令。
  • CliCommand - 放置在向shell提供命令的方法上。它的值提供了一个或多个字符串,这些字符串作为特定命令名的开始。在整个应用程序中,包括所有的插件中这些必须是唯一的。
  • CliOption - 放置在命令方法的参数中,允许它默认值声明参数值为必填的或可选的。

  下面是在命令类中使用这些注解的简单用法

 @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,这是这个类中暴露给shell调用的唯一的命令。如果类中有更多的命令,则将它们作为逗号分隔值列出。
  @CliCommand注解是创建shell命令'hw simple'。帮助消息是如果您使用帮助命令'help'将会打印什么内容。这里定义方法名是“simple”,但它可以是任何自定义的名称。
  @CliOption注解在每个命令的参数。您需要决定哪些参数是必需的,哪些是可选的,如果它们是可选的,则有一个默认值。在本例中,该命令有两个参数:消息'message'和位置'location'。需要使用消息选项,并提供一个帮助消息,以便在为该命令完成任务时为用户提供指导。
  “simple”方法的实现很简单,只是一个日志语句,但这是通常调用的其他对象,这些对象是通过Spring注入到类中的,然后可以实现复杂的功能。
  本例中的方法参数类型是String,它不会出现类型转换的任何问题。您可以指定任何的对象类型以及基本数据类型,如int, float等。对所有类型以外由默认shell(基本数据类型, Date, File)需要在您的插件中与容器的转换器接口org.springframework.shell.core.Converter 注册它的转换。
  注意,方法返回参数可以是非void,在我们的示例中,它是我们想要显示的实际消息。返回非void类型时,shell将显示为它的toString()字符。

2.4 测试shell命令

  执行测试的shell命令,您可以实例化shell在一个测试用例中执行命令,然后在返回值CommandResult执行断言。一个简单的基类设置如下所示:

 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;
} }

  这里有一个测试日期命令的例子:

 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注解方法的返回值。您应该向适当的类型转换,以帮助执行您的断言。

2.5 构建和运行shell

  在我们看来,构建和执行shell最简单的方法是剪切和粘贴脚本。这将使来自于分级的应用程序插件创建一个bin目录,该目录带有用于windows和Unix的启动脚本,并将所有依赖jar放在lib目录中。Maven有一个类似的插件——AppAssembler插件。
  shell的主类是org.springframework.shell.Bootstrap的。只要您在类路径上放置其他的插件,或者是独立开发的,引导类就会将它们合并到shell中。

  

  其他相关链接:

  《Spring Shell介绍》http://www.cnblogs.com/acm-bingzi/p/springshell.html

  《Spring Shell参考文档》http://www.cnblogs.com/acm-bingzi/p/springshell1.html

开发Spring Shell应用程序的更多相关文章

  1. Spring Shell参考文档

    Spring Shell的核心组件是它的插件模型(plugin model).内置命令(built-in commands)和转换器( converters). 1.1 Plugin Model(插件 ...

  2. Spring Framework------>version4.3.5.RELAESE----->Reference Documentation学习心得----->使用Spring Framework开发自己的应用程序

    1.直接基于spring framework开发自己的应用程序: 1.1参考资料: Spring官网spring-framework.4.3.5.RELAESE的Reference Documenta ...

  3. Hadoop:开发机运行spark程序,抛出异常:ERROR Shell: Failed to locate the winutils binary in the hadoop binary path

    问题: windows开发机运行spark程序,抛出异常:ERROR Shell: Failed to locate the winutils binary in the hadoop binary ...

  4. 使用IDEA开发Spring入门程序

    使用IDEA开发Spring入门程序 前言 本文通过一个简单的入门程序向读者演示Spring框架的使用过程,具体如下: 一.使用IDEA创建Maven应用项目并导入相应模块 使用IDEA创建一个名为n ...

  5. Spring Shell介绍

    最近开发中在下遇到了spring-shell开发工具的项目,现在整理了相关文章,以供大家学习 本博客相关的文章均是在Spring Shell 1.2.0的基础上建立   Spring Shell介绍 ...

  6. Spring Shell入门介绍

    目录 Spring Shell是什么 入门实践 基础配置 简单示例 注解@ShellMethod 注解@ShellOption 自定义参数名称 设置参数默认值 为一个参数传递多个值 对布尔参数的特殊处 ...

  7. [Ruby on Rails系列]3、初试Rails:使用Rails开发第一个Web程序

    本系列前两部分已经介绍了如何配置Ruby on Rails开发环境,现在终于进入正题啦! Part1.开发前的准备 本次的主要任务是开发第一个Rails程序.需要特别指出的是,本次我选用了一个(Paa ...

  8. 关于Eclipse平台的使用和开发第一个SWT程序

    IBM把投入巨资开发的Eclipse作为一个开源项目捐献给了开源组织Eclipse.org Eclipse出色而有独创的平台特性,现在仍由IBM子公司OTI(主要从事Eclipse开发的人)继续领导着 ...

  9. 将 Java Spring Framework 应用程序迁移到 Windows Azure

    我们刚刚发布了一个新教程和示例代码,以阐述如何在Windows Azure中使用 Java 相关技术.在该指南中,我们提供了分步教程,说明如何将 Java Spring Framework 应用程序( ...

随机推荐

  1. 数据库连接池DBUtils使用

    一.简介 DBUtils简单说python实现的线程化数据库连接(连接池),DBUtils支持所有遵循DP-API 2规范的数据库连接模块,例如:mysql.sqlserver.oracle.sqli ...

  2. linux下使用软连接之案例二

           在笔者的上一篇文章介绍过怎么通过linux的软连接在不修改上传代码的情况下,将上传到项目路径下的图片改为上传到项目外面,防止重新部署后图片被删除了.同时还可以直接通过类似访问静态资源的方 ...

  3. WPF控件加阴影模糊问题

    原文:WPF控件加阴影模糊问题 不能直接把阴影加在控件上 应该加在控件的同级兄弟节点上,覆盖在底下就不会模糊了

  4. Luogu P1196 [NOI2002]银河英雄传说

    一年没写博客了(滑稽). 这道题很玄学,导致自己都有一个坑人的问题求解.如果有大佬有能力求帮助:https://www.luogu.org/discuss/show?postid=30231 再来讲一 ...

  5. 定制 input[type="radio"] 和 input[type="checkbox"] 样式

    表单中,经常会使用到单选按钮和复选框,但是,input[type="radio"] 和 input[type="checkbox"] 的默认样式在不同的浏览器或 ...

  6. maven常用命令集

    maven常用命令 mvn compile  编译主程序源代码,不会编译test目录的源代码.第一次运行时,会下载相关的依赖包,可能会比较费时间. mvn test-compile  编译测试代码,c ...

  7. 数据库历险记(二) | Redis 和 Mecached 到底哪个好?

    文章首发于微信公众号「陈树义」,专注于 Java 技术分享的社区.点击链接扫描二维码,与500位小伙伴一起共同进步.微信公众号二维码 http://p3npq6ecr.bkt.clouddn.com/ ...

  8. Flutter - 创建侧滑菜单(不使用navigatior,仅改变content)

    之前写过一篇文章,Flutter - 创建横跨所有页面的侧滑菜单.这个里面中使用了Navigator.of(context).push来导航到新的页面. 这次介绍一种不使用导航,仅仅改变content ...

  9. centos 7 git的管理和使用

    一.linux 安装git (服务端) 1.首先创建用户账号 useradd zlx passwd zlx .... 2.创建目录git仓库 mkdir zlx_git.git 3.赋权限 chown ...

  10. Houdini Linux Crack

    安装 破解停止服务 /etc/init.d/sesinetd stop 刪除sesinetd | 拷贝破解文件sesinetd | 修改sesinetd的权限(读写权限) cd /usr/lib/se ...