EJB - 訊息驅動Bean

訊息驅動Bean是一種企業Bean，當它從佇列或主題接收訊息時，由EJB容器呼叫。訊息驅動Bean是無狀態Bean，用於非同步執行任務。

為了演示訊息驅動Bean的使用，我們將使用EJB持久化章節，我們需要執行以下任務：

步驟1 - 在資料庫中建立表（參見EJB-持久化章節）。
步驟2 - 建立與表對應的實體類（參見EJB-持久化章節）。
步驟3 - 建立資料來源和持久化單元（參見EJB-持久化章節）。
步驟4 - 建立一個具有EntityManager例項的無狀態EJB（參見EJB-持久化章節）。
步驟5 - 更新無狀態ejb。新增方法，透過實體管理器從資料庫新增和獲取記錄（參見EJB-持久化章節）。
步驟6 - 在JBoss預設應用程式目錄中建立一個名為BookQueue的佇列。
步驟7 - 一個基於控制檯的應用程式客戶端將向此佇列傳送訊息。
步驟8 - 建立一個訊息驅動Bean，它將使用無狀態Bean來持久化客戶端資料。
步驟9 - JBoss的EJB容器將呼叫上述訊息驅動Bean，並將客戶端傳送的訊息傳遞給它。

建立佇列

如果在<JBoss安裝資料夾> > server > default > deploy資料夾中不存在，則建立一個名為jbossmq-destinations-service.xml的檔案。

在這裡，我們建立一個名為BookQueue的佇列：

jbossmq-destinations-service.xml

<mbean code="org.jboss.mq.server.jmx.Queue"  
   name="jboss.mq.destination:service=Queue,name=BookQueue">  
   <depends optional-attribute-name="DestinationManager">
      jboss.mq:service=DestinationManager
   </depends>  
</mbean>

啟動JBoss時，您將在JBoss日誌中看到類似的條目。

...
10:37:06,167 INFO  [QueueService] Queue[/queue/BookQueue] started, fullSize=200000, pageSize=2000, downCacheSize=2000
...

建立訊息驅動Bean

@MessageDriven(
   name = "BookMessageHandler",
   activationConfig = {
      @ActivationConfigProperty( propertyName = "destinationType", 
                                 propertyValue = "javax.jms.Queue"),
      @ActivationConfigProperty( propertyName = "destination", 
                                 propertyValue ="/queue/BookQueue")
   }
)
public class LibraryMessageBean implements MessageListener {
 
   @Resource
   private MessageDrivenContext mdctx;  
 
   @EJB
   LibraryPersistentBeanRemote libraryBean;
 
   public LibraryMessageBean() {        
   }
 
   public void onMessage(Message message) {
   }
}

LibraryMessageBean使用@MessageDriven註解進行註解，以將其標記為訊息驅動Bean。
其屬性定義為destinationType - Queue和destination - /queue/BookQueue。
它實現了MessageListener介面，該介面公開了onMessage方法。
它具有MessgeDrivenContext作為資源。
LibraryPersistentBeanRemote無狀態Bean在此Bean中注入，用於持久化目的。

構建EjbComponent專案並將其部署到JBoss。構建和部署EJB模組後，我們需要一個客戶端向JBoss佇列傳送訊息。

示例應用程式

讓我們建立一個測試EJB應用程式來測試訊息驅動Bean。

步驟	描述
1	如EJB - 建立應用程式章節所述，在com.tutorialspoint.entity包下建立一個名為EjbComponent的專案。您也可以使用EJB - 建立應用程式章節中建立的專案，以便理解EJB持久化概念。
2	在com.tutorialspoint.entity包下建立Book.java，如EJB-持久化章節中建立的那樣。
3	建立LibraryPersistentBean.java和LibraryPersistentBeanRemote，如EJB-持久化章節中建立的那樣。
4	在EjbComponent > setup資料夾中建立jboss-ds.xml，在EjbComponent > src > conf資料夾中建立persistence.xml。這些資料夾可以在Netbeans的檔案選項卡中看到，如EJB-持久化章節中建立的那樣。
5	在com.tutorialspoint.messagebean包下建立LibraryMessageBean.java，並按如下所示修改它。
6	如上所述在JBoss中建立BookQueue佇列。
7	清理並構建應用程式，以確保業務邏輯按要求工作。
8	最後，將應用程式以jar檔案的形式部署到JBoss應用伺服器。如果JBoss應用伺服器尚未啟動，它將自動啟動。
9	現在，建立EJB客戶端，一個基於控制檯的應用程式，與EJB - 建立應用程式章節中建立訪問EJB的客戶端主題中解釋的方式相同。按如下所示修改它。

EJBComponent（EJB模組）

LibraryMessageBean.java

package com.tutorialspoint.messagebean;
 
import com.tutorialspoint.entity.Book;
import com.tutorialspoint.stateless.LibraryPersistentBeanRemote;
import javax.annotation.Resource;
import javax.ejb.ActivationConfigProperty;
import javax.ejb.EJB;
import javax.ejb.MessageDriven;
import javax.ejb.MessageDrivenContext;
import javax.jms.JMSException;
import javax.jms.Message;
import javax.jms.MessageListener;
import javax.jms.ObjectMessage;
 
@MessageDriven(
   name = "BookMessageHandler",
   activationConfig = {
      @ActivationConfigProperty( propertyName = "destinationType", 
                                 propertyValue = "javax.jms.Queue"),
      @ActivationConfigProperty( propertyName = "destination", 
                                 propertyValue ="/queue/BookQueue")
   }
)
public class LibraryMessageBean implements MessageListener {
 
   @Resource
   private MessageDrivenContext mdctx;  
 
   @EJB
   LibraryPersistentBeanRemote libraryBean;
 
   public LibraryMessageBean() {        
   }
 
   public void onMessage(Message message) {
      ObjectMessage objectMessage = null;
      try {
         objectMessage = (ObjectMessage) message;
         Book book = (Book) objectMessage.getObject(); 
         libraryBean.addBook(book);
 
      } catch (JMSException ex) {
         mdctx.setRollbackOnly();
      }       
   }   
}

EJBTester（EJB客戶端）

EJBTester.java

package com.tutorialspoint.test;
   
import com.tutorialspoint.entity.Book;
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.jms.ObjectMessage;
import javax.jms.Queue;
import javax.jms.QueueConnection;
import javax.jms.QueueConnectionFactory;
import javax.jms.QueueSender;
import javax.jms.QueueSession;
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.testMessageBeanEjb();
   }
   
   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 testMessageBeanEjb() {
 
      try {
         int choice = 1; 
         Queue queue = (Queue) ctx.lookup("/queue/BookQueue");
         QueueConnectionFactory factory =
         (QueueConnectionFactory) ctx.lookup("ConnectionFactory");
         QueueConnection connection =  factory.createQueueConnection();
         QueueSession session = 
         connection.createQueueSession(false, QueueSession.AUTO_ACKNOWLEDGE);
         QueueSender sender = session.createSender(queue);
 
         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);
               ObjectMessage objectMessage = 
                  session.createObjectMessage(book);
               sender.send(objectMessage); 
            } else if (choice == 2) {
               break;
            }
         }
 
         LibraryPersistentBeanRemote libraryBean = 
         (LibraryPersistentBeanRemote)
         ctx.lookup("LibraryPersistentBean/remote");
 
         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()方法中，使用名稱 - "/queue/BookQueue"執行jndi查詢以獲取JBoss中可用佇列的引用。然後使用佇列會話建立傳送者。
然後向用戶顯示一個圖書館商店使用者介面，並要求他/她輸入選擇。
如果使用者輸入1，系統將詢問書名，傳送者將書名傳送到佇列。當JBoss容器在佇列中接收此訊息時，它將呼叫我們訊息驅動Bean的onMessage方法。然後，我們的訊息驅動Bean使用有狀態會話Bean addBook()方法儲存書籍。會話Bean透過EntityManager呼叫將書籍持久化到資料庫。
如果使用者輸入2，則將使用名稱 - "LibraryStatefulSessionBean/remote"再次執行另一個jndi查詢以獲取遠端業務物件（有狀態EJB），然後列出書籍。

執行客戶端以訪問EJB

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

驗證Netbeans控制檯中的以下輸出：

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

上面顯示的輸出表明我們的訊息驅動Bean正在接收訊息並將書籍儲存到永續性儲存中，並且書籍是從資料庫中檢索的。

列印頁面