commons-dbutils工具介绍及实战

1.commons-dbutils简介

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

API介绍：

•org.apache.commons.dbutils.QueryRunner

•org.apache.commons.dbutils.ResultSetHandler

•工具类

org.apache.commons.dbutils.DbUtils

链接如下：

https://commons.apache.org/proper/commons-dbutils/

2.DbUtils类介绍

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

•public static void close(…) throws java.sql.SQLException：　DbUtils类提供了三个重载的关闭方法。这些方法检查所提供的参数是不是NULL，如果不是的话，它们就关闭Connection、Statement和ResultSet。

•public static void closeQuietly(…): 这一类方法不仅能在Connection、Statement和ResultSet为NULL情况下避免关闭，还能隐藏一些在程序中抛出的SQLException。

•public static void commitAndCloseQuietly(Connection

conn)：

用来提交连接，然后关闭连接，并且在关闭连接时不抛出SQL异常。

•public static boolean loadDriver(java.lang.String driverClassName)：这一方装载并注册JDBC驱动程序，如果成功就返回true。使用该方法，你不需要捕捉这个异常ClassNotFoundException。

3.QueryRunner类 介绍

该类简单化了SQL查询，它与ResultSetHandler组合在一起使用可以完成大部分的数据库操作，能够大大减少编码量。（核心工具类，定义了所有的与数据库操作的方法（查询、更新））

QueryRunner类提供了两个构造方法：

•默认的构造方法

需要一个 javax.sql.DataSource 来作参数的构造方法

QueryRunner类的主要方法

public Object query(Connection conn,String sql,Object[] params, ResultSetHandler rsh)

throws SQLException：执行一个查询操作，在这个查询中，对象数组中的每个元素值被用来作为查询语句的置换参数。该方法会自行处理 PreparedStatement和ResultSet的创建和关闭。

public Object query(String sql,Object[] params, ResultSetHandler rsh) throws SQLException:　几乎与第一种方法一样；唯一的不同在于它不将数据库连接提供给方法，并且它是从提供给构造方法的数据源(DataSource) 或使用的setDataSource 方法中重新获得 Connection。

public Object query(Connection conn,String sql, ResultSetHandler rsh) throws SQLException : 执行一个不需要置换参数的查询操作。

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

public int update(Connection conn, String sql) throws SQLException：用来执行一个不需要置换参数的更新操作。

4.ResultSetHandler接口

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

ResultSetHandler接口提供了一个单独的方法：Object

handle (java.sql.ResultSet .rs)。

ResultSetHandler 接口的实现类

ArrayHandler：把结果集中的第一行数据转成对象数组。

ArrayListHandler：把结果集中的每一行数据都转成一个数组，再存放到List中。

BeanHandler：将结果集中的第一行数据封装到一个对应的JavaBean实例中。

BeanListHandler：将结果集中的每一行数据都封装到一个对应的JavaBean实例中，存放到List里。

ColumnListHandler(列名)：将结果集中某一列的数据存放到List中。

KeyedHandler(name)：将结果集中的每一行数据都封装到一个Map里，再把这些map再存到一个map里，其key为指定的key。

MapHandler：将结果集中的第一行数据封装到一个Map里，key是列名，value就是对应的值。

MapListHandler：将结果集中的每一行数据都封装到一个Map里，然后再存放到List

5.代码示例

1.JdbcUtils

package Utils;

import java.sql.*;

/**

* 1. 返回连接 2. 关闭

*

* @author dan.dan

*

*/

public class JdbcUtils {

// 连接参数

    // private String url = "jdbc:mysql://localhost:3306/jdbc_demo";

    private static Stringurl ="jdbc:mysql://10.9.1.43:3306/dandan_test";

private static Stringuser ="root";

private static Stringpassword ="123456";

/**

    * 返回连接对象

    */

    public static Connection getConnection() {

try {

Class.forName("com.mysql.jdbc.Driver");

return DriverManager.getConnection(url,user,password);

}catch (Exception e) {

throw new RuntimeException(e);

}

}

/**

    * 关闭

    */

    public static void closeAll(Connection con, Statement stmt, ResultSet rs) {

try {

if (rs !=null) {

rs.close();// 快速异常捕获Alt + shift + z

                rs =null;// 建议垃圾回收期回收资源

            }

if (stmt !=null) {

stmt.close();

stmt =null;

}

if (con !=null && !con.isClosed()) {

con.close();

con =null;

}

}catch (SQLException e) {

throw new RuntimeException(e);

}

}

}

package d_dbUtils;

public class Admin {

private int id;

private Stringuserid;

private Stringcn_score;

private Stringmath_score;

private Stringen_score;

private Stringpo_score;

public void setUserid(String userid) {

this.userid = userid;

}

public void setCn_score(String cn_score) {

this.cn_score = cn_score;

}

public void setMath_score(String math_score) {

this.math_score = math_score;

}

public void setEn_score(String en_score) {

this.en_score = en_score;

}

public void setPo_score(String po_score) {

this.po_score = po_score;

}

public String getUserid() {

return userid;

}

public String getCn_score() {

return cn_score;

}

public String getMath_score() {

return math_score;

}

public String getEn_score() {

return en_score;

}

public String getPo_score() {

return po_score;

}

public int getId() {

return id;

}

public void setId(int id) {

this.id = id;

}

@Override

    public String toString() {

return "Admin [id=" +id +", userid=" +userid +", " +

"cn_score=" +cn_score +"," +

"math_score=" +math_score +"," +

"en_score=" +en_score +"," +

"po_score=" +po_score +"]";

}

}

package d_dbUtils;

import Utils.JdbcUtils;

import org.apache.commons.dbutils.QueryRunner;

import org.apache.commons.dbutils.ResultSetHandler;

import org.apache.commons.dbutils.handlers.*;

import org.junit.Test;

import java.sql.Array;

import java.sql.Connection;

import java.sql.ResultSet;

import java.sql.SQLException;

import java.util.Arrays;

import java.util.List;

import java.util.Map;

import java.util.Set;

public class App_query {

private Connectionconn;

// 一、查询， 自定义结果集封装数据

    @Test

    public void testQuery()throws Exception {

String sql ="select * from tb_score1 where id=?";

// 获取连接

        conn = JdbcUtils.getConnection();

// 创建DbUtils核心工具类对象

        QueryRunner qr =new QueryRunner();

// 查询

        Admin admin = qr.query(conn, sql,new ResultSetHandler() {

// 如何封装一个Admin对象

            public Admin handle(ResultSet rs)throws SQLException {

if (rs.next()) {

Admin admin =new Admin();

admin.setId(rs.getInt("id"));

admin.setUserid(rs.getString("userid"));

admin.setCn_score(rs.getString("cn_score"));

return admin;

}

return null;

}

},29);

// 测试

      System.out.println(admin);

// 关闭

      conn.close();

}

// 二、查询， 使用组件提供的结果集对象封装数据

        // 1）BeanHandler: 查询返回单个对象

    @Test

    public void testQueryOne()throws Exception {

String sql ="select * from tb_score1 where id=?";

// 获取连接

        conn = JdbcUtils.getConnection();

// 创建DbUtils核心工具类对象

        QueryRunner qr =new QueryRunner();

// 查询返回单个对象

        Admin admin =  qr.query(conn, sql,new BeanHandler(Admin.class),30);

System.out.println(admin);

conn.close();

}

// 2）BeanListHandler: 查询返回list集合，集合元素是指定的对象

    @Test

    public void testQueryMany()throws Exception {

String sql ="select * from tb_score1";

conn = JdbcUtils.getConnection();

QueryRunner qr =new QueryRunner();

// 查询全部数据

        List list = qr.query(conn, sql,new BeanListHandler(Admin.class));

        conn.close();

}

@Test

// 3) ArrayHandler, 查询返回结果记录的第一行，封装对对象数组, 即返回：Object[]

// 4) ArrayListHandler, 把查询的每一行都封装为对象数组，再添加到list集合中

// 5) ScalarHandler 查询返回结果记录的第一行的第一列  (在聚合函数统计的时候用)

// 6) MapHandler  查询返回结果的第一条记录封装为map

  public void testArray()throws Exception {

String sql ="select * from tb_score1";

conn = JdbcUtils.getConnection();

QueryRunner qr =new QueryRunner();

// 查询

      Object[] obj = qr.query(conn, sql,new ArrayHandler());

System.out.println("数组："+ Arrays.toString(obj));

List list = qr.query(conn, sql,new ArrayListHandler());

for (int i =0; i < list.size(); i++) {

System.out.println("list:"+ Arrays.toString(list.get(i)));

} //查询的结果先是数组，然后将数组添加到list中，所以由list获取的每一条都为数组，然后遍历数组才能获取值

Integer num = qr.query(conn, sql,new ScalarHandler());

System.out.println("第一列：" + num);

Map map = qr.query(conn,sql,new MapHandler());

Set<Map.Entry<String, Object>> entrys = map.entrySet();

// entry代表一个键值对

        for (Map.Entry entry : entrys) {

System.out.println("map " + entry.getKey() +"=" + entry.getValue());

}

conn.close();

}

}

6.小结

使用dbutils简化了jdbc编码的工作量，不再用JDBC编写原子性代码，直接使用QueryRunner获取结果，而且其安全性较高，内部的JDBC一些工作已经做好了实现，用户只需直接使用即可。