智能摘要文章源自JAVA秀-https://www.javaxiu.com/43292.html
ApplicationContext事件机制是观察者设计模式实现的,通过ApplicationEvent和ApplicationListener这两个接口实现ApplicationContext的事件机制。同样能够达到容器启动之后完成一些事情。以上命令中传入了三个参数,分别是aaa、bbb、ccc,这三个参数将会被run()方法接收到。以上命令传入了四个参数,一个键值对version=2.1.0,另外三个是分别是aaa、bbb、ccc。文章源自JAVA秀-https://www.javaxiu.com/43292.html
原文约 2011 字 | 图片 7 张 | 建议阅读 5 分钟 | 评价反馈文章源自JAVA秀-https://www.javaxiu.com/43292.html
六种方式,教你在SpringBoot初始化时搞点事情!
菜鸟要飞 文章源自JAVA秀-https://www.javaxiu.com/43292.html
以下文章来源于码猿技术专栏,作者不才陈某文章源自JAVA秀-https://www.javaxiu.com/43292.html
文章源自JAVA秀-https://www.javaxiu.com/43292.html 文章源自JAVA秀-https://www.javaxiu.com/43292.html 码猿技术专栏文章源自JAVA秀-https://www.javaxiu.com/43292.html 蚂蚁P8,编程修仙,专注于Java后端技术分享,多年老司机,只写外面看不到的干货,你想要的都在这里……文章源自JAVA秀-https://www.javaxiu.com/43292.html
文章源自JAVA秀-https://www.javaxiu.com/43292.html
前言
在实际工作中总是需要在项目启动时做一些初始化的操作,比如初始化线程池、提前加载好加密证书.......文章源自JAVA秀-https://www.javaxiu.com/43292.html
那么经典问题来了,这也是面试官经常会问到的一个问题:有哪些手段在Spring Boot 项目启动的时候做一些事情?文章源自JAVA秀-https://www.javaxiu.com/43292.html
方法有很多种,下面介绍几种常见的方法。文章源自JAVA秀-https://www.javaxiu.com/43292.html
1、监听容器刷新完成扩展点ApplicationListener<ContextRefreshedEvent>
ApplicationContext事件机制是观察者设计模式实现的,通过ApplicationEvent和ApplicationListener这两个接口实现ApplicationContext的事件机制。文章源自JAVA秀-https://www.javaxiu.com/43292.html
Spring中一些内置的事件如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
ContextRefreshedEvent
:ApplicationContext 被初始化或刷新时,该事件被发布。这也可以在 ConfigurableApplicationContext接口中使用 refresh() 方法来发生。此处的初始化是指:所有的Bean被成功装载,后处理Bean被检测并激活,所有Singleton Bean 被预实例化,ApplicationContext容器已就绪可用。文章源自JAVA秀-https://www.javaxiu.com/43292.htmlContextStartedEvent
:当使用 ConfigurableApplicationContext (ApplicationContext子接口)接口中的 start() 方法启动 ApplicationContext 时,该事件被发布。你可以调查你的数据库,或者你可以在接受到这个事件后重启任何停止的应用程序。文章源自JAVA秀-https://www.javaxiu.com/43292.htmlContextStoppedEvent
:当使用 ConfigurableApplicationContext 接口中的 stop() 停止 ApplicationContext 时,发布这个事件。你可以在接受到这个事件后做必要的清理的工作。文章源自JAVA秀-https://www.javaxiu.com/43292.htmlContextClosedEvent
:当使用 ConfigurableApplicationContext 接口中的 close() 方法关闭 ApplicationContext 时,该事件被发布。一个已关闭的上下文到达生命周期末端;它不能被刷新或重启。文章源自JAVA秀-https://www.javaxiu.com/43292.htmlRequestHandledEvent
:这是一个 web-specific 事件,告诉所有 bean HTTP 请求已经被服务。只能应用于使用DispatcherServlet的Web应用。在使用Spring作为前端的MVC控制器时,当Spring处理用户请求结束后,系统会自动触发该事件。文章源自JAVA秀-https://www.javaxiu.com/43292.html
好了,了解上面这些内置事件后,我们可以监听ContextRefreshedEvent
在Spring Boot 启动时完成一些操作,代码如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
@Componentpublic class TestApplicationListener implements ApplicationListener<ContextRefreshedEvent>{ @Override public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) { System.out.println(contextRefreshedEvent); System.out.println("TestApplicationListener............................"); }}
高级玩法
可以自定事件完成一些特定的需求,比如:邮件发送成功之后,做一些业务处理。文章源自JAVA秀-https://www.javaxiu.com/43292.html
自定义EmailEvent,代码如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
public class EmailEvent extends ApplicationEvent{ private String address; private String text; public EmailEvent(Object source, String address, String text){ super(source); this.address = address; this.text = text; } public EmailEvent(Object source) { super(source); } //......address和text的setter、getter}
自定义监听器,代码如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
public class EmailNotifier implements ApplicationListener{ public void onApplicationEvent(ApplicationEvent event) { if (event instanceof EmailEvent) { EmailEvent emailEvent = (EmailEvent)event; System.out.println("邮件地址:" + emailEvent.getAddress()); System.our.println("邮件内容:" + emailEvent.getText()); } else { System.our.println("容器本身事件:" + event); } }}
发送邮件后,触发事件,代码如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
public class SpringTest { public static void main(String args[]){ ApplicationContext context = new ClassPathXmlApplicationContext("bean.xml"); //创建一个ApplicationEvent对象 EmailEvent event = new EmailEvent("hello","abc@163.com","This is a test"); //主动触发该事件 context.publishEvent(event); }}
2、SpringBoot
的CommandLineRunner
接口
当容器初始化完成之后会调用CommandLineRunner
中的run()
方法,同样能够达到容器启动之后完成一些事情。这种方式和ApplicationListener相比更加灵活,如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
不同的
CommandLineRunner
实现可以通过@Order()
指定执行顺序文章源自JAVA秀-https://www.javaxiu.com/43292.html可以接收从控制台输入的参数。文章源自JAVA秀-https://www.javaxiu.com/43292.html
下面自定义一个实现类,代码如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
@Component@Slf4jpublic class CustomCommandLineRunner implements CommandLineRunner { /** * @param args 接收控制台传入的参数 */ @Override public void run(String... args) throws Exception { log.debug("从控制台接收参数>>>>"+ Arrays.asList(args)); }}
运行这个jar,命令如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
java -jar demo.jar aaa bbb ccc
以上命令中传入了三个参数,分别是aaa
、bbb
、ccc
,这三个参数将会被run()
方法接收到。如下图:文章源自JAVA秀-https://www.javaxiu.com/43292.html
文章源自JAVA秀-https://www.javaxiu.com/43292.html
源码分析
读过我的文章的铁粉都应该知道CommandLineRunner
是如何执行的,原文:头秃系列,二十三张图带你从源码分析Spring Boot 启动流程~文章源自JAVA秀-https://www.javaxiu.com/43292.html
Spring Boot 加载上下文的入口在org.springframework.context.ConfigurableApplicationContext()
这个方法中,如下图:文章源自JAVA秀-https://www.javaxiu.com/43292.html
文章源自JAVA秀-https://www.javaxiu.com/43292.html
调用CommandLineRunner在callRunners(context, applicationArguments);
这个方法中执行,源码如下图:文章源自JAVA秀-https://www.javaxiu.com/43292.html
文章源自JAVA秀-https://www.javaxiu.com/43292.html
3、SpringBoot
的ApplicationRunner
接口
ApplicationRunner
和CommandLineRunner
都是Spring Boot 提供的,相对于CommandLineRunner
来说对于控制台传入的参数封装更好一些,可以通过键值对来获取指定的参数,比如--version=2.1.0
。文章源自JAVA秀-https://www.javaxiu.com/43292.html
此时运行这个jar命令如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
java -jar demo.jar --version=2.1.0 aaa bbb ccc
以上命令传入了四个参数,一个键值对version=2.1.0
,另外三个是分别是aaa
、bbb
、ccc
。文章源自JAVA秀-https://www.javaxiu.com/43292.html
同样可以通过@Order()
指定优先级,如下代码:文章源自JAVA秀-https://www.javaxiu.com/43292.html
@Component@Slf4jpublic class CustomApplicationRunner implements ApplicationRunner { @Override public void run(ApplicationArguments args) throws Exception { log.debug("控制台接收的参数:{},{},{}",args.getOptionNames(),args.getNonOptionArgs(),args.getSourceArgs()); }}
通过以上命令运行,结果如下图:文章源自JAVA秀-https://www.javaxiu.com/43292.html
文章源自JAVA秀-https://www.javaxiu.com/43292.html
源码分析
和CommandLineRunner
一样,同样在callRunners()
这个方法中执行,源码如下图:文章源自JAVA秀-https://www.javaxiu.com/43292.html
文章源自JAVA秀-https://www.javaxiu.com/43292.html
4、@PostConstruct
注解
前三种针对的是容器的初始化完成之后做的一些事情,@PostConstruct
这个注解是针对Bean
的初始化完成之后做一些事情,比如注册一些监听器...文章源自JAVA秀-https://www.javaxiu.com/43292.html
@PostConstruct
注解一般放在Bean的方法上,一旦Bean初始化完成之后,将会调用这个方法,代码如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
@Component@Slf4jpublic class SimpleExampleBean { @PostConstruct public void init(){ log.debug("Bean初始化完成,调用..........."); }}
5、@Bean注解中指定初始化方法
这种方式和@PostConstruct
比较类似,同样是指定一个方法在Bean初始化完成之后调用。文章源自JAVA秀-https://www.javaxiu.com/43292.html
新建一个Bean,代码如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
@Slf4jpublic class SimpleExampleBean { public void init(){ log.debug("Bean初始化完成,调用..........."); }}
在配置类中通过@Bean
实例化这个Bean,不过@Bean
中的initMethod
这个属性需要指定初始化之后需要执行的方法,如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
@Bean(initMethod = "init") public SimpleExampleBean simpleExampleBean(){ return new SimpleExampleBean(); }
6、 InitializingBean
接口
InitializingBean
的用法基本上与@PostConstruct
一致,只不过相应的Bean
需要实现afterPropertiesSet
方法,代码如下:文章源自JAVA秀-https://www.javaxiu.com/43292.html
@Slf4j@Componentpublic class SimpleExampleBean implements InitializingBean { @Override public void afterPropertiesSet() { log.debug("Bean初始化完成,调用..........."); }}
总结
实现方案有很多,作者只是总结了常用的六种,学会的点个赞。文章源自JAVA秀-https://www.javaxiu.com/43292.html
推荐阅读文章源自JAVA秀-https://www.javaxiu.com/43292.html
嘘!刚刚发现了一个山寨版某库....文章源自JAVA秀-https://www.javaxiu.com/43292.html
大学期间开发了一款App!让我月薪破万文章源自JAVA秀-https://www.javaxiu.com/43292.html
发小被绿,我竭尽所学黑科技,动用云控捉奸寻找证据….文章源自JAVA秀-https://www.javaxiu.com/43292.html
终于把废旧电脑变成了服务器!差点被女票拿去换洗脸盆,真香!
文章源自JAVA秀-https://www.javaxiu.com/43292.html

评论