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;