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正在接收消息并将书籍存储到持久性存储中，并且书籍是从数据库中检索的。

打印页面