一种面向对象的Java Bean查询方法的实现

目前正在赶一个.NET项目，考虑持久层查询的封装尽量做到面向对象,看了一下这篇文章，觉得作者思路不错，故想拿来重构成.NET版本。

 

摘　要:为了克服在Java Bean方法中编写许多SQL语句实现数据查询的缺点,通过查询条件进行了对象化的封
装,提出了一种针对Java Bean的面向对象的查询方法. 通过设置查询条件对象,使用文中所提出的查询方法能
方便地实现不同条件的数据查询,可以有效地提高系统的开发效率.
关键词:反射机制;持久化; Java Bean

 

基于Java的数据库应用开发一般采用将JDBC封装到不同的Java Bean中,实现数据库表到业务对象
映射,通过调用这些Java Bean以完成对数据库访问. [ 1, 2 ]这种设计方式的主要缺陷,一是增加了工作的重
复性,间接增加了开发工作量;二是修改和维护工作量大. 利用Java的反射和标注机制, [ 3 ]笔者提出了一
种针对Java Bean持久化的支持类(Persister). 本文主要阐述Persister类的面向对象查询方法的设计与实现.
1　持久化支持类
针对同时要封装数据库表和操作方法而造成Java Bean设计复杂的问题,将业务数据的新增、修改、删
除、加载以及查询等持久化方法从Java Bean中剥离,改由持久化类( Persister)完成, Java Bean主要负责对
数据库表的封装和对数据合法性的验证,从而降低了Java Bean的实现复杂度. Persister类对传入的Java
Bean的实例对象bean Instance,利用反射机制对其字段名和字段值进行动态访问,并生成相应的SQL 语
句,通过执行SQL语句完成对数据库表的查询或更新操作,实现对Java Bean持久化操作的支持. Persister
类的主要字段属性和方法定义如下.
public class Persister{ p rivate Connection connection; public void insertMany(L ist beanL ist) ;//批量插入bean列表中的对象到数据表中 public void delete (Object bean Instance );//删除在数据库表中bean Instance所对应的行 public void deleteMany(List beanL ist) ; //批量删除数据库表中bean列表中所有bean对象所对应的行 public void update (Object bean Instance );//提取bean Instance中数据并更新数据库表中对应记录 public void updateMany(List beanL ist);//批量更新数据库表中bean列表中所有bean对象对应的行 public Boolean load (Object bean Instance);//按bean Instance指定的主键值从数据库表中提取数,并填充bean Instance的属性 List < ? > query(Class < ? > clazz, ConditionHolder conditionHolder);//按照条件查询,返回符合查询条件的Java Bean的对象列表, ConditionHolder封装了查询条件 String getTableName (Class < ? > beanClass) ;//返回bean对应数据库表名 String[ ] getIdName (Class < ? > beanClass) ;//返回bean对应数据库表的主键字段名 ⋯ public Persister (Connection connection) { this. connection = connection; } }

 

2　查询条件类的设计
将由字段( field) 、关系运算符(operator) 、查询值( value)直接确定的查询条件定义为单项条件表达
式. 通过对单项条件表达式进行与、或、非三种方式组合可得到复杂的复合条件表达式. 由于数据库字段的
值域都是有限的,对于“非”运算总可找到它相应的值域,从而可将“非”运算用“不等于”进行等价处理.
因此,对于条件组合方式只考虑逻辑“与”和逻辑“或”两种方式. 为了能使用更简便的表达方式来定义查
询条件,可对单项条件表达式和条件组合方式进行对象化封装,实现一种面向对象的数据查询方式.
(1) 单项条件表达式类. 按关系运算符的不同共分10种:
Equal类　　　　　对应SQL中的“field = value”表达式
NotEqual类对应SQL中的“field < > value”表达式
GreaterThan类对应SQL中的“field > value”表达式
LessThan类对应SQL中的“field < value”表达式
GreaterEqual类对应SQL中的“field > = value”表达式
LessEqua类对应SQL中的“field < = value”表达式
IsNull类对应SQL中的“field isNull”表达式
IsNotNull类对应SQL中的“field is notNull”表达式
L ike类对应SQL中的“field like value”表达式
NotL ike类对应SQL中的“field not like value”表达式
(2) 条件组合方式类. 包含“与(And) ”和“或(OR) ”两个对象类. 负责封装单项条件表达式或复合条
件表达式进行组合以实现更复杂的复合条件表达式.
基于(1) 、(2) ,容易实现对诸如InL ist(在⋯⋯中) 、Between (在⋯⋯之间)等查询条件表达式的描述.
单项条件表达式类与条件组合方式类的共同特点是封装查询条件表达式,并能产生对应的SQL where子
句. 为统一SQL where子句的生成操作接口,引入查询条件接口类Condition:
public interface Condition { public void generateSql( StringBuffer sbSql, List values) ; }
Condition接口类的唯一方法generateSql根据对象所封装的查询条件表达式,生成对应的带占位符的
SQL where子句并附加在传入参数( SQL 语句) sbSql之后. 同时将封装的查询值添加到对应的参数列表
values中. 要求所有单项条件表达式类与条件组合方式类均实现Condition接口类. 以下仅以L ike类和And
类为例说明.
2. 1　单项条件表达式类L ike
用于封装“field like value”字符串匹配条件,并生成对应的带L ike条件子句.

 

public class L ike imp lements Condition { //实现Condition接口 　　p rivate String fieldName; //对应字段名 　　p rivate String value; //对应查询值 public L ike ( String fieldName, String value) { this. fieldName = fieldName; this. value = value; } public void generateSql( StringBuffer sbSql, List values) { 　　　　sbSql. append ( fieldName) ; // 在sql的where子句中加入查询的字段名 　　　　sbSql. append ( " like ?" ) ; //在sql的where子句中加入占位符 　　　　values. add ( value) ; //查询值添加到对应的参数列表values中} }

 

 

 

2. 2　条件组合方式类And
用于封装对单项条件或复合条件表达式按“与”逻辑进行组合而得到更复杂的复合条件表达式,并生
成“( ⋯and ⋯) ”格式的where子句,其中“⋯”表示任一单项条件或复合条件表达式. 定义如下:

 

public classAnd imp lements Condition { //实现Condition接口 　　p rivate L ist <Condition > conditions; //封装单项或复合条件表达式的条件列表 　　public And ( ) { conditions = new ArrayList <Condition > ( ) ; } 　　public And add (Condition condition) { conditions. add ( condition) ; return this; } 　　//向条件列表新增任一单项或复合条件表达式 　　public void generateSql ( StringBuffer sbSql, L ist values) { 　　　　sbSql. append ( " ( " ) ; //根据条件列表生成( ⋯and ⋯)格式的where子句 　　　　for ( int index = 0; index < conditions. size ( ) ; index + + ) { 　　　　　conditions. get ( index). generateSql( sbSql, values) ; 　　　　　if ( index < conditions. size ( ) - 1) { sbSql. append ( " and " ) ; }else{ sbSql. append ( " ) " ) ; } } } }

 

 

2. 3　结果集排序类Order
Order类封装查询结果集的排序规则,支持多属性升降序的组合排序方式,调用generateSql生成
“order by ⋯”格式的SQL排序子句.

 

public classOrder { 　　p rivate class Entry { 　　public Entry( String fieldName, boolean isAsc) { this. fieldName = fieldName; this. isAsc = isAsc; } 　　　　String fieldName; 　boolean isAsc; } 　　p rivate L ist < Entry > orders; 　　public Order ( ) { orders = new ArrayList ( ) ; } 　　public Order addAsc ( String fieldName) { orders. add ( new Entry( fieldName, true) ) ; return this; } 　　public Order addDesc ( String fieldName) { orders. add ( new Entry( fieldName, false) ) ; return this; } 　　public void generateSql ( StringBuffer sbSql, L ist values) { sbSql. append ( " order by " ) ; 　　　　for ( int index = 0; index < orders. size ( ) ; index + + ) {Entry entry = orders. get ( index) ; 　　　　　　sbSql. append ( entry. fieldName) ; 　　　　　　if ( entry. isAsc) { sbSql. append ( " asc " ) ; else { sbSql. append ( " desc " ) ; } 　　　　　　if ( index < orders. size ( ) - 1) { sbSql. append ( " , " ) ; } } } }

 

 

2. 4　查询容器类Cond itionHolder
ConditionHolder本身只是一个查询容器, 具体的查询条件要通过setCondition 方法添加到
ConditionHolder实例中,并利用setCondition方法指定结果集排序规则. 调用generateSql生成where和order
by子句并附加在传入参数( SQL语句) sbSql之后,并将查询值添加到参数列表values中.

 

public class ConditionHolder {p rivate Condition condition; //具体查询条件 　　p rivate Order order; //结果集排序规则 　　public void generateSql ( StringBuffer sbSql, L ist values) { 　　　　if ( condition ! = null) { sbSql. append ( " where " ) ; condition. generateSql ( sbSql, values) ; } 　　　　if (order ! = null) {order. generateSql ( sbSql, values) ; } 　　public void setCondition (Condition condition) { this. condition = condition; } public Order getOrder ( ) { return order; } 　　public void setOrder (Order order) { this. order = order; } }  

 

 

 

 3　通用查询方法query的实现
通过解析ConditionHolder对象中所封装的查询条件,生成对应的where和order by子句. 最终执行类
似“select 3 from⋯where⋯order by ⋯”的sql语句,获得结果集之后通过读取结果集元数据(Metadata of
ResultSet)进行逆向的自动生成Java Bean过程,最终得到符合条件的Java Bean对象列表. 为了避免生成
赋值语句时针对不同类型的字段要采取不同的处理方式而带来的实现复杂性,通过将字段值存入查询数
组values中,利用PreparedStatement接口对象的setObject方法(自动进行类型转换)为各参数赋值. 由于字

段属性为p rivate (对外是不可访问) ,对其赋值前应调用setAccessible ( ture)方法设置字段属性为可访
问. [ 4, 5 ]本文假定Java Bean的属性与其封装的数据库表字段同名.

 

public L ist query (Class < ? > clazz, ConditionHolder condition) { ⋯ 　　StringBuffer sbSql = new StringBuffer ( ) ; //存储select sql语句 　　List values = new ArrayList ( ) ; //用于存储查询值 　　sbSql. append ( " select 3 from " + getTableName ( clazz) ) ; 　　condition. generateSql ( sbSql, values) ; //生成where子句存入sbSql,查询值存入values数组 　　PreparedStatement statement = connection. p repareStatement ( sbSql. toString( ) ) ; 　　for ( int index = 0; index < values. size ( ) ; index + + ) { 　　　statement. setObject ( index + 1, values. get ( index) ) ; //通过values为所有占位符参数赋值 　　} 　　ResultSet rs = statement. executeQuery( ) ; L ist list = new ArrayL ist ( ) ; 　　while ( rs. next ( ) ) { //根据返回的数据集生成Java Bean对象列表 　　　ResultSetMetaData meta = rs. getMetaData ( ) ; //获取结果集元数据 　　　int columnCount = meta. getColumnCount ( ) ; // 　　　Object instance = clazz. newInstance ( ) ; //生成clazz类的Java Bean实例 　　　for ( int index = 1; index < = columnCount; index + + ) { 　　　　String currentFieldName = meta. getColumnName ( index) ; 　　　　//根据结果集的字段名获得Java Bean的对应属性 　　　　Field currentField = clazz. getDeclaredField ( currentFieldName) ; 　　　　currentField. setAccessible ( true) ; / /设置属性为可访问 　　　　currentField. set ( instance, rs. getObject( index) ) ; //根据结果集中的字段值设置属性值 　　　} 　　　list. add ( instance) ; //向Java Bean列表中添加新对象 　　} 　　　return list; 　　　⋯//出错处理 }

 

 

 

 4　应用实例
以表1所给出的数据库表t_book为例,其对应的Java Bean定义如下:
表1　t_book的表结构设计
字段名字段类型主键
book Id VarChar (20) Y
title VarChar (50)
amount Numeric (6, 0)
p rice Numeric (6, 2)
⋯ ⋯
import Id; / / 引用包含ID_annotation定义的类包
import Table; / / 引用包含Table_annotation定义的类包
@ Id ( { " book Id " } ) / / 标注数据库表的主键字段名
@Table ( { " t_book" } ) / / 标注数据库表名

 

public class BookBean imp lements Serializable{ 　　p rivate String book Id; p rivate String title; 　　p rivate Integer amount; p rivate float p rice; 　　⋯ 　　public Boolean validate Insert ( ) ; // 对新增数据操作的 合法性验证 　　⋯// 省略属性字段的Getters and setters及其他方法 }

 

 

 public class PersisterTest { 　　static Connection connection; static Persister persister; 　　public static void main ( String[ ] args) throws Excep tion{ 　　　　⋯ 　　　　persister = new Persister ( connection) ; 　　　　ConditionHolder holder = new ConditionHolder ( ) ; 　　　　Condition c1 = new GreaterThan (“title”, ”h”) ; //条件1为title字段大于”h” 　　　　Condition c2 = new LessThan (“amount”, 10) ; //条件2为amount字段小于10 　　　　Condition c3 = new And ( ). add ( c1). add ( c2) ; //条件3为条件1并且条件2 　　　　holder. setCondition ( c3) ; / /设置条件3为查询条件 　　　　holder. setOrder ( new Order ( ). addDesc (“book Id”) ) ; //设置按照book Id字段降序排列 　　　　L ist queryResult = persister. query(BookBean. class, holder) ; 　　　　//按照条件查询BookBean对应数据库表,L ist包含符合条件的BookBean类的实例对象 　　　　⋯ 　　} }

 

  通过对查询条件进行了对象化的封装,用户不必再拼接SQL查询字符串,而是使用设置查询条件对
象来定义查询条件,对查询操作变得更自然和方便. Hibernate、Top link等开源框架虽然也提供了类似功
能,但都比较复杂且需要外部配置文件,因此本文的查询方法更合适于中小型项目的开发.