EJB - 消息驱动 Bean

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

为了演示消息驱动 bean 的使用，我们将利用 EJB 持久性章节，并且需要执行以下任务 −

• 步骤 1 − 在数据库中创建表(请参阅EJB-Persistence章节)。

• 步骤 2 − 创建表对应的Entity类(参考EJB-Persistence章节)。

• 步骤 3 − 创建数据源和持久性单元(请参阅EJB-持久性章节)。

• 步骤 4 − 创建一个具有 EntityManager 实例的无状态 EJB(请参阅EJB-Persistence章节)。

• 步骤 5 − 更新无状态 ejb.Add 方法以通过实体管理器添加记录和从数据库获取记录(请参阅EJB-Persistence章节)。

• 步骤 6 − 在 JBoss default 应用程序目录中创建一个名为 BookQueue 的队列。

• 步骤 7 − 基于控制台的应用程序客户端将向此队列发送消息。

• 步骤 8 − 创建一个消息驱动 bean，它将使用无状态 bean 来保存客户端数据。

• 步骤 9 − jboss 的 EJB 容器将调用上面的消息驱动 bean 并将客户端将发送到的消息传递给它。

创建队列

如果 <JBoss Installation Folder> > 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 作为资源。

• LibraryPercientBeanRemote 无状态 bean 被注入到此 bean 中以实现持久性目的。

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

示例应用程序

让我们创建一个测试 EJB 应用程序来测试消息驱动 Bean。

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 
1. Add Book
2. Exit 
Enter 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 正在接收消息并将书籍存储在持久存储中，并且从数据库中检索书籍。