Ejb 简明教程
EJB - Message Driven Beans
消息驱动 bean 是一种企业 bean,当它从队列或主题收到消息时,由 EJB 容器调用。消息驱动 bean 是一个无状态 bean,用于异步执行任务。
A message driven bean is a type of enterprise bean, which is invoked by EJB container when it receives a message from queue or topic. Message driven bean is a stateless bean and is used to do task asynchronously.
为了演示如何使用消息驱动 bean,我们将利用 EJB 持久性章节,我们需要执行以下任务-
To demonstrate use of message driven bean, we will make use of EJB-persistence chapter and we need to do the following tasks −
-
Step 1 − Create table in database (Refer to EJB-Persistence chapter).
-
Step 2 − Create Entity class corresponding to table (Refer to EJB-Persistence chapter).
-
Step 3 − Create DataSource and Persistence Unit (Refer to EJB-Persistence chapter).
-
Step 4 − Create a stateless EJB having EntityManager instance (Refer to EJB-Persistence chapter).
-
Step 5 − Update stateless ejb.Add methods to add records and get records from database via entity manager (Refer to EJB-Persistence chapter).
-
Step 6 − Create a Queue named BookQueue in JBoss default application directory.
-
Step 7 − A console based application client will send message to this queue.
-
Step 8 − Create a Message driven bean, which will use the stateless bean to persist the client data.
-
Step 9 − EJB Container of jboss will call the above message driven bean and pass it the message that client will be sending to.
Create Queue
如果不位于 *<JBoss 安装文件夹> > server > default > deploy * 文件夹中,则创建名为 jbossmq-destinations-service.xml 的文件。
Create a file named jbossmq-destinations-service.xml if not exists in *<JBoss Installation Folder> > server > default > deploy * folder.
在本文中,我们创建一个名为 BookQueue 的队列 −
Here we are creating a queue named 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 日志中看到类似的条目。
When you start the JBoss, you will see a similar entry in jboss log.
...
10:37:06,167 INFO [QueueService] Queue[/queue/BookQueue] started, fullSize=200000, pageSize=2000, downCacheSize=2000
...
Create Message Driven 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 is annotated with @MessageDriven annotation to mark it as message driven bean.
-
Its properties are defined as destinationType - Queue and destination - /queue/BookQueue.
-
It implements MessageListener interface, which exposes onMessage method.
-
It has MessgeDrivenContext as a resource.
-
LibraryPersistentBeanRemote stateless bean is injected in this bean for persistence purpose.
构建 EjbComponent 项目,并将其部署在 JBoss 上。在构建和部署 EJB 模块后,我们需要一个客户端来向 jboss 队列发送消息。
Build the EjbComponent project and deploy it on JBoss. After building and deploying the EJB module, we need a client to send a message to jboss queue.
Example Application
让我们创建一个测试 EJB 应用程序来测试消息驱动的 Bean。
Let us create a test EJB application to test Message Driven Bean.
Step |
Description |
1 |
Create a project with a name EjbComponent under a package com.tutorialspoint.entity as explained in the EJB - Create Application chapter. You can also use the project created in EJB - Create Application chapter as such for this chapter to understand EJB persistence concepts. |
2 |
Create Book.java under package com.tutorialspoint.entity as created in EJB-Persistence chapter. |
3 |
Create LibraryPersistentBean.java and LibraryPersistentBeanRemote as created in EJB-Persistence chapter. |
4 |
Create jboss-ds.xml in *EjbComponent > setup * folder and persistence.xml in *EjbComponent > src > conf * folder. These folders can be seen in files tab in Netbeans as created in EJB-Persistence chapter. |
5 |
Create LibraryMessageBean.java under a package com.tutorialspoint.messagebean and modify it as shown below. |
6 |
Create BookQueue queue in Jboss as described above. |
7 |
Clean and Build the application to make sure business logic is working as per the requirements. |
8 |
Finally, deploy the application in the form of jar file on JBoss Application Server. JBoss Application server will get started automatically if it is not started yet. |
9 |
Now create the EJB client, a console based application in the same way as explained in the EJB - Create Application chapter under topic Create Client to access EJB. Modify it as shown below. |
EJBComponent (EJB Module)
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 Client)
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执行以下任务-
EJBTester performs the following tasks −
-
Load properties from jndi.properties and initialize the InitialContext object.
-
In testStatefulEjb() method, jndi lookup is done with the name - "/queue/BookQueue" to obtain treference of queue available in Jboss. Then sender is created using queue session.
-
Then user is shown a library store User Interface and he/she is asked to enter choice.
-
If user enters 1, the system asks for book name and sender sends the book name to queue. When JBoss container receives this message in queue, it calls our message driven bean’s onMessage method. Our message driven bean then saves book using stateful session bean addBook() method. Session Bean is persisting the book in database via EntityManager call.
-
If user enters 2, then another jndi lookup is done with name - "LibraryStatefulSessionBean/remote" to obtain the remote business object (stateful EJB) again and listing of books is done.
Run Client to Access EJB
在项目浏览器中找到EJBTester.java。右键单击EJBTester类并选择 run file 。
Locate EJBTester.java in project explorer. Right click on EJBTester class and select run file.
在 Netbeans 控制台中验证以下输出 −
Verify the following output in Netbeans console −
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 正在接收消息并将图书存储在持久存储中,并且图书是从数据库中检索的。
The output shown above states that our Message driven bean is receiving the message and storing the book in persistent storage and books are retrieved from the database.