　Kodo EJB是一個支持對象/關系映射的框架，根據EJB3規范的要求，Kodo EJB除了支持在普通Java應用中提供輕量級的持久層框架之外，也支持在JAVA EE容器中使用滿足重量級企業應用的需求，充分利用JAVA EE容器中提供的優越特性如容器管理事務、遠程(Remote)訪問。

　　基于Kodo EJB開發的應用支持使用EJB或者JCA標準接入到JAVA EE環境中：

JCA
Kodo EJB支持JCA1.0標準，因此基于Kodo EJB開發的應用可以和其他JCA資源一樣輕松的發布到JAVA EE應用服務器上。
JNDI
另外一種方式是將kodo.persistence.EntityManagerFactoryImpl的一個實例綁定到JNDI，然后通過查找JNDI的方式使用Kodo EJB應用。雖然這種方式需要開發者根據不同的JAVA EE容器編寫代碼才能完成，但是這種方式能夠保持最大限度的JAVA EE容器可移植性，而且為在那些不支持JCA標準的JAVA EE容器中使用Kodo EJB創造可能。

　　本文中我們將以通過一個簡單的例子，簡單的講解和演示如何在Weblogic9上通過JNDI方式來訪問Kodo EJB應用。

環境準備

　　由于Kodo是基于注釋機制的框架，我們必須使用JDK5.0完成開發工作。所以下載、安裝Kodo之前，請確保您已經下載和安裝了JDK5.0。

　　為了演示的需要，我們選擇MySQL數據庫作為持久化的目標數據庫，請大家自己到www.mysql.com下載最新的MySQL數據庫后安裝。

安裝Kodo

　　Kodo的最新版本是Kodo 4.0.0 Early Access 4，目前大家可以到http://www.solarmetric.com/去下載試用版本，下載時需要注冊，你會得到30天的License。
將下載的壓縮文件解壓到c:/kodo4目錄下(后面將使用%KODO_HOME%來引用這個目錄)，打開%KODO_HOME%/bin/kodocmd.cmd文件，將其中的KODODIR設置為您的Kodo的安裝目錄，將JDKHOME設置為Java的安裝目錄。

安裝Weblogic9

　　Kodo EJB在JAVA EE環境下運行時需要EJB容器支持EJB3標準，BEA最新發布的Weblogic9服務器就支持EJB3標準，因此我們選擇Weblogic9作為演示時使用的目標服務器。大家可以到http://www.bea.com下載Weblogic9，然后將Weblogic9安裝到自己的機器上。

　　[注]本文中的實例是實現可遠程訪問的EJB實例，因此你可以將Weblogic9安裝到其他機器上，不過客戶端調用的時候需要增加一些環境變量，請參考后面的說明。

開發Kodo EJB應用

　　由于篇幅的關系，我們直接使用《Kodo EJB：符合EJB3規范的持久層框架》一文中已經創建好的例子，包括環境準備、持久化類創建、數據庫創建等工作，下面的章節中將盡量不再重復《Kodo EJB：符合EJB3規范的持久層框架》一文中已經提到的步驟，而是重點描述需要額外完成的工作。

　　在EJB開發中，我們通常都采用Session Façade設計模式，因此下面的例子也使用了這種設計模式來封裝Kodo EJB應用。

　　我們使用一個無狀態的Session Bean來封裝對Book類的所有操作，由于Kodo EJB應用中需要開發者完成kodo.persistence.EntityManagerFactoryImpl的實例到JNDI的綁定，我們把這部分工作訪在Session Bean中完成，下面是Session Bean的接口和實現的全部代碼，請注意代碼中增加的注釋，他們有助于您了解Kodo EJB如何工作的。

BookBean類

　　下面是BookBean類的源代碼，請大家特別注意BookBean類中的setSessionContext方法，其中的代碼將
kodo.persistence.EntityManagerFactoryImpl的實例綁定到JNDI上。

package org.vivianj.kodo.examples.ejb.stateless;
import java.rmi.RemoteException;
import java.util.Collection;
import javax.ejb.EJBException;
import javax.ejb.SessionBean;
import javax.ejb.SessionContext;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.PersistenceContextType;
import javax.persistence.Query;
import kodo.persistence.KodoPersistence;
import org.vivianj.kodo.examples.beans.Book;
/**
* BookBean 提供Session Bean的實現類
*/
public class BookBean implements SessionBean {
protected SessionContext ctx;
private EntityManagerFactory emf;
/**
* getBookById 根據Book對象的id屬性查找、返回符合條件的Book對象
*
* @param id
*      Book對象的編號
* @return 編號為id的Book對象
* @throws RemoteException
*/
public Book getBookById(int id) throws RemoteException {
/* 獲得EJB的實體管理器 */
EntityManager em = emf
.createEntityManager(PersistenceContextType.EXTENDED);
try {
/* 開始事務 */
em.getTransaction().begin();
/* 處理業務 */
Book book = em.find(Book.class, id);
/* 結束事務 */
em.getTransaction().commit();
return book;
} finally {
/* 關閉EJB實體管理器 */
em.close();
}
}
/**
* updateBook 更新Book對象的信息
*
* @param book
*      需要更新的Book對象
* @throws RemoteException
*/
public void updateBook(Book book) throws RemoteException {
/* 獲得EJB的實體管理器 */
EntityManager em = emf.getEntityManager();
try {
/* 開始事務 */
em.getTransaction().begin();
/* 處理業務 */
em.merge(book);
/* 結束事務 */
em.getTransaction().commit();
} finally {
/* 關閉EJB實體管理器 */
em.close();
}
}
/**
* createBook 方法用于持久化新的Book對象
*
* @param book
*      被持久化的Book對象
* @throws RemoteException
*/
public void createBook(Book book) throws RemoteException {
/* 獲得EJB的實體管理器 */
EntityManager em = emf.getEntityManager();
try {
/* 開始事務 */
em.getTransaction().begin();
/* 處理業務 */
em.persist(book);
/* 結束事務 */
em.getTransaction().commit();
} finally {
/* 關閉EJB實體管理器 */
em.close();
}
}
public void deleteBook(Book book) throws RemoteException {
/* 獲得EJB的實體管理器 */
EntityManager em = emf.getEntityManager();
try {
/* 開始事務 */
em.getTransaction().begin();
/* 處理業務 */
Query q = em.createQuery("delete from Book c where c.id = :id");
q.setParameter("id", book.id);
q.executeUpdate();
/* 結束事務 */
em.getTransaction().commit();
} finally {
/* 關閉EJB實體管理器 */
em.close();
}
}
public Collection getBooks(String queryString) throws RemoteException {
/* 獲得EJB的實體管理器 */
EntityManager em = emf.getEntityManager();
try {
/* 開始事務 */
em.getTransaction().begin();
/* 處理業務 */
List allBooks = em.createQuery(queryString).getResultList();
/* 結束事務 */
em.getTransaction().commit();
return allBooks;
} finally {
/* 關閉EJB實體管理器 */
em.close();
}
}
public void setSessionContext(SessionContext ctx) {
this.ctx = ctx;
try {
/* 獲取JAVA EE容器上下文環境 */
Context ejbContext = new InitialContext ();
Object o = null;
try{
/* 根據JNDI查找kodo.persistence.EntityManagerFactoryImpl的實例 */
o = ejbContext.lookup("ejb/kodo/emf");
}catch(Exception e){
/* 如果沒有找到，嘗試將kodo.persistence.EntityManagerFactoryIm
pl的實例綁定到JNDI上 */
EntityManagerFactory emfForEjb =
Persistence.createEntityManagerFactory(null);
ejbContext.bind("ejb/kodo/emf",emfForEjb);
}
if (o == null)
{
/* 如果沒有找到，嘗試再次查找 */
emf = (EntityManagerFactory)ejbContext.lookup("ejb/kodo/emf");
}
else {
emf = (EntityManagerFactory)o;
}
} catch (NamingException e) {
throw new RuntimeException(e);
}
}
public void ejbCreate() throws RemoteException {
}
public void ejbActivate() throws EJBException, RemoteException {
}
public void ejbPassivate() throws EJBException, RemoteException {
}
public void ejbRemove() throws EJBException, RemoteException {
}
public void unsetSessionContext() {
ctx = null;
}
}

BookHome接口

package org.vivianj.kodo.examples.ejb.stateless;
import java.rmi.RemoteException;
import javax.ejb.CreateException;
import javax.ejb.EJBHome;
/**
* BookHome 類提供Session Bean的home接口
*/
public interface BookHome extends EJBHome {
public BookRemote create() throws CreateException, RemoteException;
}

BookRemote接口

package org.vivianj.kodo.examples.ejb.stateless;
import java.rmi.RemoteException;
import java.util.Collection;
import javax.ejb.EJBObject;
import org.vivianj.kodo.examples.beans.Book;
/**
* BookRemote 類提供Session Bean的remote接口
*/
public interface BookRemote extends EJBObject {
public Book getBookById(int id) throws RemoteException;
public void updateBook(Book book) throws RemoteException;
public void createBook(Book book) throws RemoteException;
public void deleteBook(Book book) throws RemoteException;
public Collection getBooks(String queryString) throws RemoteException;
}

編寫EJB描述符文件

　　為了將該Session Bean發布到Weblogic9中，我們還需要提供兩個配置文件：ejb-jar.xml和weblogic-ejb-jar.xml，作者提供的演示實例中，這兩個文件的內容如下，開發者可以根據自己的實際環境進行調整。

ejb-jar.xml

<?xml version="1.0" encoding="UTF-8"?>
<ejb-jar
xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
 http://java.sun.com/xml/ns/j2ee/ejb-jar_2_1.xsd"
version="2.1">
<display-name>Sample Kodo EJB</display-name>
<enterprise-beans>
<session>
<ejb-name>BookEJB</ejb-name>
<home>org.vivianj.kodo.examples.ejb.stateless.BookHome</home>
<remote>org.vivianj.kodo.examples.ejb.stateless.BookRemote</remote>
<ejb-class>org.vivianj.kodo.examples.ejb.stateless.BookBean</ejb-class>
<session-type>Stateless</session-type>
<transaction-type>Container</transaction-type>
</session>
</enterprise-beans>
<assembly-descriptor>
<container-transaction>
<method>
<ejb-name>BookEJB</ejb-name>
<method-name>*</method-name>
</method>
<trans-attribute>Required</trans-attribute>
</container-transaction>
</assembly-descriptor>
</ejb-jar>

weblogic-ejb-jar.xml

<?xml version="1.0"?>
<weblogic-ejb-jar
xmlns="http://www.bea.com/ns/weblogic/90"
xmlns:j2ee="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.bea.com/ns/weblogic/90
http://www.bea.com/ns/weblogic/90/weblogic-ejb-jar.xsd">
<weblogic-enterprise-bean>
<ejb-name>BookEJB</ejb-name>
<jndi-name>ejb/kodo/book</jndi-name>
</weblogic-enterprise-bean>
</weblogic-ejb-jar>

打包部署

　　基于Kodo EJB開發的EJB打包和通常的EJB打包沒有什么特別，部署過程也沒有什么特別，比較簡單的方式是使用配置工具創建新的域后，將打包好的EJB jar文件直接拷貝到域目錄下的autodeploy目錄下。

　　完整地打包部署過程這里不再贅述，如果大家還不是十分熟悉，請大家參考Weblogic Server的在線幫助文檔http://edocs.bea.com/wls/docs91/index.html。

　　在這里要給大家介紹的是創建Weblogic9域后如何配置Kodo的兩部分內容：

安裝Kodo
Windows平臺下創建Weblogic9域后，可以在該域所在目錄下找到bin目錄下的setDomainEnv.cmd文件。打開該文件，在其中找到set PRE_CLASSPATH=這一行，這里假如地jar文件將被加入Weblogic9服務器的啟動CLASSPATH中，因此我們把%KODO_HOME%/lib目錄下所有jar文件增加到PRE_CLASSPATH中。下面是作者的設置情況（沒有全部填寫完整，請開發者根據實際情況填寫完整）。

set PRE_CLASSPATH= F:/OpenSource/kodo-4.0.0EA4/lib/kodo.jar; F:/OpenSource/kodo-4.0.0EA4/lib/jta-spec1_0_1.jar;F:/OpenSource/kodo-4.0.0EA4/lib/jca1.0.jar;F:/OpenSource/kodo-4.0.0EA4/lib/jdo-2.0.jar;

可選擇的，你可以將數據庫服務器的驅動jar和其他應用中需要的jar文件放在這個變量下。

提供Kodo的license

Kodo使用時需要提供License文件，在《Kodo EJB：符合EJB3規范的持久層框架》一文中，我們知道Kodo的License信息保存在應用的META-INF目錄中的kodo.xml文件中，和應用一起使用，可是在JAVA EE環境下，我們是將kodo.persistence.EntityManagerFactoryImpl的實例綁定到JNDI服務上，這個過程是服務器完成的，將License放在EJB包中并不能讓服務器獲取License的信息，查看Kodo的幫助文檔，也沒有看到相應的實施指南，不過作者經過測試后發現下面的方法可以完成這部分工作。

準備一個license.jar文件
license.jar中包含META-INF目錄，該目錄下包含有提供Kodo License的kodo.xml文件。license.jar文件的結構如下：
將該jar文件加入到Weblogic域的CLASSPATH中

請參考前面一步“安裝Kodo”的步驟將license.jar文件加入Weblogic域的CLASSPATH中。

測試

　　現在，啟動服務器，編寫段簡單的測試代碼，看看EJB是否能夠正常開始工作，下面這段代碼可以用于測試從EJB中查找符合要求的Book對象并打印它的name屬性。

/* 提供Weblogic服務器的信息 */
Hashtable<String,String> h = new Hashtable<String,String>();
h.put(Context.INITIAL_CONTEXT_FACTORY,
"weblogic.jndi.WLInitialContextFactory");
h.put(Context.PROVIDER_URL, "t3://localhost:7001");
/* 獲取指定服務器的上下文路徑 */
Context ctx = new InitialContext(h);
/* 從JNDI中獲取Session Bean的home接口 */
Object o = ctx.lookup("ejb/kodo/book");
BookHome home = (BookHome) PortableRemoteObject.narrow(o,BookHome.class);
/* 獲得Session Bean的remote接口 */
BookRemote remote = home.create();
/* 調用業務方法 */
System.out.println(remote.getBookById(1).name);

　　執行客戶端的時候，請將%KODO_HOME%/lib目錄下的jar文件和Weblogic服務器安裝目錄下的server/lib/weblogic.jar文件都放在CLASSPATH中。

總結

　　在EJB3的標準中，EJB3應用既可以用于Java SE環境中，同時還可以用于Java EE環境下使用。Kodo EJB中提供了兩種不同的方式支持在Java EE環境下使用：JCA和JNDI，其中JCA方式比較簡單，而JNDI方式則能夠提供更好的靈活性。

　　在本文中，作者以一個簡單的例子說明了在Weblogic9中如何將Kodo EJB中kodo.persistence.EntityManagerFactoryImpl的實例綁定到JNDI上，通過JNDI訪問Kodo EJB應用中的持久化類。

參考資源:

　　EJB3規范：http://jcp.org/aboutJava/communityprocess/pfd/jsr220/index.html
JDO2規范：http://jcp.org/aboutJava/communityprocess/pfd/jsr243/index.html
Kodo在線文檔：http://solarmetric.com/kodo/Documentation/4.0.0EA4/docs/full/html/index.html
Weblogic9在線文檔:http://edocs.bea.com/wls/docs91/index.html

　　下載資源：kodoejb-JavaEE.jar

posted on 2007-04-17 11:43 張金鵬閱讀(136) 評論(0) 編輯收藏

新用戶注冊刷新評論列表


只有注冊用戶登錄后才能發表評論。




網站導航: 博客園 IT新聞 Chat2DB C++博客博問管理

細心!用心!耐心!

常用鏈接

留言簿(5)

隨筆分類

文章分類

文章檔案

收藏夾

搜索

最新評論