快捷導(dǎo)航

SpringBoot通過自定義注解實現(xiàn)配置類的自動注入的實現(xiàn)

更新時間：2023年04月17日 14:36:50 作者：蘭小胖

本文主要介紹了SpringBoot通過自定義注解實現(xiàn)配置類的自動注入的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

前言

SpringBoot中通過@ConfigurationProperties或@Value注解就可以獲取配置文件中的屬性定義并綁定到Java Bean或?qū)傩陨?，這也是我們平常使用最多的一種方式。但是小胖在開發(fā)過程中就遇到一個問題：在做MQ的開發(fā)中，配置文件中會配置多個生產(chǎn)者分別提供不同的業(yè)務(wù)能力，如果通過@ConfigurationProperties注解來實現(xiàn)的話，這就意味著需要創(chuàng)建多個屬性一樣的配置類，雖然說可以實現(xiàn)功能，但是很明顯，這不是一個很好的設(shè)計。場景如下所示：

producer1:
    password: xxx
    app: xxx
    address: url1
    enabled: false
    
producer2:
    password: xxx
    app: xxx
    address: url1
    enabled: false

實現(xiàn)思路

在我們?nèi)粘５拈_發(fā)工作中，經(jīng)?？梢砸姷降氖峭ㄟ^自定義注解+攔截器+反射從而實現(xiàn)對權(quán)限的校驗或者對實體類字段值格式進行校驗。那么，我們是不是也可以參考這個思路達到我們的目的呢？答案是肯定的，其實如果對Mabatis等組件比較熟悉的話，就可以看到這樣的設(shè)計。我們話不多少，開搞~

開搞

以下內(nèi)容，為了方便，我們將配置相關(guān)內(nèi)容改為人員（people）

自定義配置類讀取配置

首先，有一點是不會改變的，我們需要自定義一個配置類，用于讀取配置文件中的配置。這里，我們需要改變一下我們配置文件信息里。將所有的配置信息放到一個類里。

my:
  peoples:
    people1:
      userName: 張三
      userSex: 男
    people2:
      userName: 李四
      userSex: 女

然后，定義一個配置類用來接收，這里通過@ConfigurationProperties注解實現(xiàn)對配置的注入。要注意，因為我們在peoples下面有很多的people，因此，屬性應(yīng)給定義的是一個MAP的類型。

@Component
@ConfigurationProperties(prefix = "my",ignoreUnknownFields = false)
public class PeopleConfigs {

    private Map&lt;String, PeopleEntity&gt; peoples;

    public Map&lt;String, PeopleEntity&gt; getPeoples() {
        return peoples;
    }

    public void setPeoples(Map&lt;String, PeopleEntity&gt; 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就會自動加載我們這個配置類。但是，這個的整個PeopleConfigs是一個Bean，并不能達到我們本文的目的，因此我們進行后續(xù)的步驟。

自定義注解

我們聲明一個運行時的注解，在屬性上進行使用。這里定義name用來標記需要注入的是哪個人。

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface People {
    String name() default "";
}

創(chuàng)建子配置Bean

首先，定義一個autoConfig的配置類，該類通過@EnableConfigurationProperties注解，指定PeopleConfig Bean在本類之前進行裝載。通過@Bean方法注解進行bean聲明，此處調(diào)用的是單個people配置類的bean生成的方法。

@Configuration
@EnableConfigurationProperties({PeopleConfigs.class})
public class PeopleAutoConfig {

    @Autowired
    PeopleConfigs peopleConfigs;

    @Bean
    public PeopleRegister peopleRegister(){
        return new PeopleRegister(peopleConfigs);
    }
}

通過反射進行people bean的注入

這里不得不提到BeanPostProcessor類，該類為我們提供了springBoot在bean初始化前后方便我們進行其他自定義操作的一些接口。我們這里通過實現(xiàn)postProcessBeforeInitialization方法，在bean裝載之前，通過反射判斷對應(yīng)bean上是否有我們自定義的people注解。如果有，則進行注入操作。詳細代碼如下：

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&lt;?&gt; beanClass = AopUtils.getTargetClass(bean);
        Field[] fields = beanClass.getDeclaredFields();
        Field[] var5 = fields;
        int var6 = fields.length;

        for(int var7 = 0;var7&lt;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;
    }
}

使用

前面工作進行完成后，接下來就是我們的使用環(huán)節(jié)，這里，我們僅需要通過@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();
    }
}

效果

回顧

本文我們通過自定義注解+反射實現(xiàn)了配置類的自動注入，看完以后是不是覺得如此簡單。我們只是把發(fā)射注入的邏輯從攔截器換到了ostProcessBeforeInitialization中來而已。

在工作中，其實有很多業(yè)務(wù)場景可以讓我們?nèi)ミM行友好的設(shè)計，關(guān)鍵在于我們有沒有這個意識，大家一起進步。

延伸

有些JRM看到這個設(shè)計，是不是感覺也很想吐，明明能很簡單搞得卻搞得這么麻煩，還寫注冊類什么的。其實實際應(yīng)用中，比如MQ一類的，我們在bean注入后，是希望直接啟動連接的，在銷毀時希望能自動關(guān)閉連接，而不是每次使用的時候都要自己對連接進行管理。因此才如此進行定義和設(shè)計。

到此這篇關(guān)于SpringBoot通過自定義注解實現(xiàn)配置類的自動注入的實現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot配置類自動注入內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: