学习 `@PreDestroy`：Java EE/Jakarta EE 生命周期回调

学习 `@PreDestroy`：Java EE/Jakarta EE 生命周期回调

• 前言
• • [1. 什么是 `@PreDestroy`？](#1. 什么是 @PreDestroy？)
  • [2. `@PreDestroy` 的用途](#2. @PreDestroy 的用途)
  • [3. 使用 `@PreDestroy` 的条件](#3. 使用 @PreDestroy 的条件)
  • [4. 代码示例](#4. 代码示例)
  • • 运行结果：
  • [5. `@PreDestroy` 的调用时机](#5. @PreDestroy 的调用时机)
  • [6. 注意事项](#6. 注意事项)
  • [7. 实际应用场景](#7. 实际应用场景)
  • • [场景 1：数据库连接管理](#场景 1：数据库连接管理)
    • [场景 2：文件资源释放](#场景 2：文件资源释放)
  • [8. 总结](#8. 总结)

---

前言

在 Java EE（Enterprise Edition）和 Jakarta EE 中，@PreDestroy 是一个非常重要的注解，用于管理对象的生命周期。它允许开发者在对象被容器销毁之前执行一些清理操作，比如释放资源、关闭连接等。本文将详细介绍 @PreDestroy 的用法、适用场景以及注意事项，并通过示例帮助大家更好地理解。

---

1. 什么是 @PreDestroy？

@PreDestroy 是 Java EE/Jakarta EE 提供的一个注解，用于标记一个方法，该方法会在对象被容器销毁之前自动调用。它是对象生命周期回调的一部分，通常与 @PostConstruct 配合使用。

• @PostConstruct：在对象创建并依赖注入完成后调用。
• @PreDestroy：在对象被销毁之前调用。

---

2. @PreDestroy 的用途

@PreDestroy 主要用于执行一些清理工作，例如：

• 关闭数据库连接。
• 释放文件或网络资源。
• 清理缓存或临时数据。
• 注销监听器或回调。

这些操作可以确保资源被正确释放，避免内存泄漏或其他资源浪费问题。

---

3. 使用 @PreDestroy 的条件

要正确使用 @PreDestroy，需要满足以下条件：

1. 方法签名 ：
   • 方法必须没有参数。
   • 方法必须返回 void。
   • 方法不能抛出受检异常（checked exceptions）。
2. 托管对象 ：
   • @PreDestroy 只能用于由容器管理的对象，比如 EJB、CDI Bean、Servlet 等。
   • 如果对象是原型作用域（prototype scope），@PreDestroy 不会被调用。

---

4. 代码示例

以下是一个简单的示例，展示了如何在 CDI Bean 中使用 @PreDestroy。

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.enterprise.context.ApplicationScoped;

@ApplicationScoped
public class ResourceManager {

    // 模拟资源初始化
    @PostConstruct
    public void init() {
        System.out.println("资源初始化完成...");
    }

    // 业务方法
    public void doWork() {
        System.out.println("正在执行任务...");
    }

    // 清理资源
    @PreDestroy
    public void cleanup() {
        System.out.println("正在清理资源...");
        // 这里可以关闭数据库连接、释放文件资源等
    }
}

运行结果：

1. 当容器启动并创建 ResourceManager 实例时，init() 方法会被调用，输出："资源初始化完成..."。
2. 当调用 doWork() 方法时，输出："正在执行任务..."。
3. 当容器关闭或 Bean 被销毁时，cleanup() 方法会被调用，输出："正在清理资源..."。

---

5. @PreDestroy 的调用时机

@PreDestroy 方法会在以下情况下被调用：

• 应用程序关闭时 ：当应用服务器或容器关闭时，所有托管对象的 @PreDestroy 方法都会被调用。
• 作用域结束时 ：对于具有特定作用域的 Bean（如 @RequestScoped、@SessionScoped），当作用域结束时，@PreDestroy 方法会被调用。
• 容器决定销毁对象时 ：当容器不再需要某个对象时（例如，对象超出作用域或容器资源不足），@PreDestroy 方法会被调用。

---

6. 注意事项

1. 原型作用域的 Bean：

   • 如果 Bean 是原型作用域（prototype scope），@PreDestroy 不会被调用，因为容器不管理原型 Bean 的生命周期。

2. 异常处理：

   • @PreDestroy 方法不能抛出受检异常，否则可能会导致容器无法正常销毁对象。

3. 与 Spring 的兼容性：

   • 在 Spring 框架中，@PreDestroy 的功能与 Java EE/Jakarta EE 中的一致。Spring 还提供了其他方式来实现类似功能，比如实现 DisposableBean 接口或在 XML 配置中指定 destroy-method。

---

7. 实际应用场景

场景 1：数据库连接管理

在数据库操作类中，可以使用 @PreDestroy 来确保数据库连接被正确关闭。

@ApplicationScoped
public class DatabaseService {

    private Connection connection;

    @PostConstruct
    public void init() {
        // 初始化数据库连接
        connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/mydb", "user", "password");
    }

    @PreDestroy
    public void close() {
        if (connection != null) {
            try {
                connection.close();
                System.out.println("数据库连接已关闭。");
            } catch (SQLException e) {
                e.printStackTrace();
            }
        }
    }
}

场景 2：文件资源释放

在文件操作类中，可以使用 @PreDestroy 来确保文件流被关闭。

@ApplicationScoped
public class FileService {

    private FileInputStream fileInputStream;

    @PostConstruct
    public void init() {
        try {
            fileInputStream = new FileInputStream("data.txt");
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        }
    }

    @PreDestroy
    public void cleanup() {
        if (fileInputStream != null) {
            try {
                fileInputStream.close();
                System.out.println("文件流已关闭。");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

---

8. 总结

@PreDestroy 是 Java EE/Jakarta EE 中非常重要的生命周期回调注解，用于在对象销毁之前执行清理操作。通过合理使用 @PreDestroy，可以确保资源被正确释放，避免内存泄漏和资源浪费。在实际开发中，@PreDestroy 通常与 @PostConstruct 配合使用，分别用于初始化和清理工作。

希望本文能帮助你更好地理解和使用 @PreDestroy！如果有任何问题，欢迎留言讨论！