SpringBoot通過(guò)自定義注解實(shí)現(xiàn)配置類的自動(dòng)注入的實(shí)現(xiàn)
前言
SpringBoot中通過(guò)@ConfigurationProperties
或@Value
注解就可以獲取配置文件中的屬性定義并綁定到Java Bean或?qū)傩陨?,這也是我們平常使用最多的一種方式。但是小胖在開發(fā)過(guò)程中就遇到一個(gè)問(wèn)題:在做MQ的開發(fā)中,配置文件中會(huì)配置多個(gè)生產(chǎn)者分別提供不同的業(yè)務(wù)能力,如果通過(guò)@ConfigurationProperties
注解來(lái)實(shí)現(xiàn)的話,這就意味著需要?jiǎng)?chuàng)建多個(gè)屬性一樣的配置類,雖然說(shuō)可以實(shí)現(xiàn)功能,但是很明顯,這不是一個(gè)很好的設(shè)計(jì)。場(chǎng)景如下所示:
producer1: password: xxx app: xxx address: url1 enabled: false producer2: password: xxx app: xxx address: url1 enabled: false
實(shí)現(xiàn)思路
在我們?nèi)粘5拈_發(fā)工作中,經(jīng)??梢砸?jiàn)到的是通過(guò)自定義注解+攔截器+反射從而實(shí)現(xiàn)對(duì)權(quán)限的校驗(yàn)或者對(duì)實(shí)體類字段值格式進(jìn)行校驗(yàn)。那么,我們是不是也可以參考這個(gè)思路達(dá)到我們的目的呢?答案是肯定的,其實(shí)如果對(duì)Mabatis等組件比較熟悉的話,就可以看到這樣的設(shè)計(jì)。我們?cè)挷欢嗌?,開搞~
開搞
以下內(nèi)容,為了方便,我們將配置相關(guān)內(nèi)容改為人員(people)
自定義配置類讀取配置
首先,有一點(diǎn)是不會(huì)改變的,我們需要自定義一個(gè)配置類,用于讀取配置文件中的配置。這里,我們需要改變一下我們配置文件信息里。將所有的配置信息放到一個(gè)類里。
my: peoples: people1: userName: 張三 userSex: 男 people2: userName: 李四 userSex: 女
然后,定義一個(gè)配置類用來(lái)接收,這里通過(guò)@ConfigurationProperties
注解實(shí)現(xiàn)對(duì)配置的注入。要注意,因?yàn)槲覀冊(cè)趐eoples下面有很多的people,因此,屬性應(yīng)給定義的是一個(gè)MAP的類型。
@Component @ConfigurationProperties(prefix = "my",ignoreUnknownFields = false) public class PeopleConfigs { private Map<String, PeopleEntity> peoples; public Map<String, PeopleEntity> getPeoples() { return peoples; } public void setPeoples(Map<String, PeopleEntity> peoples) { this.peoples = peoples; } @Override public String toString() { return "PeopleConfigs{" + "peoples=" + peoples + '}'; } } public class PeopleEntity { private String userName; private String userSex; public String getUserName() { return userName; } public void setUserName(String userName) { this.userName = userName; } public String getUserSex() { return userSex; } public void setUserSex(String userSex) { this.userSex = userSex; } @Override public String toString() { return "PeopleEntity{" + "userName='" + userName + ''' + ", userSex='" + userSex + ''' + '}'; } }
這樣,Springboot就會(huì)自動(dòng)加載我們這個(gè)配置類。但是,這個(gè)的整個(gè)PeopleConfigs
是一個(gè)Bean,并不能達(dá)到我們本文的目的,因此我們進(jìn)行后續(xù)的步驟。
自定義注解
我們聲明一個(gè)運(yùn)行時(shí)的注解,在屬性上進(jìn)行使用。這里定義name用來(lái)標(biāo)記需要注入的是哪個(gè)人。
@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD}) public @interface People { String name() default ""; }
創(chuàng)建子配置Bean
首先,定義一個(gè)autoConfig的配置類,該類通過(guò)@EnableConfigurationProperties
注解,指定PeopleConfig Bean在本類之前進(jìn)行裝載。通過(guò)@Bean
方法注解進(jìn)行bean聲明,此處調(diào)用的是單個(gè)people配置類的bean生成的方法。
@Configuration @EnableConfigurationProperties({PeopleConfigs.class}) public class PeopleAutoConfig { @Autowired PeopleConfigs peopleConfigs; @Bean public PeopleRegister peopleRegister(){ return new PeopleRegister(peopleConfigs); } }
通過(guò)反射進(jìn)行people bean的注入
這里不得不提到BeanPostProcessor
類,該類為我們提供了springBoot在bean初始化前后方便我們進(jìn)行其他自定義操作的一些接口。我們這里通過(guò)實(shí)現(xiàn)postProcessBeforeInitialization
方法,在bean裝載之前,通過(guò)反射判斷對(duì)應(yīng)bean上是否有我們自定義的people注解。如果有,則進(jìn)行注入操作。詳細(xì)代碼如下:
public class PeopleRegister implements BeanPostProcessor, ApplicationContextAware { private final PeopleConfigs peopleConfigs; private GenericApplicationContext applicationContext; PeopleRegister(PeopleConfigs peopleConfigs){ this.peopleConfigs = peopleConfigs; } @Override public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { Class<?> beanClass = AopUtils.getTargetClass(bean); Field[] fields = beanClass.getDeclaredFields(); Field[] var5 = fields; int var6 = fields.length; for(int var7 = 0;var7<var6;var7++){ Field field = var5[var7]; People annotation = field.getAnnotation(People.class); if (annotation!=null){ PeopleEntity entity = this.peopleConfigs.getPeoples().get(annotation.name()); if (!this.applicationContext.containsBean(annotation.name())){ ConfigurableListableBeanFactory beanFactory = this.applicationContext.getBeanFactory(); Object wrapperBean = beanFactory.initializeBean(entity, annotation.name()); beanFactory.registerSingleton(annotation.name(), Objects.requireNonNull(wrapperBean)); } try{ field.setAccessible(true); field.set(bean, this.applicationContext.getBean(annotation.name(), PeopleEntity.class)); }catch (Exception e){ e.printStackTrace(); } } } return bean; } @Override public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { return bean; } @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { this.applicationContext = (GenericApplicationContext)applicationContext; } }
使用
前面工作進(jìn)行完成后,接下來(lái)就是我們的使用環(huán)節(jié),這里,我們僅需要通過(guò)@People(name = "人")
指定即可:
@Controller public class BaseController { @Autowired PeopleConfigs peopleConfigs; @People(name = "people1") PeopleEntity people1; @People(name = "people2") PeopleEntity people2; @ResponseBody @GetMapping("/test") public String test() { return peopleConfigs.toString()+people1.toString()+people2.toString(); } }
效果
回顧
本文我們通過(guò)自定義注解+反射實(shí)現(xiàn)了配置類的自動(dòng)注入,看完以后是不是覺(jué)得如此簡(jiǎn)單。我們只是把發(fā)射注入的邏輯從攔截器換到了ostProcessBeforeInitialization中來(lái)而已。
在工作中,其實(shí)有很多業(yè)務(wù)場(chǎng)景可以讓我們?nèi)ミM(jìn)行友好的設(shè)計(jì),關(guān)鍵在于我們有沒(méi)有這個(gè)意識(shí),大家一起進(jìn)步。
延伸
有些JRM看到這個(gè)設(shè)計(jì),是不是感覺(jué)也很想吐,明明能很簡(jiǎn)單搞得卻搞得這么麻煩,還寫注冊(cè)類什么的。其實(shí)實(shí)際應(yīng)用中,比如MQ一類的,我們?cè)赽ean注入后,是希望直接啟動(dòng)連接的,在銷毀時(shí)希望能自動(dòng)關(guān)閉連接,而不是每次使用的時(shí)候都要自己對(duì)連接進(jìn)行管理。因此才如此進(jìn)行定義和設(shè)計(jì)。
到此這篇關(guān)于SpringBoot通過(guò)自定義注解實(shí)現(xiàn)配置類的自動(dòng)注入的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot配置類自動(dòng)注入內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
詳解Java String字符串獲取每一個(gè)字符及常用方法
這篇文章主要介紹了詳解Java String字符串獲取每一個(gè)字符及常用方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-09-09Spring MVC實(shí)現(xiàn)mysql數(shù)據(jù)庫(kù)增刪改查完整實(shí)例
這篇文章主要介紹了Spring MVC實(shí)現(xiàn)mysql數(shù)據(jù)庫(kù)增刪改查完整實(shí)例,從創(chuàng)建一個(gè)web項(xiàng)目開始,分享了項(xiàng)目結(jié)構(gòu)以及具體Java代碼和前端頁(yè)面等相關(guān)內(nèi)容,具有一定借鑒價(jià)值,需要的朋友可以了解下。2017-12-12Java Annotation(Java 注解)的實(shí)現(xiàn)代碼
本篇文章介紹了,Java Annotation(Java 注解)的實(shí)現(xiàn)代碼。需要的朋友參考下2013-05-05利用5分鐘快速搭建一個(gè)springboot項(xiàng)目的全過(guò)程
Spring Boot的監(jiān)控能夠使開發(fā)者更好地掌控應(yīng)用程序的運(yùn)行狀態(tài),下面這篇文章主要給大家介紹了關(guān)于如何利用5分鐘快速搭建一個(gè)springboot項(xiàng)目的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-05-05java 反射 動(dòng)態(tài)調(diào)用不同類的靜態(tài)方法(推薦)
下面小編就為大家?guī)?lái)一篇JAVA 反射 動(dòng)態(tài)調(diào)用不同類的靜態(tài)方法(推薦)。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-08-08Spring切面優(yōu)先級(jí)與基于xml的AOP實(shí)現(xiàn)方法詳解
這篇文章主要介紹了Spring切面的優(yōu)先級(jí)與基于xml的AOP的詳細(xì)步驟,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-11-11解析Java編程中設(shè)計(jì)模式的開閉原則的運(yùn)用
這篇文章主要介紹了解析Java編程中設(shè)計(jì)模式的開閉原則的運(yùn)用,開閉原則多應(yīng)用于Java程序的擴(kuò)展開發(fā)方面,需要的朋友可以參考下2016-02-02