一文详解RocketMQ-Spring的源码解析与实战

摘要:这篇文章主要介绍 Spring Boot 项目使用 rocketmq-spring SDK 实现消息收发的操作流程,同时笔者会从开发者的角度解读 SDK 的设计逻辑。

本文分享自华为云社区《RocketMQ-Spring : 实战与源码解析一网打尽》,作者:勇哥java实战分享。

RocketMQ 是大家耳熟能详的消息队列,开源项目 rocketmq-spring 可以帮助开发者在 Spring Boot 项目中快速整合 RocketMQ。

这篇文章会介绍 Spring Boot 项目使用 rocketmq-spring SDK 实现消息收发的操作流程,同时笔者会从开发者的角度解读 SDK 的设计逻辑。

一文详解RocketMQ-Spring的源码解析与实战

一 SDK 简介

一文详解RocketMQ-Spring的源码解析与实战

项目地址:https://github.com/apache/rocketmq-spring

rocketmq-spring 的本质是一个 Spring Boot starter 。

Spring Boot 基于“约定大于配置”(Convention over configuration)这一理念来快速地开发、测试、运行和部署 Spring 应用,并能通过简单地与各种启动器(如 spring-boot-web-starter)结合,让应用直接以命令行的方式运行,不需再部署到独立容器中。

Spring Boot starter 构造的启动器使用起来非常方便,开发者只需要在 pom.xml 引入 starter 的依赖定义,在配置文件中编写约定的配置即可。

下面我们看下 rocketmq-spring-boot-starter 的配置:

1、引入依赖

<dependency>
 <groupId>org.apache.rocketmq</groupId>
 <artifactId>rocketmq-spring-boot-starter</artifactId>
 <version>2.2.3</version>
</dependency>

2、约定配置

一文详解RocketMQ-Spring的源码解析与实战

接下来,我们分别按照生产者和消费者的顺序,详细的讲解消息收发的操作过程。

二 生产者

首先我们添加依赖后,进行如下三个步骤:

1、配置文件中配置如下

rocketmq:
  name-server: 127.0.0.1:9876
  producer:
      group: platform-sms-server-group
    # access-key: myaccesskey
    # secret-key: mysecretkey
  topic: sms-common-topic

生产者配置非常简单,主要配置名字服务地址和生产者组。

2、需要发送消息的类中注入 RcoketMQTemplate

@Autowired
private RocketMQTemplate rocketMQTemplate;
​
@Value("${rocketmq.topic}")
private String smsTopic;

3、发送消息,消息体可以是自定义对象,也可以是 Message 对象

rocketMQTemplate 类包含多钟发送消息的方法:

  1. 同步发送 syncSend
  2. 异步发送 asyncSend
  3. 顺序发送 syncSendOrderly
  4. oneway发送 sendOneWay

下面的代码展示如何同步发送消息。

String destination = StringUtils.isBlank(tags) ? topic : topic + ":" + tags;
SendResult sendResult =
 rocketMQTemplate.syncSend(
            destination, 
 MessageBuilder.withPayload(messageContent).
 setHeader(MessageConst.PROPERTY_KEYS, uniqueId).
 build()
 );
if (sendResult != null) {
 if (sendResult.getSendStatus() == SendStatus.SEND_OK) {
 // send message success ,do something 
 }
}

syncSend 方法的第一个参数是发送的目标,格式是:topic + ":" + tags ,

第二个参数是:spring-message 规范的 message 对象 ,而 MessageBuilder 是一个工具类,方法链式调用创建消息对象。

三 消费者

1、配置文件中配置如下

rocketmq:
  name-server: 127.0.0.1:9876
  consumer1:
    group: platform-sms-worker-common-group
    topic: sms-common-topic

2、实现消息监听器

@Component
@RocketMQMessageListener(
 consumerGroup = "${rocketmq.consumer1.group}", //消费组
    topic = "${rocketmq.consumer1.topic}" //主题
)
public class SmsMessageCommonConsumer implements RocketMQListener<String> {
 public void onMessage(String message) {
 System.out.println("普通短信:" + message);
 }
}

消费者实现类也可以实现 RocketMQListener<MessageExt>, 在 onMessage 方法里通过 RocketMQ 原生消息对象 MessageExt 获取更详细的消息数据 。

public void onMessage(MessageExt message) {
 try {
        String body = new String(message.getBody(), "UTF-8");
        logger.info("普通短信:" + message);
 } catch (Exception e) {
 logger.error("common onMessage error:", e);
 }
}

四 源码概览

一文详解RocketMQ-Spring的源码解析与实战

最新源码中,我们可以看到源码中包含四个模块:

1、rocketmq-spring-boot-parent

该模块是父模块,定义项目所有依赖的 jar 包。

2、rocketmq-spring-boot

核心模块,实现了 starter 的核心逻辑。

3、rocketmq-spring-boot-starter

SDK 模块,简单封装,外部项目引用。

4、rocketmq-spring-boot-samples

示例代码模块。这个模块非常重要,当用户使用 SDK 时,可以参考示例快速开发。

五 starter 实现

我们重点分析下 rocketmq-spring-boot 模块的核心源码:

一文详解RocketMQ-Spring的源码解析与实战

spring-boot-starter 实现需要包含如下三个部分:

1、定义 Spring 自身的依赖包和 RocketMQ 的依赖包 ;

2、定义spring.factories 文件

在 resources 包下创建 META-INF 目录后,新建 spring.factories 文件,并在文件中定义自动加载类,文件内容是:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.apache.rocketmq.spring.autoconfigure.RocketMQAutoConfiguration

spring boot 会根据文件中配置的自动化配置类来自动初始化相关的 Bean、Component 或 Service。

3、实现自动加载类

在 RocketMQAutoConfiguration 类的具体实现中,我们重点分析下生产者和消费者是如何分别启动的。

▍生产者发送模板类:RocketMQTemplate

RocketMQAutoConfiguration 类定义了两个默认的 Bean :

一文详解RocketMQ-Spring的源码解析与实战一文详解RocketMQ-Spring的源码解析与实战

首先SpringBoot项目中配置文件中的配置值会根据属性条件绑定到 RocketMQProperties 对象 中,然后使用 RocketMQ 的原生 API 分别创建生产者 Bean 和拉取消费者 Bean , 分别将两个 bean 设置到 RocketMQTemplate 对象中。

两个重点需要强调:

  • 发送消息时,将 spring-message 规范下的消息对象封装成 RocketMQ 消息对象

一文详解RocketMQ-Spring的源码解析与实战

  • 默认拉取消费者 litePullConsumer 。拉取消费者一般用于大数据批量处理场景 。

一文详解RocketMQ-Spring的源码解析与实战

RocketMQTemplate 类封装了拉取消费者的receive方法,以方便开发者使用。

一文详解RocketMQ-Spring的源码解析与实战

▍自定义消费者类

下图是并发消费者的例子:

一文详解RocketMQ-Spring的源码解析与实战

那么 rocketmq-spring 是如何自动启动消费者呢 ?

一文详解RocketMQ-Spring的源码解析与实战

spring 容器首先注册了消息监听器后置处理器,然后调用 ListenerContainerConfiguration 类的 registerContainer 方法 。

对比并发消费者的例子,我们可以看到: DefaultRocketMQListenerContainer 是对 DefaultMQPushConsumer 消费逻辑的封装。

一文详解RocketMQ-Spring的源码解析与实战

封装消费消息的逻辑,同时满足 RocketMQListener 泛化接口支持不同参数,比如 String 、MessageExt 、自定义对象 。

首先DefaultRocketMQListenerContainer初始化之后, 获取 onMessage 方法的参数类型 。

一文详解RocketMQ-Spring的源码解析与实战

然后消费者调用 consumeMessage 处理消息时,封装了一个 handleMessage 方法 ,将原生 RocketMQ 消息对象 MessageExt 转换成 onMessage 方法定义的参数对象,然后调用 rocketMQListener 的 onMessage 方法。

一文详解RocketMQ-Spring的源码解析与实战

上图右侧标红的代码也就是该方法的精髓:

rocketMQListener.onMessage(doConvertMessage(messageExt));

六 写到最后

开源项目 rocketmq-spring 有很多值得学习的地方 ,我们可以从如下四个层面逐层进阶:

1、学会如何使用 :参考 rocketmq-spring-boot-samples 模块的示例代码,学会如何发送和接收消息,快速编码;

2、模块设计:学习项目的模块分层 (父模块、SDK 模块、核心实现模块、示例代码模块);

3、starter 设计思路 :定义自动配置文件 spring.factories 、设计配置属性类 、在 RocketMQ client 的基础上实现优雅的封装、深入理解 RocketMQ 源码等;

4、举一反三:当我们理解了 rocketmq-spring 的源码,我们可以尝试模仿该项目写一个简单的 spring boot starter。

 

点击关注,第一时间了解华为云新鲜技术~

原文链接:https://www.cnblogs.com/huaweiyun/p/17349393.html

本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:一文详解RocketMQ-Spring的源码解析与实战 - Python技术站

(0)
上一篇 2023年4月25日
下一篇 2023年4月25日

相关文章

  • java实现分布式项目搭建的方法

    下面我来讲解一下“java实现分布式项目搭建的方法”的完整攻略。 一、前置知识 在了解分布式项目搭建之前,需要掌握以下几个基础知识: Java语言基础 Spring框架、Spring Boot框架和Spring Cloud框架的基础知识 Maven和Gradle构建工具的基础知识 数据库的基础知识 Docker、Kubernetes等技术的基础知识 二、分布…

    Java 2023年5月18日
    00
  • Hibernate5新特性介绍

    Hibernate5新特性介绍 Hibernate是一个广泛使用的ORM(对象关系映射)框架,致力于使得数据库的操作变得更为容易和快捷。而在Hibernate5中,新增了一些重要的特性,既改善了ORM的用法,又增强了其性能和扩展性。本篇文章将会介绍Hibernate5中的一些新特性,并带有相应的示例,以便让读者更好地理解和使用。 JPA2.1规范的实现 Hi…

    Java 2023年5月19日
    00
  • 详解SpringBoot实现fastdfs防盗链功能的示例代码

    以下是“详解SpringBoot实现fastdfs防盗链功能的示例代码”的完整攻略: 防盗链功能概念 防盗链技术可以防止其他站点盗链本站的内容,从而保证网站安全及资源不被滥用。在FastDFS中,通过配置nginx.conf文件实现防盗链。 安装配置FastDFS 首先,需要在本地或服务器上安装并配置FastDFS。可以参考FastDFS官网及论坛的相关文档…

    Java 2023年5月20日
    00
  • Android实现IOS相机滑动控件

    下面我会详细讲解在Android平台上实现类似IOS相机滑动控件的完整攻略。实现该控件需要涉及到自定义控件的开发和手势识别等技能。 一、基本原理 自定义滑动控件:为了实现类似IOS相机的滑动效果,需要将Android的默认控件ScrollView转换为自定义控件,在该自定义控件中重写touch事件以及scroll事件,实现手势识别和滑动效果。 手势识别:在自…

    Java 2023年5月26日
    00
  • 布隆过滤器(Bloom Filter)的Java实现方法

    布隆过滤器(Bloom Filter)的Java实现方法 什么是布隆过滤器? 布隆过滤器(Bloom Filter)是一种数据结构,它可以用来判断一个元素是否可能存在于一个集合中,但并不能确定该元素是否一定存在于该集合中。因为该数据结构的判断结果在误判率(False Positive Rate)上具有一定的不确定性。布隆过滤器可以在空间和时间上做到非常高效,…

    Java 2023年5月26日
    00
  • SpringMVC实现Controller的三种方式总结

    以下是关于“SpringMVC实现Controller的三种方式总结”的完整攻略,其中包含两个示例。 SpringMVC实现Controller的三种方式总结 SpringMVC是一个基于Java的Web框架,它可以帮助我们快速开发Web应用程序。Controller是SpringMVC中的一个组件,它用于处理HTTP请求。本文将介绍SpringMVC实现C…

    Java 2023年5月17日
    00
  • Java实现简易Web服务器

    Java实现简易Web服务器 概述 Web服务器是Web应用程序运行的基础设施之一。本文将介绍如何使用Java编程语言实现一个简单的Web服务器,并提供两个简单的示例说明,帮助理解如何使用此Web服务器。 实现流程 获取客户端请求,解析请求报文,获取客户端请求的资源路径和参数。 判断客户端请求所需资源的类型,是静态资源还是动态资源。 如果是静态资源,则根据资…

    Java 2023年5月18日
    00
  • Maven的安装配置详解

    Maven的安装配置详解 Maven是一种项目管理工具,它可以自动化构建过程并管理项目的依赖关系。Maven使用XML描述项目,使用“pom.xml”文件配置项目的基本信息、依赖以及构建方式。 本文将详细讲解Maven的安装和配置步骤。 安装Maven 访问Maven官网https://maven.apache.org/,下载最新的Maven版本(目前是3.…

    Java 2023年6月2日
    00
合作推广
合作推广
分享本页
返回顶部