包名:hibernate-conditions.jar

主要是擴展了hibernate的查詢功能,該功能依賴于hibernate及hibernate相關包.

主要擴展了將一個變量注釋成一個查詢條件的功能,把整個對象當成一個未知的查詢條件,交給解析器去解析.核心是幾個注釋的使用.下面解釋這幾個注釋.

1. AsCondition 把一個變量注釋成一個條件,該注釋有兩個最主要的字段,propertyName和symbol其中propertyName是指定要查詢的hibernate實體的字段. symbol指明查詢的操作比較符,即"=","< ",">"等操作.還有幾個比較次要的字段:  groupOrdinal 指定分組的序號,如果一個對象有多個查詢條件,可以指定這些條件序號.可以在不要的查詢過程中指定不同的查詢序號.

 ignoreNull 是否忽略null值,默認是忽略.如果不忽略null值,則在條件解析過程中遇到該查詢條件的值為空,則將該條件解析為 "propertyName" is null

inherit 是否查詢父類,默認是不查詢父類.

2. AsAlias 查詢集合,對應Criteria.createAlias()方法.只是里面有一個ignoreEmpty字段不同,該字段指定是否忽略集合為空,如果不忽略集合為空,則當該值為null的時候,解析后的查詢條件為:集合 is empty

3. DesignatedProperty 該注釋是用在被注釋的是一個類,并指定該類中的一個屬性作為查詢條件的值.

4. Conversion 用于條件值的數據類型的轉換.如:被查詢條件值為Integter而被注釋的變量為String,這時候就可以使用該注釋把數據類型從String轉換為Integter.除了通用類型的數據的轉換還可以數據的類型的轉換,把數據轉換的類型ConversionType指定為Custom,注意,如果該屬性指定為Custom則需要給出customDataConversionType的類型,該類型必須是繼承DataConversion接口.如果沒有指定,則不能進行任何的數據轉換.

Conversion里還有一個屬性throwDataConversionException,該屬性指定如果數據轉換異常,是否拋出異常,如果拋出異常則當次的查詢會終止.如果出現異常但不拋出,則會忽略該查詢條件.

使用也很簡單:

創建一個AnnotationConditionParser對象,調用該對象的parser(Object...unkownConditionObject)方法可以指定未知道的條件實體,該方法被了接收被注釋過的實體外還可以接收原來hibernate的查詢條件和字符串的查詢條件,如果是字符串的查詢條件必須符合Criteria的查詢格式,否則在hibernate解析時會有查詢的異常.

AnnotationConditionParser對象中的groupLimit(int groupLimit)方法用于限定查詢的分組,如果指定的分組則只解析屬于該組的條件.

具體執行對條件的解析操作是createCriteria(DetachedCriteria criteria)方法,該方法把所有的條件解析成DetachedCriteria 的查詢條件.接下來就是對DetachedCriteria 的操作了.由于DetachedCriteria 對象是hibernate的對象,該對象的用法相信大家比我還熟悉. 我在這里就不再解釋了.

具體例子(只作為例子講解,無法直接運行):

public class ConditionTest {  
/**  
* @param args  
*/ 
public static void main(String[] args) {  
ConditionTest test = new ConditionTest();  
test.setName("my name");  
test.setSize(10);  
OtherClass other1 = new OtherClass();  
other1.setName("name1");  
test.setObjectCondition(other1);  
OtherClass other2 = new OtherClass();  
other2.setName("name1");  
test.setOther(other2);  
DetachedCriteria detachedCriteria = DetachedCriteria.forEntityName("UserEntity");  
new AnnotationConditionParser()  
//限定查詢的分組  
.groupLimit(1)  
//設置查詢的實體對象  
.parser(test)  
//執行查詢并填充DetachedCriteria對象  
.createCriteria(detachedCriteria);  
// ...  
// 執行detachedCriteria對象的數據查詢操作  
}  
//最簡單的用法  
@AsCondition(propertyName="size")  
private int size;  
@AsCondition(propertyName="name", symbol=Symbol.LIKE)  
private String name;  
//指定對象里的一個屬性作為查詢的條件  
@AsCondition(propertyName="name")  
@DesignatedProperty(propertyName="name")  
private OtherClass objectCondition;  
 
public int getSize() {  
return size;  
}  
public void setSize(int size) {  
this.size = size;  
}  
public String getName() {  
return name;  
}  
public void setName(String name) {  
this.name = name;  
}  
public OtherClass getObjectCondition() {  
return objectCondition;  
}  
public void setObjectCondition(OtherClass objectCondition) {  
this.objectCondition = objectCondition;  
}  
public OtherClass getOther() {  
return other;  
}  
public void setOther(OtherClass other) {  
this.other = other;  
}  
//使用數據類型的轉換  
@AsCondition(propertyName="datetime", symbol=Symbol.NE, ignoreNull=true)  
@DesignatedProperty(propertyName="name")  
@Conversion(dataConversion=ConversionType.Custom, customDataConversionType=CustomTypeConversion.class)  
private OtherClass other;  
 
public static class OtherClass{  
private String name;  
public String getName() {  
return name;  
}  
public void setName(String name) {  
this.name = name;  
}  
}  
public static class CustomTypeConversion implements DataConversion{  
@Override 
public Object doConversion(Object data) throws DataConversionException {  
return Date.valueOf(data.toString());  
}  
 
}  
}  

【編輯推薦】

1. Hibernate基礎（2）
2. Hibernate基礎（1）
3. 簡單的Hibernate入門介紹
4. 在Liferay中使用Hibernate
5. Hibernate模糊查詢參數化的問題