Lombok 实战教程 - @Cleanup | 如何优雅的自动管理资源，安全地调用你的close()方法。

Lombok 提供的 @Cleanup 注解可以帮助我们自动管理资源，确保在使用完资源后能够安全地调用 close() 方法，避免资源泄露。这个注解通常用于处理需要显式关闭的资源，如文件流、数据库连接等。

@Cleanup的使用

当我们使用 @Cleanup 注解一个资源变量时，Lombok 会在变量使用完之后自动添加一个 try-finally 代码块，以确保资源在使用完后被关闭。

用法示例

下面是一些使用 @Cleanup 的例子，包括处理文件流和数据库连接。

处理文件流

import lombok.Cleanup;
import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;

public class FileReaderExample {
    public static void main(String[] args) {
        try {
            @Cleanup BufferedReader reader = new BufferedReader(new FileReader("example.txt"));
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在这个例子中，@Cleanup 确保 BufferedReader 在使用完后被自动关闭，即使在读取过程中发生异常。

处理数据库连接

import lombok.Cleanup;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;

public class DatabaseExample {
    public static void main(String[] args) {
        String url = "jdbc:mysql://localhost:3306/testdb";
        String username = "root";
        String password = "password";

        try {
            @Cleanup Connection connection = DriverManager.getConnection(url, username, password);
            @Cleanup Statement statement = connection.createStatement();
            @Cleanup ResultSet resultSet = statement.executeQuery("SELECT * FROM users");

            while (resultSet.next()) {
                System.out.println("User: " + resultSet.getString("username"));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

在这个例子中，@Cleanup 确保 Connection、Statement 和 ResultSet 在使用完后被自动关闭。

安装和配置 Lombok

1. 添加 Lombok 依赖：在你的项目中添加 Lombok 依赖（例如使用 Maven 或 Gradle）。

   Maven：

   <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
       <version>1.18.20</version>
       <scope>provided</scope>
   </dependency>
   

   Gradle：

   dependencies {
       compileOnly 'org.projectlombok:lombok:1.18.20'
       annotationProcessor 'org.projectlombok:lombok:1.18.20'
   }
   

2. 在 IDE 中启用 Lombok 支持：

   • IntelliJ IDEA：安装 Lombok 插件，并在设置中启用注解处理。
   • Eclipse：安装 Lombok 插件，并在设置中启用注解处理。

结合实际案例

假设我们有一个简单的文件处理应用，需要读取文件内容并处理数据。

传统 Java 代码：

import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;

public class TraditionalFileReader {
    public static void main(String[] args) {
        BufferedReader reader = null;
        try {
            reader = new BufferedReader(new FileReader("example.txt"));
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (reader != null) {
                try {
                    reader.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

使用 Lombok 的代码：

import lombok.Cleanup;
import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;

public class LombokFileReader {
    public static void main(String[] args) {
        try {
            @Cleanup BufferedReader reader = new BufferedReader(new FileReader("example.txt"));
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在这个例子中，使用 Lombok 的 @Cleanup 注解能够有效减少样板代码，自动管理资源，确保在使用完资源后能够正确关闭，避免资源泄露问题。

通过使用 @Cleanup，我们可以简化代码，并且不必担心忘记关闭资源，这对于编写健壮和高效的 Java 应用程序非常有帮助。