本文转载自微信公众号「程序新视界」,作者二师兄。转载本文请联系程序新视界公众号。
前言
我们在讲《Spring的Lifecycle》时提到,在Spring的使用中可以通过Lifecycle接口实现一些基于Spring容器生命周期逻辑。与此对照的就是通过@PostConstruct和@PreDestroy在Bean初始化或销毁时执行一些操作。
很明显Spring的Lifecycle是基于容器的生命周期来处理逻辑,而@PostConstruct和@PreDestroy是基于Bean的生命周期来处理业务逻辑。
这里很多朋友就产生了一个误解,以为@PostConstruct注解也是Spring提供的。其实不然,它是Java自带的注解,下面我们就从头来聊聊@PostConstruct注解。
JSR-250规范
在了解@PostConstruct注解之前,我们先来科普一个概念:JSR-250规范。
JSR-250主要围绕着“资源”的使用预定义了一些注解(Annotation),这里的“资源”可以理解为一个Class类的实例、一个JavaBean、或者一个Spring中的Bean。
JSR-250相关的注解全部在javax.annotation和javax.annotation.security包中,包括:资源定义和权限控制。像我们经常用到的@Resource、@PostConstruct、@PreDestroy、@Generated等都属于这个规范中定义的注解。
该规范并没有提供具体的实现方式,仅仅是提供了指导性的文档和几个注解,由具体的框架去实现。
也就是说,@PostConstruct注解并不是Spring提供的注解,只不过Spring按照JSR-250规范实现了规范中对@PostConstruct的约定。而别的框架,或者你自己写一个框架,同样可以按照约定进行实现。
@PostConstruct的约定
@PostConstruct和@PreDestroy是在Java EE 5引入的,位于javax.annotation包下,也就是java拓展包定义的注解。其中,javax中的x就是extension的意思。Java最初的设计者认为,这些功能并不是Java核心API,因此就放到了扩展包中,谁用谁实现,按照约定就行。
下面直接看看该类上的注解说明:
“PostConstruct注释用于在依赖关系注入完成之后需要执行的方法上,以执行任何初始化。此方法必须在将类放入服务之前调用。支持依赖关系注入的所有类都必须支持此注释。即使类没有请求注入任何资源,用PostConstruct注释的方法也必须被调用。只有一个方法可以用此注释进行注释。”
“应用PostConstruct注释的方法必须遵守以下所有标准:
- 该方法不得有任何参数,除非是在EJB拦截器(interceptor)的情况下,它将带有一个InvocationContext对象;
- 该方法的返回类型必须为void;
- 该方法不得抛出已检查异常;
- 应用PostConstruct的方法可以是public、protected、package private或private;
- 除了应用程序客户端之外,该方法不能是static;
- 该方法可以是final;
- 如果该方法抛出未检查异常,那么不得将类放入服务中,除非是能够处理异常并可从中恢复的EJB。
除了上述约定,如果用在Servlet容器当中,还有有一定的处理时机。
@PostConstruct的执行时机
下面所讲的@PostConstruct的执行时机是基于Spring的实现来讲的。被@PostConstruct修饰的方法会在服务器加载Servlet时运行,并且只会被执行一次。PostConstruct在构造函数之后执行,init()方法之前执行。
对应的流程图如下:
实例演示
理解了上面的基本概念,就先来看一个实例演示吧,使用起来非常简单。
基于Java 8的Spring Boot项目中添加如下类:
- @Service
- public class OrderService {
- public OrderService(){
- System.out.println("OrderService构造方法被执行...");
- }
- @PostConstruct
- private void init() {
- System.out.println("PostConstruct注解方法被调用");
- }
- @PreDestroy
- private void shutdown() {
- System.out.println("PreDestroy注解方法被调用");
- }
- }
启动Spring Boot项目,控制台打印日志如下:
- OrderService构造方法被执行...
- PostConstruct注解方法被调用
当关闭服务时,会打印:
- PreDestroy注解方法被调用
通过实例,基本印证了上述说的理论。
Java9的以后的移除
在Java 8中我们可以直接使用对应的注解即可,但到Java 9及以后,J2EE弃用了@PostConstruct和@PreDestroy这两个注解,并计划在Java 11中将其删除。
针对这种情况,我们有两种解决方案:第一添加额外的依赖;第二,换用其他的方式。
第一种方案针对的是,你非要使用这个注解,或者说你的项目暂时没办法弃用这两个注解。那么,可以手动添加依赖:
- <dependency>
- <groupId>javax.annotation</groupId>
- <artifactId>javax.annotation-api</artifactId>
- <version>1.3.2</version>
- </dependency>
也就是说,虽然移除了,但是你把它们的依赖添加上,依旧还是可以用的。但此时也给我们提了一个醒儿,在项目中尽量别用这两个注解了,Java 11都计划将其移除了。
此时,如果你使用的是Spring的项目,则可考虑另外一种方式,基于Spring的InitializingBean和DisposableBean接口来实现同样的功能:
- @Service
- public class PaymentService implements InitializingBean, DisposableBean {
- public PaymentService(){
- System.out.println("PaymentService构造方法被执行...");
- }
- @Override
- public void destroy() throws Exception {
- System.out.println("destroy方法被调用");
- }
- @Override
- public void afterPropertiesSet() throws Exception {
- System.out.println("afterPropertiesSet方法被调用");
- }
- }
启动项目,打印日志如下:
- PaymentService构造方法被执行...
- afterPropertiesSet方法被调用
停止项目,打印如下信息:
- destroy方法被调用
也就是说在Spring的生态中,我们已经有替代方案可实现了,而且是比较推荐的方式。
其实Spring并没有遵守约定
在上面的约定中我们讲到一个类中“只有一个方法可以用此注释进行注释”,在OrderService中再添加一个@PostConstruct注解的方法试试:
- @Service
- public class OrderService {
- public OrderService(){
- System.out.println("OrderService构造方法被执行...");
- }
- @PostConstruct
- private void init() {
- System.out.println("PostConstruct注解方法被调用");
- }
- @PostConstruct
- private void init1() {
- System.out.println("PostConstruct init1 注解方法被调用");
- }
- @PreDestroy
- private void shutdown() {
- System.out.println("PreDestroy注解方法被调用");
- }
- }
启动程序,打印日志:
- OrderService构造方法被执行...
- PostConstruct init1 注解方法被调用
- PostConstruct注解方法被调用
不但没报错,而且两个方法还都执行了。这说明什么?这说明约定有时候就是用来被打破的,记住这一特殊情况就好。
Spring中的实现原理
以上是对@PostConstruct的简单介绍,下面会从Spring源码层面简单分析一下实现原理。
我们先来看一个Spring的接口BeanPostProcessor:
- public interface BeanPostProcessor {
- // 任何Bean实例化,并且Bean已经populated(填充属性) 就会回调这个方法
- Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException;
- // 任何Bean实例化,并且Bean已经populated(填充属性) 就会回调这个方法
- Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException;
BeanPostProcessor是Spring IOC容器给我们提供的一个扩展接口,它两个回调方法。当一个BeanPostProcessor的实现类注册到Spring IOC容器后,对于该Spring IOC容器所创建的每个bean实例在初始化方法(如afterPropertiesSet和任意已声明的init方法)调用前,将会调用BeanPostProcessor中的postProcessBeforeInitialization方法,而在bean实例初始化方法调用完成后,则会调用BeanPostProcessor中的postProcessAfterInitialization方法,整个调用顺序可以简单示意如下:
- --> Spring IOC容器实例化Bean
- --> 调用BeanPostProcessor的postProcessBeforeInitialization方法
- --> 调用bean实例的初始化方法
- --> 调用BeanPostProcessor的postProcessAfterInitialization方法
而BeanPostProcessor有个实现类CommonAnnotationBeanPostProcessor,就是专门处理@PostConstruct和@PreDestroy注解。其中CommonAnnotationBeanPostProcessor的父类InitDestroyAnnotationBeanPostProcessor中,对应的调用逻辑如下:
- InitDestroyAnnotationBeanPostProcessor.postProcessBeforeInitialization()
- InitDestroyAnnotationBeanPostProcessor.findLifecycleMetadata()
- // 组装生命周期元数据
- InitDestroyAnnotationBeanPostProcessor.buildLifecycleMetadata()
- // 查找@PostConstruct注释的方法
- InitDestroyAnnotationBeanPostProcessor.initAnnotationType
- // 查找@PreDestroy注释方法
- InitDestroyAnnotationBeanPostProcessor.destroyAnnotationType
- // 反射调用
- metadata.invokeInitMethods(bean, beanName);
关于业务逻辑的处理细节,这里就不再逐一展示,大家感兴趣的话可以跟踪一下源代码。
小结
本篇文章我们需要留意几点:第一,Spring只是实现了Java中对@PostConstruct注解定义的规范;第二,该注解在Java 9逐步开始废弃,不建议再使用;第三,可采用Spring的InitializingBean和DisposableBean来替代对应的功能。