Hutool - DB：基于 ActiveRecord 思想的 JDBC 封装数据操作工具

一、简介

在 Java 开发中，与数据库进行交互是常见的需求。传统的 JDBC（Java Database Connectivity）操作虽然提供了与数据库通信的基础功能，但代码繁琐，需要处理大量的资源管理和异常处理，这增加了开发的复杂性和出错的可能性。Hutool - DB 模块是 Hutool 工具包中针对 JDBC 进行封装的数据操作工具，它基于 ActiveRecord 思想，简化了数据库操作，让开发者可以更专注于业务逻辑的实现。

ActiveRecord 是一种软件开发模式，它将数据的表示（如数据库表）和操作（如增删改查）封装在一个对象中，使得数据操作更加直观和便捷。Hutool - DB 通过这种思想，让数据库表与 Java 对象一一对应，实现了对象与数据库记录之间的映射，从而大大提高了开发效率。

二、引入依赖

如果你使用 Maven 项目，在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.16</version>
</dependency>

同时，根据你使用的数据库类型，添加相应的 JDBC 驱动依赖。例如，如果你使用 MySQL 数据库，添加以下依赖：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.26</version>
</dependency>

若使用 Gradle 项目，在 build.gradle 中添加：

implementation 'cn.hutool:hutool-all:5.8.16'
implementation 'mysql:mysql-connector-java:8.0.26' // 如果使用 MySQL

三、配置数据库连接

在 resources 目录下创建 db.setting 文件，用于配置数据库连接信息，示例如下：

[main]
url = jdbc:mysql://localhost:3306/testdb?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
user = root
pass = 123456

这里配置了一个名为 main 的数据库连接，url 是数据库的连接地址，user 是数据库用户名，pass 是数据库密码。

四、创建实体类

假设我们有一个 user 表，包含 id、name 和 age 字段，创建对应的 Java 实体类：

import cn.hutool.db.Entity;

public class User {
    private Long id;
    private String name;
    private Integer age;

    // 构造方法、getter 和 setter 方法
    public User() {
    }

    public User(Long id, String name, Integer age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    // 将 User 对象转换为 Entity 对象
    public Entity toEntity() {
        return Entity.create("user")
               .set("id", id)
               .set("name", name)
               .set("age", age);
    }

    // 从 Entity 对象创建 User 对象
    public static User fromEntity(Entity entity) {
        return new User(
                entity.getLong("id"),
                entity.getStr("name"),
                entity.getInt("age")
        );
    }
}

这里的 Entity 是 Hutool - DB 提供的用于表示数据库记录的类，通过 toEntity 方法可以将 User 对象转换为 Entity 对象，fromEntity 方法可以从 Entity 对象创建 User 对象。

五、基本的数据库操作

1. 查询操作

import cn.hutool.db.Db;
import cn.hutool.db.Entity;
import java.sql.SQLException;
import java.util.List;

public class QueryExample {
    public static void main(String[] args) {
        try {
            // 查询所有用户
            List<Entity> userEntities = Db.use().query("SELECT * FROM user");
            for (Entity entity : userEntities) {
                User user = User.fromEntity(entity);
                System.out.println("ID: " + user.getId() + ", Name: " + user.getName() + ", Age: " + user.getAge());
            }

            // 根据条件查询用户
            List<Entity> youngUsers = Db.use().query("SELECT * FROM user WHERE age < ?", 25);
            for (Entity entity : youngUsers) {
                User user = User.fromEntity(entity);
                System.out.println("Young User - ID: " + user.getId() + ", Name: " + user.getName() + ", Age: " + user.getAge());
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

在上述代码中，Db.use() 方法获取一个数据库操作对象，通过 query 方法执行 SQL 查询语句。对于查询结果，使用 User.fromEntity 方法将 Entity 对象转换为 User 对象进行处理。

2. 插入操作

import cn.hutool.db.Db;
import java.sql.SQLException;

public class InsertExample {
    public static void main(String[] args) {
        User newUser = new User(null, "Alice", 22);
        try {
            // 插入新用户
            Db.use().insert(newUser.toEntity());
            System.out.println("新用户插入成功！");
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

这里创建了一个新的 User 对象，通过 toEntity 方法将其转换为 Entity 对象，然后使用 Db.use().insert 方法将其插入到数据库中。

3. 更新操作

import cn.hutool.db.Db;
import java.sql.SQLException;

public class UpdateExample {
    public static void main(String[] args) {
        try {
            // 根据 ID 更新用户信息
            Db.use().update(
                    Entity.create("user").set("age", 23),
                    Entity.create("user").set("id", 1)
            );
            System.out.println("用户信息更新成功！");
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

Db.use().update 方法接受两个 Entity 对象，第一个表示要更新的字段和值，第二个表示更新的条件。

4. 删除操作

import cn.hutool.db.Db;
import java.sql.SQLException;

public class DeleteExample {
    public static void main(String[] args) {
        try {
            // 根据 ID 删除用户
            Db.use().del(Entity.create("user").set("id", 1));
            System.out.println("用户删除成功！");
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

Db.use().del 方法接受一个 Entity 对象，表示删除的条件。

六、事务处理

import cn.hutool.db.Db;
import cn.hutool.db.Entity;
import java.sql.SQLException;

public class TransactionExample {
    public static void main(String[] args) {
        try {
            Db.use().tx(() -> {
                // 插入新用户
                Db.use().insert(Entity.create("user").set("name", "Bob").set("age", 25));
                // 更新用户信息
                Db.use().update(
                        Entity.create("user").set("age", 26),
                        Entity.create("user").set("name", "Alice")
                );
                // 模拟异常
                if (true) {
                    throw new RuntimeException("模拟事务异常");
                }
            });
        } catch (SQLException e) {
            System.out.println("事务执行失败，已回滚：" + e.getMessage());
        }
    }
}

在上述代码中，Db.use().tx 方法用于开启一个事务，在事务中执行多个数据库操作。如果在事务执行过程中抛出异常，事务会自动回滚。

七、注意事项

• 数据库连接管理：Hutool - DB 会自动管理数据库连接，但在高并发场景下，可能需要配置连接池来提高性能。可以使用 HikariCP、Druid 等连接池，将连接池配置集成到 db.setting 文件中。
• SQL 注入风险：在使用动态 SQL 时，要注意 SQL 注入问题。Hutool - DB 支持使用占位符（如 ?）来避免 SQL 注入，尽量使用这种方式构建 SQL 语句。
• 异常处理：数据库操作可能会抛出 SQLException 等异常，在代码中要进行适当的异常处理，确保程序的健壮性。

通过使用 Hutool - DB，开发者可以更轻松地进行数据库操作，减少样板代码的编写，提高开发效率。无论是小型项目还是大型企业级应用，Hutool - DB 都能提供便捷的数据库操作解决方案。