【Java.ThirdParty】Apache Commons —— DbUtils —— JDBC轻量级封装

DBUtils是个小巧的JDBC轻量级封装的工具包，其最核心的特性是结果集的封装，可以直接将查询出来的结果集封装成JavaBean，这就为我们做了最枯燥乏味、最容易出错的一大部分工作。

在使用DBUtils之前，应该注意一些问题：

• DBUtils是JDBC的简单封装，可以和JDBC混合使用。

• DBUtils对结果集自动封装为JavaBean是有着苛刻要求的：必须满足JavaBean的规范，其次Bean的getter与setter方法的名字与结果集的列名一一对应，而不要求JavaBean的私有成员与表结果集列名一一对应。

• • 比如：person表中有个字段叫：address，那么对应的JavaBean的Person类中必须有getAddress和setAddress两个方法，而Person类中可以将address属性命名为add，这是没问题的。

• DBUtils可以将结果集封装为各种类型，主要有：Bean/List<Bean>，Map/List<Map>/Map<Map>，数组/List<数组>，列/List<列>，这些类型。

• • 对于Map<Map>的类型使用KeyedHandler作为结果集处理器，内层的Map是“列名-值"对，外层的Map是“主键-内层Map的引用”，但此处的主键不一定就是数据库的主键，可以随意指定，比如：

<span style="font-size:10px;">ResultSetHandler h = new KeyedHandler("id"); 
Map found = (Map) queryRunner.query("select id, name, age from person", h); 
Map jane = (Map) found.get(new Long(1)); // jane's id is 1 
String janesName = (String) jane.get("name"); 
Integer janesAge = (Integer) jane.get("age");</span>

• DBUtils执行插入操作的时候，无法返回自增主键，这是一个很严重的问题，当然不能怪DBUtils，可以通过变通的方法来实现，比如在MySQL中，执行完了一个插入SQL后，接着执行SELECT LAST_INSERT_ID()语句，就可以获取到自增主键。

• DBUtils的性能和JDBC性能是一样，测试过程中没发现性能损失，拥有了很高性能的同时，而不失JDBC的灵活性。

• 对于JavaBean的成员类型定义，有一条原则那就是：尽可能使用包装类型，而不要使用基本类型。例如：

<span style="font-size:10px;">//错误
int a1 = (Integer) null;
boolean x1 = (Boolean)null;
//正确
Integer a2 = (Integer) null;
Boolean x2 = (Boolean)null;</span>

• • 实际上就是为了保证在查询结果为null的时候，也不会因为给基本类型赋null值而发生错误。

DBUtils包/类摘要

DBUtils共3个package:

• org.apache.commons.dbutils
  • ResultSetHandler - 将结果集转换成别的对象的工具
  • RowProcessor - 将结果集行转换成别的对象的工具
  • DbUtils - JDBC辅助工具
  • ProxyFactory - 产生JDBC接口的代理实现
  • QueryLoader - 属性文件加载器，主要用于加载属性文件中的 SQL 到内存中
  • QueryRunner - 使用可插拔的策略执行SQL查询并处理结果集
  • ResultSetIterator - 包装结果集为一个迭代器

• org.apache.commons.dbutils.handles
  • ResultSetHandler接口的实现类
  • AbstractListHandler - 将ResultSet转为List的抽象类
  • ArrayHandler - 将ResultSet转为一个Object[]的ResultSetHandler实现类
  • ArrayListHandler - 将ResultSet转换为List<Object[]>的ResultSetHandler实现类
  • BeanHandler - 将ResultSet行转换为一个JavaBean的ResultSetHandler实现类
  • BeanListHandler - 将ResultSet转换为List<JavaBean>的ResultSetHandler实现类
  • ColumnListHandler - 将ResultSet的一个列转换为List<Object>的ResultSetHandler实现类
  • KeyedHandler - 将ResultSet转换为Map<Map>的ResultSetHandler实现类
  • MapHandler - 将ResultSet的首行转换为一个Map的ResultSetHandler实现类
  • MapListHandler - 将ResultSet转换为List<Map>的ResultSetHandler实现类
  • ScalarHandler - 将ResultSet的一个列到一个对象。

使用DBUtils

只是使用的话，只看两个类（DbUtils和QueryRunner）和一个接口（ResultSetHandler）就可以了。

• DbUtils

DbUtils是一个为做一些诸如关闭连接、装载JDBC驱动程序之类的常规工作提供有用方法的类，它里面所有的方法都是静态的。
这个类里的重要方法有：

• • close() - DbUtils类提供了三个重载的关闭方法。这些方法检查所提供的参数是不是NULL，如果不是的话，它们就关闭连接、声明和结果集（ResultSet）。

• • CloseQuietly - 这一方法不仅能在连接、声明或者结果集（ResultSet）为NULL情况下避免关闭，还能隐藏一些在程序中抛出的SQLEeception。如果你不想捕捉这些异常的话，这对你是非常有用的。在重载CloseQuietly方法时，特别有用的一个方法是closeQuietly(Connection conn,Statement stmt,ResultSet rs)，这是因为在大多数情况下，连接、声明和结果集（ResultSet）是你要用的三样东西，而且在最后的块你必须关闭它们。使用这一方法，你最后的块就可以只需要调用这一方法即可。

• • CommitAndCloseQuietly(Connection conn) - 这一方法用来提交连接，然后关闭连接，并且在关闭连接时不向上抛出在关闭时发生的一些SQL异常。

• • LoadDriver(String driveClassName) - 这一方法装载并注册JDBC驱动程序，如果成功就返回TRUE使用这种方法，你不需要去捕捉这个异常ClassNotFoundException。使用loadDrive方法，编码就变得更容易理解，你也就得到了一个很好的Boolean返回值，这个返回值会告诉你驱动类是不是已经加载成功了。

• ResultSetHandler

这一接口执行处理一个jaca.sql.ResultSet，将数据转变并处理为任何一种形式，这样有益于其应用而且使用起来更容易。

这一组件提供了ArrayHandler, ArrayListHandler, BeanHandler, BeanListHandler, MapHandler, MapListHandler, and ScalarHandler等执行程序。

ResultSetHandler接口提供了一个单独的方法：Object handle (java.sql.ResultSet .rs)。因此任何ResultSetHandler 的执行需要一个结果集（ResultSet）作为参数传入，然后才能处理这个结果集，再返回一个对象。

因为返回类型是java.lang.Object，所以除了不能返回一个原始的Java类型之外，其它的返回类型并没有什么限制。

如果你发现这七个执行程序中没有任何一个提供了你想要的服务，你可以自己写执行程序并使用它。

• QueryRunner

这个类使执行SQL查询简单化了，它与ResultSetHandler串联在一起有效地履行着一些平常的任务，它能够大大减少你所要写的编码。

QueryRunner类提供了两个构造器：其中一个是一个空构造器，另一个则拿一个 javax.sql.DataSource 来作为参数。在你不用为一个方法提供一个数据库连接来作为参数的情况下，提供给构造器的数据源(DataSource) 被用来获得一个新的连接并将继续进行下去。

这一类中的重要方法包括以下这些：

• • query(Connection conn, String sql, Object[] params, ResultSetHandler rsh) - 这一方法执行一个选择查询，在这个查询中，对象数组参数被用来作为查询的置换参数。这一方法内在地处理PreparedStatement 和ResultSet 的创建和关闭。ResultSetHandler对把从 ResultSet得来的数据转变成一个更容易的或是应用程序特定的格式来使用。
  • query(String sql, Object[] params, ResultSetHandler rsh) - 这几乎与第一种方法一样；唯一的不同在于它不将数据库连接提供给方法，并且它是从提供给构造器的数据源(DataSource) 或使用的setDAtaSource 方法中重新获得的。
  • query(Connection conn, String sql, ResultSetHandler rsh) - 这执行一个不要参数的选择查询。
  • update(Connection conn, String sql, Object[] params) - 这一方法被用来执行一个插入、更新或删除操作。对象数组参数为声明保存着置换参数。

使用步骤

• 加载JDBC驱动程序类，并用DriverManager来得到一个数据库连接conn。

• 实例化 QueryRunner,得到实例化对象qRunner。

• qRunner.update()方法，执行增改删的sql命令，qRunner.query()方法，得到结果集。

使用实例

连接类ConnectDb:import java.sql.DriverManager;

<span style="font-size:10px;">import java.sql.SQLException;  
import java.sql.Connection;   
  
public class ConnectDb {  
    private static String driveClassName = "com.mysql.jdbc.Driver";  
    private static String url = "jdbc:mysql://192.168.1.161:3306/test?useUnicode=true&characterEncoding=utf8";   
      
    private static String user = "root";  
    private static String password = "e-playnow";  
      
    public static Connection Connect(){  
        Connection conn = null;  
          
        //load driver  
        try {  
            Class.forName(driveClassName);  
        } catch (ClassNotFoundException  e) {  
            System.out.println("load driver failed!");  
            e.printStackTrace();  
        }  
          
        //connect db  
        try {  
            conn = DriverManager.getConnection(url, user, password);  
        } catch (SQLException e) {  
            System.out.println("connect failed!");  
            e.printStackTrace();  
        }         
          
        return conn;  
    }  
}  </span>

数据库表：

<span style="font-size:10px;">CREATE TABLE `user` (  
  `id` int(11) NOT NULL auto_increment,  
  `name` varchar(50) NOT NULL,  
  `age` tinyint(10) NOT NULL,  
  PRIMARY KEY  (`id`)  
) ENGINE=MyISAM AUTO_INCREMENT=4 DEFAULT CHARSET=utf8  </span>

Bean:

<span style="font-size:10px;">package Beans;  
  
public class UserBean {  
    private int id;   
    private String name;   
    private int age;  
      
    public int getId() {  
        return id;  
    }  
    public void setId(int id) {  
        this.id = id;  
    }  
    public String getName() {  
        return name;  
    }  
    public void setName(String name) {  
        this.name = name;  
    }  
    public int getAge() {  
        return age;  
    }  
    public void setAge(int age) {  
        this.age = age;  
    }  
}  </span>

Demo:

<span style="font-size:10px;">import java.sql.Connection;  
import java.sql.SQLException;  
import java.util.List;  
import org.apache.commons.dbutils.DbUtils;  
import org.apache.commons.dbutils.QueryRunner;  
import org.apache.commons.dbutils.handlers.BeanListHandler;  
import Beans.UserBean;  
  
public class main {  
  
    public static void main(String[] args) throws SQLException {  
        insert_test();  
        del_test();  
    }  
      
    static void insert_test() throws SQLException{  
        Connection conn = ConnectDb.Connect();  
          
        //创建SQL执行工具   
        QueryRunner qRunner = new QueryRunner();   
          
        //执行SQL插入   
        int n = qRunner.update(conn, "insert into user(name,age) values('xxx',22)");   
        System.out.println("成功插入" + n + "条数据！");   
          
        //关闭数据库连接   
        DbUtils.closeQuietly(conn);       
    }   
      
    static void select_test() throws SQLException{  
        Connection conn = ConnectDb.Connect();  
          
        //创建SQL执行工具   
        QueryRunner qRunner = new QueryRunner();   
          
        @SuppressWarnings("unchecked")  
        List<UserBean> list = (List<UserBean>) qRunner.query(conn, "select id,name,age from user", new BeanListHandler(UserBean.class));   
        //输出查询结果   
        for (UserBean user : list) {   
                System.out.println(user.getAge());   
        }   
          
        //关闭数据库连接   
        DbUtils.closeQuietly(conn);   
    }   
  
    static void update_test() throws SQLException{  
        Connection conn = ConnectDb.Connect();  
          
        //创建SQL执行工具   
        QueryRunner qRunner = new QueryRunner();   
        //执行SQL插入   
        int n = qRunner.update(conn, "update user set name = 'xxx',age=28");   
        System.out.println("成功更新" + n + "条数据！");   
          
        //关闭数据库连接   
        DbUtils.closeQuietly(conn);   
    }   
      
    static void del_test() throws SQLException{  
        Connection conn = ConnectDb.Connect();  
          
        //创建SQL执行工具   
        QueryRunner qRunner = new QueryRunner();   
        //执行SQL插入   
        int n = qRunner.update(conn, "DELETE from user WHERE name='xxx';");   
        System.out.println("删除成功" + n + "条数据！");   
          
        //关闭数据库连接   
        DbUtils.closeQuietly(conn);   
    }   
}  </span>