【转】Hibernate过滤器使用窍门

本文向大家介绍Hibernate过滤器，可能好多人还不了解Hibernate过滤器，没有关系，看完本文你肯定有不少收获，希望本文能教会你更多东西。

Hibernate3新增了对某个类或者集合使用预先定义的Hibernate过滤器条件(filter criteria)的功能。过滤器条件相当于定义一个 非常类似于类和各种集合上的“where”属性的约束子句，但是过滤器条件可以带参数。

应用程序可以在运行时决定是否启用给定的Hibernate过滤器，以及使用什么样的参数值。 过滤器的用法很像数据库视图，只不过是在应用程序中确定使用什么样的参数的。

要使用过滤器，必须首先在相应的映射节点中定义。而定义一个过滤器，要用到位于<hibernate-mapping/> 节点之内的<filter-def/>节点：

1. <filter-def name="myFilter"> 
2.  
3.     <filter-param name="myFilterParam" type="string"/> 
4.  
5. </filter-def> 

定义好之后，就可以在某个类中使用这个过滤器：

1. <class name="myClass" ...> 
2.  
3.     ...  
4.  
5.     <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> 
6.  
7. </class> 

也可以在某个集合使用它：

1. <set ...> 
2.  
3.     <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> 
4.  
5. </set> 

可以在多个类或集合中使用某个过滤器；某个类或者集合中也可以使用多个过滤器。

Session对象中会用到的方法有：enableFilter(String filterName), getEnabledFilter(String filterName), 和 disableFilter(String filterName). Session中默认是不启用过滤器的，必须通过Session.enabledFilter()方法显式的启用。 该方法返回被启用的Filter的实例。以上文定义的过滤器为例：

1. session.enableFilter("myFilter").setParameter("myFilterParam", "some-value"); 

注意，org.hibernate.Filter的方法允许链式方法调用。（类似上面例子中启用Filter之后设定Filter参数这个“方法链”） Hibernate的其他部分也大多有这个特性。

下面是一个比较完整的例子，使用了记录生效日期模式过滤有时效的数据：

1. <filter-def name="effectiveDate"> 
2.  
3.     <filter-param name="asOfDate" type="date"/> 
4.  
5. </filter-def> 
6.  
7.  
8.  
9. <class name="Employee" ...> 
10.  
11. ...  
12.  
13.     <many-to-one name="department" column="dept_id" class="Department"/> 
14.  
15.     <property name="effectiveStartDate" type="date" column="eff_start_dt"/> 
16.  
17.     <property name="effectiveEndDate" type="date" column="eff_end_dt"/> 
18.  
19. ...  
20.  
21.     <!--  
22.  
23.         Note that this assumes non-terminal records have an eff_end_dt set to  
24.  
25.         a max db date for simplicity-sake  
26.  
27.  
28.  
29.         注意，为了简单起见，此处假设雇用关系生效期尚未结束的记录的eff_end_dt字段的值等于数据库最大的日期  
30.  
31.     --> 
32.  
33.     <filter name="effectiveDate" 
34.  
35.             condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> 
36.  
37. </class> 
38.  
39.  
40.  
41. <class name="Department" ...> 
42.  
43. ...  
44.  
45.     <set name="employees" lazy="true"> 
46.  
47.         <key column="dept_id"/> 
48.  
49.         <one-to-many class="Employee"/> 
50.  
51.         <filter name="effectiveDate" 
52.  
53.                 condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> 
54.  
55.     </set> 
56.  
57. </class> 

定义好后，如果想要保证取回的都是目前处于生效期的记录，只需在获取雇员数据的操作之前先开启过滤器即可：

1. Session session = ...;  
2.  
3. session.enabledFilter("effectiveDate").setParameter("asOfDate", new Date());  
4.  
5. List results = session.createQuery("from Employee as e where e.salary > :targetSalary")  
6.  
7.          .setLong("targetSalary", new Long(1000000))  
8.  
9.          .list();  

在上面的HQL中，虽然我们仅仅显式的使用了一个薪水条件，但因为启用了过滤器，查询将仅返回那些目前雇用 关系处于生效期的，并且薪水高于一百万美刀的雇员的数据。

注意：

如果你打算在使用外连接（或者通过HQL或load fetching）的同时使用过滤器，要注意条件表达式的方向（左还是右）。 最安全的方式是使用左外连接（left outer joining）。并且通常来说，先写参数， 然后是操作符，最后写数据库字段名。