当心！不要在 SpringBoot 中再犯这样严重的错误

2024-07-05
福建
本文字数：2323 字
阅读完需：约 8 分钟

1. 简介

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

2. 实战案例

2.1 循环依赖错误

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

复制

@Configurationpublic class AppConfig {

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

复制代码

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

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

方式 1：

开启循环依赖

复制

spring:  main:    allow-circular-references: true1.2.3.

复制代码

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

方式 2：

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

复制

@Beanpublic static DAO dao() {  return new DAO() ;}1.2.3.4.

复制代码

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

2.2 自定义处理器错误

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

复制

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

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

复制代码

配置文件中配置信息；

复制

pack:  title: xxxooo1.2.

复制代码

控制台输出

复制

AppConfig [title=xxxooo]1.

复制代码

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

自定义 BeanPostProcessor；

复制

public class PackBeanPostProcessor implements BeanPostProcessor {  // TODO}1.2.3.

复制代码

通过 @Bean 注册上面的 BeanPostProcessor；

复制

@Beanpublic PackBeanPostProcessor packBeanPostProcessor() {  return new PackBeanPostProcessor() ;}1.2.3.4.

复制代码

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

复制

AppConfig [title=xxxooo]1.

复制代码

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

复制

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

复制代码

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

复制

AppConfig [title=null]1.

复制代码

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

复制

@Configurationpublic class AppConfig {

  @Resource  private Person person ;}1.2.3.4.5.6.7.

复制代码

输出结果：

复制

AppConfig [persnotallow=null]1.

复制代码

同样不能被注入；

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

方式 1：

通过实现 ApplicationContextInitializer 接口；

复制

public class PackApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {

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

复制代码

注册该实现；

复制

org.springframework.context.Applicatinotallow=\com.pack.PackApplicationContextInitializer1.2.

复制代码

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

方式 2：

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

复制

@Beanpublic static PackBeanPostProcessor packBeanPostProcessor() {  return new PackBeanPostProcessor() ;}1.2.3.4.

复制代码

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

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

复制

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

复制代码

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

作为程序员，持续学习和充电非常重要，作为开发者，我们需要保持好奇心和学习热情，不断探索新的技术，只有这样，我们才能在这个快速发展的时代中立于不败之地。低代码也是一个值得我们深入探索的领域，让我们拭目以待，它将给前端世界带来怎样的变革。

介绍一款程序员都应该知道的软件JNPF快速开发平台，很多人都尝试用过它，它是功能的集大成者，任何信息化系统都可以基于它开发出来。

JNPF 可以实现应用从创建、配置、开发、测试到发布、运维、升级等完整生命周期的管理。减少了传统应用程序的代码编写量，通过图形化、可视化的界面，以拖放组件的方式，即可快速生成应用程序的产品，大幅降低了开发企业管理类软件的难度。

发布于: 刚刚阅读数: 5

秃头小帅oi

关注

摸个鱼，顺便发点有用的东西 2023-06-19 加入

互联网某厂人（重生版）

发布

暂无评论

创作场景

当心！不要在 SpringBoot 中再犯这样严重的错误

1. 简介

2. 实战案例

2.1 循环依赖错误

方式 1：

方式 2：

2.2 自定义处理器错误

方式 1：

方式 2：

秃头小帅oi

评论