SpringBoot通過自定義註解實現設定類的自動注入的實現

2023-09-06 22:04:46

前言

SpringBoot中通過@ConfigurationProperties或@Value註解就可以獲取組態檔中的屬性定義並繫結到Java Bean或屬性上，這也是我們平常使用最多的一種方式。但是小胖在開發過程中就遇到一個問題：在做MQ的開發中，組態檔中會設定多個生產者分別提供不同的業務能力，如果通過@ConfigurationProperties註解來實現的話，這就意味著需要建立多個屬性一樣的設定類，雖然說可以實現功能，但是很明顯，這不是一個很好的設計。場景如下所示：

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

實現思路

在我們日常的開發工作中，經常可以見到的是通過自定義註解+攔截器+反射從而實現對許可權的校驗或者對實體類欄位值格式進行校驗。那麼，我們是不是也可以參考這個思路達到我們的目的呢？答案是肯定的，其實如果對Mabatis等元件比較熟悉的話，就可以看到這樣的設計。我們話不多少，開搞~

開搞

以下內容，為了方便，我們將設定相關內容改為人員（people）

自定義設定類讀取設定

首先，有一點是不會改變的，我們需要自定義一個設定類，用於讀取組態檔中的設定。這裡，我們需要改變一下我們組態檔資訊裡。將所有的設定資訊放到一個類裡。

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

然後，定義一個設定類用來接收，這裡通過@ConfigurationProperties註解實現對設定的注入。要注意，因為我們在peoples下面有很多的people，因此，屬性應給定義的是一個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，並不能達到我們本文的目的，因此我們進行後續的步驟。

自定義註解

我們宣告一個執行時的註解，在屬性上進行使用。這裡定義name用來標記需要注入的是哪個人。

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

建立子設定Bean

首先，定義一個autoConfig的設定類，該類通過@EnableConfigurationProperties註解，指定PeopleConfig Bean在本類之前進行裝載。通過@Bean方法註解進行bean宣告，此處呼叫的是單個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初始化前後方便我們進行其他自定義操作的一些介面。我們這裡通過實現postProcessBeforeInitialization方法，在bean裝載之前，通過反射判斷對應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;
    }
}

使用

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