详解Hibernate拦截器与事件监听器

开发 后端
Hibernate 为我们提供了实现拦截器的接口org.hibernate.Interceptor,它里面提供了许多拦截事件。通常不需要实现这个接口,因为我们实现自己的拦截器不可能每一个事件都是必须的。

拦截器(Intercept):与Struts2的拦截器机制基本一样,都是一个操作穿过一层层拦截器,每穿过一个拦截器就会触发相应拦截器的事件做预处理或善后处理。

监听器(Listener):其实功能与拦截器是相似的,但它实现原理不同,它是为每一个事件注册一个或多个监听器,一旦事件发生,则事件源通知所有监听该事件的监听器,然后监听器处理通知(观察者模式)。

拦截器

Hibernate 为我们提供了实现拦截器的接口org.hibernate.Interceptor,它里面提供了许多拦截事件。通常不需要实现这个接口,因为我们实现自己的拦截器不可能每一个事件都是必须的。所以Hibernate为我们提供了org.hibernate.Interceptor接口的一个空实现类 org.hibernate.EmptyIntercept,通常情况下我们只需继承这个空实现类,Override需要的事件方法即可。

拦截器的工作原理简易示意图:

设置拦截器后,相应的操作都会先穿过一层层相应的拦截器,让拦截器执行预处理或善后处理。

拦截器使用实例:

创建拦截器:

  1. public class AutoUpdateTimeInterceptor extends EmptyInterceptor  
  2. {  
  3.     private static final long serialVersionUID = -8597658125309889388L;  
  4.       
  5.     /*  
  6.      * entity - POJO对象  
  7.      * id - POJO对象的主键  
  8.      * state - POJO对象的每一个属性所组成的集合(除了ID)  
  9.      * propertyNames - POJO对象的每一个属性名字组成的集合(除了ID)  
  10.      * types - POJO对象的每一个属性类型所对应的Hibernate类型组成的集合(除了ID)  
  11.      */ 
  12.     @Override 
  13.     public boolean onSave(Object entity, Serializable id, Object[] state,  
  14.             String[] propertyNames, Type[] types)  
  15.     {      
  16.         if (entity instanceof People)  
  17.         {  
  18.             for (int index=0;index<propertyNames.length;index++)  
  19.             {  
  20.                 /*找到名为"checkinTime"的属性*/ 
  21.                 if ("checkinTime".equals(propertyNames[index]))  
  22.                 {  
  23.                     /*使用拦截器将People对象的"checkinTime"属性赋上值*/ 
  24.                     state[index] = new Timestamp(new Date().getTime());  
  25.                     return true;  
  26.                 }  
  27.             }  
  28.         }  
  29.  
  30.         return false;  
  31.     }  
  32. }  

场景类

  1. public class Client  
  2. {  
  3.     public static void main(String[] args)  
  4.     {  
  5.         /*为Session添加拦截器*/ 
  6.         Session session = HibernateUtil.getSessionFactory().openSession(new AutoUpdateTimeInterceptor());  
  7.         Transaction tx = null;  
  8.         try 
  9.         {  
  10.             tx = session.beginTransaction();  
  11.               
  12.             People people = new People();  
  13.             people.setName("zhangsan");  
  14.               
  15.             session.save(people);  
  16.               
  17.             tx.commit();  
  18.         }  
  19.         catch (Exception e)  
  20.         {  
  21.             if(tx!=null)  
  22.             {  
  23.                 tx.rollback();  
  24.             }  
  25.               
  26.             e.printStackTrace();  
  27.         }  
  28.         finally 
  29.         {  
  30.             session.close();  
  31.         }  
  32.     }  

场景类中并没有显示的设置了people对象的"checkinTime"的属性值,启动该场景类代码,现在来查看数据库信息:

可以看到checkin_time这列属性依然被赋值了,说明该赋值操作是拦截器帮助我们完成的。使用拦截器的时候需要注意拦截器的返回值,我以前一直以为拦截器的返回值会控制一个操作是否可以继续,通过实验发现,即使返回false操作也会继续执行的,只是返回false的话,拦截器的所有设置都是无效的,不会反应到数据库中。

返回false:

  1. public class AutoUpdateTimeInterceptor extends EmptyInterceptor  
  2. {  
  3.     private static final long serialVersionUID = -8597658125309889388L;  
  4.       
  5.     /*  
  6.      * entity - POJO对象  
  7.      * id - POJO对象的主键  
  8.      * state - POJO对象的每一个属性所组成的集合(除了ID)  
  9.      * propertyNames - POJO对象的每一个属性名字组成的集合(除了ID)  
  10.      * types - POJO对象的每一个属性类型所对应的Hibernate类型组成的集合(除了ID)  
  11.      */ 
  12.     @Override 
  13.     public boolean onSave(Object entity, Serializable id, Object[] state,  
  14.             String[] propertyNames, Type[] types)  
  15.     {      
  16.         if (entity instanceof People)  
  17.         {  
  18.             for (int index=0;index<propertyNames.length;index++)  
  19.             {  
  20.                 /*找到名为"checkinTime"的属性*/ 
  21.                 if ("checkinTime".equals(propertyNames[index]))  
  22.                 {  
  23.                     /*使用拦截器将People对象的"checkinTime"属性赋上值*/ 
  24.                     state[index] = new Timestamp(new Date().getTime());  
  25. //                  return true;  
  26.                 }  
  27.             }  
  28.         }  
  29.  
  30.         return false;  
  31.     }  

查看插入的数据:

可以看到数据依然保存到数据库中了,但拦截器的操作并没有反映到数据库中,拦截器的操作是无效的。

但是比较奇怪的是Console输出的SQL语句:

  1. Hibernate:   
  2.     insert   
  3.     into  
  4.         people  
  5.         (name, checkin_time, id)   
  6.     values  
  7.         (?, ?, ?)  
  8. Hibernate:   
  9.     update  
  10.         people   
  11.     set  
  12.         name=?,  
  13.         checkin_time=?   
  14.     where  
  15.         id=? 

居然多了一条Update语句,我使用了p6spy显示了这两条SQL语句的绑定值:

  1. 1327304507491|0|0|statement|insert into people (name, checkin_time, id) values (?, ?, ?)|insert into people (name, checkin_time, id) values ('zhangsan''2012-01-23 15:41:47.45''402881e53509837f0135098380370001')  
  2. 1327304507491|0|0|statement|update people set name=?, checkin_time=? where id=?|update people set name='zhangsan', checkin_time='' where id='402881e53509837f0135098380370001' 

可以看到,拦截器的操作会直接反映到数据库中的,但是如果返回值是false的话,Hibernate会产生一条Update SQL语句将拦截器的操作结果取消了。

最后,Hibernate的拦截器有两种设置方式,一种是使用sessionFactory.openSession(Interceptor interceptor),这样的拦截器只会针对该session有效,又叫做局部拦截器。另一种是使用Configuration的setInterceptor(Interceptor interceptor)方法设置,这样的拦截器对每一个session都有效,又称之为全局拦截器。

事件监听器

基本上,Session接口的每个方法都有相对应的事件。比如 LoadEvent,FlushEvent,等等(查阅XML配置文件的DTD,以及org.hibernate.event包来获得所有已定义的事件的列表)。当某个方法被调用时,Hibernate Session会生成一个相对应的事件并激活所有配置好的事件监听器。系统预设的监听器实现的处理过程就是被监听的方法要做的(被监听的方法所做的其实仅仅是激活监听器, “实际”的工作是由监听器完成的)。不过,你可以自由地选择实现一个自己定制的监听器(比如,实现并注册用来处理处理LoadEvent的 LoadEventListener接口), 来负责处理所有的调用Session的load()方法的请求。

在定义自己的事件监听器时,其实不需要实现XXXListener接口,Hibernate为了方便我们定义事件监听器,已经为每个事件监听器接口实提供了一个默认的实现。在org.hibernate.event.def包下面可以找到Hibernate为我们提供的默认实现,我们只需要继承这些默认实现,在其基础上添加我们自定义的功能即可。

事件监听器的简单示意图:

 

当某个方法被调用时,Hibernate Session会生成一个相对应的事件并激活所有配置好的事件监听器。

事件监听器使用:

创建事件监听器:

  1. public class SaveOrUpdateListener extends DefaultSaveOrUpdateEventListener  
  2. {  
  3.     private static final long serialVersionUID = 7496518453770213930L;  
  4.  
  5.     /*监听保存或更新事件*/ 
  6.     @Override 
  7.     public void onSaveOrUpdate(SaveOrUpdateEvent event)  
  8.     {  
  9.         People people = null;  
  10.           
  11.         if(event.getObject() instanceof People)  
  12.         {  
  13.             people = (People)event.getObject();  
  14.         }  
  15.           
  16.         people.setCheckinTime(new Timestamp(new Date().getTime()));  
  17.           
  18.         System.out.println("invoke!");  
  19.           
  20.         /*一定要调用父类提供的功能,不然就和继承接口一样了*/ 
  21.         super.onSaveOrUpdate(event);  
  22.     }  

通过hibernate.cfg.xml配置文件将事件监听器配置到Hibernate中:

第一种配置方式:

  1. <event type="save-update"> 
  2.     <listener class="com.suxiaolei.hibernate.listener.SaveOrUpdateListener"/> 
  3. </event> 

第二种配置方式:

  1. <listener class="com.suxiaolei.hibernate.listener.SaveOrUpdateListener" type="save-update"/> 

两种配置方式产生的效果都是一样的。只是一个以"事件"为主,一个以"监听器"为主。type是指定监听事件的类型,class指定监听器的实现类,一个事件可以有多个监听器。type有许多取值,下表列出了所有type的值:

上面列表每一个选项对应着一个特定的事件。

场景类:

  1. public class Client  
  2. {  
  3.     public static void main(String[] args)  
  4.     {  
  5.         Session session = HibernateUtil.getSessionFactory().openSession();  
  6.         Transaction tx = null;  
  7.         try 
  8.         {  
  9.             tx = session.beginTransaction();  
  10.               
  11.             People people = new People();  
  12.             people.setName("lisi");  
  13.               
  14.             session.saveOrUpdate(people);  
  15.               
  16.             tx.commit();  
  17.         }  
  18.         catch (Exception e)  
  19.         {  
  20.             if(tx!=null)  
  21.             {  
  22.                 tx.rollback();  
  23.             }  
  24.               
  25.             e.printStackTrace();  
  26.         }  
  27.         finally 
  28.         {  
  29.             session.close();  
  30.         }  
  31.     }  

people对象依然没有设置checkinTime属性,运行程序后,查看数据库:

可以看到,checkin_time字段的依然赋值了,说明我们配置的事件监听器生效了。

使用事件监听器我发现需要注意父类行为的顺序,例如:

  1. public void onSaveOrUpdate(SaveOrUpdateEvent event)  
  2. {  
  3.         People people = null;  
  4.           
  5.         if(event.getObject() instanceof People)  
  6.         {  
  7.             people = (People)event.getObject();  
  8.         }  
  9.           
  10.         people.setCheckinTime(new Timestamp(new Date().getTime()));  
  11.           
  12.         System.out.println("invoke!");  
  13.           
  14.         /*一定要调用父类提供的功能,不然就和继承接口一样了*/ 
  15.         super.onSaveOrUpdate(event);  
  1. public void onSaveOrUpdate(SaveOrUpdateEvent event)  
  2. {  
  3.         /*一定要调用父类提供的功能,不然就和继承接口一样了*/ 
  4.         super.onSaveOrUpdate(event);  
  5.           
  6.         People people = null;  
  7.           
  8.         if(event.getObject() instanceof People)  
  9.         {  
  10.             people = (People)event.getObject();  
  11.         }  
  12.           
  13.         people.setCheckinTime(new Timestamp(new Date().getTime()));  
  14.           
  15.         System.out.println("invoke!");  

例如上面的顺序,虽然最后产生的效果一致,但是第二种顺序会多产生一条update语句,有可能会产生性能问题,所以在使用事件监听器的时候需要多加注意。

原文链接:http://www.cnblogs.com/otomedaybreak/archive/2012/01/23/2328980.html

【编辑推荐】

  1. Hibernate的缓存解读
  2. Hibernate的集合映射
  3. Hibernate关联关系配置
  4. Hibernate复合主键映射
  5. Hibernate继承映射
责任编辑:林师授 来源: 音①晓的博客
相关推荐

2011-05-16 10:14:11

Hibernate

2009-09-27 17:46:22

Hibernate监听

2009-09-27 17:37:32

Hibernate拦截

2023-11-01 07:55:03

事件监听器传递数据

2010-08-09 11:06:01

Flex事件机制

2009-01-03 13:37:26

Oracle监听器Oracle服务器Oracle网络配置

2010-08-09 09:47:34

Flex事件机制

2011-03-21 16:21:49

Oracle监听口令监听器

2020-12-15 10:46:29

事件监听器Spring Boot

2009-07-08 17:39:23

Servlet监听器

2009-06-22 09:23:18

事件监听器

2009-07-17 09:55:02

事件监听器SWT和SwingAWT

2009-06-24 16:00:00

2020-04-20 11:09:49

过滤器监听器 Web

2023-09-05 08:58:07

2021-07-08 07:52:49

容器监听器Event

2011-11-21 14:21:26

SpringMVCJava框架

2009-07-08 17:02:11

JDK实现调用拦截器

2010-02-22 15:06:31

WCF信道监听器

2009-11-09 10:03:09

WCF通道监听器
点赞
收藏

51CTO技术栈公众号