本文詳細的介紹了Spring組件的實現(xiàn)步驟，分享給大家，具體如下：

背景

Spring 框架提供了許多接口，可以使用這些接口來定制化 bean ，而非簡單的 getter/setter 或者構(gòu)造器注入。細翻 Spring Cloud Netflix、Spring Cloud Alibaba 等這些構(gòu)建在 Spring Framework 的成熟框架源碼，你會發(fā)現(xiàn)大量的擴展 bean 例如

Eureka 健康檢查

package org.springframework.cloud.netflix.eureka;public class EurekaHealthCheckHandler implements InitializingBean {}

Seata Feign 配置

package com.alibaba.cloud.seata.feign;public class SeataContextBeanPostProcessor implements BeanPostProcessor {}

代碼示例

DemoBean

@Slf4jpublic class DemoBean implements InitializingBean { public DemoBean() { log.info('--> instantiate '); } @PostConstruct public void postConstruct() { log.info('--> @PostConstruct '); } @Override public void afterPropertiesSet() throws Exception { log.info('--> InitializingBean.afterPropertiesSet '); } public void initMethod() { log.info('--> custom initMehotd'); }}

DemoBeanPostProcessor

@Configurationpublic class DemoBeanPostProcessor implements BeanPostProcessor { @Override public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { if ('demoBean'.equals(beanName)){ log.info('--> BeanPostProcessor.postProcessBeforeInitialization '); } return bean; } @Override public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { if ('demoBean'.equals(beanName)){ log.info('--> BeanPostProcessor.postProcessAfterInitialization '); } return bean; }}

DemoConfig

@Configurationpublic class DemoConfig { @Bean(initMethod = 'initMethod') public DemoBean demoBean() { return new DemoBean(); }}

運行輸出日志

整個 bean 的創(chuàng)建過程日志輸出如下和文首圖片橫線以上 bean 創(chuàng)建周期一致

DemoBean : --> instantiateDemoBeanPostProcessor: --> BeanPostProcessor.postProcessBeforeInitializationDemoBean : --> @PostConstructDemoBean : --> InitializingBean.afterPropertiesSetDemoBean : --> custom initMehotdDemoBeanPostProcessor: --> BeanPostProcessor.postProcessAfterInitialization

執(zhí)行過程核心源碼

AbstractAutowireCapableBeanFactory.initializeBean

protected Object initializeBean(final String beanName, final Object bean, @Nullable RootBeanDefinition mbd) { // 執(zhí)行BeanPostProcessor.postProcessBeforeInitialization Object wrappedBean = wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName); ... // 執(zhí)行用戶自定義初始化and JSR 250 定義的方法 invokeInitMethods(beanName, wrappedBean, mbd); ... // 執(zhí)行執(zhí)行BeanPostProcessor.postProcessAfterInitialization wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName); return wrappedBean;}

下文就詳細說明一下每個 bean 的擴展周期的最佳使用場景BeanPostProcessor

BeanPostProcessor 是一個可以自定義實現(xiàn)回調(diào)方法接口，來實現(xiàn)自己的實例化邏輯、依賴解決邏輯等，如果想要在 Spring 完成對象實例化、配置、初始化之后實現(xiàn)自己的業(yè)務(wù)邏輯，可以通過擴展實現(xiàn)一個或多個 BeanPostProcessor 處理。

多用于適配器模式，可以在實現(xiàn)同一接口 bean 創(chuàng)建前后進行包裝轉(zhuǎn)換

// seata 上下文轉(zhuǎn)換，將其他類型 wrap 成 SeataFeignContextpublic class SeataContextBeanPostProcessor implements BeanPostProcessor { @Override public Object postProcessBeforeInitialization(Object bean, String beanName){ if (bean instanceof FeignContext && !(bean instanceof SeataFeignContext)) { return new SeataFeignContext(getSeataFeignObjectWrapper(), (FeignContext) bean); } return bean; }}

自定義 注解查找擴展

net.dreamlu.mica.redisson.stream.RStreamListenerDetector 查找自定義 @RStreamListener 實現(xiàn) 基于 Redisson 的 pub/subpublic class RStreamListenerDetector implements BeanPostProcessor { @Override public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { Class<?> userClass = ClassUtils.getUserClass(bean); ReflectionUtils.doWithMethods(userClass, method -> { RStreamListener listener = AnnotationUtils.findAnnotation(method, RStreamListener.class); .... do something }, ReflectionUtils.USER_DECLARED_METHODS); return bean; }}

PostConstruct

JavaEE5 引入了@PostConstruct 作用于 Servlet 生命周期的注解，實現(xiàn) Bean 初始化之前的自定義操作。

這里需要注意的 這個注解不是 Spring 定義的，而是屬于 JavaEE JSR-250 規(guī)范定義的注解,當(dāng)你在使用 Java11 的時候要手動引入相關(guān) jar（因為 Java11 移除了）

<dependency> <groupId>javax.annotation</groupId> <artifactId>javax.annotation-api</artifactId></dependency>

使用場景： 在之前的版本，我們可以在啟動后通過 @PostConstruct 注解的方法執(zhí)行初始化數(shù)據(jù)。但由于 Java 高版本已經(jīng)移除相關(guān) API ，我們不推薦使用此 注解，可以通過 Spring 相關(guān) Event 回調(diào)事件處理

@PostConstruct 注解的方法在項目啟動的時候執(zhí)行這個方法，也可以理解為在 spring 容器啟動的時候執(zhí)行，可作為一些數(shù)據(jù)的常規(guī)化加載，比如數(shù)據(jù)字典之類的。

InitializingBean

InitializingBean 接口方法會在 容器初始化（getter/setter/構(gòu)造器）完成 bean 的屬性注入后執(zhí)行。

應(yīng)用場景： 動態(tài)修改容器注入的 Bean 參數(shù)

正常用戶配置參數(shù)注入到 bean

security: oauth2: ignore-urls: - ’/ws/**’@ConfigurationProperties(prefix = 'security.oauth2')public class PermitAllUrlProperties { @Getter @Setter private List<String> ignoreUrls = new ArrayList<>();}

我們發(fā)現(xiàn)此時用戶配置并不完整，還有一些通用不需要用戶維護，可通過實現(xiàn) InitializingBean 接口回調(diào)擴展

@ConfigurationProperties(prefix = 'security.oauth2.ignore')public class PermitAllUrlProperties implements InitializingBean { @Getter @Setter private List<String> urls = new ArrayList<>(); @Override public void afterPropertiesSet() { urls.add('/common/*'); }}

initMethod

上文 @PostConstruct 已經(jīng)不推薦大家使用，可以使用 Bean(initMethod = ’initMehotd’) 替代，相關(guān)的限制如上。

@Bean(initMethod = 'initMethod')public DemoBean demoBean() { return new DemoBean();}public void initMethod() { log.info('--> custom initMehotd');}

總結(jié)

參考

https://docs.spring.io/spring/docs/5.2.6.RELEASE/spring-framework-reference/core.html#beans-factory-naturemica : https://github.com/lets-mica/mica

pig: https://github.com/lltx/pig

到此這篇關(guān)于如何寫好一個Spring組件的實現(xiàn)步驟的文章就介紹到這了,更多相關(guān)Spring 組件內(nèi)容請搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！