消息驱动的 Bean（Message Driven Beans）

优质

小牛编辑

143浏览

2023-12-01

消息驱动Bean是一种企业bean，当EJB容器从队列或主题接收消息时由EJB容器调用。消息驱动的bean是一个无状态bean，用于异步执行任务。

为了演示消息驱动bean的使用，我们将使用EJB-persistence章节，我们需要执行以下任务 -

Step 1 - 在数据库中创建表（请参阅EJB-Persistence章节）。
Step 2 - 创建与表对应的实体类（请参阅EJB-Persistence章节）。
Step 3 - 创建数据源和持久性单元（请参阅EJB-Persistence章节）。
Step 4 - 创建具有EntityManager实例的无状态EJB（请参阅EJB-Persistence章节）。
Step 5 - 更新无状态ejb.Add方法以通过实体管理器添加记录并从数据库获取记录（请参阅EJB-Persistence章节）。
Step 6 - 在JBoss default应用程序目录中创建一个名为BookQueue的队列。
Step 7 - 基于控制台的应用程序客户端将向此队列发送消息。
Step 8 - 创建一个消息驱动的bean，它将使用无状态bean来持久保存客户端数据。
Step 9 - jboss的EJB容器将调用上面的消息驱动bean并将其传递给客户端将发送到的消息。

创建队列

如果《JBoss Installation Folder》》 server 》 default 》 deploy文件《JBoss Installation Folder》》 server 》 default 》 deploy不存在，则创建名为jbossmq-destinations-service.xml的文件。

这里我们创建一个名为BookQueue的队列 -

的JBossMQ - 目的地 - 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作为资源。
为了持久性目的，在此bean中注入了LibraryPersistentBeanRemote无状态bean。

构建EjbComponent项目并将其部署在JBoss上。在构建和部署EJB模块之后，我们需要一个客户端向jboss队列发送消息。

例子 Example Application

让我们创建一个测试EJB应用程序来测试Message Driven Bean。

步	描述
1	在EJB - Create Application章节中解释，在cn.xnip.entity包下创建一个名为EjbComponent的项目。您还可以使用在EJB - Create Application的项目EJB - Create Application章节，以便本章了解EJB持久性概念。
2	在EJB-Persistence章节中创建的包Book.java下创建Book.java 。
3	创建在EJB-Persistence章节中创建的LibraryPersistentBean.java和LibraryPersistentBeanRemote 。
4	在EjbComponent 》 setup创建jboss-ds.xml EjbComponent 》 setup文件夹和EjbComponent 》 src 》 conf中的EjbComponent 》 src 》 conf文件夹。这些文件夹可以在EJB-Persistence章节中创建的Netbeans文件选项卡中看到。
5	在cn.xnip.messagebean包下创建LibraryMessageBean.java cn.xnip.messagebean如下所示进行修改。
6	BookQueue在Jboss中创建BookQueue队列。
7	清理并构建应用程序以确保业务逻辑按照要求运行。
8	最后，在JBoss Application Server上以jar文件的形式部署应用程序。如果JBoss Application服务器尚未启动，它将自动启动。
9	现在创建EJB客户端，一个基于控制台的应用程序，其方式与EJB - Create Application章节中主题Create Client to access EJB 。修改它，如下所示。

EJBComponent (EJB Module)

LibraryMessageBean.java

package cn.xnip.messagebean;
import cn.xnip.entity.Book;
import cn.xnip.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 Client)

EJBTester.java

package cn.xnip.test;
import cn.xnip.entity.Book;
import cn.xnip.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类并选择run file 。

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