CommandLineRunner、ApplicationRunner、ApplicationListener @PostConstruct
使用场景:
我们在开发过程中会有这样的场景:需要在项目启动后执行一些操作,比如:读取配置文件信息,数据库连接,删除临时文件,清除缓存信息,工厂类初始化,加载活动数据,或者缓存的同步等。我们会有多种的实现方式,例如@PostConstruct 、CommandLineRunner、ApplicationRunner、ApplicationListener都可以实现在springboot启动后执行我们特定的逻辑,接下对比下他们的区别
1. @PostConstruct
该注解被用来修饰一个非静态的void方法,被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行,并且只会被服务器执行一次。
触发时机:
SpringBoot会把标记了Bean相关注解(例如@Component、@Service、@Repository等)的类或接口自动初始化全局的单一实例,如果标记了初始化顺序会按照用户标记的顺序,否则按照默认顺序初始化。在初始化的过程中,执行完一个Bean的构造方法后会执行该Bean的@PostConstruct方法(如果有),然后初始化下一个Bean。
spring中bean的创建过程
配置Bean(@Component、@Service、@Controller等注解配置) —–> 解析为Bean的元数据(Bean容器中的BeanDefinition对象) –> 根据Bean的元数据生成Bean(创建bean)
创建bean的时候执行顺序
Constructor(构造方法) -> @Autowired(依赖注入) -> @PostConstruct(注释的方法)
1 |
|
优点:
- 使用简单,在spring容器管理的类中添加此注解即可
缺点:
- 在spring创建bean的时候触发,此时容器还未完全初始化完毕,如果逻辑中引用了还未完成初始化的bean会导致异常 ,所以需要考虑加载顺序。
如果@PostConstruct方法内的逻辑处理时间较长,就会增加SpringBoot应用初始化Bean的时间,进而增加应用启动的时间。因为只有在Bean初始化完成后,SpringBoot应用才会打开端口提供服务,所以在此之前,应用不可访问。
一句话:会影响你程序启动的时间。
2 、CommandLineRunner、ApplicationRunner
使用起来很简单,只需要实现CommandLineRunner或者ApplicationRunner接口,重写run方法就行。
触发时机:
通过springboot启动源码:
启动后会执行 callRunners方法;
1 |
|
从上面源码可以看到 ,在springboot完全初始化完毕后,会执行CommandLineRunner和ApplicationRunner,两者唯一的区别是参数不同,但是不会影响,都可以获取到执行参数。
1 |
|
3、ApplicationListener
通过事件监听我们也可以实现springboot启动执行方法。实现ApplicationListener,重写onApplicationEvent方法,便可在所有的bean加载完毕后执行。
触发时机:
在IOC的容器的启动过程,当所有的bean都已经处理完成之后,spring ioc容器会有一个发布ContextRefreshedEvent事件的动作。
1 |
|
系统会存在两个容器,一个是root application context ,另一个就是我们自己的 projectName-servlet context(作为root application context的子容器)
ApplicationContext.context.pushevent()
WebtapplicationContext.context.pushevent()
这种情况下,就会造成onApplicationEvent方法被执行两次。为了避免上面提到的问题,我们可以只在root application context初始化完成后调用逻辑代码,其他的容器的初始化完成,则不做任何处理
1 |
|
- 一些比较独立、内容小巧的初始化逻辑,不影响springboot启动速度的使用@PostConstruct注解;
- 若想通过ApplicationListener事件监听的方式,则需要处理好指定的容器。
- 在数据初始化层面,不推荐@PostConstruct和ApplicationListener,原因是两者都会影响程序的启动。如果执行逻辑耗时很长,会启动服务就很长。
- 建议使用 CommandLineRunner、ApplicationRunner的方式,不会影响服务的启动速度 ,处理起来也比较简单。