使用Spring提供的CommandLineRunner接口可以实现了一个命令行应用程序。但是,参数/选项/参数处理却不是那么好。幸运的是,有一种更好的方法可以使用Spring Boot编写命令行应用程序,并且还可以使用ApplicationRunner接口进行解析。
在我们开始快速说明之前。在这两种情况下,无论是CommandLineRunner还是ApplicationRunner,都始终支持Spring的属性处理。我们可以像往常一样使用@Value注释注入值。
完整的工作源代码在 这里
首先,我们创建一个简单的Spring Boot应用程序并实现ApplicationRunner接口。现在,Spring可以获得我们的这个类并执行它。它类似于CommandLineRunner。
我们还必须实现一个方法run,但是我们将ApplicationArguments 作为入参数而不是String列表。
ApplicationArguments区分选项参数和非选项参数。选项参数是我们可以通过Spring Boot属性处理使用的(如 app.name = Myapp)。它们还可以通过传入逗号分隔列表或多次使用参数来为每个选项包含多个值。
非选项参数是我们在命令行传递除了VM参数的所有其他参数。
在示例中,我们将打印出我们收到的每种类型的参数,然后显示它们。
@SpringBootApplication public class CommandlineAppApplication implements ApplicationRunner{ public static void main(String[] args) { SpringApplication.run(CommandlineAppApplication.class, args); } @Override public void run(ApplicationArguments args) throws Exception { System.out.println("# NonOptionArgs: " + args.getNonOptionArgs().size()); System.out.println("NonOptionArgs:"); args.getNonOptionArgs().forEach(System.out::println); System.out.println("# OptionArgs: " + args.getOptionNames().size()); System.out.println("OptionArgs:"); args.getOptionNames().forEach(optionName -> { System.out.println(optionName + "=" + args.getOptionValues(optionName)); }); } }
非选项参数通过getNonOptionArgs()作为字符串列表重新获得。
而对于选项参数,我们可以通过接收选项名称getOptionNames和实际值通过getOptionValues,它会返回一个列表字符串。
当我们现在启动应用程序并传递一些参数,如:
java -jar commandline-app-0.0.1-SNAPSHOT.jar iamnonoption --app.name=CmdRulez --app.hosts=abc,def,ghi --app.name=2
上述执行的输出:
#NonOptionArgs:1个 NonOptionArgs: nonoption #OptionArgs:2个 OptionArgs: app.hosts = [ABC,DEF,GHI] app.name = [CmdRulez,2]