做个通用的JDBC-DAO类，有点像Hibernate的雏形

　　以前用JDBC开发DAO的时候写的一个类，当时还并没有接触Hibernate，只是感觉自己写DAO太麻烦，于是想写个通用的会比较好。但之后不少方法都感觉不是很通用。后来想到用反射机制去实现，于是就有了这个通用的DAO，感觉还不错。

　　后来接触了Hibernate，才发现原来Hibernate的实现也有些类似，不过Hibernate有映射文件。到现在的新版中还支持注解的方式来描述映射文件，而我当年没想到用映射文件，所以用我这个通用Dao的时候有个弊端。就是表的列名要和实体类的属性名要一模一样。而且早期的版本是不支持视图的，后来把视图也考虑进去了，并且改进了列名要和实体类的属性名要一模一样问题，这也是受了Hibernate的影响，当然目前还是不需要映射文件的。

　　这个Dao只是给大家提供一种思路，希望大家能用得上。

package org.newboy.util; import java.lang.reflect.Field; import java.lang.reflect.Method; import java.sql.Connection; import java.sql.DriverManager; import java.sql.PreparedStatement; import java.sql.ResultSet; import java.sql.SQLException; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; /** * 自定义的数据库访问工具 * * @author 夜光寒 * */ public class DataBaseUtil<T> { public final static String DRIVER = "com.microsoft.sqlserver.jdbc.SQLServerDriver"; // 数据库驱动 public final static String URL = "jdbc:sqlserver://localhost:1433;databaseName=y2"; // url public final static String DB_USERNAME = "sa"; // 数据库用户名 public final static String DB_PASSWORD = "111111"; // 数据库密码 private Connection conn = getConnection(); private PreparedStatement pstmt = null; private ResultSet rs = null; /** * 运行SQL查询语句，将查询的结果保存到List中，List的每个元素是一个指定类型的JavaBean， * 要求Bean的属性名与数据库的字段名相同，个数也相同，同时要找的列数为所有的列 如：select * 或是 select id,name * * @param sql SQL查询语句，与查询有关的语句 * @param sqlParam 语句各参数的值，即?是什么代替，这里代表where后面的值，如果为null，则表示没有参数要传进去 * @param beanClassName要加载的JavaBean的名字，不能为null * @return 以List返回的记录集 */ @SuppressWarnings("unchecked") public List<T> readDataToBeans(String sql, Object sqlParam[], Class<T> beanClassName) throws Exception { // 建立ArrayList List<T> keys = new ArrayList<T>(); // bean的方法名字 Method beanAttrMethod[] = beanClassName.getDeclaredMethods(); try { pstmt = conn.prepareStatement(sql); // 检查参数是否正确 if (sqlParam != null) { for (int i = 0; i < sqlParam.length; i++) { // 用一个Object就可以了，基本数据类型也一样。 pstmt.setObject(i + 1, sqlParam[i]); } } rs = pstmt.executeQuery(); while (rs.next()) { // 得到JavaBean的实例 T entity = beanClassName.newInstance(); // 得到所有的表中的列 for (int i = 1; i <= rs.getMetaData().getColumnCount(); i++) { // 得到每一个列名 String colName = rs.getMetaData().getColumnName(i); for (int j = 0; j < beanAttrMethod.length; j++) { // 得到要调用的set方法，每个方法名去比较 String methodName = beanAttrMethod[j].getName(); // 如果是相应的set方法，则调用它，相当于调用setXXX(rs.getXXX); if ("set".concat(colName).equalsIgnoreCase(methodName)) { // 只有一个参数，得到参数的类型名 String argType = beanAttrMethod[j].getParameterTypes()[0] .getSimpleName(); if (argType.equals("int") || argType.equals("Integer")) { beanAttrMethod[j].invoke(entity, rs.getInt(colName)); } else if (argType.equals("long") || argType.equals("Long")) { beanAttrMethod[j].invoke(entity, rs.getLong(colName)); } else if (argType.equals("short") || argType.equals("Short")) { beanAttrMethod[j].invoke(entity, rs.getShort(colName)); } else if (argType.equals("float") || argType.equals("Float")) { beanAttrMethod[j].invoke(entity, rs.getFloat(colName)); } else if (argType.equals("double") || argType.equals("Double")) { beanAttrMethod[j].invoke(entity, rs.getDouble(colName)); } else if (argType.equals("String")) { beanAttrMethod[j].invoke(entity, rs.getString(colName)); } else if (argType.equals("Time")) { beanAttrMethod[j].invoke(entity, rs.getTime(colName)); } else if (argType.equals("boolean") || argType.equals("Boolean")) { beanAttrMethod[j].invoke(entity, rs.getBoolean(colName)); } // boolean型必须是1或0,在db中用bit型 else if (argType.equals("byte") || argType.equals("Byte")) { beanAttrMethod[j].invoke(entity, rs.getByte(colName)); } else if (argType.equals("Date")) { beanAttrMethod[j].invoke(entity, rs.getDate(colName)); } else if (argType.equals("Object")) { beanAttrMethod[j].invoke(entity, rs.getObject(colName)); } else { Class cls = beanAttrMethod[j].getParameterTypes()[0]; beanAttrMethod[j].invoke(entity, cls.cast(rs.getObject(colName))); } // 其它的类型，转了以后再调用 } } } // for循环调用完所有的set方法 // 将本对象加到List中 keys.add(entity); } } catch (SQLException se) { se.printStackTrace(); throw new SQLException("数据库访问时出现异常", se); } finally { closeConnection(conn, pstmt, rs); } return keys; } /** * 将JavaBean中有值的属性写到数据库相应的字段中，要求构建的Bean的属性名与数据库的字段名相同 * JavaBean中的set和get方法要求全是对象，如int应写成Integer * * @param tableName 数据库的表名 * @param beanObject 已经有数据的Bean的对象 * @return 真表示插入成功 */ @SuppressWarnings("unchecked") public int writeBeanToDB(String tableName, Object beanObject) throws SQLException { int count = 0; // 得到它的Bean的类型 if (beanObject == null) { throw new SQLException("第二个Object参数不能为空"); } Class beanClassName = beanObject.getClass(); // 转成相应的类型 beanClassName.cast(beanObject); // 得到所有的属性，判断其是否是对象类型，不是原始类型 Field fieldBean[] = beanClassName.getDeclaredFields(); for (int i = 0; i < fieldBean.length; i++) { // 如果对象类型名的首字母是小写，则表示它是原始的数据类型 if (Character.isLowerCase(fieldBean[i].getType().getSimpleName().charAt(0))) { throw new SQLException(beanObject.getClass().getSimpleName() + "中的属性：" + fieldBean[i].getName() + "为原始数据类型" + fieldBean[i].getType().getSimpleName() + "。调用本方法要求Java Bean的所有属性用对象类型"); } } // bean的方法名字 Method beanAttrMethod[] = beanClassName.getDeclaredMethods(); // 构建查询语句 String sqlStr = "insert into " + tableName; String finalFieldName = ""; String fieldValues = ""; try { for (int i = 0; i < beanAttrMethod.length; i++) { // 只要得到所有的方法 String methodName = beanAttrMethod[i].getName(); // 因为没有原始的boolean类型，所以不用考虑is开头的，只考虑get方法 if (methodName.startsWith("get")) { // 先调用一次要返回是否为null，即这一项没有赋值 Object invokeResult = beanAttrMethod[i].invoke(beanObject); if (invokeResult != null) { String fieldName = methodName.substring(3, methodName.length()); finalFieldName = finalFieldName + "," + fieldName; fieldValues += "?,"; } } } /* * 构建一条insert语句 形如： insert into employee * (Id,Name,Age,Salary,Sex,Jointime,Birthday) values * (?,?,?,?,?,?,?); */ sqlStr = sqlStr + " (" + finalFieldName.substring(1, finalFieldName.length()) + ") values (" + fieldValues.substring(0, fieldValues.length() - 1) + ");"; pstmt = conn.prepareStatement(sqlStr); int index = 1; for (int i = 0; i < beanAttrMethod.length; i++) { // 只要得到所有的get和is开头的方法就可以了，而且顺序与前面的匹配 String methodName = beanAttrMethod[i].getName(); if (methodName.startsWith("get")) { Object invokeResult = beanAttrMethod[i].invoke(beanObject); if (invokeResult != null) { // 设置每个?号的值 pstmt.setObject(index++, beanAttrMethod[i].invoke(beanObject)); } } } count = pstmt.executeUpdate(); } catch (Exception ex) { ex.printStackTrace(); throw new SQLException(ex); } finally { closeConnection(conn, pstmt, null); } return count; } /** * @param tableName 表名 * @param keyName 主键列的名称 * @param keyValue 主键的值，用整数和字符串都可 * @return beanName类型的一个对象，里面包含了一条记录的JavaBean */ public T findById(String tableName, String keyName, String keyValue, Class<T> beanName) { String sql = "select * from " + tableName + " where " + keyName + "=?;"; try { List<T> objlist = (List<T>) readDataToBeans(sql, new String[] { keyValue }, beanName); if (objlist.size() == 1) { return beanName.cast(objlist.get(0)); } } catch (Exception ex) { ex.printStackTrace(); } return null; } /** * @param tableName 表名 * @param keyName 主键列名 * @param keyValue 主键值 * @return 大于0,则删除成功 */ public int deleteByPrimaryKey(String tableName, String keyName, String keyValue) { int count = 0; try { pstmt = conn.prepareStatement("delete from " + tableName + " where " + keyName + "=?;"); pstmt.setString(1, keyValue); count = pstmt.executeUpdate(); } catch (SQLException ex) { ex.printStackTrace(); } finally { closeConnection(conn, pstmt, null); } return count; } /** * @param tableName表名 * @param beanName JavaBean的类名 * @return 包含所有记录的List，List中的每个元素是一个JavaBean对象 */ public List<T> findAllRecords(String tableName, Class<T> beanName) { String sql = "select * from " + tableName; try { return readDataToBeans(sql, null, beanName); } catch (Exception ex) { ex.printStackTrace(); return null; } } /** * 运行SQL查询语句，将查询的结果保存到List中，List的每个元素是一个HashMap， * HashMap中所有的键值与结果集的字段名相同，大小写敏感，个数也相同。记住在外面关闭连接对象 如：select * 或是 select * id,name 不能以?的形式出现 * * @param sql SQL查询语句，与查询有关的语句 * @param sqlParam 语句各参数的值，即?是什么代替，这里代表where后面的值，如果为null，则表示没有参数要传进去 * @return 以ArrayList返回的记录集 */ public List<Map<String, Object>> readDataToBeans(String sql, Object sqlParam[]) throws SQLException { // ^不同为真，所以两个条件不能同时成立。当sql有?，则Object就不能为空 if (sql.contains("?") ^ sqlParam != null) { throw new SQLException("当sql中有?时，sqlParam数组对象不能为空；或当sql中没有?时，sqlParam必须为null"); } // 不为null表示有？号 if (sqlParam != null) { // 检查？的个数是否与数组的参数个数相同 int n = 0; for (int i = 0; i < sql.length(); i++) { if (sql.charAt(i) == '?') { n++; } } if (n != sqlParam.length) { throw new SQLException("?号的个数与sqlParam数组元素的个数要相等!"); } } // 建立ArrayList List<Map<String, Object>> keys = new ArrayList<Map<String, Object>>(); try { pstmt = conn.prepareStatement(sql); if (sqlParam != null) { for (int i = 0; i < sqlParam.length; i++) { // 用一个Object就可以了，基本数据类型也一样。 pstmt.setObject(i + 1, sqlParam[i]); } } rs = pstmt.executeQuery(); // 先得到列名，列名从1开始 String[] colNames = new String[rs.getMetaData().getColumnCount()]; for (int i = 0; i < colNames.length; i++) { colNames[i] = rs.getMetaData().getColumnName(i + 1); } // 查找结果集 while (rs.next()) { HashMap<String, Object> map = new HashMap<String, Object>(); for (int i = 0; i < colNames.length; i++) { // 考虑多表联接查询中两个表中有同名的字段的情况 if (map.get(colNames[i]) != null) { throw new SQLException("结果集中不能出现多个相同的列名：" + colNames[i] + "，请给相同的列名起个别名"); } else { map.put(colNames[i], rs.getObject(colNames[i])); } } // 将本对象加到ArrayList中 keys.add(map); } } catch (SQLException se) { se.printStackTrace(); throw new SQLException("数据库访问时出现异常", se); } finally { closeConnection(conn, pstmt, null); } return keys; } /** * 得到数据库连接 * * @throws ClassNotFoundException * @throws SQLException * @return 数据库连接 */ public static Connection getConnection() { Connection conn = null; try { Class.forName(DRIVER); conn = DriverManager.getConnection(URL, DB_USERNAME, DB_PASSWORD); } catch (SQLException ex) { ex.printStackTrace(); } catch (ClassNotFoundException ce) { ce.printStackTrace(); } return conn; } /** * 关闭连接 * * @param conn 数据库连接 * @param ps PreparedStatement对象 * @param rs 结果集 */ public static void closeConnection(Connection conn, PreparedStatement ps, ResultSet rs) { try { if (rs != null) { rs.close(); rs = null; } if (ps != null) { ps.close(); ps = null; } if (conn != null) { conn.close(); conn = null; } } catch (SQLException se) { se.printStackTrace(); } } /** * 关闭没有结果集的连接 */ public void closeConnection(Connection conn, PreparedStatement ps) { closeConnection(conn, ps, null); } }

 

这是测试类的代码：

package org.newboy.test; import java.sql.SQLException; import java.util.List; import java.util.Map; import org.junit.Before; import org.junit.Test; import org.newboy.entity.Customer; import org.newboy.entity.Employee; import org.newboy.util.DataBaseUtil; @SuppressWarnings(value = "unchecked") public class TestData { DataBaseUtil dbu; @Before public void setUp() throws Exception { dbu = new DataBaseUtil(); } /** * 测试顾客表 */ public void testCustomer() { List<Customer> cutomers = dbu.findAllRecords("customer", Customer.class); for (Customer customer : cutomers) { System.out.println("ID:" + customer.getId()); System.out.println("姓名:" + customer.getName()); System.out.println("年龄:" + customer.getAge()); System.out.println("性别:" + (customer.getSex() ? "男" : "女")); System.out.println("工资:" + customer.getSalary()); System.out.println("==================="); } } /** * 测试员工表 */ public void testEmployee() { List<Employee> employees = dbu.findAllRecords("employee", Employee.class); for (Employee employee : employees) { System.out.println("姓名：" + employee.getEmployeeName()); System.out.println("地址：" + employee.getEmployeeAddress()); System.out.println("电话：" + employee.getEmployeePhone()); System.out.println("工资：" + employee.getEmployeeSalary()); System.out.println("==================="); } } /** * 测试部分属性 * * @throws SQLException */ public void testProperties() throws SQLException { List<Map<String, Object>> cutomers = dbu.readDataToBeans( "select name, salary from customer where salary > ?", new Object[] { 5000d }); for (Map<String, Object> map : cutomers) { System.out.println("姓名：" + map.get("name")); System.out.println("工资：" + map.get("salary")); System.out.println("==================="); } } /** * 测试多表连接查询 * * @throws SQLException */ @Test public void testMultiTable() throws SQLException { //找所有男性，工资大于5000 List<Map<String, Object>> employees = dbu.readDataToBeans( "select e.name,e.sex, e.salary,d.name as dname from tabEmployee e,tabDept d where " + "e.deptId=d.id and e.salary > ? and e.sex=?", new Object[] { 5000d, true }); for (Map<String, Object> emp : employees) { System.out.println("姓名：" + emp.get("name")); System.out.println("性别：" + (((Boolean)emp.get("sex"))?"男":"女")); System.out.println("工资：" + emp.get("salary")); System.out.println("部门：" + emp.get("dname")); System.out.println("==================="); } } /** * 测试按主键查询 */ public void testFindById() { Employee e = (Employee) dbu.findById("employee", "employeeId", "4", Employee.class); System.out.println(e.getEmployeeId()); System.out.println(e.getEmployeeName()); } }

 

中间所用到的实体类：

package org.newboy.entity; import java.io.Serializable; public class Employee implements Serializable { private Integer employeeId; private String employeeName; private String employeeAddress; private Double employeeSalary; private String employeePhone; public Integer getEmployeeId() { return employeeId; } public void setEmployeeId(Integer employeeId) { this.employeeId = employeeId; } public String getEmployeeName() { return employeeName; } public void setEmployeeName(String employeeName) { this.employeeName = employeeName; } public String getEmployeeAddress() { return employeeAddress; } public void setEmployeeAddress(String employeeAddress) { this.employeeAddress = employeeAddress; } public Double getEmployeeSalary() { return employeeSalary; } public void setEmployeeSalary(Double employeeSalary) { this.employeeSalary = employeeSalary; } public String getEmployeePhone() { return employeePhone; } public void setEmployeePhone(String employeePhone) { this.employeePhone = employeePhone; } }

 

至于表的话，大家可以按实体类的属性，建出表的列就可以了。上面只用到了一个实体类，因为是通用的DAO，所以大家可以换成其它的实体类，或是多表连接查询都是可以的。