Apache—DBUtils
简介
commons-dbutils 是 Apache 组织提供的一个开源 JDBC工具类库,它是对JDBC的简单封装,学习成本极低,并且使用dbutils能极大简化jdbc编码的工作量,同时也不会影响程序的性能。
API介绍:
org.apache.commons.dbutils.QueryRunner
org.apache.commons.dbutils.ResultSetHandler
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 commitAndCloseQuietly(Connection conn): //用来提交连接,然后关闭连接,并且在关闭连接时不抛出SQL异常。 public static boolean loadDriver(java.lang.String driverClassName)://这一方装载并注册JDBC驱动程序,如果成功就返回true。 //使用该方法,你不需要捕捉这个异常ClassNotFoundException。
QueryRunner类
该类简单化了SQL查询,它与ResultSetHandler组合在一起使用可以完成大部分的数据库操作,能够大大减少编码量。
QueryRunner类提供了两个构造方法:
默认的构造方法
需要一个 javax.sql.DataSource 来作参数的构造方法。
/** * 测试 QueryRunner 类的 update 方法 * 该方法可用于 INSERT, UPDATE 和 DELETE */ @Test public void testQueryRunnerUpdate() { //1. 创建 QueryRunner 的实现类 QueryRunner queryRunner = new QueryRunner(); String sql = "DELETE FROM customers " + "WHERE id IN (?,?)"; Connection connection = null; try { connection = JDBCTools.getConnection(); //2. 使用其 update 方法 queryRunner.update(connection, sql, 12, 13); } catch (Exception e) { e.printStackTrace(); } finally{ JDBCTools.releaseDB(null, null, connection); } }
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
/** * 测试 QueryRunner 的 query 方法 */ @SuppressWarnings({ "unchecked", "rawtypes" }) @Test public void testResultSetHandler(){ String sql = "SELECT id, name, email, birth " + "FROM customers"; //1. 创建 QueryRunner 对象 QueryRunner queryRunner = new QueryRunner(); Connection conn = null; try { conn = JDBCTools.getConnection(); /** * 2. 调用 query 方法: * ResultSetHandler 参数的作用: query 方法的返回值直接取决于 * ResultSetHandler 的 hanlde(ResultSet rs) 是如何实现的. 实际上, 在 * QueryRunner 类的 query 方法中也是调用了 ResultSetHandler 的 handle() * 方法作为返回值的。 */ Object object = queryRunner.query(conn, sql, new ResultSetHandler(){ @Override public Object handle(ResultSet rs) throws SQLException { List<Customer> customers = new ArrayList<>(); while(rs.next()){ int id = rs.getInt(1); String name = rs.getString(2); String email = rs.getString(3); Date birth = rs.getDate(4); Customer customer = new Customer(id, name, email, birth); customers.add(customer); } return customers; } } ); System.out.println(object); } catch (Exception e) { e.printStackTrace(); } finally{ JDBCTools.releaseDB(null, null, conn); } }
/** * 测试 ResultSetHandler 的 BeanListHandler 实现类 * 当数据库列名和DAO中实体类属性不同时,要用别名使其一致 * BeanListHandler: 把结果集转为一个 Bean 的 List. 该 Bean的类型在创建 BeanListHandler 对象时传入: * new BeanListHandler<>(Customer.class) */ Object object = queryRunner.query(conn, sql, new BeanListHandler<>(Customer.class),4);
/** * 1. ResultSetHandler 的作用: QueryRunner 的 query 方法的返回值最终取决于 * query 方法的 ResultHandler 参数的 hanlde 方法的返回值. * * 2. BeanListHandler: 把结果集转为一个 Bean 的 List, 并返回. Bean 的类型在 * 创建 BeanListHanlder 对象时以 Class 对象的方式传入. 可以适应列的别名来映射 * JavaBean 的属性名: * String sql = "SELECT id, name customerName, email, birth " + * "FROM customers WHERE id = ?"; * * BeanListHandler(Class<T> type) * * 3. BeanHandler: 把结果集转为一个 Bean, 并返回. Bean 的类型在创建 BeanHandler * 对象时以 Class 对象的方式传入 * BeanHandler(Class<T> type) * * 4. MapHandler: 把结果集转为一个 Map 对象, 并返回. 若结果集中有多条记录, 仅返回 * 第一条记录对应的 Map 对象. Map 的键: 列名(而非列的别名), 值: 列的值 * * 5. MapListHandler: 把结果集转为一个 Map 对象的集合, 并返回. * Map 的键: 列名(而非列的别名), 值: 列的值 * * 6. ScalarHandler: 可以返回指定列的一个值或返回一个统计函数的值. */
使用DBUtils 编写通用的DAO接口,及其实现类
DAO.java
/** * 访问数据的 DAO 接口. * 里边定义好访问数据表的各种方法 * @param T: DAO 处理的实体类的类型. */ public interface DAO<T> { /** * 批量处理的方法 * @param connection * @param sql * @param args: 填充占位符的 Object [] 类型的可变参数. * @throws SQLException */ void batch(Connection connection, String sql, Object [] ... args) throws SQLException; /** * 返回具体的一个值, 例如总人数, 平均工资, 某一个人的 email 等. * @param connection * @param sql * @param args * @return * @throws SQLException */ <E> E getForValue(Connection connection, String sql, Object ... args) throws SQLException; /** * 返回 T 的一个集合 * @param connection * @param sql * @param args * @return * @throws SQLException */ List<T> getForList(Connection connection, String sql, Object ... args) throws SQLException; /** * 返回一个 T 的对象 * @param connection * @param sql * @param args * @return * @throws SQLException */ T get(Connection connection, String sql, Object ... args) throws SQLException; /** * INSRET, UPDATE, DELETE * @param connection: 数据库连接 * @param sql: SQL 语句 * @param args: 填充占位符的可变参数. * @throws SQLException */ void update(Connection connection, String sql, Object ... args) throws SQLException; }
JdbcDAOImpl.java
/** * 使用 QueryRunner 提供其具体的实现 * @param <T>: 子类需传入的泛型类型. */ public class JdbcDaoImpl<T> implements DAO<T> { private QueryRunner queryRunner = null; private Class<T> type; public JdbcDaoImpl() { queryRunner = new QueryRunner(); type = ReflectionUtils.getSuperGenericType(getClass()); } @Override public void batch(Connection connection, String sql, Object[]... args) throws SQLException { queryRunner.batch(connection, sql, args); } @Override public <E> E getForValue(Connection connection, String sql, Object... args) throws SQLException { return (E) queryRunner.query(connection, sql, new ScalarHandler(), args); } @Override public List<T> getForList(Connection connection, String sql, Object... args) throws SQLException { return queryRunner.query(connection, sql, new BeanListHandler<>(type), args); } @Override public T get(Connection connection, String sql, Object... args) throws SQLException { return queryRunner.query(connection, sql, new BeanHandler<>(type), args); } @Override public void update(Connection connection, String sql, Object... args) throws SQLException { queryRunner.update(connection, sql, args); } }