Apache-Commons-DbUtils整合Spring框架实现简单的CRUD

jiezi

5 年前

Commons DbUtils 是 Apache 提供的一个对 JDBC 进行简单封装的开源工具类库，能够简化 JDBC 相关的开发。Commons DbUtils 可以非常方便的整合 Spring Framework，比较轻量级，执行 SQL 语句非常方便（特别是查询语句），可以代替 Spring JdbcTemplate、MyBatis 等数据库访问层技术。

DbUtils 通过 QueryRunner 类来执行 SQL，使用起来非常类似于 Spring 框架中的JdbcTemplate。

<bean id="dataSource" class="com.zaxxer.hikari.HikariDataSource" destroy-method="close">
    <property name="driverClassName" value="com.mysql.jdbc.Driver" />
    <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/test_db" />
    <property name="username" value="root" />
    <property name="password" value="xxx" />
</bean>
<bean id="queryRunner" class="org.apache.commons.dbutils.QueryRunner">
    <constructor-arg ref="dataSource" />
</bean>

我这里使用的连接池是 HikariCP，这里可以根据需要换成其他的连接池，例如 DBCP、Druid 等。

由于 DbUtils 本身不支持 Spring 事务，如果想要支持事务，例如 @Transactional 注解，还需要给 DataSource 加一层代理：

<bean id="dataSource" class="org.springframework.jdbc.datasource.TransactionAwareDataSourceProxy">
    <property name="targetDataSource">
        <bean class="com.zaxxer.hikari.HikariDataSource" destroy-method="close">
            <property name="driverClassName" value="com.mysql.jdbc.Driver" />
            <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/test_db" />
            <property name="username" value="root" />
            <property name="password" value="xxx" />
        </bean>
    </property>
</bean>
<bean id="queryRunner" class="org.apache.commons.dbutils.QueryRunner">
    <constructor-arg ref="dataSource" />
</bean>

Java 代码中可以通过 Autowired 引入 QueryRunner：

public class UserDao {

    @Autowired
    private QueryRunner queryRunner;
}

增删改操作，也就是 INSERT、DELETE、UPDATE 语句，都可以通过 QueryRunner 的 execute 方法来直接执行：

queryRunner.execute("delete from user_info");
queryRunner.execute("update user_info set user_name=?,user_age=? where user_id=?", "xxg", 28, 6);

由于 DbUtils 本身也是基于 JDBC 中的 PreparedStatement 来实现的，所以也是支持 SQL 中带有参数的。

ResultSetHandler是 DbUtils 中的一个接口，该接口的实现类可用于将 JDBC 查询语句返回的结果（也就是 ResultSet），转成你想要的数据类型。这个和 Spring JdbcTemplate 查询时用到的RowMapper 接口非常类似。

下面写了一个 ResultSetHandler 实现类，将一条 SQL 的查询结果转为一个 List<User>：

List<User> list = queryRunner.query("select * from user_info limit 100", new ResultSetHandler<List<User>>() {
    @Override
    public List<User> handle(ResultSet rs) throws SQLException {List<User> l = new ArrayList<User>();
        while (rs.next()) {User user = new User();
            user.setUserId(rs.getInt("user_id"));
            user.setUserName(rs.getString("user_name"));
            user.setCreateTime(rs.getTimestamp("create_time"));
            l.add(user);
        }
        return l;
    }
});

由于 ResultSetHandler 接口中只有一个抽象方法，所以如果是 Java 8 版本的话也可以使用 Lambda 表达式来简化代码：

List<User> list = queryRunner.query("select * from user_info limit 100", rs -> {List<User> l = new ArrayList<User>();
    while (rs.next()) {User user = new User();
        user.setUserId(rs.getInt("user_id"));
        user.setUserName(rs.getString("user_name"));
        user.setCreateTime(rs.getTimestamp("create_time"));
        l.add(user);
    }
    return l;
});

DbUtils 提供了一些常用的 ResultSetHandler 实现类，可以简化查询，一般情况下不需要像上面那样自己来实现 ResultSetHandler 接口。

用于返回查询结果第一行第一列数据：

long count = queryRunner.query("select count(*) from user_info", new ScalarHandler<Long>()); // 查询 count
String userName = queryRunner.query("select user_name from user_info where user_id=?", new ScalarHandler<String>(), 1); // 查询 user_id= 1 的用户的用户名

返回查询结果（所有行）第一列的数据 List：

List<String> userNameList = queryRunner.query("select user_name from user_info", new ColumnListHandler<String>()); // 查询所有用户的 user_name

返回查询结果第一行数据（所有列）并组装成 Map，Map 的 key 为列名，value 为值：

Map<String, Object> userInfo = queryRunner.query("select user_id,user_name from user_info where user_id=1", new MapHandler());
long userId = (Long) userInfo.get("user_id");
String userName = (String) userInfo.get("user_name");

和 MapHandler 机制类似，MapListHandler会将 ResultSet 转成一个List<Map<String, Object>>：

List<Map<String, Object>> dataList = queryRunner.query("select user_id,user_name from user_info", new MapListHandler());

返回查询结果第一行数据，将所有列值按顺序组成一个数据：

Object[] data = queryRunner.query("select user_id,user_name from user_info where user_id=1", new ArrayHandler());
long userId = (Long) data[0];
String userName = (String) data[1];

和 ArrayHandler 机制类似，ArrayListHandler会将 ResultSet 转成一个List<Object[]>：

List<Object[]> list = queryRunner.query("select user_id,user_name from user_info", new ArrayListHandler());

将 ResultSet 转为 Map<?, Map<String, Object>>，外层 Map 每个元素对应查询结果的一条数据，key 为数据的主键或者唯一索引，value 也是一个 Map，内容是一行数据的列名和值，和MapHandler 机制类似：

Map<Long, Map<String, Object>> dataMap = queryRunner.query("select user_id,user_name from user_info", new KeyedHandler<Long>("user_id")); // Key 指定为 user_id 列
Map<String, Object> data = dataMap.get(1L); // 获取 user_id= 1 的一条记录
long userId = (Long) data.get("user_id");
String userName = (String) data.get("user_name");

BeanHandler是比较实用的一个类，可以通过反射机制将查询结果第一行数据根据数据库列名映射到 Java 对象上，先定义一个 Java 对象：

public class User {

    private int userId;
    private String userName;
    private int userAge;
    private Date createTime;

    // 省略 getter setter
}

执行查询：

// 查询 user_id= 1 的用户数据并返回 User 对象
User user = queryRunner.query("select user_id as userId,user_name as userName,user_age as userAge,create_time as createTime from user_info where user_id=1", new BeanHandler<User>(User.class));

数据库列名很多人会使用下划线作为单词间分隔符，而 Java 命名规范要求变量名是驼峰命名，这样会导致无法直接映射，所以上面代码中在 SQL 语句上通过 AS 将列名下划线分隔符转成驼峰命名。但是如果字段比较多，或者想使用 select * 查询，上面的这种方法就不好使了。下面提供一种方案，可以将带有下划线分隔符的列名映射到驼峰命名的 Java 对象上：

User user = queryRunner.query("select user_id,user_name,user_age,create_time from user_info where user_id=1",
        new BeanHandler<User>(User.class, new BasicRowProcessor(new GenerousBeanProcessor())));

和 BeanHandler 机制类似，BeanListHandler可以将多条查询结果转为 Java Bean 的 List：

List<User> userList = queryRunner.query("select user_id as userId,user_name as userName,user_age as userAge,create_time as createTime from user_info",
        new BeanListHandler<User>(User.class));

同样也可以将带有下划线分隔符的列名映射到驼峰命名的 Java 对象上：

List<User> userList = queryRunner.query("select user_id,user_name,user_age,create_time from user_info",
        new BeanListHandler<User>(User.class, new BasicRowProcessor(new GenerousBeanProcessor())));

类似于 KeyedHandler 机制，将 ResultSet 转为一个 Map，Map 中每条数据对应查询结果的一条数据，key 为数据的主键或者唯一索引，value 是数据通过反射机制转成的 Java 对象：

Map<Long, User> users = queryRunner.query("select user_id as userId,user_name as userName,user_age as userAge,create_time as createTime from user_info",
        new BeanMapHandler<Long, User>(User.class, "userId")); // 使用 userId 列作为 Map 的 key
User user1 = users.get(1L); // 获取 user_id= 1 的用户

同样也可以将带有下划线分隔符的列名映射到驼峰命名的 Java 对象上：

// Map 的 key 默认使用查询语句中的第一列（即主键 user_id）Map<Long, User> users = queryRunner.query("select user_id,user_name,user_age,create_time from user_info",
        new BeanMapHandler<Long, User>(User.class, new BasicRowProcessor(new GenerousBeanProcessor())));
User user1 = users.get(1L); // 获取 user_id= 1 的用户

Apache-Commons-DbUtils整合Spring框架实现简单的CRUD

配置

增删改

查询

ResultSetHandler

常用 ResultSetHandler 实现类

ScalarHandler

ColumnListHandler

MapHandler

MapListHandler

ArrayHandler

ArrayListHandler

KeyedHandler

BeanHandler

BeanListHandler

BeanMapHandler

关注我