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

栏目: Java · 发布时间: 6年前

内容简介：Commons DbUtils是Apache提供的一个对JDBC进行简单封装的开源工具类库，能够简化JDBC相关的开发。Commons DbUtils可以非常方便的整合Spring Framework，比较轻量级，执行SQL语句非常方便（特别是查询语句），可以代替Spring JdbcTemplate、MyBatis等数据库访问层技术。DbUtils通过我这里使用的连接池是HikariCP，这里可以根据需要换成其他的连接池，例如DBCP、Druid等。

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等。

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

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

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

：

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;
});

常用ResultSetHandler实现类

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

ScalarHandler

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

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的用户的用户名

ColumnListHandler

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

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

MapHandler

返回查询结果第一行数据（所有列）并组装成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");

MapListHandler

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

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

ArrayHandler

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

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];

ArrayListHandler

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

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

KeyedHandler

将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

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())));

BeanListHandler

和 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())));

BeanMapHandler

类似于 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的用户

以上就是本文的全部内容，希望本文的内容对大家的学习或者工作能带来一定的帮助，也希望大家多多支持 码农网

查看所有标签

猜你喜欢:

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。

码农书籍
软利器

软利器

保罗·莱文森 / 何道宽 / 复旦大学出版社 / 2011-5 / 35.00元

《软利器:信息革命的自然历史与未来》内容简介：何谓“软利器”？一种轻盈、透明、无质无形、难以把握的力量，由信息和物理载体构成，这就是媒介。了解媒介的属性和演化规律的人，常占尽优势：反之则身处险境。是不是有些危言耸听？ 如果你看过保罗•莱文森的这本《软利器：信息革命的自然历史与未来》，或许就会深信不疑。在书中，莱文森如同一位经验丰富的航海家，带领你穿越媒介时空——你将邂逅古埃及的法老、古希腊的......一起来看看 《软利器》 这本书的介绍吧!

码农工具
随机密码生成器
随机密码生成器

多种字符组合密码

SHA 加密
SHA 加密

SHA 加密工具

HEX CMYK 转换工具
HEX CMYK 转换工具

HEX CMYK 互转工具

  • New
  • 文章
  • 话题
  • 教程
    • 关注 码农网 公众号
    版权所有，保留一切权利！© 2018-2024 码农网 粤ICP备17054400号-3