Spring——SpringBean初始接口

🕗 发布于 2024-12-08 15:16 spring java 后端

摘要

本文详细介绍了Spring框架中SpringBean的初始化接口和注解，包括BeanPostProcessor接口、InitializingBean接口和@PostConstruct注解。文章解释了这些接口和注解的原理、作用、适用场景，并提供了示例代码。最后，对比了不同SpringBean初始化方式的优缺点。

1. BeanPostProcessor接口

在 Spring 中，如果需要在 Spring 容器完成 bean 的属性设置之前执行初始化逻辑，可以使用 BeanPostProcessor 接口中的 postProcessBeforeInitialization 方法。与 @PostConstruct 和 InitializingBean 不同，这种方式允许开发者在属性填充完成之前定制初始化逻辑。

1.1. BeanPostProcessor接口原理

Spring 提供了 BeanPostProcessor 接口，用于在 Spring 容器管理的 bean 初始化生命周期中加入自定义逻辑。它包含两个方法：

postProcessBeforeInitialization：

- 在 bean 的初始化回调方法（如 @PostConstruct 或 afterPropertiesSet）之前执行。
- 可用于拦截并修改 bean 的初始化前的逻辑。

postProcessAfterInitialization：

- 在 bean 的初始化回调方法之后执行。
- 通常用于代理增强等逻辑

1.2. BeanPostProcessor接口作用

postProcessBeforeInitialization 主要用于修改或验证 bean 的初始状态。
设置默认值（如果属性未配置）。
验证属性的正确性。
添加初始化前的日志或调试信息。

1.3. BeanPostProcessor接口适用场景

当你需要在依赖注入完成之前对 bean 进行拦截和自定义处理。
需要跨多个 bean 应用统一的逻辑，比如：

- 自动配置某些属性。
- 统一校验所有 bean 的依赖关系。

用于框架级功能（比如 AOP 或日志代理）。

1.4. BeanPostProcessor接口示例

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.stereotype.Component;

@Component
public class MyBeanPostProcessor implements BeanPostProcessor {

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        if (bean instanceof MyBean) {
            System.out.println("Before Initialization: " + beanName);
            MyBean myBean = (MyBean) bean;

            // 在属性填充之前，可以修改 bean 的初始状态
            if (myBean.getName() == null || myBean.getName().isEmpty()) {
                myBean.setName("DefaultName");
            }
        }
        return bean;
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        if (bean instanceof MyBean) {
            System.out.println("After Initialization: " + beanName);
        }
        return bean;
    }
}

import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void init() {
        System.out.println("Initializing MyBean with name: " + name);
    }
}

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan(basePackages = "com.example")
public class MainApplication {

    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(MainApplication.class);
        MyBean myBean = context.getBean(MyBean.class);

        System.out.println("Bean name after processing: " + myBean.getName());
    }
}

Before Initialization: myBean
Initializing MyBean with name: DefaultName
After Initialization: myBean
Bean name after processing: DefaultName

2. InitializingBean接口

InitializingBean接口是Spring框架中的一个生命周期接口，用于在Spring容器完成bean的属性设置后执行初始化逻辑。实现了该接口的bean会在Spring容器注入完所有的依赖之后自动调用afterPropertiesSet方法，从而让开发者在bean初始化后执行一些额外的操作，如检查配置、初始化数据等。

2.1. InitializingBean接口原理

实现InitializingBean接口Spring对象执行顺序

Spring容器创建bean：当Spring容器启动时，会根据配置文件（XML或者注解）扫描到所有的bean，并创建它们。
依赖注入：Spring会将配置文件中定义的属性注入到bean实例中。这些属性可以是基础类型、引用类型或集合类型等。
调用afterPropertiesSet方法：如果bean实现了InitializingBean接口，Spring会在所有依赖注入完成后自动调用该bean的afterPropertiesSet方法。这是Spring容器在bean初始化的过程中执行的一部分。

2.2. InitializingBean接口适用场景

afterPropertiesSet方法通常用于执行初始化任务，比如：

校验配置参数是否正确。
初始化一些资源或数据。
打印调试信息，确认bean已经成功初始化。

2.3. InitializingBean接口示例

假设你有一个类需要在Spring容器初始化完成后执行一些初始化工作，可以通过实现InitializingBean接口来实现。

import org.springframework.beans.factory.InitializingBean;

public class MyBean implements InitializingBean {
    
    private String name;

    // Spring容器会通过依赖注入注入name属性
    public void setName(String name) {
        this.name = name;
    }

    // 实现 afterPropertiesSet 方法，完成初始化工作
    @Override
    public void afterPropertiesSet() throws Exception {
        // 初始化逻辑，比如验证name属性是否为空
        if (name == null || name.isEmpty()) {
            throw new IllegalArgumentException("Name property must be set");
        }
        System.out.println("MyBean initialized with name: " + name);
    }
}

在Spring配置文件中，您可以像下面这样定义该bean：

<bean id="myBean" class="com.example.MyBean">
  <property name="name" value="SpringBeanExample" />
</bean>

使用注解配置：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyBean implements InitializingBean {

    @Value("${bean.name}")
    private String name;

    @Override
    public void afterPropertiesSet() throws Exception {
        if (name == null || name.isEmpty()) {
            throw new IllegalArgumentException("Name property must be set");
        }
        System.out.println("MyBean initialized with name: " + name);
    }
}

2.4. InitializingBean接口注意事项

InitializingBean接口的afterPropertiesSet方法可以与自定义的初始化方法一起使用。Spring也允许在bean的配置中指定一个init-method属性，用于指定一个自定义的初始化方法。如果bean同时实现了InitializingBean接口并配置了init-method，则会按顺序执行。
Spring的@PostConstruct注解提供了一种更简洁的方式来实现初始化逻辑，可以在方法上直接添加该注解，Spring会在bean初始化后自动调用它。

import org.springframework.stereotype.Component;

import jakarta.annotation.PostConstruct;

@Component
public class MyBean {

    private String name;

    // Setter 方法，Spring 容器会通过依赖注入设置属性
    public void setName(String name) {
        this.name = name;
    }

    // 使用 @PostConstruct 标记初始化方法
    @PostConstruct
    public void init() {
        if (name == null || name.isEmpty()) {
            throw new IllegalArgumentException("Name property must be set");
        }
        System.out.println("MyBean initialized with name: " + name);
    }
}

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    @Bean
    public MyBean myBean() {
        MyBean myBean = new MyBean();
        myBean.setName("SpringExample");
        return myBean;
    }
}

如果使用的是 Java 9 或更高版本，需要引入 jakarta.annotation 的依赖：

<dependency>
  <groupId>jakarta.annotation</groupId>
  <artifactId>jakarta.annotation-api</artifactId>
  <version>2.1.1</version>
</dependency>

@PostConstruct 方法要求：
方法无返回值 (void)。
方法不能接受参数。
方法不能是 static 的。

3. @PostConstruct注解

在 Spring 中，@PostConstruct 是 Java 标准中的注解，位于 jakarta.annotation（或早期的 javax.annotation）包中。Spring 对该注解提供了支持，用于在 bean 完成依赖注入后 自动调用标注的方法，执行初始化逻辑。它是由 Spring 的 BeanPostProcessor 实现机制来完成的。

3.1. @PostConstruct注解原理

具体原理流程如下：

Bean 实例化：Spring 容器扫描到配置的类并创建该类的实例。
依赖注入：容器根据配置将需要的依赖注入到该实例中。
调用 @PostConstruct 方法：

- Spring 容器会检测到 bean 中是否有被 @PostConstruct 标注的方法。
- 如果存在，该方法会在依赖注入完成后、初始化逻辑执行前被调用。

这个功能是通过 Spring 内部的 CommonAnnotationBeanPostProcessor 实现的，该类实现了 Spring 的 BeanPostProcessor 接口，并负责处理 @PostConstruct 和其他类似注解（如 @PreDestroy）。

3.2. @PostConstruct注解作用

BeanPostProcessor： Spring 使用 CommonAnnotationBeanPostProcessor，它是 BeanPostProcessor 的一个实现类。
在 bean 初始化阶段，它会调用每个 bean 的 postProcessBeforeInitialization 方法，检查是否有 @PostConstruct 标注的方法。
调用 @PostConstruct 方法：

- 找到标注的方法。
- 利用反射调用该方法。
- 确保该方法只执行一次。

3.3. @PostConstruct注解示例

import jakarta.annotation.PostConstruct;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

    private String name;

    public void setName(String name) {
        this.name = name;
    }

    // @PostConstruct 用于初始化逻辑
    @PostConstruct
    public void init() {
        if (name == null || name.isEmpty()) {
            this.name = "DefaultName";  // 如果未设置值，赋予默认值
        }
        System.out.println("MyBean initialized with name: " + name);
    }
}

配置类示例

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    @Bean
    public MyBean myBean() {
        MyBean myBean = new MyBean();
        myBean.setName("SpringExample");
        return myBean;
    }
}

运行测试类

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class MainApplication {
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
        MyBean myBean = context.getBean(MyBean.class);
        System.out.println("Bean is fully initialized and ready to use.");
    }
}

4. SpringBean初始化方式的对比

方式	定义位置	灵活性	优缺点
`@PostConstruct`	方法上，注解方式	简单且通用	优势：标准注解，语义清晰，易用。缺点：Java 9+ 需额外引入依赖。
`InitializingBean`	实现 `InitializingBean` 接口	中等	优势：Spring 原生支持。缺点：需要绑定到 Spring 接口，不灵活。
XML `init-method`	XML 配置文件中定义初始化方法	灵活	优势：无需修改代码。缺点：XML 配置繁琐，不够直观。
Java Config 方法	Java 配置类中直接调用初始化逻辑	灵活性高	优势：可自定义。缺点：需要在配置类中管理所有初始化逻辑。

方法	调用时机	用途	优点
`postProcessBeforeInitialization`	Bean 属性填充前	属性填充前拦截并修改 bean	灵活，适合跨 bean 的通用逻辑处理
`@PostConstruct`	属性填充完成后，初始化方法之前	依赖注入完成后的初始化逻辑	简洁，适合单个 bean 的初始化工作
`afterPropertiesSet`	属性填充完成后，`@PostConstruct` 之后	初始化任务	Spring 专用接口，适合复杂初始化

博文参考

原文地址：https://blog.csdn.net/weixin_41605937/article/details/144317656

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：Linux条件变量&线程池详解
下一篇：Python123_Python程序语言设计基础_基本数据类型

.NET(C#) 如何配置用户首选项及保存用户设置
.NET(C#) 如何配置用户首选项及保存用户设置
阅读更多2024-12-14
【最新】北大数字普惠金融指数数据集-省市县（2011-2023年）
郭峰,王靖一,王芳,孔涛,张勋,程志云.测度中国数字普惠金融发展:指数编制与空间特征[J].经济学(季刊),2020,19(04):1401-1418.时间跨度：省级和城市级指数时间跨度为2011-2
阅读更多2024-12-14
GESP202412 四级【Recamán】题解（AC）
a11ak−1−kkakak−1−kak−1k小杨想知道 Recamán 数列的前n项从小到大排序后的结果。手动计算非常困难，小杨希望你能帮他解决这个问题。
阅读更多2024-12-14
IDEA遇到EasyConnect中的网络资源无法访问的问题
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。原文链接：https://blog.csdn.net/wanshanyu_/article/de
阅读更多2024-12-14
双目摄像头标定方法
此时已经完成标定，左下角为反投影误差，右边为外参可视化。将双目左右目拍的图像上传（左右目最好不少于20张）此时回到主页面，即可看到成功导出。把这些误差大的删除即可。
阅读更多2024-12-14
Servlet、omcat服务器架构与工作原理
Servlet是运行在服务器端的Java程序，它的主要职责之一是接收并处理来自客户端（如浏览器）的HTTP请求。当客户端发送一个请求到服务器时，Servlet可以解析请求中的信息，例如请求的URL路径
阅读更多2024-12-14
Vue生命周期钩子函数：深入解析与实践
作为高级Vue前端开发人员，对Vue组件的生命周期钩子函数有着深刻的理解是至关重要的。生命周期钩子函数是指在Vue组件的创建、更新、销毁等过程中，Vue自动调用的一系列方法。通过这些钩子函数，我们可以
阅读更多2024-12-14
安卓开发--使用android studio发布APP
app发布
阅读更多2024-12-14
数据结构与算法学习笔记----拓扑排序
@ author: 明月清了个风。
阅读更多2024-12-14
python 将数据保存到现有的Excel文件的新工作表
out_file = ‘query.xlsx’df1 = pd.DataFrame(out_data)若直接写入：df1.to_excel(out_file, index=False, sheet_n
阅读更多2024-12-14