服务热线:13616026886

技术文档 欢迎使用技术文档,我们为你提供从新手到专业开发者的所有资源,你也可以通过它日益精进

位置:首页 > 技术文档 > JAVA > 新手入门 > 基础入门 > 查看文档

在java ee环境下使用kodo ejb


  kodo ejb是一个支持对象/关系映射的框架,根据ejb3规范的要求,kodo ejb除了支持在普通java应用中提供轻量级的持久层框架之外,也支持在java ee容器中使用满足重量级企业应用的需求,充分利用java ee容器中提供的优越特性如容器管理事务、远程(remote)访问。

  基于kodo ejb开发的应用支持使用ejb或者jca标准接入到java ee环境中:
  1. jca

    kodo ejb支持jca1.0标准,因此基于kodo ejb开发的应用可以和其他jca资源一样轻松的发布到java ee应用服务器上。

  2. 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的两部分内容:
  1. 安装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文件放在这个变量下。
  1. 提供kodo的license

    kodo使用时需要提供license文件,在《kodo ejb:符合ejb3规范的持久层框架》一文中,我们知道kodo的license信息保存在应用的meta-inf目录中的kodo.xml文件中,和应用一起使用,可是在java ee环境下,我们是将kodo.persistence.entitymanagerfactoryimpl的实例绑定到jndi服务上,这个过程是服务器完成的,将license放在ejb包中并不能让服务器获取license的信息,查看kodo的帮助文档,也没有看到相应的实施指南,不过作者经过测试后发现下面的方法可以完成这部分工作。
    1. 准备一个license.jar文件
      license.jar中包含meta-inf目录,该目录下包含有提供kodo license的kodo.xml文件。license.jar文件的结构如下:

      在java ee环境下使用kodo ejb

    2. 将该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

扫描关注微信公众号