Springboot使用 @PostConstruct 和 @PreDestroy 了解 Bean 的生命周期

原创已于 2023-09-16 13:00:44 修改 · 818 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java #spring

于 2023-09-16 12:54:31 首次发布

图片来源

介绍

在 Java 世界中，Spring 框架因其丰富的功能和简化复杂企业级应用程序的能力而脱颖而出。Spring 的核心特性之一是依赖注入（DI）的概念，它围绕 bean 的生命周期进行。Spring 的 DI 容器负责实例化、配置和管理 bean。对于开发人员来说，了解 bean 生命周期所涉及的阶段并能够利用这些阶段来执行特定操作至关重要。

本文深入分析了 Spring bean 的生命周期，并强调了和@PostConstruct注释的重要性@PreDestroy。

Bean 生命周期：概述

Spring bean 的生命周期是一个复杂的过程，由几个阶段组成。每个阶段都在确保 Bean 正确初始化、使用和最终丢弃方面发挥着关键作用。

实例化：这是一个bean的诞生。Spring 根据 bean 定义实例化 bean，该定义可以通过 XML 配置、Java 配置或注释提供。结果是一个原始的、未配置的对象。
填充属性：实例化后，Spring 使用依赖注入将值注入到 bean 的属性中。它可以通过 setter 方法或字段注入。在此阶段，如果为 bean 定义了任何依赖项，它们也会得到解析。
设置Bean名称：如果一个bean实现了该BeanNameAware接口，Spring会从配置中提供该bean的id。当您希望 bean 知道其在容器内的标识符时，这非常有用。
应用 Bean 后处理器：在调用 Bean 初始化方法之前，Spring 应用任何 BeanPostProcessor。这些是容器的高级扩展，可以修改 bean 实例，例如用代理包装它。
初始化：这是一个关键阶段，bean 被初始化以准备使用。它通常涉及开发人员可能想要运行的自定义逻辑。如果 bean 实现了该InitializingBean接口，afterPropertiesSet则调用其方法。此外，任何带有注释的方法@PostConstruct都会被执行。
Bean 已准备好使用：一旦初始化，Bean 就准备好了。它可以由其他 bean 检索和使用，甚至可以从应用程序上下文中手动检索和使用。它会保持这种状态，直到容器关闭或 Bean 被显式删除。
销毁：在将 Bean 从容器中取出之前，它会经历一个清理阶段。如果它实现了该DisposableBean接口，destroy则调用其方法。此外，@PreDestroy还执行带有注释的方法。确保在此阶段释放 Bean 可能持有的任何资源（如数据库连接）至关重要。
Bean 被删除：最后，Bean 被从 Spring 容器中删除，释放资源并确保应用程序正常关闭。

@PostConstruct

注解@PostConstruct一直是 Java EE 世界的核心部分，其在 Spring 框架中的重要性怎么强调也不为过。让我们详细剖析一下这个注释。

起源与支持

@PostConstruct源自Java EE包javax.annotation。它是一个标准注释，这意味着它的使用不仅限于 Spring 生态系统，还可以扩展到任何兼容 Java EE 的系统。

目的

注解的主要作用@PostConstruct是将方法标记为生命周期事件回调。此回调确保在 Spring 容器完成 bean 的初始化阶段后执行该方法，其中包括设置所有 bean 属性和应用任何 ApplicationContextAware 接口。

执行指令

在 bean 生命周期内，@PostConstruct在设置 bean 属性并应用所有 bean 后处理器之后调用方法。如果 bean 也实现了该InitializingBean接口，则其afterPropertiesSet方法将在带注释的方法之前调用@PostConstruct。

用例

资源初始化：一种常见用途@PostConstruct是初始化资源，例如打开数据库连接或设置缓存。
数据验证：注入依赖后，@PostConstruct可用于检查数据是否一致和有效。
日志记录和监视：在初始化 Bean 时通知或记录以监视 Bean 生命周期。

怎么运行的

import javax.annotation.PostConstruct;

@Component
public class UserProcessor {
    
    private UserRepository userRepository;

    @Autowired
    public UserProcessor(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    @PostConstruct
    public void initializeCache() {
        // Assuming there's a method to preload user data into cache
        userRepository.preloadUserData();
        System.out.println("User data has been preloaded into cache.");
    }
}

在上面的代码中，在UserProcessor初始化 bean 并设置其依赖项后，initializeCache会自动调用该方法，将用户数据预加载到缓存中。

限制

一个 bean 中只有一个方法应该用进行注释@PostConstruct。如果注释了多个方法，则行为是未定义的，并且可能会因 Java EE 规范的不同版本或实现而异。
该方法应该具有 void 返回类型。
它不应该接受任何参数。
它可以是任何访问类型（公共、私有、受保护或包）。

与其他技术的比较

虽然@PostConstructSpring 提供了指定初始化逻辑的声明性方式，但还提供了其他技术，例如InitializingBean接口。@PostConstructover的优点InitializingBean是它使您的 bean 不受 Spring 特定代码的影响，确保更好的关注点分离和更轻松的单元测试

@PreDestroy

在 Spring 框架的广泛领域中，确保 Bean 的顺利有序关闭与它们的初始化一样重要。这就是@PreDestroy发挥作用的地方。让我们更深入地研究它的复杂性。

起源和兼容性

来自javax.annotationJava EE的包，@PreDestroy是一个标准的注释。其标准性质意味着它受 Java EE 兼容框架的支持，从而使使用它的代码更加可移植。

目的

该@PreDestroy注释用于将方法标记为销毁生命周期事件回调。当一个bean的生命周期接近结束，并且即将从Spring容器中删除时，使用此注释标记的方法将被执行。

执行指令

在 bean 生命周期内，用注释的方法@PreDestroy会在 bean 不再可用之后、正式从容器中删除之前执行。如果 bean 也实现了该DisposableBean接口，则destroy该接口的方法将在带注释的方法之后执行@PreDestroy。

用例

资源清理：通常@PreDestroy用于释放网络连接、数据库连接或文件句柄等资源，确保不会发生资源泄漏。
外部系统通知：通知外部系统或服务有关 Bean 生命周期的终止。
日志记录：记录终止事件以用于审核或监控目的。

怎么运行的

import javax.annotation.PreDestroy;

@Component
public class DataConnection {
    
    private Connection connection;

    public DataConnection() {
        // Imagine this constructor initializes the database connection
        this.connection = initializeDBConnection();
    }

    @PreDestroy
    public void closeConnection() {
        connection.close();
        System.out.println("Database connection has been closed.");
    }
}

在此示例中，在DataConnection从容器中删除 bean 之前，该closeConnection方法确保数据库连接正确关闭。

限制

与其对应的方法一样@PostConstruct，bean 中只有一个方法应该用@PreDestroy注释来修饰。多个带注释的方法会导致未定义的行为。
带注释的方法应返回 void。
它不应该接受任何参数。
它可以是任何访问类型（公共、私有、受保护或包）。

与其他技术的比较

虽然@PreDestroySpring 提供了一种简洁的声明式机制来指定销毁逻辑，但它还提供了DisposableBean接口等替代方案。其优势@PreDestroy在于DisposableBean它与 Spring 特定代码的解耦，为更好的模块化和易于单元测试铺平了道路。

@PostConstruct 和 @PreDestroy 的替代方案

@PostConstruct在 Spring 生态系统中，除了广泛认可的注解之外，还有多种可用于 bean 初始化和销毁的机制@PreDestroy。了解这些替代方案可以让开发人员为他们的用例选择最合适的方法，确保生命周期管理的灵活性和清晰度。

初始化Bean和DisposableBean

这是 Spring 中用于生命周期回调的两个主要接口。

InitializingBean：实现此接口的 Bean 必须提供一个afterPropertiesSet方法。在设置 bean 的属性后，Spring 容器会执行此方法。

例子：

public  class  SampleBean  Implements  InitializingBean { 
    
    @Override 
    public  void  afterPropertiesSet ()  throws Exception { 
        // 这里初始化逻辑
    } 
}

DisposableBean：实现该接口的Bean必须提供一个destroy方法。当 bean 即将被删除时，Spring 容器会调用此方法。

例子：


public  class  SampleBean  Implements  DisposableBean { 
    
    @Override 
    public  void  destroy ()  throws Exception { 
        // 这里清理逻辑
    } 
}

注意：虽然这些接口是 Spring 特有的，但它们为初始化和销毁提供了更直接的契约。缺点是与 Spring 特定接口的紧密耦合。

使用 @Bean 自定义 init 和 destroy 方法

使用Java配置定义bean时，可以在注释中指定自定义initMethod和destroyMethod属性@Bean。

例子：

@Configuration 
public  class  AppConfig { 

    @Bean(initMethod = "start", destroyMethod = "end") 
    public SampleService SampleService () { 
        return  new  SampleService (); } 
    } 
} 

public  class  SampleService { 

    public  void  start () { 
        // 初始化逻辑
    } 

    public  void  end () { 
        // 清理逻辑
    } 
}

这种方法在配置中提供了关于哪些方法用于初始化和销毁的明确声明，从而在声明性配置和编程控制之间提供了平衡。

XML配置

在广泛采用注释之前，基于 XML 的配置是定义 bean 及其生命周期方法的首选方法。

例子：

<bean  id = "sampleBean"  class = "com.example.SampleBean"  init-method = "initialize"  destroy-method = "cleanup" /> 

<!-- 对应的Bean类 -->
 public class SampleBean { 

    public void initialize( ) { 
        // 初始化逻辑
    } 

    public void cleanup() { 
        // 清理逻辑
    } 
}

虽然 XML 配置由于其冗长而在现代 Spring 开发中有些失宠，但它们仍然是一种健壮且灵活的方法，特别是在需要重新配置而不重新编译的情况下。