RabbitMQ学习之spring-amqp的重要类的认识

对于大多数应用来说都做了与spring整合，对于rabbitmq来说。也有与spring的整合。可能通过spring的官网找到spring-amqp项目下载。spring-amqp项目包括三个子项目：spring-amqp、spring-erlang、spring-rabbit.

下面来认识一下spring-amqp中的几个重要类；以spring-amqp-1.0.0.M3版本为例

1、Message : Spring AMQP定义的Message类是AMQP域模型中代表之一。Message类封装了body(消息BODY)和properties（消息属性） 。使得这个API看起来很简单。Message类定义如下：

1. public class Message {
2. private final MessageProperties messageProperties;
3. private final byte[] body;
4. public Message(byte[] body, MessageProperties messageProperties) {
5. this.body = body;
6. this.messageProperties = messageProperties;
7. }
8. public byte[] getBody() {
9. return this.body;
10. }
11. public MessageProperties getMessageProperties() {
12. return this.messageProperties;
13. }
14. }

其中MessageProperties类中定义了例如messageId、timestamp、contentType等属性。这此属性可以扩展到用户通过setHeader(String key, Object value)方法来自定义“headers”。

 2、Exchange
      Exchange接口代表一个AMQP的Exchange，决定消息生产者发送消息。每个Exchange都包括一个特定的唯一名字的虚拟主机的代理和一些其他属性。

1. public interface Exchange {
2. String getName();
3. String getType();
4. boolean isDurable();
5. boolean isAutoDelete();
6. Map<String, Object> getArguments();
7. }

其中 AbstractExchange类实现了Exchange类。而DirectExchange、TopicExchange、FanoutExchang、HeadersExchange四个类继承AbstractExchange。并重写了getType()类。根据各自相对应的Exchange类型。DirectExchange、TopicExchange、FanoutExchang、HeadersExchange分别对应的类型为direct,topic,fanout,headers.

 3、Queue
 Queue类是消息消费者接收消息中重要的一个组成部分。通过与Exchange判定来肯定消费者所接收的消息。伪代码如下：

1. public class Queue {
2. private final String name;
3. private volatile boolean durable;
4. private volatile boolean exclusive;
5. private volatile boolean autoDelete;
6. private volatile Map<String, Object> arguments;
7. public Queue(String name) {
8. this.name = name;
9. }

其中name表示队列的名称、durable表示持久性。true表示是。exclusive表示独占性。由于在AmqpTemplate中提供一个方法来得到唯一的队列。这个队列可能是一个”reply-to“地址或者其他信息，因此一般exclusive和autoDelete一般设定为true.

4、Binding
     Bingding类通过多种构造参数来判定Exchange,Queue,routingkey;例如

1. Binding(Queue queue, FanoutExchange exchange)
2. Binding(Queue queue, HeadersExchange exchange, Map<String, Object> arguments)
3. Binding(Queue queue, DirectExchange exchange)
4. Binding(Queue queue, DirectExchange exchange, String routingKey)
5. Binding(Queue queue, TopicExchange exchange, String routingKey)

5、AmqpTemplate
AmqpTemplate是用来发送消息的模板类

1. /**
2. * Specifies a basic set of AMQP operations.
3. *
4. * Provides synchronous send and receive methods. The {@link #convertAndSend(Object)} and {@link #receiveAndConvert()}
5. * methods allow let you send and receive POJO objects. Implementations are expected to delegate to an instance of
6. * {@link MessageConverter} to perform conversion to and from AMQP byte[] payload type.
7. *
8. * @author Mark Pollack
9. * @author Mark Fisher
10. */
11. public interface AmqpTemplate {
12. // send methods for messages
13. /**
14. * Send a message to a default exchange with a default routing key.
15. *
16. * @param message a message to send
17. * @throws AmqpException if there is a problem
18. */
19. void send(Message message) throws AmqpException;
20. /**
21. * Send a message to a default exchange with a specific routing key.
22. *
23. * @param routingKey the routing key
24. * @param message a message to send
25. * @throws AmqpException if there is a problem
26. */
27. void send(String routingKey, Message message) throws AmqpException;
28. /**
29. * Send a message to a specific exchange with a specific routing key.
30. *
31. * @param exchange the name of the exchange
32. * @param routingKey the routing key
33. * @param message a message to send
34. * @throws AmqpException if there is a problem
35. */
36. void send(String exchange, String routingKey, Message message) throws AmqpException;
37. // send methods with conversion
38. /**
39. * Convert a Java object to an Amqp {@link Message} and send it to a default exchange with a default routing key.
40. *
41. * @param message a message to send
42. * @throws AmqpException if there is a problem
43. */
44. void convertAndSend(Object message) throws AmqpException;
45. /**
46. * Convert a Java object to an Amqp {@link Message} and send it to a default exchange with a specific routing key.
47. *
48. * @param routingKey the routing key
49. * @param message a message to send
50. * @throws AmqpException if there is a problem
51. */
52. void convertAndSend(String routingKey, Object message) throws AmqpException;
53. /**
54. * Convert a Java object to an Amqp {@link Message} and send it to a specific exchange with a specific routing key.
55. *
56. * @param exchange the name of the exchange
57. * @param routingKey the routing key
58. * @param message a message to send
59. * @throws AmqpException if there is a problem
60. */
61. void convertAndSend(String exchange, String routingKey, Object message) throws AmqpException;
62. /**
63. * Convert a Java object to an Amqp {@link Message} and send it to a default exchange with a default routing key.
64. *
65. * @param message a message to send
66. * @param messagePostProcessor a processor to apply to the message before it is sent
67. * @throws AmqpException if there is a problem
68. */
69. void convertAndSend(Object message, MessagePostProcessor messagePostProcessor) throws AmqpException;
70. /**
71. * Convert a Java object to an Amqp {@link Message} and send it to a default exchange with a specific routing key.
72. *
73. * @param routingKey the routing key
74. * @param message a message to send
75. * @param messagePostProcessor a processor to apply to the message before it is sent
76. * @throws AmqpException if there is a problem
77. */
78. void convertAndSend(String routingKey, Object message, MessagePostProcessor messagePostProcessor)
79. throws AmqpException;
80. /**
81. * Convert a Java object to an Amqp {@link Message} and send it to a specific exchange with a specific routing key.
82. *
83. * @param exchange the name of the exchange
84. * @param routingKey the routing key
85. * @param message a message to send
86. * @param messagePostProcessor a processor to apply to the message before it is sent
87. * @throws AmqpException if there is a problem
88. */
89. void convertAndSend(String exchange, String routingKey, Object message, MessagePostProcessor messagePostProcessor)
90. throws AmqpException;
91. // receive methods for messages
92. /**
93. * Receive a message if there is one from a default queue. Returns immediately, possibly with a null value.
94. *
95. * @return a message or null if there is none waiting
96. * @throws AmqpException if there is a problem
97. */
98. Message receive() throws AmqpException;
99. /**
100. * Receive a message if there is one from a specific queue. Returns immediately, possibly with a null value.
101. *
102. * @param queueName the name of the queue to poll
103. * @return a message or null if there is none waiting
104. * @throws AmqpException if there is a problem
105. */
106. Message receive(String queueName) throws AmqpException;
107. // receive methods with conversion
108. /**
109. * Receive a message if there is one from a default queue and convert it to a Java object. Returns immediately,
110. * possibly with a null value.
111. *
112. * @return a message or null if there is none waiting
113. * @throws AmqpException if there is a problem
114. */
115. Object receiveAndConvert() throws AmqpException;
116. /**
117. * Receive a message if there is one from a specific queue and convert it to a Java object. Returns immediately,
118. * possibly with a null value.
119. *
120. * @param queueName the name of the queue to poll
121. * @return a message or null if there is none waiting
122. * @throws AmqpException if there is a problem
123. */
124. Object receiveAndConvert(String queueName) throws AmqpException;
125. // send and receive methods for messages
126. /**
127. * Basic RPC pattern. Send a message to a default exchange with a default routing key and attempt to receive a
128. * response. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time
129. * limited by a timeout.
130. *
131. * @param message a message to send
132. * @return the response if there is one
133. * @throws AmqpException if there is a problem
134. */
135. Message sendAndReceive(Message message) throws AmqpException;
136. /**
137. * Basic RPC pattern. Send a message to a default exchange with a specific routing key and attempt to receive a
138. * response. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time
139. * limited by a timeout.
140. *
141. * @param routingKey the routing key
142. * @param message a message to send
143. * @return the response if there is one
144. * @throws AmqpException if there is a problem
145. */
146. Message sendAndReceive(String routingKey, Message message) throws AmqpException;
147. /**
148. * Basic RPC pattern. Send a message to a specific exchange with a specific routing key and attempt to receive a
149. * response. Implementations will normally set the reply-to header to an exclusive queue and wait up for some time
150. * limited by a timeout.
151. *
152. * @param exchange the name of the exchange
153. * @param routingKey the routing key
154. * @param message a message to send
155. * @return the response if there is one
156. * @throws AmqpException if there is a problem
157. */
158. Message sendAndReceive(String exchange, String routingKey, Message message) throws AmqpException;
159. // send and receive methods with conversion
160. /**
161. * Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a default
162. * routing key and attempt to receive a response, converting that to a Java object. Implementations will normally
163. * set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
164. *
165. * @param message a message to send
166. * @return the response if there is one
167. * @throws AmqpException if there is a problem
168. */
169. Object convertSendAndReceive(Object message) throws AmqpException;
170. /**
171. * Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a
172. * specific routing key and attempt to receive a response, converting that to a Java object. Implementations will
173. * normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
174. *
175. * @param routingKey the routing key
176. * @param message a message to send
177. * @return the response if there is one
178. * @throws AmqpException if there is a problem
179. */
180. Object convertSendAndReceive(String routingKey, Object message) throws AmqpException;
181. /**
182. * Basic RPC pattern with conversion. Send a Java object converted to a message to a specific exchange with a
183. * specific routing key and attempt to receive a response, converting that to a Java object. Implementations will
184. * normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
185. *
186. * @param exchange the name of the exchange
187. * @param routingKey the routing key
188. * @param message a message to send
189. * @return the response if there is one
190. * @throws AmqpException if there is a problem
191. */
192. Object convertSendAndReceive(String exchange, String routingKey, Object message) throws AmqpException;
193. /**
194. * Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a default
195. * routing key and attempt to receive a response, converting that to a Java object. Implementations will normally
196. * set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
197. *
198. * @param message a message to send
199. * @param messagePostProcessor a processor to apply to the message before it is sent
200. * @return the response if there is one
201. * @throws AmqpException if there is a problem
202. */
203. Object convertSendAndReceive(Object message, MessagePostProcessor messagePostProcessor) throws AmqpException;
204. /**
205. * Basic RPC pattern with conversion. Send a Java object converted to a message to a default exchange with a
206. * specific routing key and attempt to receive a response, converting that to a Java object. Implementations will
207. * normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
208. *
209. * @param routingKey the routing key
210. * @param message a message to send
211. * @param messagePostProcessor a processor to apply to the message before it is sent
212. * @return the response if there is one
213. * @throws AmqpException if there is a problem
214. */
215. Object convertSendAndReceive(String routingKey, Object message, MessagePostProcessor messagePostProcessor) throws AmqpException;
216. /**
217. * Basic RPC pattern with conversion. Send a Java object converted to a message to a specific exchange with a
218. * specific routing key and attempt to receive a response, converting that to a Java object. Implementations will
219. * normally set the reply-to header to an exclusive queue and wait up for some time limited by a timeout.
220. *
221. * @param exchange the name of the exchange
222. * @param routingKey the routing key
223. * @param message a message to send
224. * @param messagePostProcessor a processor to apply to the message before it is sent
225. * @return the response if there is one
226. * @throws AmqpException if there is a problem
227. */
228. Object convertSendAndReceive(String exchange, String routingKey, Object message, MessagePostProcessor messagePostProcessor) throws AmqpException;
229. }

 6、AmqpAdmin和RabbitAdmin
   用户配置Queue、Exchange、Binding的代理类。代理类会自动声明或创建这些配置信息。
下面这个类用于异步接收消息的处理类
  7、MessageConverter 消息转换器类

 8、SimpleMessageListenerContainer 监听消息容器类

spring-amqp:

http://projects.spring.io/spring-amqp/

https://github.com/spring-projects/spring-amqp-samples

转载：http://wubin850219.iteye.com/blog/1050251