关于细粒度泛型DAO封装的一些思考

关于细粒度泛型DAO封装的一些思考

 

 

此文首发于老紫竹的Java世纪网，原文地址：http://www.java2000.net/p17630

 

还是把自己花了时间写的文章复制一份到自己的博客保存，以下为原文内容：

 

1、泛型查询动作接口（非完整版本，如分页功能都未加入）

package com.china.codingmouse.cmsdk4j.dao.genericsdao.action; import java.util.List; import com.china.codingmouse.cmsdk4j.dao.genericsdao.condition.SQLBaseCondition; /** * 泛型查询动作接口 * IGenericsFindAction * @author CodingMouse * @version 1.0 2009-6-17 * @param <T> 类型参数 */ public interface IGenericsFindAction<T> { /** * 根据模型ID获取该类型的单个模型 * @param clz 注册返回类型 * @param modelId 模型ID（请预先在 pojo.csm.xml 配置档中设定 ID 列名） * @return 该类型的单个模型 * @throws Exception 获取异常 */ T get(Class<?> clz, Integer modelId) throws Exception; /** * 根据查询条件获取该类型的单个模型 * @param clz 注册返回类型 * @param param SQL参数列表（可变参数） * @return 该类型的单个模型 * @throws Exception 获取异常 */ T get(Class<?> clz, SQLBaseCondition... param) throws Exception; /** * 根据条件模型获取匹配的单个模型 * @param conditionModel 条件模型（不需要作为查询条件的成员变量请保持为 null 值，它将自动被过滤掉） * @return 匹配的单个模型 * @throws Exception 获取异常 */ T get(T conditionModel) throws Exception; /** * 获取该类型的全部模型有序集合 * @param clz 注册返回类型 * @param param SQL参数列表（可变参数） * @return 该类型的全部模型有序集合 * @throws Exception 获取异常 */ List<T> find(Class<?> clz, SQLBaseCondition... param) throws Exception; /** * 根据条件模型获取匹配的全部模型有序集合 * @param conditionModel 条件模型（不需要作为查询条件的成员变量请保持为 null 值，它将自动被过滤掉） * @return 匹配的全部模型有序集合 * @throws Exception 获取异常 */ List<T> find(T conditionModel) throws Exception; }

 

 

2、泛型查询动作实现类

 

package com.china.codingmouse.cmsdk4j.dao.genericsdao.action; import java.util.List; import com.china.codingmouse.cmsdk4j.config.POJOConfigurationReader; import com.china.codingmouse.cmsdk4j.dao.genericsdao.GenericsBaseDAO; import com.china.codingmouse.cmsdk4j.dao.genericsdao.condition.SQLBaseCondition; import com.china.codingmouse.cmsdk4j.generator.sql.SQLGenerator; /** * 泛型查询动作实现类 * GenericsFindAction * @author CodingMouse * @version 1.0 2009-6-21 * @param <T> 类型参数 */ public class GenericsFindAction<T> extends GenericsBaseDAO<T> implements IGenericsFindAction<T> { /** * 根据模型ID获取该类型的单个模型 * @param clz 注册返回类型 * @param modelId 模型ID（请预先在 pojo.csm.xml 配置档中设定 ID 列名） * @return 该类型的单个模型 * @throws Exception 获取异常 */ public T get(Class<?> clz, Integer modelId) throws Exception { return this.get( clz, SQLBaseCondition.build( POJOConfigurationReader.getInstance().getPojoClassTable().get(clz.getName()).getId().getColumn(), modelId) ); } /** * 根据查询条件获取该类型的单个模型 * @param clz 注册返回类型 * @param param SQL参数列表（可变参数） * @return 该类型的单个模型 * @throws Exception 获取异常 */ public T get(Class<?> clz, SQLBaseCondition... param) throws Exception { return this.executeScalar( clz, SQLGenerator.getInstance().buildSQLForSelect(clz, param), param); } /** * 根据条件模型获取匹配的单个模型 * @param conditionModel 条件模型（不需要作为查询条件的成员变量请保持为 null 值，它将自动被过滤掉） * @return 匹配的单个模型 * @throws Exception 获取异常 */ public T get(T conditionModel) throws Exception { return this.get( conditionModel.getClass(), ActionConverter.converterModel2Condition(conditionModel)); } /** * 获取该类型的全部模型有序集合 * @param clz 注册返回类型 * @param param SQL参数列表（可变参数） * @return 该类型的全部模型有序集合 * @throws Exception 获取异常 */ public List<T> find(Class<?> clz, SQLBaseCondition... param) throws Exception { return this.executeQuery( clz, SQLGenerator.getInstance().buildSQLForSelect(clz, param), param); } /** * 根据条件模型获取匹配的全部模型有序集合 * @param conditionModel 条件模型（不需要作为查询条件的成员变量请保持为 null 值，它将自动被过滤掉） * @return 匹配的全部模型有序集合 * @throws Exception 获取异常 */ public List<T> find(T conditionModel) throws Exception { return this.find( conditionModel.getClass(), ActionConverter.converterModel2Condition(conditionModel)); } }

 

3、泛型数据访问接口（非完整版本，仅以查询和保存动作为例），用于实现所有CRUD动作集的组装

 

package com.china.codingmouse.cmsdk4j.dao.genericsdao; import com.china.codingmouse.cmsdk4j.dao.genericsdao.action.IGenericsFindAction; import com.china.codingmouse.cmsdk4j.dao.genericsdao.action.IGenericsSaveAction; /** * 泛型数据访问接口 * IGenericsDAO * @author CodingMouse * @version 1.0 2009-6-8 * @param <T> 类型参数 */ public interface IGenericsDAO<T> extends IGenericsFindAction<T>, IGenericsSaveAction<T> { }

 

4、泛型数据访问实现类

 

package com.china.codingmouse.cmsdk4j.dao.genericsdao; import java.util.List; import com.china.codingmouse.cmsdk4j.dao.genericsdao.action.GenericsFindAction; import com.china.codingmouse.cmsdk4j.dao.genericsdao.action.GenericsSaveAction; import com.china.codingmouse.cmsdk4j.dao.genericsdao.action.IGenericsFindAction; import com.china.codingmouse.cmsdk4j.dao.genericsdao.action.IGenericsSaveAction; import com.china.codingmouse.cmsdk4j.dao.genericsdao.condition.SQLBaseCondition; /** * 泛型数据访问实现类 * GenericsDAO * @author CodingMouse * @version 1.0 2009-6-9 * @param <T> 类型参数 */ public class GenericsDAO<T> implements IGenericsDAO<T> { /** * 声明泛型查询动作接口 */ private IGenericsFindAction<T> findAction; /** * 声明泛型保存动作接口 */ private IGenericsSaveAction<T> saveAction; /** * 默认构造器 */ public GenericsDAO() { // 实例化泛型查询动作接口实现类 this.findAction = new GenericsFindAction<T>(); // 实例化泛型保存动作接口实现类 this.saveAction = new GenericsSaveAction<T>(); } /** * 根据模型ID获取该类型的单个模型 * @param clz 注册返回类型 * @param modelId 模型ID（请预先在 pojo.csm.xml 配置档中设定 ID 列名） * @return 该类型的单个模型 * @throws Exception 获取异常 */ public T get(Class<?> clz, Integer modelId) throws Exception { return this.findAction.get(clz, modelId); } /** * 根据查询条件获取该类型的单个模型 * @param clz 注册返回类型 * @param param SQL参数列表（可变参数） * @return 该类型的单个模型 * @throws Exception 获取异常 */ public T get(Class<?> clz, SQLBaseCondition... param) throws Exception { return this.findAction.get(clz, param); } /** * 根据条件模型获取匹配的单个模型 * @param conditionModel 条件模型（不需要作为查询条件的成员变量请保持为 null 值，它将自动被过滤掉） * @return 匹配的单个模型 * @throws Exception 获取异常 */ public T get(T conditionModel) throws Exception { return this.findAction.get(conditionModel); } /** * 获取该类型的全部模型有序集合 * @param clz 注册返回类型 * @param param SQL参数列表（可变参数） * @return 该类型的全部模型有序集合 * @throws Exception 获取异常 */ public List<T> find(Class<?> clz, SQLBaseCondition... param) throws Exception { return this.findAction.find(clz, param); } /** * 根据条件模型获取匹配的全部模型有序集合 * @param conditionModel 条件模型（不需要作为查询条件的成员变量请保持为 null 值，它将自动被过滤掉） * @return 匹配的全部模型有序集合 * @throws Exception 获取异常 */ public List<T> find(T conditionModel) throws Exception { return this.findAction.find(conditionModel); } /** * 保存单个实体模型 * @param persistenceModel 持久化模型（不需要持久化的成员变量请保持为 null 值，它将自动被过滤掉） * @return true-成功/false-失败 */ public boolean save(T persistenceModel) throws Exception { return this.saveAction.save(persistenceModel); } /** * 批量保存模型有序集合中的模型 * @param persistenceModelList 持久化模型有序集合（不需要持久化的成员变量请保持为 null 值，它将自动被过滤掉） * @return true-成功/false-失败 */ public boolean saveBatch(List<T> persistenceModelList) throws Exception { return this.saveAction.saveBatch(persistenceModelList); } }

 

5、一些调用的测试

 

package com.china.codingmouse.cmsdk4j.dao.genericsdao.example; import java.util.List; import com.china.codingmouse.cmsdk4j.dao.genericsdao.GenericsDAO; import com.china.codingmouse.cmsdk4j.dao.genericsdao.condition.SQLCondition; import com.china.codingmouse.cmsdk4j.web.servlet.example.pojo.AccountPOJO; /** * 泛型数据访问测试类 * TestGenericsDAO * @author CodingMouse * @version 1.0 2009-6-20 */ public class TestGenericsDAO { public static void main(String[] args) { GenericsDAO<AccountPOJO> dao = new GenericsDAO<AccountPOJO>(); try { // 0、查询所有POJO // List<AccountPOJO> list = dao.find(AccountPOJO.class); // for (AccountPOJO account : list) { // System.out.println(account.getId() + " | " + account.getAccountname() + " | " + account.getEmail() + " | " + account.getBirthday()); // } // 1、查询多个POJO // List<AccountPOJO> list = dao.find( // AccountPOJO.class, // SQLCondition.build("accountState", 1)); // for (AccountPOJO account : list) { // System.out.println(account.getId() + " | " + account.getAccountname() + " | " + account.getEmail() + " | " + account.getBirthday()); // } // 2、查询单个POJO（多条件查询） // AccountPOJO account = dao.get( // AccountPOJO.class, // SQLCondition.build("accountState", 1), // SQLCondition.build("birthday", java.sql.Date.valueOf("1984-12-26"))); // System.out.println(account.getId() + " | " + account.getAccountname() + " | " + account.getEmail() + " | " + account.getBirthday()); // 3、模糊查询多个POJO // List<AccountPOJO> list = dao.find( // AccountPOJO.class, // SQLCondition.build("accountname", "/%邓/%"), // SQLCondition.build("birthday", ">", java.sql.Date.valueOf("1982-4-16"))); // for (AccountPOJO account : list) { // System.out.println(account.getId() + " | " + account.getAccountname() + " | " + account.getEmail() + " | " + account.getBirthday()); // } // 4、模糊查询单个POJO // AccountPOJO account = dao.get( // AccountPOJO.class, // SQLCondition.build("accountName", "/%超")); // System.out.println(account.getId() + " | " + account.getAccountname() + " | " + account.getEmail() + " | " + account.getBirthday()); // 5、运算符查询多个POJO // List<AccountPOJO> list = dao.find( // AccountPOJO.class, // SQLCondition.build("onlineTime", ">=", 500), // SQLCondition.build("email", "zh/%")); // for (AccountPOJO account : list) { // System.out.println(account.getId() + " | " + account.getAccountname() + " | " + account.getEmail() + " | " + account.getBirthday()); // } // 6、运算符查询指定区间的POJO List<AccountPOJO> list = dao.find( AccountPOJO.class, SQLCondition.build("birthday", ">", java.sql.Date.valueOf("1985-01-01")), SQLCondition.build("birthday", "<", java.sql.Date.valueOf("1989-01-01"))); for (AccountPOJO account : list) { System.out.println(account.getId() + " | " + account.getAccountname() + " | " + account.getEmail() + " | " + account.getBirthday()); } // 7、查询单个POJO（通过ID列） // AccountPOJO account = dao.get(AccountPOJO.class, 5); // System.out.println(account.getId() + " | " + account.getAccountname() + " | " + account.getEmail() + " | " + account.getBirthday()); // 8、根据条件POJO查询单个POJO // AccountPOJO account = dao.get(new AccountPOJO(5, null, 1321, java.sql.Date.valueOf("1987-10-21"), null, null, null, true)); // System.out.println(account.getId() + " | " + account.getAccountname() + " | " + account.getEmail() + " | " + account.getBirthday()); // 9、根据条件POJO查询多个POJO // AccountPOJO conditionModel = new AccountPOJO(); // conditionModel.setLoginpassword("/%123"); // conditionModel.setAccountstate(true); // List<AccountPOJO> list = dao.find(conditionModel); // for (AccountPOJO account : list) { // System.out.println(account.getId() + " | " + account.getAccountname() + " | " + account.getEmail() + " | " + account.getBirthday()); // } // 1、添加单个POJO // AccountPOJO account = new AccountPOJO(null, "测试添加1", 1, java.sql.Date.valueOf("1986-02-01"), "test", "testpwd", "test@test.com", true); // if (dao.save(account)) { // System.out.println("添加 " + account.getAccountname() + " 成功！"); // } else { // System.out.println("添加 " + account.getAccountname() + " 失败！"); // } // 2、批量添加多个POJO // List<AccountPOJO> list = new Vector<AccountPOJO>(); // for (int i = 0; i < 10000; i++) { // list.add(new AccountPOJO(null, "新建测试数据" + (i+1), 1, java.sql.Date.valueOf("1986-02-01"), "NewTest" + (i+1), "newtestpwd" + (i+1), "newtest" + (i+1) + "@gmail.com", true)); // } // long time = System.currentTimeMillis(); // if (dao.saveBatch(list)) { // System.out.println(list.size() + "条测试数据批处理添加成功！"); // } else { // System.out.println(list.size() + "条测试数据批处理添加失败！"); // } // System.out.println("累计耗时：" + (System.currentTimeMillis() - time) + "毫秒！"); // 3、非批量方式添加多个POJO // List<AccountPOJO> list = new Vector<AccountPOJO>(); // for (int i = 0; i < 10000; i++) { // list.add(new AccountPOJO(null, "新建测试数据" + (i+1), 1, java.sql.Date.valueOf("1986-02-01"), "NewTest" + (i+1), "newtestpwd" + (i+1), "newtest" + (i+1) + "@gmail.com", true)); // } // long time = System.currentTimeMillis(); // for (AccountPOJO accountPOJO : list) { // if (!dao.save(accountPOJO)) { // System.out.println("测试数据使用非批处理方式添加失败！ -- " + accountPOJO.getAccountname()); // } // } // System.out.println(list.size() + "条测试数据使用非批处理方式添加成功！"); // System.out.println("累计耗时：" + (System.currentTimeMillis() - time) + "毫秒！"); } catch (Exception e) { e.printStackTrace(); } } }

 

6、以上测试（未注释部分）的结果输出（配置档中已开启自动生成的SQL信息及自行编写的连接池状态信息输出）

 

[Current Connection Pool Size In 2009-07-07 20:33:41.994]：10
[CmSdk4j Auto SQL Generator In 2009-07-07 20:33:42.005]
SELECT id, accountname, onlinetime, birthday, loginname, loginpassword, email, accountstate FROM account WHERE birthday > ? AND birthday < ?
------------------------------
[SQL Where Clause Parameter In 2009-07-07 20:33:42.038]
No：1
Column：birthday
Type：java.sql.Date
Value：1985-01-01
------------------------------
[SQL Where Clause Parameter In 2009-07-07 20:33:42.038]
No：2
Column：birthday
Type：java.sql.Date
Value：1989-01-01
------------------------------
2 | 张三 | zhangsan123@tom.com | 1988-03-12
5 | 赵六 | zhaoliu123@yahoo.com.cn | 1987-10-21
7 | 邓远辰 | test@test.com | 1986-02-01
[Current Connection Pool Size In 2009-07-07 20:33:44.995]：10
[Current Connection Pool Size In 2009-07-07 20:33:47.995]：10
[Current Connection Pool Size In 2009-07-07 20:33:50.995]：10
[Current Connection Pool Size In 2009-07-07 20:33:53.995]：10
[Current Connection Pool Size In 2009-07-07 20:33:56.995]：10

 

7、相关说明
原来也封装过几次DAO，但都显得很苍白。一是粒度不够细，二是都是纯SQL参数的封装，不能实现ORM自动映射持久化动作。
直到接触了Hibernate后，才发现有ORM这样的概念，虽然对Hibernate的使用涉及不深，也没有去阅读Hibernate的优雅代码，但对其复杂的实体关联关系的映射档配置深有感触。特别是对UML中基本的实体关系都不熟悉的程序员，要将关联映射弄透彻又谈何容易？当然，我的实现中也模拟了一些Hibernate的作法，比如对POJO的所有成员变量都用包装类型来处理，以便于将POJO对象作为查询条件。
于是，我便有了一种书写一个类似于简易版本的ORM框架的想法，主要还是通过反射与泛型编程的结合，打造一个自己的实现ORM的泛型DAO。当然，由于我什么东西都想自己去实践一遍，以便理解流行框架的实现原理和技术实质，所以做这个泛型DAO封装时还自行模拟了一个连接池，也定制了自己的配置档，使用者可以自行调配。配置档内容如下：

<?xml version="1.0" encoding="UTF-8"?> <!-- CmSdk4j DataBase Connection Configuration Document --> <cmsdk4j-configuration> <default-dbserver> <default-dbserver>SQL2005</default-dbserver> <show-sql>true</show-sql> <show-poolstate>true</show-poolstate> </default-dbserver> <dbserver-list> <server id="SQL2000"> <description>Microsoft SQL Server 2000 DataBase Connection Configuration</description> <display-name>Microsoft SQL Server 2000</display-name> <connection-url>jdbc:microsoft:sqlserver://localhost:1433;DatabaseName=Test</connection-url> <driver-class>com.microsoft.jdbc.sqlserver.SQLServerDriver</driver-class> <user-name>sa</user-name> <user-password>sa</user-password> </server> <server id="SQL2005"> <description>Microsoft SQL Server 2005 DataBase Connection Configuration</description> <display-name>Microsoft SQL Server 2005</display-name> <connection-url>jdbc:sqlserver://localhost:1433;DatabaseName=CmSdk4jTestDatabase</connection-url> <driver-class>com.microsoft.sqlserver.jdbc.SQLServerDriver</driver-class> <user-name>sa</user-name> <user-password>sql2005</user-password> </server> <server id="Oracle"> <description>Oracle 8/8i/9i/10g/11g DataBase Connection Configuration</description> <display-name>Oracle 8/8i/9i/10g/11g</display-name> <connection-url>jdbc:oracle:thin:@localhost:1521:orcl</connection-url> <driver-class>oracle.jdbc.driver.OracleDriver</driver-class> <user-name>cm</user-name> <user-password>cm</user-password> </server> <server id="DB2"> <description>IBM DB2 DataBase Connection Configuration</description> <display-name>IBM DB2</display-name> <connection-url>jdbc:db2://localhost:5000/sample</connection-url> <driver-class>com.ibm.db2.jdbc.app.DB2Driver</driver-class> <user-name>sys</user-name> <user-password>db2</user-password> </server> <server id="MySQL"> <description>MySQL DataBase Connection Configuration</description> <display-name>MySQL</display-name> <connection-url>jdbc:mysql://localhost:3306/test</connection-url> <driver-class>com.mysql.jdbc.Driver</driver-class> <user-name>root</user-name> <user-password>mysql</user-password> </server> </dbserver-list> <connection-pool> <init-count>10</init-count> <max-count>2000</max-count> <timeout>60000</timeout> <step>5</step> <interval>3000</interval> </connection-pool> </cmsdk4j-configuration>

 

另外还有一个专门用于映射数据库表和实体关系的配置档，由于此文并非探讨ORM原理，所以就不贴出来了。

就上面的测试效果而言，其执行效率还是挺不错的。由于配合了JDBC的批处理功能，上面的批处理方式添加多个POJO的执行时间（向数据库中插入一万条测试数据）为1.4秒（Vista+JDK6.0），感觉还不错。由于我在类型反射动作上做了一些缓存处理，所以我这个ORM映射处理逻辑对执行速度的损失不是很明显。

从上面的代码中也可以看出，细粒度划分CRUD动作后，代码的层次结构显得非常清晰，也更容易理解。可能是我的个人习惯缘故，我建模时都是先建数据库模型再建类模型，即还是以客户数据为中心，当数据库模型建好后，再以此为原型建立实体类（我习惯使用不带业务逻辑的POJO）模型，并且在实体类模型中移除所有数据库模型中的关联关系。这些关联关系由专门的业务逻辑层去统一处理。这也可能是我的ORM映射处理逻辑执行速度感觉较快的原因。

也许屏幕前的您并不赞同我这样的作法，还请您给予指点为谢！


By CodingMouse
2009年7月7日