# reliable-message

**Repository Path**: NuLiing/reliable-message

## Basic Information

- **Project Name**: reliable-message
- **Description**: 分布式事务解决方案之基于可靠消息的最终一致性方案。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://www.showdoc.cc/rmq
- **GVP Project**: No

## Statistics

- **Stars**: 155
- **Forks**: 61
- **Created**: 2019-03-11
- **Last Updated**: 2025-06-29

## Categories & Tags

**Categories**: distributed-service

**Tags**: None

## README

<p align="center">
<img src="https://images.gitee.com/uploads/images/2019/1211/141859_3eed102c_1588475.png" ></img>
</p>

<p align="center">
    <a target="_blank" href="https://search.maven.org/search?q=g:%22com.gitee.nuliing%22%20AND%20a:%22rmq-api%22">
        <img src="https://img.shields.io/maven-central/v/com.gitee.nuliing/rmq-api.svg?label=Maven%20Central" ></img>
    </a>
    <a target="_blank" href="https://www.apache.org/licenses/LICENSE-2.0.html">
        <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" ></img>
    </a>
    <a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">
        <img src="https://img.shields.io/badge/JDK-1.8+-green.svg" ></img>
    </a>
    <a target="_blank" href="https://www.codacy.com/app/a327919006/reliable-message?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=a327919006/reliable-message&amp;utm_campaign=Badge_Grade">
        <img src="https://api.codacy.com/project/badge/Grade/26af17c01c55497e9296160ef2d13352"/>
    </a>
</p>

------------

#### 介绍

**RMQ**（reliable-message-queue）是**基于可靠消息的最终一致性**的分布式事务解决方案。

如果感觉有帮助，帮忙点个star！

# [中文文档](https://www.showdoc.cc/rmq "中文文档")
- 中文文档地址：[https://www.showdoc.cc/rmq](https://www.showdoc.cc/rmq "https://www.showdoc.cc/rmq")

##### RMQ对接示例：
- [https://gitee.com/NuLiing/reliable-message-samples](https://gitee.com/NuLiing/reliable-message-samples "https://gitee.com/NuLiing/reliable-message-samples")
- [https://github.com/a327919006/reliable-message-samples](https://github.com/a327919006/reliable-message-samples "https://github.com/a327919006/reliable-message-samples")

## 框架定位
- RMQ本身不生产消息队列，只是消息的搬运工。
- RMQ框架提供消息预发送、消息发送、消息确认、消息恢复、消息管理等功能，结合成熟的消息中间件，解决分布式事务，达到数据最终一致性。

------------

#### Maven模块描述

| 模块名称 | 描述 |
| --- | --- |
| rmq-api | 提供业务系统调用的RMQ服务接口 |
| rmq-service-api | 基础消息服务接口、系统工具类、实体类封装 |
| rmq-service | RMQ服务接口实现、基础消息服务接口实现、消息管理子系统服务接口实现 |
| rmq-schedule-api | 消息确认子系统、消息恢复子系统服务接口 |
| rmq-schedule | 消息确认子系统，与上游业务系统确认消息是否发送<br>消息恢复子系统，重新发送消息给下游业务 |
| rmq-cms-api | 消息管理子系统服务接口、实体类封装 |
| rmq-cms | 消息管理子系统，提供消息管理后台 |
| rmq-dal | 数据库访问层： sql语句|

------------
## 业务系统对接RMQ
详细对接说明请查看《[快速入门](https://www.showdoc.cc/rmq?page_id=1815635527586509 "快速入门")》和《[对接示例说明](https://www.showdoc.cc/rmq?page_id=1820953552972418 "对接示例说明")》

#### maven依赖
在业务系统的pom文件中引入rmq-api最新版本依赖：
```
# 中央仓库： https://search.maven.org/search?q=rmq-api
<dependency>
  <groupId>com.gitee.nuliing</groupId>
  <artifactId>rmq-api</artifactId>
  <version>${最新稳定版本}</version>
</dependency>
```

#### 在业务代码中引入RMQ的Dubbo服务
```
import org.apache.dubbo.config.annotation.Reference;
import com.cn.rmq.api.service.IRmqService;

@Reference
private IRmqService rmqService;
```

#### 编写消息发送方业务方法
```
public void doBusiness() {
        // 自定义消息队列名称
        String queue = "test.queue";
        // 消息内容, 如果传输对象，建议转换成json字符串
        String messageContent = "......";

        // 调用RMQ，预发送消息
        String messageId = rmqService.createPreMessage(queue, messageContent);

        // 执行业务
        ...
        ...

        // 异步调用RMQ，确认发送消息
        RpcContext.getContext().asyncCall(() -> rmqService.confirmAndSendMessage(messageId));
    }
```

#### 编写消息消费方业务方法
```
public void handleMsg(RmqMessage msg) {
        try {
            String messageContent = msg.getMessageBody();

            // 执行业务
            ...
            ...

            // 通知RMQ消息消费成功
            // 如果使用的是RMQ的directSendMessage，则无需通知
            if (StringUtils.isNotBlank(msg.getMessageId())) {
                rmqService.deleteMessageById(msg.getMessageId());
            }
        } catch (Exception e) {
            ...
        }
    }
```

------------

#### 更多分布式事务框架

| 框架 | 描述 | 状态 |
| --- | --- | --- |
| [cn-rmq](https://gitee.com/NuLiing/reliable-message "cn-rmq") | 基于可靠消息的最终一致性方案 | 已发布 |
| [cn-ben](https://gitee.com/NuLiing/cn-ben "cn-ben") | 最大努力通知方案 | 已发布 |