JCR模塊
Spring Modules的一部分,JCR模塊的主要目標是:以一種類似Spring主分發包中ORM包的方式,簡化使用JSR-170 API進行開發。特點如下:
- JcrTemplate,允許執行JcrCallback和異常處理(將需檢查的JCR異常轉換成不需檢查的Spring DAO異常)。這個模板實現了來自JCRSession的絕大部分方法,可以簡單地作為替換物使用。此外該模板知道線程綁定的會話,這個會話可以跨幾個方法使用,這在使用事務型倉庫時非常有用。
- RepositoryFactoryBean,它配置、啟動和停止倉庫實例。因為JSR-170并沒有說明倉庫配置的標準方式,需要注意實現在這個方面的不同。這個支持包含預定義的用于Jackrabbit和Jeceira的FactoryBean,以及一個可以很容易支持其它倉庫的抽象基類。
- SessionFactory,用來統一Repository,Credentials和Workspace接口,允許自動注冊監聽器和自定義名字空間。
- Spring聲明性事務為那些實現了(可選)事務特性的倉庫提供了支持。
- OpenSessionInView攔截器和過濾器允許每個線程跨不同組件使用同一會話。與JcrTemplate一起,檢索、關閉和管理JCR會話的工作已經外部化,對于調用者完全透明。
本文將使用參考實現(Jackrabbit),由于JCR模塊使用的是javax.jcr接口,因此改變實現根本就是一個配置的問題。讓我們一步一步地來看看在Jackrabbit之上如何使用Java內容倉庫,以及如何讓Spring模塊來幫助完成這一工作。
配置倉庫和SessionFactory
<bean id="repository" class="org.springmodules.jcr.jackrabbit.RepositoryFactoryBean">
<!-- normal factory beans params -->
<property name="configuration" value="classpath:jackrabbit-repo.xml"/>
<property name="homeDir" ref="./tmp/repo"/>
</bean>
JCR支持提供RepositoryFactoryBean類配置Jackrabbit,它需要JackRabbit的配置文件和主目錄。注意,RepositoryFactoryBean在使用本地文件系統時特別有用;對于服務器環境,倉庫可能被注冊在JNDI中,此時可以使用JndiObjectFactoryBean幫助類(Spring分發包的一部分)檢索它:
<bean id="repository" class="org.springframework.jndi.JndiObjectFactoryBean">
<property name="jndiName" value="java:comp/env/jcr/myRepository"/>
</bean>
或使用Spring 2.0的模式名字空間:
<jndi:lookup id="entityManagerFactory" jndi-name="jcr/myRepository"/>
為了簡化與JCR的工作,模塊增加了SessionFactory接口:
public interface SessionFactory {
public Session getSession() throws RepositoryException;
public SessionHolder getSessionHolder(Session session);
}
SessionFactory隱藏了實現內部的認證細節,因此一旦配置完成,使用同一證書的會話可以很容易的被檢索出來。為了利用實現的特性(沒有涵蓋在規范中的),這個接口允許檢索SessionHolder。它是一個JCR模塊特定類,主要被用于事務和會話管理(通過一種可用于每個JCR實現的缺省、通用實現),但是它不支持可選特性或自定義特性(如JackrabbitSessionHolder,它支持Jackrabbit的事務基礎結構)。JCR模塊提供一種簡易、透明的方式來發現SessionHolder實現(這些我將在以后詳細提到),使之很容易地插入對JSR-170其它兼容庫的支持。
SessionFactory的缺省實現是JcrSessionFactory,它要求一個進行工作的倉庫和證書。
<!-— SessionFactory -->
<bean id="jcrSessionFactory" class="org.springmodules.jcr.JcrSessionFactory">
<property name="repository" ref="repository"/>
<property name="credentials">
<bean class="javax.jcr.SimpleCredentials">
<constructor-arg index="0" value="bogus"/>
<!-- create the credentials using a bean factory -->
<constructor-arg index="1">
<bean factory-bean="password" factory-method="toCharArray"/>
</constructor-arg>
</bean>
</property>
</bean>
<!-- create the password to return it as a char[] -->
<bean id="password" class="java.lang.String">
<constructor-arg index="0" value="pass"/>
</bean>
這個bean聲明非常簡單,唯一需要注意的地方是,密碼被提供給SimpleCredential的構造函數:它只接受字符數組,使用Spring工廠聲明作為一種變通。
JcrTemplate
JcrTemplate是JCR模塊的核心類之一,它提供了與JCR會話一起工作的方便方法,將調用者從必須處理的打開和關閉會話、事務回滾(如果底層倉庫提供)、以及處理其它特性中的異常等工作中解放出來:
<bean id="jcrTemplate" class="org.springmodules.jcr.JcrTemplate">
<property name="sessionFactory" ref="jcrSessionFactory"/>
<property name="allowCreate" value="true"/>
</bean>
模板定義非常簡單,類似來自Spring框架的其它模板類,如HibernateTemplate。
例子
既然倉庫已經配置了,接下來看看“Spring化”的例子之一,它來自Jackrabbit的wiki頁:
public Node importFile(final Node folderNode, final File file, final String mimeType,
final String encoding) {
return (Node) execute(new JcrCallback() {
/**
* @see org.springmodules.jcr.JcrCallback#doInJcr(javax.jcr.Session)
*/
public Object doInJcr(Session session) throws
RepositoryException, IOException {
JcrConstants jcrConstants = new JcrConstants(session);
//create the file node - see section 6.7.22.6 of the spec
Node fileNode = folderNode.addNode(file.getName(),
jcrConstants.getNT_FILE());
//create the mandatory child node - jcr:content
Node resNode = fileNode.addNode(jcrConstants.getJCR_CONTENT(),
jcrConstants.getNT_RESOURCE());
resNode.setProperty(jcrConstants.getJCR_MIMETYPE(), mimeType);
resNode.setProperty(jcrConstants.getJCR_ENCODING(), encoding);
resNode.setProperty(jcrConstants.getJCR_DATA(), new FileInputStream(file));
Calendar lastModified = Calendar.getInstance();
lastModified.setTimeInMillis (file.lastModified ());
resNode.setProperty(jcrConstants.getJCR_LASTMODIFIED(), lastModified);
session.save();
return resNode;
}
});
}
主要區別是:代碼被包裝在一個JCR模板中,它將我們從不得不使用的try/catch語句塊(因為IO和Repository的需檢查異常)和處理會話(和事務,如果有的話)清除工作中解放出來。值得提及的是硬編碼字符串,如“jcr:data”,是通過JcrConstants工具類解析出來的。它知道名字空間的前綴變化,并提供一種干凈的方式處理JCR常數。正如你看到的,我只是使例子更加健壯,但是對于實際業務代碼影響最小。
事務支持
使用JCR模塊的一個好處就是能將Spring事務基礎設施(包括聲明性和編程性)應用于Java內容倉庫。JSR 170將事務支持視為可選特性,并沒有強制一個標準的方式來暴露事務鉤子,因此每個實現可以選擇不同的方法。在本文撰寫時,只有Jackrabbit支持事務(在它的大部分操作中),它通過為每個JcrSession暴露一個javax.transaction.XAResource做到這一點。JCR模塊提供LocalTransactionManager用于本地事務:
<bean id="jcrTransactionManager" class="org.springmodules.jcr.jackrabbit.LocalTransactionManager">
<property name="sessionFactory" ref="jcrSessionFactory"/>
</bean>
為了聲明事務劃分,我與上述事務管理器bean聲明一起使用標準Spring類:
<!-- transaction proxy for Jcr services/facades -->
<bean id="txProxyTemplate" abstract="true" class="org.springframework.transaction.interceptor.TransactionProxyFactoryBean">
<property name="proxyTargetClass">
<value>true</value>
</property>
<property name="transactionManager" ref="jcrTransactionManager"/>
<property name="transactionAttributes">
<props>
<prop key="save*">PROPAGATION_REQUIRED</prop>
<prop key="*">PROPAGATION_REQUIRED, readOnly</prop>
</props>
</property>
</bean>
<bean id="jcrService" parent="txProxyTemplate">
<property name="target">
<bean class="org.springmodules.examples.jcr.JcrService">
<property name="template" ref="jcrTemplate"/>
</bean>
</property>
</bean>
如果要求一個JTA管理器,一個簡單而優雅的解決辦法是使用來自Jackrabbit捐獻包的jca連接器。為了使用jca,你并不需要一個應用服務器,因為你可以用一個可插入的JCA容器,如Jencks。JCA容器的配置已經超出本文的范圍,但是你可以參考JCR模塊例子中使用Jencks的例子。
TransactionAwareRepository
對于要求普通JCR代碼的應用程序,JCR模塊允許用直接使用JCR API的代碼,透明地使用事務驅動會話。 此時,可以使用TransactionAwareRepository,它有一個參數是JcrSessionFactory。這樣,在使用Session.login()(它接收定義在JcrSessionFactory中的參數)創建任何新會話時,如果發現有線程綁定的會話,就將返回它。注意:如果使用事務,JCR會話就是事務性的,否則你必須手動設置屬性allowNonTxRepository為true,配置如下,要不然將拋出一個異常:
<bean id="transactionRepository" class="org.springmodules.jcr.TransactionAwareRepository">
<property name="allowNonTxRepository" value="true"/>
<property name="targetFactory" ref="jcrSessionFactory"/>
</bean>
transactionRepositorybean可以被用作一個普通的JCR倉庫,不關心底層機制或線程綁定會話、事務性或非事務性(如果有事務,關閉會話時要提交事務)。
可選特性支持偵測
為了最大化代碼重用,但仍然允許插入可選特性,如用于不同JCR實現的事務支持,JCR模塊使用SessionHolder接口(前面已經提到),同時還有SessionHolderProvider和SessionHolderProviderManager接口。用戶一般不用與它們打交道,因為它們是框架內部使用的;但是,它們代表了JCR模塊主要的擴展點。
SessionHolder類被內部不同組件使用,主要被事務管理器用來操作會話,SessionHolderProvider和SessionHolderProviderManager處理sessionHolder創建的方式以及提供者是如何被個別使用的。缺省將使用ServiceSessionHolderProviderManager,它利用JDK 1.3 Service Provider的自動發現特性。管理器將在類路徑中搜索META-INF/services/org.springmodules.jcr.SessionHolderProvider條目,它包含了SessionHolderProvider實現的完整限定名。Jackrabbit支持就是這樣配置的,JCR模塊的分發包中包含一個META-INF/services/org.springmodules.jcr.SessionHolderProvider(譯注:原文有誤,沒有給出后面的文件名)文件,它只有一行:
org.springmodules.jcr.jackrabbit.support.JackRabbitSessionHolderProvider
缺省,SessionHolderProviderManager被JcrSessionFactory內部使用,因此在工廠啟動時,任何客戶化實現可以被獲取,并與合適的倉庫一起使用。但是,通過設置JcrSessionFactory中的SessionHolderProviderManager,可以很容易的切換到一個不同的發現策略。一個可替代的發現服務是ListSessionHolderProviderManager,它接收一組提供者列表,可以方便地使用自定義提供(如測試)。
<bean id="listProviderManager" class="org.springmodules.jcr.support.ListSessionHolderProviderManager">
<property name="providers">
<list>
<bean class="org.mycompany.jcr.CustomHolderProvider"/>
<bean class="org.springmodules.jcr.jackrabbit.support.JackRabbitSessionHolderProvider"/>
<bean class="org.springmodules.jcr.support.GenericHolderProvider"/>
</list>
</property
</bean>
<bean id="jcrSessionFactory" class="org.springmodules.jcr.JcrSessionFactory">
...
<property name="sessionHolderProviderManager" ref="listProviderManager"/>
</bean>
注意,每個倉庫一個提供者。如果列表包含多個工作于同一倉庫的提供者,順序將非常重要,因為先匹配的先使用。
Java內容倉庫的未來
盡管JSR-170已經于2005年5月完成,Java內容倉庫的工作并沒有終止。JSR-283,官方的后繼者,將聚焦于功能增強,如聯邦,remoting,客戶端/服務器協議映射和擴展內容模型的能力。同時還存在著一些JSR之外的想法和項目:綁定/映射框架,它可以將java類轉換為一個JCR樹,反之亦然(類似ORM,后端用Java內容倉庫替代數據庫),建構于JCR之上的WebDAV服務器(參見Jackrabbit的捐獻包),以及其他。已經出現了用于不同產品的JSR-170連接器,如Alfresco、BEA Portal Server和IBM Domino。
至于JCR模塊,路線圖包括用于幾個實現的Acegi安全集成,支持Spring 2.0名字空間模式(它將減少XML的配置)和與其它JCR實現集成。很顯然,JCR的看起來一片光明。
原文地址: http://blogger.org.cn/blog/more.asp?name=toyboysli&id=33638
本博客為學習交流用,凡未注明引用的均為本人作品,轉載請注明出處,如有版權問題請及時通知。由于博客時間倉促,錯誤之處敬請諒解,有任何意見可給我留言,愿共同學習進步。