当心！请不要在SpringBoot中再犯这样严重的错误-51CTO.COM

环境：SpringBoot3.3.0

1. 简介

在Spring Boot中，@Configuration注解用于声明配置类，以定义和注册Bean对象。这些Bean对象可以是普通的业务组件，也可以是特殊的处理器，如BeanPostProcessor或BeanFactoryPostProcessor，用于在Spring容器中对其他Bean进行额外的处理。接下来我们将详细的介绍关于在SpringBoot环境下各种不正确的配置导致的各种问题。

2. 实战案例

2.1 循环依赖错误

当我们在一个配置类中使用@PostConstruct注解并且在其方法内部去引用其它Bean时，将会出现循环依赖错误，如下示例：

@Configuration
public class AppConfig {


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

在init()方法中调用dao()方法后，将无正确的启动SpringBoot，抛出如下错误

图片

循环依赖错误，导致该错误的原因是非静态@Bean方法在语义上需要一个完全初始化的配置类实例来调用；简单点说就是在调用dao方法时需要完全的初始化AppConfig类，但是@PostConstruct注解的方法在执行时当前的这个AppConfig并没有完全的执行完成。要解决该问题可以通过如下2种方式：

方式1：

开启循环依赖

spring:
  main:
    allow-circular-references: true

从SpringBoot2.6+开始默认不允许循环依赖。这样SpringBoot程序就能正确启动，不过这不是最好的方式也不推荐该种方式。

方式2：

将上面的dao方法声明为static方法；

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

static修饰的方法不需要包裹它的配置类提起初始化完成。这也是最为推荐的方法。

2.2 自定义处理器错误

当通过 @Bean 定义 BeanPostProcessor 和 BeanFactoryPostProcessor 时可能导致当前配置依赖注入的bean将不会生效（也就是@Autowired和@Value注解可能没有生效），如下示例：

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


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

配置文件中配置信息；

pack:
  title: xxxooo

控制台输出

AppConfig [title=xxxooo]

没有问题；但是如果你在AppConfig配置类中注册BeanPostProcessor后会出现什么情况呢？

自定义BeanPostProcessor；

public class PackBeanPostProcessor implements BeanPostProcessor {
  // TODO
}

通过@Bean注册上面的BeanPostProcessor；

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

再次运行服务，控制台输出

AppConfig [title=xxxooo]

还是能正确的输出！？注意接下来我们对上面的自定义处理器做如下修改；

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

这时候我们去实现了PriorityOrdered优先级接口，并将优先级设置的比较的高。如上调整后再次启动服务

AppConfig [title=null]

问题出现了配置的属性并没有正确的解析注入，这是因为在默认情况下处理@Value注解的处理器的优先级低于你当前自定义处理器的优先级，所以这就导致了问题。同样的如果你使用@Autowired或@Resource也将会导致问题，如下示例：

@Configuration
public class AppConfig {


  @Resource
  private Person person ;
}

输出结果：

AppConfig [persnotallow=null]

同样不能被注入；

要解决该问题可以通过如下2种方式：

方式1：

通过实现ApplicationContextInitializer接口；

public class PackApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {


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

注册该实现；

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

这种方式实现非常麻烦；推荐下面的第二种方式

方式2：

将@Bean对应的方法声明为static即可。

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

将该方法声明为static后，那么容器在获取BeanPostProcessor是不需要先实例化包裹它的类的实例。

其实对于@Configuration注解的配置类，如果你有需要注入的对象，官方建议采用参数的方式注入，如下示例：

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

构造函数注入也是在任何形式下的推荐注入方式。