1、Apache-DBUtils简介

commons-dbutils 是 Apache 组织提供的一个开源 JDBC工具类库，它是对JDBC的简单封装，学习成本极低，并且使用dbutils能极大简化jdbc编码的工作量，同时也不会影响程序的性能。

2、测试环境准备

2.1、maven工程添加依赖

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.8</version>
</dependency>
<dependency>
    <groupId>commons-dbutils</groupId>
    <artifactId>commons-dbutils</artifactId>
    <version>1.7</version>
</dependency>

2.2、新建获取数据库连接工具类

以下测试代码均使用Druid作为数据库连接池获取数据库连接，使用配置文件的方式获取，对应JdbcUtils.java代码如下：

import com.alibaba.druid.pool.DruidDataSourceFactory;

import javax.sql.DataSource;
import java.io.InputStream;
import java.sql.Connection;
import java.util.Properties;

/**
 * Jdbc工具类
 */
public class JdbcUtils {
    private static DataSource source = null;

    static {
        try {
            Properties pros = new Properties();
            // 加载配置文件
            InputStream is = DruidTest.class.getClassLoader().getResourceAsStream("druid.properties");
            pros.load(is);
            // 根据提供的DruidDataSourceFactory创建对应的DataSource对象
            source = DruidDataSourceFactory.createDataSource(pros);
        } catch (Exception e) {
            e.printStackTrace();
        }

    }

    /**
     * 使用Druid数据库连接池的配置文件方式，获取数据库的连接：推荐
     */
    public static Connection getConnection() throws Exception {
        return source.getConnection();
    }
}

【druid.properties】内容如下：

driverClassName=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://192.168.175.128:3306/test?rewriteBatchedStatements=true
username=root
password=root

initialSize=10
maxActive=20
maxWait=1000
filters=wall

2.3、创建数据库表

CREATE TABLE `user_info` (
  `id` int NOT NULL AUTO_INCREMENT,
  `name` varchar(255) COLLATE utf8_bin DEFAULT NULL,
  `balance` int DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb3 COLLATE=utf8_bin;

3、主要API介绍

3.1、DbUtils类

• DbUtils：提供如关闭连接、装载JDBC驱动程序等常规工作的工具类，里面的所有方法都是静态的。主要方法如下：

public static void close(…) throws java.sql.SQLException：DbUtils类提供了三个重载的关闭方法。这些方法检查所提供的参数是不是NULL，如果不是的话，它们就关闭Connection、Statement和ResultSet。
public static void closeQuietly(…): 这一类方法不仅能在Connection、Statement和ResultSet为NULL情况下避免关闭，还能隐藏一些在程序中抛出的SQLEeception。
public static void commitAndClose(Connection conn)throws SQLException： 用来提交连接的事务，然后关闭连接
public static void commitAndCloseQuietly(Connection conn)： 用来提交连接，然后关闭连接，并且在关闭连接时不抛出SQL异常。 
public static void rollback(Connection conn)throws SQLException：允许conn为null，因为方法内部做了判断
public static void rollbackAndClose(Connection conn)throws SQLException 
public static void rollbackAndCloseQuietly(Connection)
public static boolean loadDriver(java.lang.String driverClassName)：这一方装载并注册JDBC驱动程序，如果成功就返回true。使用该方法，你不需要捕捉这个异常ClassNotFoundException。

3.2、QueryRunner类

• 该类简单化了SQL查询，它与ResultSetHandler组合在一起使用可以完成大部分的数据库操作，能够大大减少编码量。
• QueryRunner类提供了两个构造器：
  • 默认的构造器
  • 需要一个 javax.sql.DataSource 来作参数的构造器
• QueryRunner类的主要方法：

更新：
public int update(Connection conn, String sql, Object... params) throws SQLException:用来执行一个更新（插入、更新或删除）操作。

插入：
public <T> T insert(Connection conn,String sql,ResultSetHandler<T> rsh, Object... params) throws SQLException：只支持INSERT语句，其中 rsh 为自动生成的键值。

批处理：
public int[] batch(Connection conn,String sql,Object[][] params)throws SQLException： INSERT, UPDATE, or DELETE语句
public <T> T insertBatch(Connection conn,String sql,ResultSetHandler<T> rsh,Object[][] params)throws SQLException：只支持INSERT语句

查询：
public Object query(Connection conn, String sql, ResultSetHandler rsh,Object... params) throws SQLException：执行一个查询操作，在这个查询中，对象数组中的每个元素值被用来作为查询语句的置换参数。该方法会自行处理 PreparedStatement 和 ResultSet 的创建和关闭。

• 测试代码如下

/**
 * 测试添加
 */
@Test
public void testInsert() throws Exception {
    QueryRunner runner = new QueryRunner();
    Connection conn = JdbcUtils.getConnection();
    String sql = "insert into user_info(name, balance) values (?, ?)";
    ResultSetHandler<Integer> rsh = resultSet -> {
        if (resultSet.next()) {
            return resultSet.getInt(1);
        }
        return 0;
    };
    int id = runner.insert(conn, sql, rsh, "张三", 20000);
    System.out.println("添加了的数据id值为：" + id);
    DbUtils.close(conn);
}

/**
 * 测试更新
 */
@Test
public void testUpdate() throws Exception {
    QueryRunner runner = new QueryRunner();
    Connection conn = JdbcUtils.getConnection();
    String sql = "update user_info set balance = balance + ? where id < ?";
    int count = runner.update(conn, sql, 500, 3);
    System.out.println("更新了" + count + "条记录");
    DbUtils.close(conn);
}

/**
 * 测试删除
 */
@Test
public void testDelete() throws Exception {
    QueryRunner runner = new QueryRunner();
    Connection conn = JdbcUtils.getConnection();
    String sql = "delete from user_info where id > ?";
    int count = runner.update(conn, sql, 3);
    System.out.println("删除了" + count + "条记录");
    DbUtils.close(conn);
}

3.3、ResultSetHandler接口及实现类

• 该接口用于处理 java.sql.ResultSet，将数据按要求转换为另一种形式。

• ResultSetHandler 接口提供了一个单独的方法：Object handle (java.sql.ResultSet .rs)。

• 接口的主要实现类：

  • ArrayHandler：把结果集中的第一行数据转成对象数组。
  • ArrayListHandler：把结果集中的每一行数据都转成一个数组，再存放到List中。
  • BeanHandler：将结果集中的第一行数据封装到一个对应的JavaBean实例中。
  • BeanListHandler：将结果集中的每一行数据都封装到一个对应的JavaBean实例中，存放到List里。
  • ColumnListHandler：将结果集中某一列的数据存放到List中。
  • KeyedHandler(name)：将结果集中的每一行数据都封装到一个Map里，再把这些map再存到一个map里，其key为指定的key。
  • MapHandler：将结果集中的第一行数据封装到一个Map里，key是列名，value就是对应的值。
  • MapListHandler：将结果集中的每一行数据都封装到一个Map里，然后再存放到List
  • ScalarHandler：查询单个值对象

• 测试代码如下

UserInfo.java实体类代码：

public class UserInfo {
    private String name;
    private Integer balance;

    public String getName() {
        return name;
    }

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

    public Integer getBalance() {
        return balance;
    }

    public void setBalance(Integer balance) {
        this.balance = balance;
    }

    @Override
    public String toString() {
        return "UserInfo{name='" + name + '\'' + ", balance=" + balance + '}';
    }
}

测试代码：

/**
 * 测试查询：查询一条记录，使用ResultSetHandler的实现类：BeanHandler
 */
@Test
public void testQueryInstance() throws Exception {
    QueryRunner runner = new QueryRunner();
    Connection conn = JdbcUtils.getConnection();
    String sql = "select name, balance from user_info where name = ?";
    BeanHandler<UserInfo> handler = new BeanHandler<>(UserInfo.class);
    UserInfo userInfo = runner.query(conn, sql, handler, "AA");
    System.out.println(userInfo);
    DbUtils.close(conn);
}

/**
 * 测试查询：查询多条记录构成的集合：使用ResultSetHandler的实现类：BeanListHandler
 */
@Test
public void testQueryList() throws Exception {
    QueryRunner runner = new QueryRunner();
    Connection conn = JdbcUtils.getConnection();
    String sql = "select name, balance from user_info where balance <= ?";
    BeanListHandler<UserInfo> handler = new BeanListHandler<>(UserInfo.class);
    List<UserInfo> list = runner.query(conn, sql, handler, 5000);
    list.forEach(System.out::println);
    DbUtils.close(conn);
}