我们在开发中可能会有这样的情景。需要在容器启动的时候执行一些内容。比如读取配置文件,数据库连接之类的。SpringBoot给我们提供了两个接口来帮助我们实现这种需求。这两个接口分别为CommandLineRunner和ApplicationRunner。
他们的执行时机在官网上有这么一段话描述的:
If you need to run some specific code once the SpringApplication has started, you can implement the ApplicationRunner or CommandLineRunner interfaces. Both interfaces work in the same way and offer a single run method, which is called just before SpringApplication.run(…) completes.
我的理解是spring加载完所有需要预加载的东西(环境/配置)之后再来执行这个,因为这两个方法完全可以有对环境的依赖及其他模块的调用,如果没有其它需要执行的东西,这里执行完就会输出启动完成。
也就是说:该方法仅在SpringApplication.run(…)完成之前调用,是在容器启动成功时的最后一步回调。
这两个接口中有一个run方法,我们只需要实现这个方法即可。这两个接口的不同之处在于:
ApplicationRunner中run方法的参数为ApplicationArguments,而CommandLineRunner接口中run方法的参数为String数组。下面我写两个简单的例子,来看一下这两个接口的实现。
CommandLineRunner
package com.zkn.learnspringboot.runner; import org.springframework.boot.CommandLineRunner;import org.springframework.stereotype.Component; /** * Created by zkn on 2016/8/12. */@Componentpublic class TestImplCommandLineRunner implements CommandLineRunner { @Override public void run(String... args) throws Exception { System.out.println("<<<<<<<<<<< <这个是测试commandlinerunn接口> >>>>>>>>>>>>>"); }} 这个是测试commandlinerunn接口>
ApplicationRunner接口
package com.zkn.learnspringboot.runner; import org.springframework.boot.ApplicationArguments;import org.springframework.boot.ApplicationRunner;import org.springframework.stereotype.Component; /** * Created by zkn on 2016/8/12. * 注意:一定要有@Component这个注解。要不然SpringBoot扫描不到这个类,是不会执行。 */@Componentpublic class TestImplApplicationRunner implements ApplicationRunner { @Override public void run(ApplicationArguments args) throws Exception { System.out.println(args); System.out.println("这个是测试ApplicationRunner接口"); }}
@Order注解
如果有多个实现类,而你需要他们按一定顺序执行的话,可以在实现类上加上@Order注解。@Order(value=整数值)。SpringBoot会按照@Order中的value值从小到大依次执行。Tips如果你发现你的实现类没有按照你的需求执行,请看一下实现类上是否添加了Spring管理的注解(@Component)。
如果你发现你的实现类没有按照你的需求执行,请看一下实现类上是否添加了Spring管理的注解(@Component)。