EJB - 回撥



回撥是一種機制,它可以攔截企業 Bean 的生命週期。EJB 3.0 規範指定了回撥,為此建立了回撥處理程式方法。EJB 容器呼叫這些回撥。我們可以在 EJB 類本身或單獨的類中定義回撥方法。EJB 3.0 提供了許多用於回撥的註解。

以下是無狀態 Bean 的回撥註解列表:

註解 描述
@PostConstruct 在第一次建立 Bean 時呼叫。
@PreDestroy 在 Bean 從 Bean 池中移除或被銷燬時呼叫。

以下是有狀態 Bean 的回撥註解列表:

註解 描述
@PostConstruct 在第一次建立 Bean 時呼叫。
@PreDestroy 在 Bean 從 Bean 池中移除或被銷燬時呼叫。
@PostActivate 在載入 Bean 以供使用時呼叫。
@PrePassivate 在將 Bean 放回 Bean 池時呼叫。

以下是訊息驅動 Bean 的回撥註解列表:

註解 描述
@PostConstruct 在第一次建立 Bean 時呼叫。
@PreDestroy 在 Bean 從 Bean 池中移除或被銷燬時呼叫。

以下是實體 Bean 的回撥註解列表:

註解 描述
@PrePersist 在資料庫中建立實體時呼叫。
@PostPersist 在資料庫中建立實體後呼叫。
@PreRemove 在從資料庫中刪除實體時呼叫。
@PostRemove 在從資料庫中刪除實體後呼叫。
@PreUpdate 在更新資料庫中的實體之前呼叫。
@PostLoad 在從資料庫中提取記錄並載入到實體中時呼叫。

示例應用程式

讓我們建立一個測試 EJB 應用程式來測試 EJB 中的各種回撥。

步驟 描述
1

根據EJB - 建立應用程式章節中所述,建立一個名為EjbComponent的專案,位於包com.tutorialspoint.stateless下。您也可以使用EJB - 永續性章節中建立的專案,在本節中向 EJB 新增各種回撥。

2

根據EJB - 建立應用程式章節中所述,建立LibrarySessionBean.javaLibrarySessionBeanRemote。保持其餘檔案不變。

3

使用EJB - 永續性章節中建立的 Bean。新增如下所示的回撥方法。保持其餘檔案不變。

4

在包com.tutorialspoint.callback下建立一個名為BookCallbackListener的 Java 類。此類將演示回撥方法的分離。

5

清理並構建應用程式,以確保業務邏輯按要求工作。

6

最後,將應用程式以 jar 檔案的形式部署到 JBoss 應用伺服器上。如果 JBoss 應用伺服器尚未啟動,它將自動啟動。

7

現在建立 EJB 客戶端,一個基於控制檯的應用程式,方法與EJB - 建立應用程式章節中建立訪問 EJB 的客戶端主題中所述相同。

EJBComponent(EJB 模組)

BookCallbackListener.java

package com.tutorialspoint.callback;

import javax.persistence.PrePersist;
import javax.persistence.PostLoad;
import javax.persistence.PostPersist;
import javax.persistence.PostRemove;
import javax.persistence.PostUpdate;
import javax.persistence.PreRemove;
import javax.persistence.PreUpdate;

import com.tutorialspoint.entity.Book;

public class BookCallbackListener {
    
   @PrePersist
   public void prePersist(Book book) {
      System.out.println("BookCallbackListener.prePersist:" 
         + "Book to be created with book id: "+book.getId());
   }

   @PostPersist
   public void postPersist(Object book) {
      System.out.println("BookCallbackListener.postPersist::"
         + "Book created with book id: "+((Book)book).getId());
   }

   @PreRemove
   public void preRemove(Book book) {
      System.out.println("BookCallbackListener.preRemove:"
         + " About to delete Book: " + book.getId());
   }

   @PostRemove
   public void postRemove(Book book) {
      System.out.println("BookCallbackListener.postRemove::"
         + " Deleted Book: " + book.getId());
   }

   @PreUpdate
   public void preUpdate(Book book) {
      System.out.println("BookCallbackListener.preUpdate::"
         + " About to update Book: " + book.getId());
   }

   @PostUpdate
   public void postUpdate(Book book) {
      System.out.println("BookCallbackListener.postUpdate::"
         + " Updated Book: " + book.getId());
   }

   @PostLoad
   public void postLoad(Book book) {
      System.out.println("BookCallbackListener.postLoad::"
         + " Loaded Book: " + book.getId());
   }
}

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;
   }    
}

LibraryStatefulSessionBean.java

package com.tutorialspoint.stateful;

import java.util.ArrayList;
import java.util.List;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import javax.ejb.PostActivate;
import javax.ejb.PrePassivate;
import javax.ejb.Stateful;

@Stateful
public class LibraryStatefulSessionBean 
   implements LibraryStatefulSessionBeanRemote {
   List<String> bookShelf;    

   public LibraryStatefulSessionBean() {
      bookShelf = new ArrayList<String>();
   }

   public void addBook(String bookName) {
      bookShelf.add(bookName);
   }    

   public List<String> getBooks() {
      return bookShelf;
   }

   @PostConstruct
   public void postConstruct() {
      System.out.println("LibraryStatefulSessionBean.postConstruct::"
         + " bean created.");
   }

   @PreDestroy
   public void preDestroy() {
      System.out.println("LibraryStatefulSessionBean.preDestroy:"
         + " bean removed.");
   }

   @PostActivate
   public void postActivate() {
      System.out.println("LibraryStatefulSessionBean.postActivate:"
         + " bean activated.");
   }

   @PrePassivate
   public void prePassivate() {
      System.out.println("LibraryStatefulSessionBean.prePassivate:"
         + " bean passivated.");
   }    
}

LibraryStatefulSessionBeanRemote.java

package com.tutorialspoint.stateful;

import java.util.List;
import javax.ejb.Remote;

@Remote
public interface LibraryStatefulSessionBeanRemote {
   void addBook(String bookName);
   List getBooks();
}

LibraryPersistentBean.java

package com.tutorialspoint.stateless;

import com.tutorialspoint.entity.Book;
import java.util.List;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import javax.ejb.Stateless;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;

@Stateless
public class LibraryPersistentBean 
   implements LibraryPersistentBeanRemote {
    
   public LibraryPersistentBean() {}

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

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

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

   @PostConstruct
   public void postConstruct() {
      System.out.println("postConstruct:: LibraryPersistentBean session bean"
         + " created with entity Manager object: ");
   }

   @PreDestroy
   public void preDestroy() {
      System.out.println("preDestroy: LibraryPersistentBean session"
      + " bean is removed ");
   }
}

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();
    
}
  • 一旦您在 JBOSS 上部署 EjbComponent 專案,請注意 jboss 日誌。

  • JBoss 自動為我們的會話 Bean 建立了一個 JNDI 條目 - LibraryPersistentBean/remote

  • 我們將使用此查詢字串來獲取型別為 com.tutorialspoint.stateless.LibraryPersistentBeanRemote 的遠端業務物件。

JBoss 應用伺服器日誌輸出

...
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=LibraryPersistentBean,service=EJB3
16:30:02,723 INFO  [EJBContainer] STARTED EJB: com.tutorialspoint.stateless.LibrarySessionBeanRemote ejbName: LibraryPersistentBean
...   

EJBTester(EJB 客戶端)

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.stateful.LibrarySessionBeanRemote;

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 物件。

  • 在 testStatelessEjb() 方法中,使用名稱“LibrarySessionBean/remote”進行 jndi 查詢以獲取遠端業務物件(無狀態 EJB)。

  • 然後向用戶顯示一個圖書館商店使用者介面,並要求他/她輸入選擇。

  • 如果使用者輸入 1,系統將詢問書名並使用無狀態會話 Bean addBook() 方法儲存書籍。會話 Bean 將書籍儲存在資料庫中。

  • 如果使用者輸入 2,系統將使用無狀態會話 Bean getBooks() 方法檢索書籍並退出。

執行客戶端以訪問 EJB

在專案資源管理器中找到 EJBTester.java。右鍵單擊 EJBTester 類並選擇執行檔案

驗證 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: 13 seconds)

JBoss 應用伺服器日誌輸出

您可以在 JBoss 日誌中找到以下回調條目

14:08:34,293 INFO  [STDOUT] postConstruct:: LibraryPersistentBean session bean created with entity Manager object
...
16:39:09,484 INFO  [STDOUT] BookCallbackListener.prePersist:: Book to be created with book id: 0
16:39:09,531 INFO  [STDOUT] BookCallbackListener.postPersist:: Book created with book id: 1
16:39:09,900 INFO  [STDOUT] BookCallbackListener.postLoad:: Loaded Book: 1
...
廣告