1.7分钟学会Spring Boot的CommandLineRunner

本文介绍一个非常酷的Spring Boot接口，名字叫做CommandLineRunner。

使用这个接口，你可以在Spring的Bean们以及Application Context被创建之后，来做一些事情。也就是在程序启动的时候做一些事情。

来自Spring Boot 文档：

If you want access to the raw command line arguments, or you need to run some specific code once the SpringApplication has started you can implement the CommandLineRunner interface. The run(String… args) method will be called on all Spring beans implementing this interface. You can additionally implement the @Ordered interface if several CommandLineRunner beans are defined that must be called in a specific order.

如果要访问raw命令行参数，或者在SpringApplication启动后需要运行一些特定代码，可以实现 CommandLineRunner接口。 run（String ... args）方法将在实现此接口的所有Spring bean上调用。 如果你定义了多个 CommandLineRunner bean必须按特定顺序调用的话，那么你可以再实现一个接口@Ordered就可以了。

下面是一个来自NixMash Spring简单的例子：

@Component
public class ApplicationLoader implements CommandLineRunner {

    private static final Logger logger = LoggerFactory.getLogger(ApplicationLoader.class);

    @Override
    public void run(String... strings) throws Exception {
        StringBuilder sb = new StringBuilder();
        for (String option : strings) {
            sb.append(" ").append(option);
        }
        sb = sb.length() == 0 ? sb.append("No Options Specified") : sb;
        logger.info(String.format("WAR launched with following options: %s", sb.toString()));
    }
}

这是一个有点多余的小函数，只是记录一下在命令行启动WAR文件时使用的命令行参数。

有趣的是，上面的 ApplicationLoader类是在NixMash Spring JPA RootContext模块中，但是MVC WebContext模块中的 @SpringBootApplication将拾取该类，因为我们添加了 @Component注释并实现了 CommandLineRunner接口。

下面是从命令行启动的一个示例：

$ java -jar nixmashSpring.war --spring.one=one --spring.two=two

启动后，就可以看到输出了我们runner里边打印的内容，在第三行：

当然在实际的开发中，你通常想要使用 CommandLineRunner做比我们在这里做的更多的事。比如，你可以使用该接口注入Spring Cloud Zuul的filter。 你也可以使用 CommandLineRunner的另外一个实现 JobLauncherCommandLineRunner，通过这个接口你可以在Spring Batch中运行批处理作业。

总之，你要记住CommandLineRunner！