DbUtils应用指南

小鱼儿 2022-09-18 04:51 150阅读 0赞

DbUtils是一个小型的类库，它设计用于使JDBC编程更加方便、简单。JDBC编程中，资源的关闭是显式的，极易导致编程错误，DbUtils把这些清理工作抽象出来，使得程序员编程时仅需要关心真正需要关心的，即：query和update数据。

DbUtils的一些优点：  
1.杜绝资源泄漏。修正JDBC代码并不困难，但是这是耗时而乏味的，这通常导致连接泄露并且难以跟踪到；  
2.清洁干净的持久化代码。大段的持久化数据到数据库代码彻底精简，剩下的代码清晰地表达了编码的意图。  
3.从ResultSet里自动组装JavaBean。你不再需要手工set每一行每一列的值到bean中，每一行数据都将会以一个Bean实例的形式出现。

DbUtils设计用于：  
1.Small - 你应该在短时间内理解所有的包的用途；  
2.Transparent - DbUtils在幕后并不做任何复杂的看似奇妙的工作，仅仅是你给一个查询，他去执行并且清理资源；  
3.Fast - 你并不需要n多个临时对象给DbUtils。

DbUtils并不是：  
1.一个对象/关系的桥梁 - 现在已经有很多优秀的O/R工具，DbUtils只是给决定用纯JDBC的开发场景使用的；  
2.数据访问对象（DAO）框架 - 虽然DbUtils能被用在DAO框架之中；  
3.一个面向对象的抽象的数据库对象，比如表、列或是主键；  
4.任何一种轻量级的框架 - DbUtils的目标仅是让程序员直接而方便的使用JDBC的帮助类库。

依赖：DbUtils以一个独立的Jar包形式发布，仅仅依赖不低于1.5版本的Java。

DbUtils核心其实只有三个类/接口，即QueryRunner 、ResultSetHandler 和DbUtils （官方文档中写的是前两个）

一．下面先过一下DbUtils的几个包（package）：  
1.org.apache.commons.dbutils 提供核心类/接口，提供最常用最通用的功能。  
2.org.apache.commons.dbutils.handlers　提供对ResultSet 的各种形式的包装，所有类都实现了ResultSetHandler ，因此也可以看做是ResultSetHandler 的延伸。其功能比如把ResultSet 中每一行变成一个JavaBean或一个数组等。  
3.org.apache.commons.dbutils.wrappers 提供对ResultSet 中的值的包装过滤，所有类都实现了java.lang.reflect.InvocationHandler 。其功能比如将ResultSet 中所有String 值进行trim() 操作，或是把所有null值赋一个有意义的新值。

二．下面是对DbUtils各类的使用进行介绍：  
1.org.apache.commons.dbutils.DbUtils  
DbUtils类是一个工具类，里面所有方法都是静态的，因此无需实例化即可调用，通过API介绍即可了解其功能：  
    \* close ：关闭Connection 、Statement 或ResultSet ，忽略null；  
    \* closeQuietly ：安静的关闭Connection 、Statement 或ResultSet ，它会尽力去关闭，忽略null和SQLException ；  
    \* commitAndClose ：提交并关闭Connection ，忽略null；  
    \* commitAndCloseQuietly ：提交并关闭Connection ，忽略null和SQLException ；  
    \* loadDriver ：和Class.forName().newInstance() 功能一样，但它能捕获异常，并返回true 或false ；  
    \* printStackTrace ：打印SQLException 的详细错误信息；  
    \* printWarnings ：打印Connection 的警告信息；  
    \* rollback ：回滚操作，忽略null；  
    \* rollbackAndClose ：回滚操作并关闭，忽略null；  
    \* rollbackAndCloseQuietly ：回滚操作并关闭，忽略null、SQLException 。  
2.org.apache.commons.dbutils.QueryRunner  
    \* batch ：执行成批的INSERT、UPDATE、DELETE操作；  
    \* fillStatement ：用Object\[\] 或JavaBean的值填充PreparedStatement 中的占位符；  
    \* query ：执行查询操作（Statement 或PreparedStatement 均可），并用ResultSetHandler 来处理ResultSet ；  
    \* update ：执行INSERT或UPDATE操作（Statement 或PreparedStatement 均可）。  
3.org.apache.commons.dbutils.ResultSetHandler　所有在DbUtils里提供的的ResultSetHandler 实现都是线程安全的  
    \* ArrayHandler ：把ResultSet 第一行包装成Object\[\] ；  
    \* ArrayListHandler ：把ResultSet包装成List<Object\[\]> ；  
    \* BeanHandler ：把ResultSet 第一行包装成一个JavaBean；  
    \* BeanListHandler ：把ResultSet 第一行包装成一个List<JavaBean> ；  
    \* ColumnListHandler ：抽取ResultSet 指定的列，以List<Object> 对象的形式返回，默认第一列；  
    \* KeyedHandler ：包装ResultSet ，以Map<Object,Map<String,Object>> 对象形式返回，第一个Object 是指定的列值，第二个Map 中String 是列名；  
    \* MapHandler ：把ResultSet 第一行包装成Map<String, Object> ；  
    \* MapListHandler ：把ResultSet包装成List<Map<String,Object>> ；  
    \* ScalarHandler ：抽取ResultSet 第一行指定列，以Object 对象形式返回。  
4.org.apache.commons.dbutils.wrappers.SqlNullCheckedResultSet 对ResultSet 中的null值进行处理。  
5.org.apache.commons.dbutils.wrappers.StringTrimmedResultSet 对ResultSet 中的String 进行trim() 处理。

下面我们来看一个例子：

public class QueryRunnerExample { public static void main(String[] args) { QueryRunnerExample example = new QueryRunnerExample(); try { example.batch(); example.query(); example.fill(); example.update(); example.close(); } catch (SQLException e) { DbUtils.printStackTrace(e); } } private BasicDataSource dataSource; private QueryRunner runner; public QueryRunnerExample() { dataSource = new BasicDataSource(); dataSource.setUrl("jdbc:mysql://127.0.0.1:3306/test"); dataSource.setUsername("root"); dataSource.setPassword("root"); // oracle数据库不支持preparedStatement.getParameterMetaData()方法 // 传递pmdKnownBroken参数true runner = new QueryRunner(dataSource, true); } public void batch() throws SQLException { Object[][] params = new Object[][] { { "user1", "pwd1" }, { "user2", "pwd2" } }; int[] result = runner.batch("insert into user (username, password) values (?, ?)", params); p("batch插入，返回相应结果数组" + Arrays.toString(result)); } public void fill() throws SQLException { PreparedStatement ps = dataSource.getConnection().prepareStatement( "insert into user (username, password) values (?, ?)"); runner.fillStatementWithBean(ps, new User("user0", "pwd0"), "userName", "password"); p("fillStatementWithBean方法，把Bean中的值，填充到ps中，名字必须与数据库字段名完全一样 " + "执行结果:" + ps.executeUpdate()); } public void query() throws SQLException { String sql = "select * from user where username like ?"; Object[] r1 = runner.query(dataSource.getConnection(), sql, new ArrayHandler(), "user%"); p("ArrayHandler，把ResultSet第一行包装为Object[] " + Arrays.toString(r1)); List<Object[]> r2 = runner.query(sql, new ArrayListHandler(), "user%"); p("ArrayListHandler，把rs包装为List<Object[]>" + Arrays.deepToString(r2.toArray())); User r3 = runner.query(sql, new BeanHandler<User>(User.class), "user%"); p("BeanHandler，把rs第一行包装为Bean" + r3); List<User> r4 = runner.query(sql, new BeanListHandler<User>(User.class), "user%"); p("BeanListHandler，把rs包装为List<bean>" + r4); Map<String, Object> r5 = runner.query(sql, new MapHandler(), "user%"); p("MapHandler，把rs第一行包装为Map<列名, 值>" + r5); List<Map<String, Object>> r6 = runner.query(sql, new MapListHandler(), "user%"); p("MapListHandler，把rs包装为List<Map<列名, 值>>" + r6); Object r7 = runner.query(sql, new ScalarHandler(2), "user%"); p("ScalarHandler，取得rs第一行，指定列的值，默认是第一列" + r7); List<Object> r8 = runner.query(sql, new ColumnListHandler(), "user%"); p("ScalarHandler，取得rs指定列的值，默认是第一列" + r8); Map<Object, Map<String, Object>> r9 = runner.query(sql, new KeyedHandler(2), "user%"); p("KeyedHandler，把rs包装为Map<某列值, Map<列名, 值>>" + r9); } public void update() throws SQLException { String updateSQL = "update user set username = 'aaa' where username = 'user1'"; int r1 = runner.update(updateSQL); String deleteSQL = "delete from user"; int r2 = runner.update(deleteSQL); p("update方法，返回执行sql后，相应结果条数 update了" + r1 + "条记录 " + "delete了" + r2 + "条记录"); } public void close() throws SQLException { dataSource.close(); } private void p(Object o) { System.out.println(o + "\n"); } } package dbutils; public class User { private String userName; private String password; public String getUserName() { return userName; } public void setUserName(String userName) { this.userName = userName; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public User(String userName, String password) { this.userName = userName; this.password = password; } public User() { } }