主要介绍Spring中的几种自定义扩展点,并总结了不同拓展方式的加载顺序。
一、ApplicationRunner和CommandLineRunner的拓展
实现接口ApplicationRunner和CommandLineRunner的类主要是在Spring容器启动之后做一些初始化的操作;
@Component @Order(value = 1) public class CommandLineApplicationTest implements CommandLineRunner { @Override public void run(String... args) throws Exception { System.out.println(">>>>>>>>>>>>>>>>>>>开始加载缓存服务>>>>>>>>>>>>>>>"); } }
运行之后的效果:
二、BeanFactoryPostProcessor和BeanPostProcessor的拓展
BeanFactoryPostProcessor和BeanPostProcessor都是针对容器内全部Bean实例进行自定义操作的,BeanFactoryPostProcessor可以获取BeanFactory,所以能够对bean的定义进行操作。BeanPostProcessor获取的是要加载到容器中的bean和beanName,其处理顺序在BeanFactoryPostProcessor之后。
@Component @Order(value = 1) public class BeanFactoryPostProcessorTest implements BeanFactoryPostProcessor { @Override public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException { BeanDefinition beanDefinition = beanFactory.getBeanDefinition("myTestController"); MutablePropertyValues values = beanDefinition.getPropertyValues(); if (values.contains("name")) { values.addPropertyValue("age", 18); } } }
BeanPostProcessor的常用场景是针对在加载Bean之前需要进行的通用操作。
@Component @Order(value = 1) public class BeanPostProcessorTest implements BeanPostProcessor { @Override public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { System.out.println(">>>>>>>>>>>>>>BeanPostProcessorTest.postProcessBeforeInitialization()" + beanName); return bean; } }
三、Aware感知类拓展
aware是感知的意思,xxxAware就是能获取到xxx资源,实现xxxAware接口的setXXX()方法就能后获取xxx资源,再对其进行操作。Aware接口在代码上实现BeanPostProcessor接口的postProcessBeforeInitialization方法。
常见Aware类和其用途:
BeanNameAware | 获得到容器中Bean的名称 |
BeanFactoryAware | 获得当前bean factory,这样可以调用容器的服务 |
ApplicationContextAware* | 获得当前application context,这样可以调用容器的服务 |
MessageSourceAware | 获得message source这样可以获得文本信息 |
ApplicationEventPublisherAware | 应用事件发布器,可以发布事件 |
ResourceLoaderAware | 获得资源加载器,可以获得外部资源文件 |
BeanNameAware | 获取到bean名称 |
EnvironmentAware | 能够获取配置文件中的配置项 |
比如实现了EnvironmentAware接口的自定义类,在启动的时候会获取到application.properties中的配置项。
@Component @Order(value = 1) public class EnvironmentAwareTest implements EnvironmentAware { Environment environment; @Override public void setEnvironment(Environment environment) { this.environment = environment; System.out.println(">>>>>>>>>>>>>>>>>>>name = " + environment.getProperty("name")); } }
四、bean中方法级别拓展
主要说明bean在初始化前后的拓展点。主要有两种方法:
方法一:通过bean实现InitializingBean和 DisposableBean接口;
方法二:通过@PostConstruct 和 @PreDestroy 方法 实现初始化和销毁bean之前进行的操作;
针对方法一:
通过实现InitializingBean接口的afterPropertiesSet()方法,看方法名即可得知是在bean属性赋值之后再进行该方法的处理;
针对方法二:
只需要在需要在初始化时执行的方法上加注解@PostConstruct即可。
两种方法的实现代码如下:
@Component("initializingBeanTest") @Order(value = 1) public class InitializingBeanTest implements InitializingBean { @Override public void afterPropertiesSet() throws Exception { //属性注入后进行处理 System.out.println(">>>>>>>>>>>InitializingBeanTest.afterPropertiesSet()"); } @PostConstruct void testPostConstruct() { System.out.println(">>>>>>>>>>>>InitializingBeanTest.testPostConstruct()"); } }
运行效果:
总结:这两者都是在bean赋值后初始化前进行的。
五、实现ApplicationContextInitializer接口的拓展
实现ApplicationContextInitializer这个类的主要作用就是在ConfigurableApplicationContext类型(或者子类型)的ApplicationContext做refresh之前,允许我们对ConfiurableApplicationContext的实例做进一步的设置和处理。常用场景是在开始创建所有bean之前做一些初始化操作。
@Component public class ApplicationContextInitializer1 implements ApplicationContextInitializer { @Override public void initialize(ConfigurableApplicationContext applicationContext) { // 打印容器里面有多少个bean System.out.println("bean count=====" + applicationContext.getBeanDefinitionCount()); // 打印人所有 beanName System.out.println(applicationContext.getBeanDefinitionCount() + "个Bean的名字如下:"); String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames(); for (String beanName : beanDefinitionNames) { System.out.println(beanName); } } }
@SpringBootApplication @EnableAsync public class SpringDemoApplication { public static void main(String[] args) { SpringApplication app = new SpringApplication(SpringDemoApplication.class); // 方法一:添加自定义的 ApplicationContextInitializer 实现类的实例(注册ApplicationContextInitializer) app.addInitializers(new ApplicationContextInitializer1()); app.run(args); } }
执行效果如下:
六、总结
以上各种拓展点的执行顺序大致如下:
bean的自定义拓展点:https://www.processon.com/diagraming/64809abd7fa8dd435931a76f
参考资料
- SpringBoot扩展点之二:ApplicationRunner和CommandLineRunner的扩展:https://www.cnblogs.com/duanxz/p/11251739.html