Ejb 简明教程

EJB - Persistence

在 EJB 2.0 中使用的 EJB 3.0 实体 bean 在很大程度上已被持久性机制取代。现在实体 bean 是一个简单的 POJO，具有与表的映射。

以下是持久性 API 中的关键参与者 −

Entity − 表示数据存储记录的持久对象。它是可序列化的。
EntityManager − 持久性接口，用于在持久对象（实体）上执行诸如添加/删除/更新/查找的数据操作。它还有助于使用 Query 接口执行查询。

Persistence unit (persistence.xml) − 持久性单元描述持久性机制的属性。

Data Source (*ds.xml) − 数据源描述与数据存储相关的属性，例如连接 URL。用户名、密码等。

要演示 EJB 持久性机制，我们需要执行以下任务 −

Step 1 − 在数据库中创建表。
Step 2 − 创建与表对应的实体类。
Step 3 − 创建数据源和持久性单元。
Step 4 − 创建具有 EntityManager 实例的无状态 EJB。
Step 5 − 更新无状态 EJB。添加方法通过实体管理器向数据库添加记录和从数据库获取记录。
Step 6 − 一个基于控制台的应用程序客户端将访问无状态 EJB，以将数据保留到数据库中。

Create Table

在默认数据库 postgres 中创建一个表 books 。

CREATE TABLE books (
   id     integer PRIMARY KEY,
   name   varchar(50)
);

Create Entity class

//mark it entity using Entity annotation
//map table name using Table annotation
@Entity
@Table(name="books")
public class Book implements Serializable{

   private int id;
   private String name;

   public Book() {
   }

   //mark id as primary key with autogenerated value
   //map database column id with id field
   @Id
   @GeneratedValue(strategy= GenerationType.IDENTITY)
   @Column(name="id")
   public int getId() {
      return id;
   }
   ...
}

Create DataSource and Persistence Unit

DataSource (jboss-ds.xml)

<?xml version = "1.0" encoding = "UTF-8"?>
<datasources>
   <local-tx-datasource>
      <jndi-name>PostgresDS</jndi-name>
      <connection-url>jdbc:postgresql://localhost:5432/postgres</connection-url>
      <driver-class>org.postgresql.driver</driver-class>
      <user-name>sa</user-name>
      <password>sa</password>
      <min-pool-size>5</min-pool-size>
      <max-pool-size>20</max-pool-size>
      <idle-timeout-minutes>5</idle-timeout-minutes>
   </local-tx-datasource>
</datasources>

Persistence Unit (persistence.xml)

<persistence version = "1.0" xmlns = "http://java.sun.com/xml/ns/persistence" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd">

   <persistence-unit name = "EjbComponentPU" transaction-type = "JTA">
      <jta-data-source>java:/PostgresDS</jta-data-source>
      <exclude-unlisted-classes>false</exclude-unlisted-classes>
      <properties/>
   </persistence-unit>

   <persistence-unit name = "EjbComponentPU2" transaction-type = "JTA">
      <provider>org.hibernate.ejb.HibernatePersistence</provider>
      <jta-data-source>java:/PostgresDS</jta-data-source>
      <exclude-unlisted-classes>false</exclude-unlisted-classes>

      <properties>
         <property name="hibernate.hbm2ddl.auto" value="update"/>
      </properties>
   </persistence-unit>

</persistence>

Create Stateless EJB Having EntityManager Instance

@Stateless
public class LibraryPersistentBean implements LibraryPersistentBeanRemote {

   //pass persistence unit to entityManager.
   @PersistenceContext(unitName="EjbComponentPU")
   private EntityManager entityManager;

   public void addBook(Book book) {
      entityManager.persist(book);
   }

   public List<Book> getBooks() {
      return entityManager.createQuery("From Books").getResultList();
   }
   ...
}

在构建 EJB 模块后，我们需要一个客户端来访问无状态 bean，我们将在下一节中创建。

Example Application

让我们创建一个测试 EJB 应用程序，以测试 EJB 持久机制。

Step	Description
1	正如 EJB- 创建应用程序章节中说明的那样，使用包 com.tutorialspoint.entity 下的名为 EjbComponent 的项目，创建一个项目。还可以使用在 EJB- 创建应用程序章节中创建的项目，以便本章理解 EJB 持久化概念。
2	在包 com.tutorialspoint.entity 中创建 Book.java，然后按照如下所示修改。
3	正如在 EJB- 创建应用程序章节中说明的那样，创建 LibraryPersistentBean.java 和 LibraryPersistentBeanRemote，并对其进行修改如下所示。
4	在EjbComponent > 安装文件夹中创建 jboss-ds.xml，在EjbComponent > src > conf文件夹中创建 persistence.xml。可以从 Netbeans 的文件选项卡中看到这些文件夹。对这些文件进行修改，如上所示。
5	清理并构建应用程序以确保业务逻辑按需求工作。
6	最后，以 jar 文件的形式将应用程序部署在 JBoss 应用程序服务器上。如果 JBoss 应用程序服务器尚未启动，它会自动启动。
7	现在按照 EJB - 创建应用程序章节的主题 Create Client to access EJB 中的说明，以相同的方式创建 EJB 客户端（控制台应用程序）。按照如下所示修改。

EJBComponent (EJB Module)

Book.java

package com.tutorialspoint.entity;

import java.io.Serializable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EntityListeners;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Entity
@Table(name="books")
public class Book implements Serializable{

   private int id;
   private String name;

   public Book() {
   }

   @Id
   @GeneratedValue(strategy= GenerationType.IDENTITY)
   @Column(name="id")
   public int getId() {
      return id;
   }

   public void setId(int id) {
      this.id = id;
   }

   public String getName() {
      return name;
   }

   public void setName(String name) {
      this.name = name;
   }
}

LibraryPersistentBeanRemote.java

package com.tutorialspoint.stateless;

import com.tutorialspoint.entity.Book;
import java.util.List;
import javax.ejb.Remote;

@Remote
public interface LibraryPersistentBeanRemote {

   void addBook(Book bookName);

   List<Book> getBooks();

}

LibraryPersistentBean.java

package com.tutorialspoint.stateless;

import com.tutorialspoint.entity.Book;
import java.util.List;
import javax.ejb.Stateless;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;

@Stateless
public class LibraryPersistentBean implements LibraryPersistentBeanRemote {

   public LibraryPersistentBean() {
   }

   @PersistenceContext(unitName="EjbComponentPU")
   private EntityManager entityManager;

   public void addBook(Book book) {
      entityManager.persist(book);
   }

   public List<Book> getBooks() {
      return entityManager.createQuery("From Book").getResultList();
   }
}

在 JBOSS 上部署 EjbComponent 项目后，请注意 jboss 日志。
JBoss 已自动为我们的会话 bean 创建了一个 JNDI 条目 - LibraryPersistentBean/remote 。
我们将使用此查找字符串来获取类型为的远程业务对象- com.tutorialspoint.stateless.LibraryPersistentBeanRemote

JBoss Application Server Log Output

...
16:30:01,401 INFO  [JndiSessionRegistrarBase] Binding the following Entries in Global JNDI:
   LibraryPersistentBean/remote - EJB3.x Default Remote Business Interface
   LibraryPersistentBean/remote-com.tutorialspoint.stateless.LibraryPersistentBeanRemote - EJB3.x Remote Business Interface
16:30:02,723 INFO  [SessionSpecContainer] Starting jboss.j2ee:jar=EjbComponent.jar,name=LibraryPersistentBeanRemote,service=EJB3
16:30:02,723 INFO  [EJBContainer] STARTED EJB: com.tutorialspoint.stateless.LibraryPersistentBeanRemote ejbName: LibraryPersistentBean
16:30:02,731 INFO  [JndiSessionRegistrarBase] Binding the following Entries in Global JNDI:

   LibraryPersistentBean/remote - EJB3.x Default Remote Business Interface
   LibraryPersistentBean/remote-com.tutorialspoint.stateless.LibraryPersistentBeanRemote - EJB3.x Remote Business Interface
...

EJBTester (EJB Client)

jndi.properties

java.naming.factory.initial=org.jnp.interfaces.NamingContextFactory
java.naming.factory.url.pkgs=org.jboss.naming:org.jnp.interfaces
java.naming.provider.url=localhost

这些属性被用于初始化java命名服务的InitialContext对象。
InitialContext对象将被用于查找无状态会话bean。

EJBTester.java

package com.tutorialspoint.test;

import com.tutorialspoint.stateless.LibraryPersistentBeanRemote;
import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;
import java.util.Properties;
import javax.naming.InitialContext;
import javax.naming.NamingException;

public class EJBTester {

   BufferedReader brConsoleReader = null;
   Properties props;
   InitialContext ctx;
   {
      props = new Properties();
      try {
         props.load(new FileInputStream("jndi.properties"));
      } catch (IOException ex) {
         ex.printStackTrace();
      }
      try {
         ctx = new InitialContext(props);
      } catch (NamingException ex) {
         ex.printStackTrace();
      }
      brConsoleReader =
      new BufferedReader(new InputStreamReader(System.in));
   }

   public static void main(String[] args) {

      EJBTester ejbTester = new EJBTester();

      ejbTester.testEntityEjb();
   }

   private void showGUI() {
      System.out.println("**********************");
      System.out.println("Welcome to Book Store");
      System.out.println("**********************");
      System.out.print("Options \n1. Add Book\n2. Exit \nEnter Choice: ");
   }

   private void testEntityEjb() {

      try {
         int choice = 1;

         LibraryPersistentBeanRemote libraryBean =
         LibraryPersistentBeanRemote)ctx.lookup("LibraryPersistentBean/remote");

         while (choice != 2) {
            String bookName;
            showGUI();
            String strChoice = brConsoleReader.readLine();
            choice = Integer.parseInt(strChoice);
            if (choice == 1) {
               System.out.print("Enter book name: ");
               bookName = brConsoleReader.readLine();
               Book book = new Book();
               book.setName(bookName);
               libraryBean.addBook(book);
            } else if (choice == 2) {
               break;
            }
         }

         List<Book> booksList = libraryBean.getBooks();

         System.out.println("Book(s) entered so far: " + booksList.size());
         int i = 0;
         for (Book book:booksList) {
            System.out.println((i+1)+". " + book.getName());
            i++;
         }
      } catch (Exception e) {
         System.out.println(e.getMessage());
         e.printStackTrace();
      }finally {
         try {
            if(brConsoleReader !=null) {
               brConsoleReader.close();
            }
         } catch (IOException ex) {
            System.out.println(ex.getMessage());
         }
      }
   }
}

EJBTester 执行以下任务。

从jndi.properties加载属性并初始化InitialContext对象。
在 testStatefulEjb() 方法中，使用名称“LibraryStatefulSessionBean/remote”进行 jndi 查找，以获取远程业务对象（状态会话 bean）。
然后向用户显示库存储用户界面，并要求其输入选择。
如果用户输入 1，系统会要求输入书名，并使用无状态会话 bean addBook() 方法保存这本书。会话 Bean 正在通过 EntityManager 调用在数据库中保留这本书。
如果用户输入 2，系统使用状态会话 bean getBooks() 方法检索书籍并退出。
然后使用名称为“LibraryStatelessSessionBean/remote”执行另一个 jndi 查找，以再次获取远程业务对象（无状态 EJB），并列出书目。

Run Client to Access EJB

在项目浏览器中找到EJBTester.java。右键单击EJBTester类并选择 run file 。

在 Netbeans 控制台中验证以下输出 −

run:
**********************
Welcome to Book Store
**********************
Options
1. Add Book
2. Exit
Enter Choice: 1
Enter book name: Learn Java
**********************
Welcome to Book Store
**********************
Options
1. Add Book
2. Exit
Enter Choice: 2
Book(s) entered so far: 1
1. learn java
BUILD SUCCESSFUL (total time: 15 seconds)

Run Client Again to Access EJB

在访问 EJB 之前重新启动 JBoss。

在项目浏览器中找到EJBTester.java。右键单击EJBTester类并选择 run file 。

在Netbeans控制台中验证以下输出。

run:
**********************
Welcome to Book Store
**********************
Options
1. Add Book
2. Exit
Enter Choice: 1
Enter book name: Learn Spring
**********************
Welcome to Book Store
**********************
Options
1. Add Book
2. Exit
Enter Choice: 2
Book(s) entered so far: 2
1. learn java
2. Learn Spring
BUILD SUCCESSFUL (total time: 15 seconds)

上面显示的输出指出书被存储在持久存储中，并从数据库中检索。