1. 程式人生 > >Hibernate攔截器和監聽器

Hibernate攔截器和監聽器

12.1.  攔截器(Interceptors)

Interceptor介面提供了從會話(session)回撥(callback)應用程式(application)的機制, 這種回撥機制可以允許應用程式在持久化物件被儲存、更新、刪除或是載入之前,檢查並(或)修改其 屬性。一個可能的用途,就是用來跟蹤稽核(auditing)資訊。例如:下面的這個攔截器,會在一個實現了 Auditable介面的物件被建立時自動地設定createTimestamp屬性,並在實現了Auditable介面的物件被更新時,同步更新lastUpdateTimestamp屬性。

你可以直接實現Interceptor

介面,也可以(最好)繼承自EmptyInterceptor

package org.hibernate.test;

import java.io.Serializable;
import java.util.Date;
import java.util.Iterator;

import org.hibernate.EmptyInterceptor;
import org.hibernate.Transaction;
import org.hibernate.type.Type;

public class AuditInterceptor extends EmptyInterceptor {

    private int updates;
    private int creates;
    private int loads;

    public void onDelete(Object entity,
                         Serializable id,
                         Object[] state,
                         String[] propertyNames,
                         Type[] types) {
        // do nothing
    }

    public boolean onFlushDirty(Object entity,
                                Serializable id,
                                Object[] currentState,
                                Object[] previousState,
                                String[] propertyNames,
                                Type[] types) {

        if ( entity instanceof Auditable ) {
            updates++;
            for ( int i=0; i < propertyNames.length; i++ ) {
                if ( "lastUpdateTimestamp".equals( propertyNames[i] ) ) {
                    currentState[i] = new Date();
                    return true;
                }
            }
        }
        return false;
    }

    public boolean onLoad(Object entity,
                          Serializable id,
                          Object[] state,
                          String[] propertyNames,
                          Type[] types) {
        if ( entity instanceof Auditable ) {
            loads++;
        }
        return false;
    }

    public boolean onSave(Object entity,
                          Serializable id,
                          Object[] state,
                          String[] propertyNames,
                          Type[] types) {

        if ( entity instanceof Auditable ) {
            creates++;
            for ( int i=0; i<propertyNames.length; i++ ) {
                if ( "createTimestamp".equals( propertyNames[i] ) ) {
                    state[i] = new Date();
                    return true;
                }
            }
        }
        return false;
    }

    public void afterTransactionCompletion(Transaction tx) {
        if ( tx.wasCommitted() ) {
            System.out.println("Creations: " + creates + ", Updates: " + updates, "Loads: " + loads);
        }
        updates=0;
        creates=0;
        loads=0;
    }

}

攔截器可以有兩種:Session範圍內的,和SessionFactory範圍內的。

當使用某個過載的SessionFactory.openSession()使用Interceptor作為引數呼叫開啟一個session的時候,就指定了Session範圍內的攔截器。

Session session = sf.openSession( new AuditInterceptor() );

SessionFactory範圍內的攔截器要通過Configuration中註冊,而這必須在建立SessionFactory之前。在這種情況下,給出的攔截器會被這個SessionFactory

所開啟的所有session使用了;除非session開啟時明確指明瞭使用的攔截器。SessionFactory範圍內的攔截器,必須是執行緒安全的,因為多個session可能併發使用這個攔截器,要因此小心不要儲存與session相關的狀態。

new Configuration().setInterceptor( new AuditInterceptor() );

12.2.  事件系統(Event system)

如果需要響應持久層的某些特殊事件,你也可以使用Hibernate3的事件框架。 該事件系統可以用來替代攔截器,也可以作為攔截器的補充來使用。

基本上,Session介面的每個方法都有相對應的事件。比如 LoadEventFlushEvent,等等(查閱XML配置檔案 的DTD,以及org.hibernate.event包來獲得所有已定義的事件的列表)。當某個方 法被呼叫時,Hibernate Session會生成一個相對應的事件並激活所 有配置好的事件監聽器。系統預設的監聽器實現的處理過程就是被監聽的方法要做的(被監聽的方法所做的其實僅僅是啟用監聽器, “實際”的工作是由監聽器完成的)。不過,你可以自由地選擇實現 一個自己定製的監聽器(比如,實現並註冊用來處理處理LoadEventLoadEventListener介面), 來負責處理所有的呼叫Sessionload()方法的請求。

監聽器應該被看作是單例(singleton)物件,也就是說,所有同類型的事件的處理共享同一個監聽器例項,因此監聽器 不應該儲存任何狀態(也就是不應該使用成員變數)。

使用者定製的監聽器應該實現與所要處理的事件相對應的介面,或者從一個合適的基類繼承(甚至是從Hibernate自帶的預設事件監聽器類繼承, 為了方便你這樣做,這些類都被宣告成non-final的了)。使用者定製的監聽器可以通過程式設計使用Configuration物件 來註冊,也可以在Hibernate的XML格式的配置檔案中進行宣告(不支援在Properties格式的配置檔案宣告監聽器)。 下面是一個使用者定製的載入事件(load event)的監聽器:

public class MyLoadListener implements LoadEventListener {
    // this is the single method defined by the LoadEventListener interface
    public void onLoad(LoadEvent event, LoadEventListener.LoadType loadType)
            throws HibernateException {
        if ( !MySecurity.isAuthorized( event.getEntityClassName(), event.getEntityId() ) ) {
            throw MySecurityException("Unauthorized access");
        }
    }
}

你還需要修改一處配置,來告訴Hibernate,除了預設的監聽器,還要附加選定的監聽器。

<hibernate-configuration>
    <session-factory>
        ...
        <event type="load">
            <listener class="com.eg.MyLoadListener"/>
            <listener class="org.hibernate.event.def.DefaultLoadEventListener"/>
        </event>
    </session-factory>
</hibernate-configuration>

看看用另一種方式,通過程式設計的方式來註冊它。

Configuration cfg = new Configuration();
LoadEventListener[] stack = { new MyLoadListener(), new DefaultLoadEventListener() };
cfg.EventListeners().setLoadEventListeners(stack);

通過在XML配置檔案宣告而註冊的監聽器不能共享例項。如果在多個<listener/>節點中使用 了相同的類的名字,則每一個引用都將會產生一個獨立的例項。如果你需要在多個監聽器型別之間共享 監聽器的例項,則你必須使用程式設計的方式來進行註冊。

為什麼我們實現了特定監聽器的介面,在註冊的時候還要明確指出我們要註冊哪個事件的監聽器呢? 這是因為一個類可能實現多個監聽器的介面。在註冊的時候明確指定要監聽的事件,可以讓啟用或者禁用對某個事件的監聽的配置工作簡單些。


本文出自:http://blog.csdn.net/gaowenming/article/details/5035043