RocketMQ starter 封装 包含springBoot& springMVC两种接入

springboot-rocketmq-starter starter源码github地址:https://github.com/Lickey1991/rocketmq-spring-boot-starter
笔者这里fork https://github.com/maihaoche/rocketmq-spring-boot-starter项目,做了一下小改动,一个项目支持多个producer group,如果不需要此修改,可以check此项目。

springboot-demo springboot接入demo源码 github地址:https://github.com/Lickey1991/rocketmq-springbooot-demo

rocketmq-demo-springMVC springMVC接入demo源码 github地址:https://github.com/Lickey1991/rocketmq-springmvc-demo

RocketMq版本 4.5

1.spring Boot 项目接入

1.1 maven 添加依赖

<dependency>
   <groupId>com.lickey</groupId>
   <artifactId>spring-boot-starter-rocketmq</artifactId>
   <version>1.0.0-SNAPSHOT</version>
</dependency>

1.2 添加rocketMq配置

rocketMq NameSvrAddr spring.rocketmq.name-server-address: 10.17.0.171:9876;10.17.0.172:9876 
# 可选, 如果无需发送消息则忽略该配置 
spring.rocketmq.producer-group: ${rocketmq.groupid.demo} 
# 发送超时配置毫秒数, 可选, 默认3000 
spring.rocketmq.send-msg-timeout: 5000 
# 追溯消息具体消费情况的开关,默认打开 
#trace-enabled: false

2. Sping MVC 项目接入

2.1 maven 添加依赖

<dependencies> 
         <dependency>
          <groupId>com.lickey</groupId>
          <artifactId>spring-boot-starter-rocketmq</artifactId>                    
          <version>1.0.0-SNAPSHOT</version>
          <exclusions>
                 <exclusion> 
                       <artifactId>slf4j-log4j12</artifactId>                                  
                       <groupId>org.slf4j</groupId>
                 </exclusion>
         </exclusions>
 </dependency>

2.2 添加rocketMq配置

添加rocketmq.properties 文件,配置内容与springboot一致

rocketmq.properties

2.3 springMvc 配置@Value读取properties

  1. application-context.xml配置
<!--加载 RocketMq starter  autoConfiguration-->
<context:component-scan base-package="com.lickey.starter.rocketmq.config"/>
<!-- 加载配置属性文件 --> 
<context:property-placeholder ignore-unresolvable="true" location="classpath:rocketmq.properties" />

2.spring-mvc.xml或者dispatcher-servlet.xml 配置

<!-- 加载配置属性文件 --> 
<context:property-placeholder ignore-unresolvable="true" location="classpath:rocketmq.properties" />

因为controller配置在spring-mvc.xml/dispatcher-servlet.xml 中,所以想要在controller中使用@value("${key}")读取properties 需要在spring-mvc.xml/dispatcher-servlet.xml 也定义properties配置

RocketMq配置中 name-sercer-address可以在 rocketMq的控制台中查看,daily控制台中查看。 多个地址,中间使用分号【;】进行分隔

RockatMq控制台

3. 创建producer

3.1 普通producer

  1. 创建`producer
    参考demo中RocketMqProducer,如果需要在消息发送完成后,做统一处理逻辑例如记录日志等,需要重写doAfterSyncSend方法
创建producer

使用@MQProducer注解创建普通producer,producerGroup为生产者组,如果此处不指定生产这组,则取配置文件中spring.rocketmq.producer-group值为默认生产者组,二者必须有个值不能为空,否则创建失败,需要继承 AbstractMQProducer 类

2.发送同步消息

参考TestServiceImpl#sendMqMessqge,调用producer的syncSend (Message message)

sendMessage

使用MessageBuilder构建消息体Message,通过静态of方法,指定message的topic与tag,或者指定messageBody信息。同时提供topic,tag,massageBody对相应的set方法。

messageBuild.of

setKey设置rocketMq消息中的key,消息发送后在rocketMq控制台查看detail信息如下

message info

3.发送异步消息

参考demoTestServiceImpl#asyncSend,调用producer的asyncSend (Message message, SendCallback sendCallback)方法

异步消息

sendCallBack为发送后的回调,实现方式参考DemoSendCallback,实现SendCallBack接口,重写onSuccess和onException方法

DemoSendCallback

4.发送顺序消息

调用producer的syncSendOrderly(Message message, String hashKey)方法,该方式使用rocketMq顺序消息的hashKey计算消息顺序方法

hashQueue

3.2创建事物producer

1.创建producer

参考demo中的RocketMqTransactionProducer,使用@MQTransactionProducer注解创建事物producer,producerGroup为生产者组,必须有值不能为空且不能与其他producer组相同,否则创建失败,需要继承 AbstractMQTransactionProducer类,实现executeLocalTransaction、checkLocalTransaction方法(checkLocalTransation方法作用本地事物执行时间过长 或者集群收到producer传过来的状态是unknow,集群通过查询事物消息TOPIC,回调check),该功能在rocketMq 3.6版本中去除。回调的实现通过ClientRemotingProcessor#processRequest。 所以checkLocalTransaction 无需写实际方法体。想要测试,在executeLocalTransaction中返回UNKNOW,processRequest处断点观察。回调触发,有兴趣可以看下相关文章

事物producer

2.发送事物消息

参考demoTestServiceImpl#transactionSend,调用producer的sendMessageInTransaction(Message msg, Object arg)方法

发送事物消息

4.创建消费者

参考demo中DemoTopicConsumer,使用@MQConsumer注解创建事物,consumerGroup为消费者组,topic为监听的topic,重写process方法,方法参数message为反序列化后的messageBody实例,extMap key包括MessageExtConst中 MessageExt、Message.property两部分

创建消费者

MessageExtConst中extMap包含的key

 /** 来自 MessageExt */ 
public static final String PROPERTY_EXT_QUEUE_ID = "QUEUE_ID"; 
public static final String PROPERTY_EXT_STORE_SIZE = "STORE_SIZE";
public static final String PROPERTY_EXT_QUEUE_OFFSET = "QUEUE_OFFSET"; 
public static final String PROPERTY_EXT_SYS_FLAG = "SYS_FLAG"; 
public static final String PROPERTY_EXT_BORN_TIMESTAMP = "BORN_TIMESTAMP"; 
public static final String PROPERTY_EXT_BORN_HOST = "BORN_HOST"; 
public static final String PROPERTY_EXT_STORE_TIMESTAMP = "STORE_TIMESTAMP"; 
public static final String PROPERTY_EXT_STORE_HOST = "STORE_HOST"; 
public static final String PROPERTY_EXT_MSG_ID = "MSG_ID"; 
public static final String PROPERTY_EXT_COMMIT_LOG_OFFSET = "COMMIT_LOG_OFFSET"; 
public static final String PROPERTY_EXT_RECONSUME_TIMES = "RECONSUME_TIMES"; 
public static final String PROPERTY_EXT_PREPARED_TRANSACTION_OFFSET = "PREPARED_TRANSACTION_OFFSET"; 
public static final String PROPERTY_EXT_BODY_CRC = "BODY_CRC";   
/** 以下属性来自 Message.property */ 
public static final String PROPERTY_KEYS = "KEYS"; 
public static final String PROPERTY_TAGS = "TAGS"; 
public static final String PROPERTY_WAIT_STORE_MSG_OK = "WAIT"; 
public static final String PROPERTY_DELAY_TIME_LEVEL = "DELAY"; 
public static final String PROPERTY_RETRY_TOPIC = "RETRY_TOPIC"; 
public static final String PROPERTY_REAL_TOPIC = "REAL_TOPIC"; 
public static final String PROPERTY_REAL_QUEUE_ID = "REAL_QID"; 
public static final String PROPERTY_TRANSACTION_PREPARED = "TRAN_MSG"; 
public static final String PROPERTY_PRODUCER_GROUP = "PGROUP"; 
public static final String PROPERTY_MIN_OFFSET = "MIN_OFFSET"; 
public static final String PROPERTY_MAX_OFFSET = "MAX_OFFSET"; 
public static final String PROPERTY_BUYER_ID = "BUYER_ID"; 
public static final String PROPERTY_ORIGIN_MESSAGE_ID = "ORIGIN_MESSAGE_ID"; 
public static final String PROPERTY_TRANSFER_FLAG = "TRANSFER_FLAG"; 
public static final String PROPERTY_CORRECTION_FLAG = "CORRECTION_FLAG"; 
public static final String PROPERTY_MQ2_FLAG = "MQ2_FLAG"; 
public static final String PROPERTY_RECONSUME_TIME = "RECONSUME_TIME"; 
public static final String PROPERTY_MSG_REGION = "MSG_REGION"; 
public static final String PROPERTY_TRACE_SWITCH = "TRACE_ON"; 
public static final String PROPERTY_UNIQ_CLIENT_MESSAGE_ID_KEYIDX = "UNIQ_KEY"; 
public static final String PROPERTY_MAX_RECONSUME_TIMES = "MAX_RECONSUME_TIMES"; 
public static final String PROPERTY_CONSUME_START_TIMESTAMP = "CONSUME_START_TIME";

以上是接入starter Demo

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,125评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,293评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,054评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,077评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,096评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,062评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,988评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,817评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,266评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,486评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,646评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,375评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,974评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,621评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,642评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,538评论 2 352

推荐阅读更多精彩内容