Hibernate的拦截器和监听器

最近项目需要，用到了Hibernate的拦截器和监听器，有些小小心得，和大家分享下。

首先说说这两个东西。
拦截器（Intercept）：顾名思义，拦截操作，也就是在Hibernate做出动作之前会调用的方法。如果你有需要在Hibernate操作数据库之前想要做的操作，就需要用到这个东西了。

监听器（Listener）：监听，就是监视Hibernate的一举一动，如果我们要获取Hibernate各种操作PO的前前后后的信息，那就要用到他了。

这里有的朋友可能就有疑问了，从上面的描述来看，这个监听器似乎能够实现拦截器的功能，因为他也能获取Hibernate操作数据库前的状况。
其实不然，在此我只举出两个很典型的例子，大家就会明白他们俩是不能被互相取代的。

1、监听器只会默默的获取信息，不会阻断Hibernate的工作，而用拦截器时，我们可以根据我们的需求，去终止某个Hibernate的持久化动作。
2、如果我有这样一个需求，在PO保存时，我想按我的需求改变某个属性的值后，再保存入库。分析下知道，这个操作要在Hibernate执行Save之前来做，那么看似拦截器和监听器都能实现，但实践一下就会知道，如果我们用监听器来做（比如此时用PreInsertEventListener），当我们在此改变某属性值后，会发现，保存入库的仍然是原来的值，监听器的Pre******是不允许我们这样做的。此时就需要用到拦截器，实现其OnSave方法，在此进行处理。

说完了这些，就简单说下他们的用法及配置方法。

一、
首先说监听器，我们以PostUpdateEventListener讲解
新建一个我们自己的监听器类，实现PostUpdateEventListener接口即可

Java代码 
1.public class MyListener extends DefaultLoadEventListener   
2.implements PostUpdateEventListener {   
3. 
4.    public void onPostUpdate(PostUpdateEvent event) {   
5.        System.out.println(event.getEntity().getClass().getName()+":更新完毕");   
6.        for (int i = 0; i < event.getState().length; i++) {   
7.            // 更新前的值   
8.            Object oldValue = event.getOldState()[i];  
9.            // 更新后的新值   
10.            Object newValue = event.getState()[i];  
11.            //更新的属性名   
12.            String propertyName = event.getPersister().getPropertyNames()[i];  
13.        }  
14.    }  
15.} 
Java代码 
1.public class MyListener extends DefaultLoadEventListener   
2.implements PostUpdateEventListener {  
3. 
4.    public void onPostUpdate(PostUpdateEvent event) {  
5.        System.out.println(event.getEntity().getClass().getName()+":更新完毕");  
6.        for (int i = 0; i < event.getState().length; i++) {  
7.            // 更新前的值  
8.            Object oldValue = event.getOldState()[i];  
9.            // 更新后的新值  
10.            Object newValue = event.getState()[i];  
11.            //更新的属性名  
12.            String propertyName = event.getPersister().getPropertyNames()[i];  
13.        }  
14.    }  
15.} 
public class MyListener extends DefaultLoadEventListener
implements PostUpdateEventListener {

public void onPostUpdate(PostUpdateEvent event) {
System.out.println(event.getEntity().getClass().getName()+":更新完毕");
for (int i = 0; i < event.getState().length; i++) {
// 更新前的值
Object oldValue = event.getOldState()[i];
// 更新后的新值
Object newValue = event.getState()[i];
//更新的属性名
String propertyName = event.getPersister().getPropertyNames()[i];
}
}
}

如果要实现其他监听器，只需实现其他的监听器接口即可，具体有哪些监听器，大家可以查看Hibernate包下的org.hibernate.event，里面能看到所有的监听器。

之后要加载监听器，我这里只讲解用过spring注入sessionFactory，用property配置的方法，因为另外的两种配置方法在网上很容易搜索到，这里就不重复。
先将我们的监听器定义到spring中

Xml代码 
1.<bean id="myListener" class="com.app.common.util.hibernateSupport.MyListener"> 
Xml代码 
1.<bean id="myListener" class="com.app.common.util.hibernateSupport.MyListener"> 
<bean id="myListener" class="com.app.common.util.hibernateSupport.MyListener">

在sessionFactory的bean标签中加入如下内容：

Xml代码 
1.<bean id="sessionFactory" 
2. class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">  
3....  
4.        <property name="eventListeners">    
5.            <map>  
6.                <entry key="post-update">  
7.                    <ref bean="myListener" />  
8.                </entry>  
9.            </map>  
10.        </property>  
11....  
12.</bean>  
Xml代码 
1.<bean id="sessionFactory" 
2. class="org.springframework.orm.hibernate3.LocalSessionFactoryBean"> 
3....  
4.        <property name="eventListeners">   
5.            <map> 
6.                <entry key="post-update"> 
7.                    <ref bean="myListener" /> 
8.                </entry> 
9.            </map> 
10.        </property> 
11....  
12.</bean> 
<bean id="sessionFactory"
class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
...
<property name="eventListeners">
<map>
<entry key="post-update">
<ref bean="myListener" />
</entry>
</map>
</property>
...
</bean>

这样我们的监听器就可以工作了，当Hibernate执行update操作时，就会输出我们的信息了。

二、
再来说说拦截器
拦截器的实现要比监听器简单得多。
我们只要新建一个自己的拦截器类，继承自org.hibernate.EmptyInterceptor类，重写原来的方法，之后在spring中配置即可。
简单例子：

Java代码 
1.public class MyIntercept extends EmptyInterceptor {  
2.      
3.    @Override  
4.    public boolean onSave(Object entity, Serializable id, Object[] state,   
5.            String[] propertyNames, Type[] types) {  
6.        //entity就是当前的实体对象   
7.        //如果当前操作的TbUser，则做处理   
8.        if(entity instanceof TbUser){   
9.            TbUser user=(TbUser)entity;  
10.            user.setUserPassword("123");   
11.            if(user.getUserId()==null){   
12.                //返回true则拦截本次操作   
13.                return true;   
14.            }  
15.        }  
16.        return super.onSave(entity, id, state, propertyNames, types);   
17.    }  
18.} 
Java代码 
1.public class MyIntercept extends <SPAN class=hilite2><SPAN style="BACKGROUND-COLOR: #55ff55">EmptyInterceptor</SPAN></SPAN> {  
2.      
3.    @Override 
4.    public boolean onSave(Object entity, Serializable id, Object[] state,  
5.            String[] propertyNames, Type[] types) {  
6.        //entity就是当前的实体对象  
7.        //如果当前操作的TbUser，则做处理  
8.        if(entity instanceof TbUser){  
9.            TbUser user=(TbUser)entity;  
10.            user.setUserPassword("123");  
11.            if(user.getUserId()==null){  
12.                //返回true则拦截本次操作  
13.                return true;  
14.            }  
15.        }  
16.        return super.onSave(entity, id, state, propertyNames, types);  
17.    }  
18.} 
public class MyIntercept extends EmptyInterceptor {

@Override
public boolean onSave(Object entity, Serializable id, Object[] state,
String[] propertyNames, Type[] types) {
//entity就是当前的实体对象
//如果当前操作的TbUser，则做处理
if(entity instanceof TbUser){
TbUser user=(TbUser)entity;
user.setUserPassword("123");
if(user.getUserId()==null){
//返回true则拦截本次操作
return true;
}
}
return super.onSave(entity, id, state, propertyNames, types);
}
}

配置文件：

Xml代码 
1.<bean id="myIntercept"   
2.class="com.app.common.util.hibernateSupport.MyIntercept">  
3........  
4.<bean id="sessionFactory"    
5.class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">  
6....  
7.        <property name="entityInterceptor">    
8.            <ref bean="myIntercept"/>  
9.        </property>  
10....  
11.</bean>  
Xml代码 
1.<bean id="myIntercept"   
2.class="com.app.common.util.hibernateSupport.MyIntercept"> 
3........  
4.<bean id="sessionFactory"   
5.class="org.springframework.orm.hibernate3.LocalSessionFactoryBean"> 
6....  
7.        <property name="entityInterceptor">   
8.            <ref bean="myIntercept"/> 
9.        </property> 
10....  
11.</bean>