環(huán)境：SpringBoot3.3.0

1. 簡(jiǎn)介

在Spring Boot中，@Configuration注解用于聲明配置類(lèi)，以定義和注冊(cè)Bean對(duì)象。這些Bean對(duì)象可以是普通的業(yè)務(wù)組件，也可以是特殊的處理器，如BeanPostProcessor或BeanFactoryPostProcessor，用于在Spring容器中對(duì)其他Bean進(jìn)行額外的處理。接下來(lái)我們將詳細(xì)的介紹關(guān)于在SpringBoot環(huán)境下各種不正確的配置導(dǎo)致的各種問(wèn)題。

2. 實(shí)戰(zhàn)案例

2.1 循環(huán)依賴錯(cuò)誤

當(dāng)我們?cè)谝粋€(gè)配置類(lèi)中使用@PostConstruct注解并且在其方法內(nèi)部去引用其它Bean時(shí)，將會(huì)出現(xiàn)循環(huán)依賴錯(cuò)誤，如下示例：

@Configuration
public class AppConfig {


  @PostConstruct
  public void init() {
    dao() ;
    System.out.println("AppConfig init...") ;
  }
  @Bean
  DAO dao() {
    return new DAO() ;
  }
}

在init()方法中調(diào)用dao()方法后，將無(wú)正確的啟動(dòng)SpringBoot，拋出如下錯(cuò)誤

圖片

循環(huán)依賴錯(cuò)誤，導(dǎo)致該錯(cuò)誤的原因是非靜態(tài)@Bean方法在語(yǔ)義上需要一個(gè)完全初始化的配置類(lèi)實(shí)例來(lái)調(diào)用；簡(jiǎn)單點(diǎn)說(shuō)就是在調(diào)用dao方法時(shí)需要完全的初始化AppConfig類(lèi)，但是@PostConstruct注解的方法在執(zhí)行時(shí)當(dāng)前的這個(gè)AppConfig并沒(méi)有完全的執(zhí)行完成。要解決該問(wèn)題可以通過(guò)如下2種方式：

方式1：

開(kāi)啟循環(huán)依賴

spring:
  main:
    allow-circular-references: true

從SpringBoot2.6+開(kāi)始默認(rèn)不允許循環(huán)依賴。這樣SpringBoot程序就能正確啟動(dòng)，不過(guò)這不是最好的方式也不推薦該種方式。

方式2：

將上面的dao方法聲明為static方法；

@Bean
public static DAO dao() {
  return new DAO() ;
}

static修飾的方法不需要包裹它的配置類(lèi)提起初始化完成。這也是最為推薦的方法。

2.2 自定義處理器錯(cuò)誤

當(dāng)通過(guò) @Bean 定義 BeanPostProcessor 和 BeanFactoryPostProcessor 時(shí)可能導(dǎo)致當(dāng)前配置依賴注入的bean將不會(huì)生效（也就是@Autowired和@Value注解可能沒(méi)有生效），如下示例：

@Configuration
public class AppConfig {
  @Value("${pack.title}")
  private String title ;


  @Override
  public String toString() {
    return "AppConfig [title=" + title + "]";
  }
}

配置文件中配置信息；

pack:
  title: xxxooo

控制臺(tái)輸出

AppConfig [title=xxxooo]

沒(méi)有問(wèn)題；但是如果你在AppConfig配置類(lèi)中注冊(cè)BeanPostProcessor后會(huì)出現(xiàn)什么情況呢？

自定義BeanPostProcessor；

public class PackBeanPostProcessor implements BeanPostProcessor {
  // TODO
}

通過(guò)@Bean注冊(cè)上面的BeanPostProcessor；

@Bean
public PackBeanPostProcessor packBeanPostProcessor() {
  return new PackBeanPostProcessor() ;
}

再次運(yùn)行服務(wù)，控制臺(tái)輸出

AppConfig [title=xxxooo]

還是能正確的輸出??？注意接下來(lái)我們對(duì)上面的自定義處理器做如下修改；

public class PackBeanPostProcessor implements BeanPostProcessor, PriorityOrdered {
  // TODO
  @Override
  public int getOrder() {
    return -1 ;
  }
}

這時(shí)候我們?nèi)?shí)現(xiàn)了PriorityOrdered優(yōu)先級(jí)接口，并將優(yōu)先級(jí)設(shè)置的比較的高。如上調(diào)整后再次啟動(dòng)服務(wù)

AppConfig [title=null]

問(wèn)題出現(xiàn)了配置的屬性并沒(méi)有正確的解析注入，這是因?yàn)樵谀J(rèn)情況下處理@Value注解的處理器的優(yōu)先級(jí)低于你當(dāng)前自定義處理器的優(yōu)先級(jí)，所以這就導(dǎo)致了問(wèn)題。同樣的如果你使用@Autowired或@Resource也將會(huì)導(dǎo)致問(wèn)題，如下示例：

@Configuration
public class AppConfig {


  @Resource
  private Person person ;
}

輸出結(jié)果：

AppConfig [persnotallow=null]

同樣不能被注入；

要解決該問(wèn)題可以通過(guò)如下2種方式：

方式1：

通過(guò)實(shí)現(xiàn)ApplicationContextInitializer接口；

public class PackApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {


  @Override
  public void initialize(ConfigurableApplicationContext context) {
    context.getBeanFactory().addBeanPostProcessor(new PackBeanPostProcessor());
  }
}

注冊(cè)該實(shí)現(xiàn)；

org.springframework.context.Applicatinotallow=\
com.pack.PackApplicationContextInitializer

這種方式實(shí)現(xiàn)非常麻煩；推薦下面的第二種方式

方式2：

將@Bean對(duì)應(yīng)的方法聲明為static即可。

@Bean
public static PackBeanPostProcessor packBeanPostProcessor() {
  return new PackBeanPostProcessor() ;
}

將該方法聲明為static后，那么容器在獲取BeanPostProcessor是不需要先實(shí)例化包裹它的類(lèi)的實(shí)例。

其實(shí)對(duì)于@Configuration注解的配置類(lèi)，如果你有需要注入的對(duì)象，官方建議采用參數(shù)的方式注入，如下示例：

@Configuration
public class AppConfig {
  private final Person person ;
  public AppConfig(Person person) {
    this.person = person ;
  }
}

構(gòu)造函數(shù)注入也是在任何形式下的推薦注入方式。