Spring从零开始学使用系列（四）之@PostConstruct和@PreDestroy注解的使用

如果各位老爷觉得可以，请点赞收藏评论，谢谢啦！！

文章中涉及到的图片均由AI生成

公众号在最下方！！！

1. 介绍

1.1 @PostConstruct概述

1.2 @PreDestroy概述

2. 基本用法

2.1 注册CommonAnnotationBeanPostProcessor

2.2 使用@PostConstruct注解的方法

2.3 使用@PreDestroy注解的方法

3. 使用场景

3.1 资源管理

3.2 缓存管理

3.3 初始化复杂对象

4. 注意事项

4.1 线程安全

4.2 异常处理

4.3 使用限制

4.4 调用初始化模板和方法

4.5 初始化顺序和Bean的生命周期

5. 结论

1. 介绍

在Spring框架中，@PostConstruct和@PreDestroy注解是用于管理Bean生命周期的重要工具。这些注解提供了一种简洁的方式，在Bean的初始化和销毁阶段执行特定的逻辑，从而增强了应用程序的灵活性和可维护性。

1.1 @PostConstruct概述

@PostConstruct注解用于在Bean初始化完成后立即执行特定的方法。这通常用于在依赖注入完成后进行一些初始化操作，例如分配资源或预填充缓存。

1.2 @PreDestroy概述

@PreDestroy注解用于在Bean销毁之前执行特定的方法。这通常用于在Bean被销毁之前进行一些清理操作，例如释放资源或清空缓存。

这些注解是在JSR-250规范中定义的，最初是作为Java标准库的一部分引入的。从JDK 9开始，这些注解被移除并移至Jakarta EE中。如果需要使用这些注解，需要在项目中引入jakarta.annotation-api依赖。

2. 基本用法

2.1 注册CommonAnnotationBeanPostProcessor

要使用@PostConstruct和@PreDestroy注解，首先需要在Spring配置中注册CommonAnnotationBeanPostProcessor（老版本是不需要的，因为jdk8自带@PostConstruct注解），这样Spring才能识别并处理这些注解：

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

@Configuration
public class AppConfig {
    
    @Bean
    public CommonAnnotationBeanPostProcessor commonAnnotationBeanPostProcessor() {
        return new CommonAnnotationBeanPostProcessor();
    }
}

2.2 使用@PostConstruct注解的方法

@PostConstruct注解用于在Bean初始化完成后执行特定的方法。以下是一个示例，展示如何在Bean初始化完成后填充缓存：

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

@Component
public class CachingMovieLister {

    @PostConstruct
    public void populateMovieCache() {
        // 在初始化时填充电影缓存...
        System.out.println("Movie cache populated upon initialization");
    }
}

2.3 使用@PreDestroy注解的方法

@PreDestroy注解用于在Bean销毁之前执行特定的方法。以下是一个示例，展示如何在Bean销毁之前清空缓存：

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

@Component
public class CachingMovieLister {

    @PreDestroy
    public void clearMovieCache() {
        // 在销毁时清空电影缓存...
        System.out.println("Movie cache cleared upon destruction");
    }
}

3. 使用场景

3.1 资源管理

在许多应用程序中，Bean在初始化时可能需要分配一些资源（如数据库连接、文件句柄等），并在销毁时释放这些资源。@PostConstruct和@PreDestroy注解可以帮助我们在这些关键点上执行必要的操作，防止资源泄漏。

3.2 缓存管理

在某些应用程序中，可能需要在Bean初始化时预填充缓存，并在销毁时清空缓存，以确保数据一致性和内存有效利用。

3.3 初始化复杂对象

有时Bean依赖于其他资源进行初始化，@PostConstruct可以确保在所有依赖注入完成后执行初始化逻辑。

import jakarta.annotation.PostConstruct;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class ComplexInitializer {

    @Autowired
    private SomeDependency dependency;

    private ComplexObject complexObject;

    @PostConstruct
    public void init() {
        complexObject = new ComplexObject(dependency);
        System.out.println("ComplexObject initialized with dependency");
    }

    public ComplexObject getComplexObject() {
        return complexObject;
    }
}

4. 注意事项

4.1 线程安全

在使用@PostConstruct和@PreDestroy注解的方法中，确保线程安全是非常重要的。由于Spring容器可能会在多个线程中并发地管理Bean的生命周期，方法中的代码应避免共享可变状态，或者使用同步机制保护共享资源。

4.2 异常处理

在这些方法中处理异常是非常关键的。如果在@PostConstruct方法中抛出异常，Spring容器可能会终止Bean的初始化过程。如果在@PreDestroy方法中抛出异常，可能会导致资源泄漏。建议在这些方法中捕获并记录异常，确保应用程序的稳定性。

@PostConstruct
public void initialize() {
    try {
        // 初始化逻辑
    } catch (Exception e) {
        // 处理异常
        e.printStackTrace();
    }
}

@PreDestroy
public void cleanup() {
    try {
        // 清理逻辑
    } catch (Exception e) {
        // 处理异常
        e.printStackTrace();
    }
}

4.3 使用限制

@PostConstruct和@PreDestroy注解的方法不能是final或static的，因为Spring需要通过代理机制来管理Bean的生命周期，final或static方法无法被代理。此外，这些方法不能有参数，并且必须是无返回值的void方法。

4.4 调用初始化模板和方法

在某些复杂的场景中，可能需要在多个Bean中复用相同的初始化或清理逻辑。可以通过定义一个模板方法，并在具体Bean中调用该模板方法来实现代码复用。

public abstract class AbstractInitializer {

    @PostConstruct
    public void postConstruct() {
        init();
    }

    @PreDestroy
    public void preDestroy() {
        destroy();
    }

    protected abstract void init();
    protected abstract void destroy();
}

@Component
public class ConcreteInitializer extends AbstractInitializer {

    @Override
    protected void init() {
        // 具体的初始化逻辑
        System.out.println("ConcreteInitializer initialized");
    }

    @Override
    protected void destroy() {
        // 具体的清理逻辑
        System.out.println("ConcreteInitializer destroyed");
    }
}

通过这种方式，可以在多个Bean中共享相同的初始化和清理逻辑，减少代码重复，提高代码的可维护性。

4.5 初始化顺序和Bean的生命周期

在Spring中，Bean的初始化顺序可能会导致在使用@PostConstruct注解时调用其他Bean出现问题。具体来说，如果一个Bean在其@PostConstruct方法中依赖于另一个尚未初始化的Bean，就会导致初始化失败。为了避免这种情况，应该确保依赖的Bean在当前Bean之前初始化。

@Service
public class MyService {

    @Autowired
    private AnotherService anotherService;

    @PostConstruct
    public void init() {
        anotherService.performAction();
    }
}

@Service
public class AnotherService {

    public void performAction() {
        System.out.println("Action performed");
    }
}

在上面的示例中，如果AnotherService尚未初始化而MyService已经在其@PostConstruct方法中调用了anotherService的方法，则会导致错误。

解决方法：

确保Bean的初始化顺序：可以通过在Spring配置文件中明确指定Bean的依赖关系，确保依赖的Bean在当前Bean之前初始化。
使用@DependsOn注解：可以使用@DependsOn注解明确指定Bean的初始化顺序
在Bean的生命周期中处理依赖：了解Bean的生命周期，并在正确的生命周期阶段处理Bean的依赖关系。Spring的Bean生命周期包括实例化、属性注入、初始化和销毁等阶段。@PostConstruct方法在属性注入之后、初始化之前调用，因此应确保在此阶段所有依赖的Bean都已准备好。