Java Spring 中常用的 @PostConstruct 注解使用总结

🕗 发布于 2024-10-20 00:56 java spring 开发语言

在这里插入图片描述

引言

在最近的学习中，我发现了一个非常实用的注解 —— @PostConstruct。通过深入学习，逐步发现这个注解在实际开发中可以帮助我们更轻松地解决不少原本复杂的问题，特别是在项目启动时自动执行一些必要的初始化操作。相比于手动调用，它更加简洁和方便。

接下来，我将结合实例，详细讲解 @PostConstruct 注解的特性和用法。由于 @PreDestroy 在实际开发中用得较少，所以本文主要聚焦于 @PostConstruct 的应用。

正文

1. 适用场景

@PostConstruct 是在 Java 5 中引入的注解，最早用于 Servlet 生命周期的管理，能够在 Bean 初始化之后执行自定义操作。在实际项目中，@PostConstruct 主要用于在应用启动时加载一些初始化数据，比如缓存预热、数据字典加载或读取配置文件等。

它的一个常见应用场景是依赖注入完成后，需要执行的初始化方法。被 @PostConstruct 注解标记的方法会在 Servlet 初始化之前运行，并且在整个应用生命周期中只会被调用一次。

总结一下 @PostConstruct 的主要特性：

只有一个非静态方法能使用此注解。
被注解的方法不能有任何参数。
被注解的方法必须返回 void 类型。
被注解的方法不得抛出已检查异常。
此方法只会被执行一次。

2. 执行顺序

在 Bean 初始化过程中，@PostConstruct 的执行顺序如下：

构造方法：通过 @Constructor 完成 Bean 实例化。
依赖注入：通过 @Autowired 注入 Bean 所需的依赖。
初始化方法：在依赖注入完成后，Spring 自动调用 @PostConstruct 标记的方法，执行初始化逻辑。

举个例子，在项目启动时如果需要初始化某些资源，我们可以将 @Component 和 @PostConstruct 组合使用，保证在依赖注入完成后执行自定义的初始化操作。

3. 注意事项

使用 @PostConstruct 注解时需要注意以下几点：

服务启动时间：因为 @PostConstruct 会在服务启动时扫描所有类和依赖库中的 jar 包，过多或复杂的初始化操作可能影响应用启动时间。
执行一次性操作：@PostConstruct 标记的方法只会在 Bean 初始化完成后被执行一次，因此适合执行一些一次性的初始化任务。
不能使用静态方法：被 @PostConstruct 注解标记的方法不能是静态方法。
加载顺序：对于静态变量和常量，@PostConstruct 可以帮助避免某些场景下由于变量尚未初始化而出现的 null 问题，具体见后文案例。

4. 案例分析

接下来我们通过两个简单的实例来演示 @PostConstruct 的使用。

4.1 数据预热

在某些场景下，我们可能需要在项目启动时完成缓存的预热操作，比如将常用的数据从数据库中加载到内存中。通常情况下，如果使用 Redis 进行缓存，需要在第一次调用时触发缓存。但通过 @PostConstruct，我们可以提前在项目启动时完成数据预热。

@Slf4j
@Configuration
public class BeanConfiguration {
 
    @Autowired
    private BusinessService businessService;
 
    // 模拟预热的数据
    private static String mysql_data;
 
    @PostConstruct
    public void construct() {
        log.info("依赖注入完成，开始预热数据...");
        mysql_data = businessService.demo5();
        log.info("数据预热完成：mysql_data = " + mysql_data);
    }
}

@Slf4j
@Service
public class BusinessServiceImpl implements BusinessService {
 
    /**
     * 模拟从数据库查询数据的操作
     */
    public String demo5() {
        log.info("从数据库加载数据...");
        return "mysql data";
    }
}

执行效果：在项目启动时，mysql_data 会被从数据库中加载并完成预热。

4.2 加载配置文件

在很多项目中，我们会使用 @Value 注解从配置文件中读取常量。但 @Value 注解的常量不能是静态的，因为静态字段会在 @Value 加载之前初始化，导致其值为 null。通过 @PostConstruct，我们可以在 Bean 初始化之后手动为静态字段赋值，避免这个问题。

@Slf4j
@Component
public class GlobalConstent {
 
    @Value("${server.port}")
    private String port;
    
    // 模拟静态常量
    public static String server_port;
    
    @PostConstruct
    public void construct() {
        log.info("Before PostConstruct：" + server_port);
        server_port = port;
        log.info("After PostConstruct：" + server_port);
    }
}

在使用过程中，静态常量 server_port 可以通过类名直接访问：

@Slf4j
@RestController
@RequestMapping("/construct")
public class PostConstructController {
 
    @RequestMapping("/demo")
    public String demo() {
        log.info("当前服务端口：" + GlobalConstent.server_port);
        return "success";
    }
}

结果展示：在项目启动之前，server_port 会通过 @PostConstruct 完成赋值操作。

5. 总结

通过本文，晓得嘞 @PostConstruct 注解的适用场景、执行顺序和使用中的注意事项。我们通过两个实际案例展示了如何利用 @PostConstruct 进行数据预热和配置文件加载。

@PostConstruct 在项目中非常有用，特别是在需要依赖注入完成后自动执行某些初始化任务的场景。它不仅简化了代码逻辑，还提高了项目的启动效率。如果你在项目中需要进行初始化操作，不妨试试这个注解。

要点：

@PostConstruct 只会在 Bean 初始化后执行一次，适合执行一次性初始化任务。
它的执行顺序是在构造方法和依赖注入之后。
使用时要注意静态变量的赋值顺序问题。

希望本文对你理解 @PostConstruct 注解有所帮助，下面一起Demo搞起来吧。