一、背景
有些时候,一个Bean在注入必要的依赖后,需要进行初始化(监听消息等)。在容器关闭时,有时候还需要清理资源(关闭连接池等)。
二、@PostConstruct:
1.@PostConstruct注解不是Spring提供的。是Java自己的注解。
2.在Java中该注解的说明:@PostConstruct该注解被用来修饰一个非静态的void()方法。被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行,并且只会被服务器执行一次。PostConstruct在构造函数之后执行,init()方法之前执行。
3.通常我们会是在Spring框架中使用到@PostConstruct注解 该注解的方法在整个Bean初始化中的执行顺序:
Constructor(构造方法) -> @Autowired(依赖注入) -> @PostConstruct(注释的方法)
应用1:本例为我自己做过项目的代码,用于报表框架Ureport2设置内置数据源。
通过包名也能清楚地看到该注解是属于javax包下而不是spring提供的。
package org.springblade.report.config;
import com.bstek.ureport.definition.datasource.BuildinDatasource;
import com.mysql.cj.jdbc.Driver;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.Properties;
/**
* @ClassName : IbmsDatasource
* @Description : 园区系统数据源
* @Author : THQ
* @Date: 2021-07-14 10:19
* @Version V1.0
*/
@Component
public class IbmsDatasource implements BuildinDatasource {
String url;
String user;
String password;
@Autowired
private ApplicationContext applicationContext;
/**
* 初始化执行
* /@PostConstruct:在bean对应的类中 修饰某个方法 将该方法声明为初始化方法,对象创建之后立即执行。
*/
@PostConstruct
public void setProperty(){
Environment environment = applicationContext.getEnvironment();
url = environment.getProperty("datasource.ibms.url");
user = environment.getProperty("datasource.ibms.user");
password = environment.getProperty("datasource.ibms.password");
}
@Override
public String name() {
return "园区管理";
}
@Override
public Connection getConnection() {
try {
Driver driver = new Driver();
//用于存储用户名和密码
Properties info=new Properties();
info.put("user", user);
info.put("password", password);
return driver.connect(url,info);
} catch (SQLException throwables) {
throwables.printStackTrace();
}
return null;
}
}
应用2:在静态方法中调用依赖注入的Bean中的方法。
package com.example.studySpringBoot.util;
import com.example.studySpringBoot.service.MyMethorClassService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
@Component
public class MyUtils {
private static MyUtils staticInstance = new MyUtils();
@Autowired
private MyMethorClassService myService;
@PostConstruct
public void init(){
staticInstance.myService = myService;
}
public static Integer invokeBean(){
return staticInstance.myService.add(10,20);
}
}
三、@PreDestroy:
销毁时,容器会首先调用标记有@PreDestroy的方法进行清理。
四、例子:
在Bean的初始化和清理方法上标记@PostConstruct和@PreDestroy:
@Component
public class MailService {
@Autowired(required = false)
ZoneId zoneId = ZoneId.systemDefault();
@PostConstruct
public void init() {
System.out.println("Init mail service with zoneId = " + this.zoneId);
}
@PreDestroy
public void shutdown() {
System.out.println("Shutdown mail service");
}
}
Spring容器会对上述Bean做如下初始化流程:
- 调用构造方法创建MailService实例;
- 根据@Autowired进行注入;
- 调用标记有@PostConstruct的init()方法进行初始化。
- 而销毁时,容器会首先调用标记有@PreDestroy的shutdown()方法。
Spring只根据Annotation查找无参数方法,对方法名不作要求。
五、那么Java提供的@PostConstruct注解,Spring是如何实现的呢?
需要先学习下BeanPostProcessor这个接口:
public interface BeanPostProcessor {
/**
* Apply this BeanPostProcessor to the given new bean instance <i>before</i> any bean
* initialization callbacks (like InitializingBean's {@code afterPropertiesSet}
* or a custom init-method). The bean will already be populated with property values.
* The returned bean instance may be a wrapper around the original.
*
* 任何Bean实例化,并且Bean已经populated(填充属性) 就会回调这个方法
*
*/
Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException;
/**
* Apply this BeanPostProcessor to the given new bean instance <i>after</i> any bean
* initialization callbacks (like InitializingBean's {@code afterPropertiesSet}
* or a custom init-method). The bean will already be populated with property values.
* The returned bean instance may be a wrapper around the original.
*
* 任何Bean实例化,并且Bean已经populated(填充属性) 就会回调这个方法
*
*/
Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException;
那Spring初始化是那里回调这些方法呢?
AbstractApplicationContext.finishBeanFactoryInitialization(...);
beanFactory.preInstantiateSingletons();
DefaultListableBeanFactory.getBean(beanName);
AbstractBeanFactory.doGetBean();
AbstractAutowireCapableBeanFactory.createBean(....)
populateBean(beanName, mbd, instanceWrapper);
initializeBean(...)
//调用BeanPostProcessor.postProcessBeforeInitialization()方法
applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName);
//调用BeanPostProcessor.postProcessBeforeInitialization()方法
applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName);
BeanPostProcessor有个实现类CommonAnnotationBeanPostProcessor,就是专门处理@PostConstruct @PreDestroy注解。
CommonAnnotationBeanPostProcessor的父类InitDestroyAnnotationBeanPostProcessor()
InitDestroyAnnotationBeanPostProcessor.postProcessBeforeInitialization()
InitDestroyAnnotationBeanPostProcessor.findLifecycleMetadata()
// 组装生命周期元数据
InitDestroyAnnotationBeanPostProcessor.buildLifecycleMetadata()
// 查找@PostConstruct注释的方法
InitDestroyAnnotationBeanPostProcessor.initAnnotationType
// 查找@PreDestroy注释方法
InitDestroyAnnotationBeanPostProcessor.destroyAnnotationType
// 反射调用
metadata.invokeInitMethods(bean, beanName);
参考:https://blog.csdn.net/qq360694660/article/details/82877222