JDBC—DBUtils和DAO

DBUtils和DAO

---

一. DBUtils

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

1. DbUtils类

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

主要方法如下：

1.public static void close(…) throws java.sql.SQLException

• DbUtils类提供了三个重载的关闭方法。这些方法检查所提供的参数是不是NULL，如果不是的话，它们就关闭Connection、Statement和ResultSet。

2.public static void closeQuietly(…)

• 这一类方法不仅能在Connection、Statement和ResultSet为NULL情况下避免关闭，还能隐藏一些在程序中抛出的SQLEeception。

3.public static void commitAndClose(Connection conn)throws SQLException

• 用来提交连接的事务，然后关闭连接

4.public static void commitAndCloseQuietly(Connection conn)

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

5.public static void rollback(Connection conn)throws SQLException

• 允许conn为null，因为方法内部做了判断

6.public static void rollbackAndClose(Connection conn)throws SQLException

7.rollbackAndCloseQuietly(Connection)

8.public static boolean loadDriver(java.lang.String driverClassName)

• 这一方装载并注册JDBC驱动程序，如果成功就返回true。使用该方法，你不需要捕捉这个异常ClassNotFoundException。

2.QueryRunner类

该类封装了SQL的执行，是线程安全的：
-（1）可以实现增、删、改、查、批处理、
-（2）考虑了事务处理需要共用Connection。
-（3）该类最主要的就是简单化了SQL查询，它与ResultSetHandler组合在一起使用可以完成大部分的数据库操作，能够大大减少编码量。

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

• QueryRunner()：默认的构造方法
• QueryRunner(DataSource ds)：需要一个 javax.sql.DataSource 来作参数的构造方法

（1）更新

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

…

（2）插入

public <T> T insert(Connection conn,String sql,ResultSetHandler<T> rsh, Object... params) throws SQLException

只支持INSERT语句，其中 rsh

• The handler used to create the result object from the ResultSet of auto-generated keys.
• 返回值: An object generated by the handler.即自动生成的键值
  …

（3）批处理

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

…

（4）使用QueryRunner类实现查询

public Object query(Connection conn, String sql, ResultSetHandler rsh,Object... params) throws SQLException

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

3. ResultSetHandler接口

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

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

Object handle (java.sql.ResultSet  rs)

该方法的返回值将作为QueryRunner类的query()方法的返回值。

该接口有如下实现类可以使用：

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

4.数据表与JavaBean

当使用QueryRunner和ResultSetHandler，将将查询结果集中的记录封装到一个对应的JavaBean实例中时，需要注意数据表的字段数据类型、名称与JavaBean的属性数据类型、名称是否对应。

1）数据类型

• int,double等在Java中需要使用包装类：因为mysql中的所有类型都可能是NULL，而Java只有引用数据类型才有NULL值
• mysql中用char，而在Java中也要用String
• mysql中用Date，Java中可以使用String或Date

2）字段名称与属性名称

• 两者需要个数、顺序与名称一致
• 通过给列取别名的方式，来告知数据库的列名与其对应实体的属性名

案例：

QueryRunner qr = new QueryRunner();
// 1.将记录封装成具体的实例
// 注意：当JavaBean的属性名与字段名不一致时，可以通过指定别名告知属性名
String sql = "select id,title,author,price,sales,stock,img_path imgPath from books where price between ? and ? ";
List<Book> list = qr.query(JDBCTools.getConnection(), sql, new BeanListHandler<Book>(Book.class), 10, 20);
for (Book b : list) {
	System.out.println(b);
}

//2.批处理
Object[][] params = new Object[2][3];
params[0][0] = 1;
params[0][1] = 1;
params[0][2] = 1;

params[1][0] = 1;
params[1][1] = 1;
params[1][2] = 2;

String sql = "update books set sales = sales + ? , stock = stock - ? where id = ?";
qr.batch(JDBCTools.getConnection(), sql, params);

//3.查询单个值
// 获取数据库中图书的总记录数
String sql = "select count(*) from books";
Long count = qr.query(JDBCTools.getConnection(), sql,  new ScalarHandler<Long>());
System.out.println(count);

//Book类
public class Book {
	private Integer id;
	private String title;
	private String author;
	private Double price;
	private Integer sales;
	private Integer stock;
	private String imgPath ="static/img/default.jpg";
	......
}

二.DAO

DAO：Data Access Object，访问数据信息的类和接口，包括了对数据的CRUD（Create、Retrival、Update、Delete），而不包含任何业务相关的信息。

作用：为了实现功能的模块化，更有利于代码的维护和升级。

1. DAO接口

作用：实体类的数据访问接口

public interface UserDAO {
	/**
	 * 根据用户名和密码获取数据库中的记录
	 * @param user
	 * @return User：用户名和密码正确; null：用户名或密码不正确
	 */
	public User getUser(User user);

	/**
	 * 根据用户名获取数据库中的记录
	 * @param user
	 * @return true：用户名已存在; false：用户名可用
	 */
	public boolean checkUserName(User user);

	/**
	 * 将用户保存到数据库
	 * @param user
	 */
	public void saveUser(User user);
}

2.BasicDao类

作用：定义一个用来被继承的对数据库进行基本操作的Dao

方式一：实体类Class通过参数的方式传入

public class BasicDAO {
	//定义一个QueryRunner对象，用于实现具体的数据库操作
	private QueryRunner queryRunner = new QueryRunner();

	/**
	 * 通用的增删改操作
	 * @param sql语句
	 * @param params SQL占位符对应的参数
	 * @return 返回操作影响的记录数
	 */
	public int update(String sql, Object... params) {
		// 获取连接
		Connection connection = JDBCTools.getConnection();
		int count = 0;
		try {
			count = queryRunner.update(connection, sql, params);
		} catch (SQLException e) {
			//将编译时异常转换为运行时异常向上抛
			throw new RuntimeException(e);
		}
		return count;
	}

	/**
	 * 获取一个对象
	 * @param sql
	 * @param params
	 * @return 将查询的记录封装成type Class对应的对象
	 */
	public <T> T getBean(Class<T> type,String sql, Object... params) {
		// 获取连接
		Connection connection = JDBCTools.getConnection();
		T t = null;
		try {
			t = queryRunner.query(connection, sql, new BeanHandler<T>(type), params);
		} catch (SQLException e) {
			//将编译时异常转换为运行时异常向上抛
			throw new RuntimeException(e);
		}
		return t;
	}

	/**
	 * 获取所有对象的集合
	 * @param sql
	 * @param params
	 * @return
	 */
	public <T> List<T> getBeanList(Class<T> type,String sql, Object... params) {
		// 获取连接
		Connection connection = JDBCTools.getConnection();
		List<T> list = null;
		try {
			list = queryRunner.query(connection, sql, new BeanListHandler<T>(type), params);
		} catch (SQLException e) {
			//将编译时异常转换为运行时异常向上抛
			throw new RuntimeException(e);
		} 
		return list;
	}

	/**
	 * 获取一个单一值的方法，专门用来执行像select count(*)... 这样的sql语句
	 * @param sql
	 * @param params
	 * @return
	 */
	public Object getSingleValue(String sql, Object... params) {
		// 获取连接
		Connection connection = JDBCTools.getConnection();
		Object value = null;
		try {
			value = queryRunner.query(connection, sql, new ScalarHandler(), params);
		} catch (SQLException e) {
			//将编译时异常转换为运行时异常向上抛
			throw new RuntimeException(e);
		}
		return value;
	}
	/**
	 * 进行批处理的方法
	 * 关于二维数组Object[][] params
	 * 		二维数组的第一维是sql语句要执行的次数
	 * 		二维数组的第二维就是每条sql语句中要填充的占位符
	 * @param sql
	 * @param params
	 */
	public void batchUpdate(String sql , Object[][] params){
		//获取连接
		Connection connection = JDBCTools.getConnection();
		try {
			queryRunner.batch(connection ,sql, params);
		} catch (SQLException e) {
			//将编译时异常转换为运行时异常向上抛
			throw new RuntimeException(e);
		}
	}
}

方式二：通过泛型使用反射的方式，确定实体类的类型

/**
 * 定义一个用来被继承的对数据库进行基本操作的Dao
 * @author ZhengXuanYi
 */
public abstract class BaseDao<T> {
	private QueryRunner queryRunner = new QueryRunner();
	
	//定义一个变量来接收泛型的类型
	private Class<T> type;
	// 获取T的Class对象，获取泛型的类型，泛型是在被子类继承时才确定
	public BaseDao() {
		//1.获取子类的类型
		Class clazz = this.getClass();
		//2.获取父类的类型
		//1）getGenericSuperclass()用来获取当前类的父类的类型
		//2）ParameterizedType表示的是带泛型的类型
		ParameterizedType parameterizedType = (ParameterizedType) clazz.getGenericSuperclass();
		//getActualTypeArguments获取具体的泛型的类型
		//这个方法会返回一个Type的数组
		Type[] types = parameterizedType.getActualTypeArguments();
		//获取具体的泛型的类型·
		this.type = (Class<T>) types[0];
	}
	
	/**
	 * 通用的增删改操作
	 * 
	 * @param sql
	 * @param params
	 * @return
	 */
	public int update(String sql, Object... params) {
		// 获取连接
		Connection connection = JDBCUtils.getConnection();
		int count = 0;
		try {
			count = queryRunner.update(connection, sql, params);
		} catch (SQLException e) {
			e.printStackTrace();
		} finally {
			JDBCUtils.releaseConnection(connection);
		}
		return count;
	}

	/**
	 * 获取一个对象
	 * 
	 * @param sql
	 * @param params
	 * @return
	 */
	public T getBean(String sql, Object... params) {
		// 获取连接
		Connection connection = JDBCUtils.getConnection();
		T t = null;
		try {
			t = queryRunner.query(connection, sql, new BeanHandler<T>(type),
					params);
		} catch (SQLException e) {
			e.printStackTrace();
		} finally {
			JDBCUtils.releaseConnection(connection);
		}
		return t;
	}

	/**
	 * 获取所有对象
	 * @param sql
	 * @param params
	 * @return
	 */
	public List<T> getBeanList(String sql, Object... params) {
		// 获取连接
		Connection connection = JDBCUtils.getConnection();
		List<T> list = null;
		try {
			list = queryRunner.query(connection, sql, new BeanListHandler<T>(
					type), params);
		} catch (SQLException e) {
			e.printStackTrace();
		} finally {
			JDBCUtils.releaseConnection(connection);
		}
		return list;
	}
}

3.DAO实现类

public class UserDAOImpl extends BasicDAO implements UserDAO{

	@Override
	public User getUser(User user) {
		// 写查询数据库的sql语句
		String sql = "select id , username , password , email from users where username = ? and password = ?";
		// 调用BaseDao中的getBean方法
		User bean = getBean(User.class, sql, user.getUsername(), user.getPassword());
		return bean;
	}

	@Override
	public boolean checkUserName(User user) {
		// 写查询数据库的sql语句
		String sql = "select id , username , password , email from users where username = ?";
		// 调用BaseDao中的getBean方法
		User bean = getBean(User.class, sql, user.getUsername());
		return bean!=null;//不为空，说明已存在，返回true，如果bEan是空的，没找到，bean!=null返回false，说明不存在
	}

	@Override
	public void saveUser(User user) {
		//写添加数据到数据库的sql语句
		String sql = "insert into users(username,password,email) values(?,?,?)";
		//调用BaseDao中通用的增删改的方法
		update(sql, user.getUsername(),user.getPassword(),user.getEmail());
	}
}