在.NET Framework中使用RocketMQ（阿里云版）实战【第一章】

一帘有梦

章节

第一章：https://www.cnblogs.com/kimiliucn/p/17662052.html

第二章：

作者：西瓜程序猿
主页传送门：https://www.cnblogs.com/kimiliucn/

开发背景

在开发某一个需求的时候，领导要求使用RocketMQ(阿里云版) 作为消息队列。使用的版本是5.x，目前也已经没有4.x购买的入口了，所以只能买5.x系列。公司项目还是用的比较老的技术.NET Framework 4.8，生产者主要有WebAPI/MVC/JOB(控制台应用程序)，然后消费者采用的是Windows服务进行长链接消费信息。这期间因为各种原因踩过很多坑，然后咨询了客服说RocketMQ(阿里云版)5.0不支持.NET Framework，但最终操作下来竟然能使用（只支持集群模式，不支持订阅模式），那今天[西瓜程序猿]来记录一下如何使用RocketMQ(阿里云版)，给各位小伙伴作为参考防止踩坑。

环境版本

阿里云RocketMQ版本：5.0系列

.NET版本：.NET Framework 4.8
.NET版本：生产端(WebAPI/MVC/JOB)、消费端(Windows服务)

如果不知道怎么选，或者不知道怎么买云消息队列RocketMQ(阿里云版)？可以联系我[西瓜程序猿]，如果需要特价购买可以通过下面地址访问：

活动地址：https://www.aliyun.com/activity?userCode=tkq1f513

一、RocketMQ基本介绍

官网地址：http://rocketmq.apache.org
RocketMQ阿里云-官方文档：https://help.aliyun.com/zh/apsaramq-for-rocketmq/cloud-message-queue-rocketmq-5-x-series/product-overview/basic-concepts?spm=a2c4g.11186623.0.0.513c5b3aztI6tB

1.1-RocketMQ简介

RocketMQ（Apache RocketMQ）是一个开源的分布式消息中间件系统，由阿里巴巴集团旗下的阿里云计算平台团队开发和维护。它最初是为满足阿里巴巴内部大规模分布式消息传递需求而设计的，后来成为 Apache 基金会的顶级开源项目之一。

1.2-RocketMQ优势

在众多应用场景中广泛应用，如电子商务、物流配送、金融支付、大数据处理等。它被许多企业用于构建高性能和可靠的消息队列系统，实现异步通信和解耦应用程序组件。RocketMQ 提供了可靠、可扩展和高性能的消息传递解决方案，具备以下特点：

• 异步通信：RocketMQ 支持发布-订阅和点对点两种消息通信模式，以满足不同场景下的需求。
  
• 高可靠性：提供多种存储选项，包括本地文件存储和远程共享存储，以确保消息的可靠传输和持久化。
  
• 高吞吐量：支持水平扩展，可以轻松应对大规模消息传递和高并发的需求。
  
• 严格有序性：支持消息按照发送顺序和消费顺序进行有序处理，保证消息的顺序性。
  
• 分布式架构：采用分布式架构，具备良好的横向扩展能力和高可用性。
  

1.3-RocketMQ基本概念

此段内容根据阿里云官方文档整理：https://help.aliyun.com/zh/apsaramq-for-rocketmq/cloud-message-queue-rocketmq-5-x-series/product-overview/basic-concepts?spm=a2c4g.11186623.0.0.32df362aLrD7Ok

主题（Topic）：云消息队列 RocketMQ 版中消息传输和存储的顶层容器，用于标识同一类业务逻辑的消息。主题通过TopicName来做唯一标识和区分。
消息类型（MessageType）：云消息队列 RocketMQ 版中按照消息传输特性的不同而定义的分类，用于类型管理和安全校验。云消息队列 RocketMQ 版支持的消息类型有普通消息、顺序消息、事务消息和定时/延时消息。
消息队列（MessageQueue）：队列是云消息队列 RocketMQ 版中消息存储和传输的实际容器，也是消息的最小存储单元。云消息队列 RocketMQ 版的所有主题都是由多个队列组成，以此实现队列数量的水平拆分和队列内部的流式存储。队列通过QueueId来做唯一标识和区分。
消息（Message）：消息是云消息队列 RocketMQ 版中的最小数据传输单元。生产者将业务数据的负载和拓展属性包装成消息发送到云消息队列 RocketMQ 版服务端，服务端按照相关语义将消息投递到消费端进行消费。
消息视图（MessageView）：消息视图是云消息队列 RocketMQ 版面向开发视角提供的一种消息只读接口。通过消息视图可以读取消息内部的多个属性和负载信息，但是不能对消息本身做任何修改。
消息标签（MessageTag）：消息标签是云消息队列 RocketMQ 版提供的细粒度消息分类属性，可以在主题层级之下做消息类型的细分。消费者通过订阅特定的标签来实现细粒度过滤。
消息位点（MessageQueueOffset）：消息是按到达云消息队列 RocketMQ 版服务端的先后顺序存储在指定主题的多个队列中，每条消息在队列中都有一个唯一的Long类型坐标，这个坐标被定义为消息位点。
消费位点（ConsumerOffset）：一条消息被某个消费者消费完成后不会立即从队列中删除，云消息队列 RocketMQ 版会基于每个消费者分组记录消费过的最新一条消息的位点，即消费位点。
消息索引（MessageKey）：消息索引是云消息队列 RocketMQ 版提供的面向消息的索引属性。通过设置的消息索引可以快速查找到对应的消息内容。
生产者（Producer）：生产者是云消息队列 RocketMQ 版系统中用来构建并传输消息到服务端的运行实体。生产者通常被集成在业务系统中，将业务消息按照要求封装成云消息队列 RocketMQ 版的消息并发送至服务端。
事务检查器（TransactionChecker）：云消息队列 RocketMQ 版中生产者用来执行本地事务检查和异常事务恢复的监听器。事务检查器应该通过业务侧数据的状态来检查和判断事务消息的状态。
事务状态（TransactionResolution）：云消息队列 RocketMQ 版中事务消息发送过程中，事务提交的状态标识，服务端通过事务状态控制事务消息是否应该提交和投递。事务状态包括事务提交、事务回滚和事务未决。
消费者分组（ConsumerGroup）：消费者分组是云消息队列 RocketMQ 版系统中承载多个消费行为一致的消费者的负载均衡分组。和消费者不同，消费者分组并不是运行实体，而是一个逻辑资源。在云消息队列 RocketMQ 版中，通过消费者分组内初始化多个消费者实现消费性能的水平扩展以及高可用容灾。
消费者（Consumer）：消费者是云消息队列 RocketMQ 版中用来接收并处理消息的运行实体。消费者通常被集成在业务系统中，从云消息队列 RocketMQ 版服务端获取消息，并将消息转化成业务可理解的信息，供业务逻辑处理。
消费结果（ConsumeResult）：云消息队列 RocketMQ 版中PushConsumer消费监听器处理消息完成后返回的处理结果，用来标识本次消息是否正确处理。消费结果包含消费成功和消费失败。
订阅关系（Subscription）：订阅关系是云消息队列 RocketMQ 版系统中消费者获取消息、处理消息的规则和状态配置。订阅关系由消费者分组动态注册到服务端系统，并在后续的消息传输中按照订阅关系定义的过滤规则进行消息匹配和消费进度维护。
消息过滤：消费者可以通过订阅指定消息标签（Tag）对消息进行过滤，确保最终只接收被过滤后的消息合集。过滤规则的计算和匹配在云消息队列 RocketMQ 版的服务端完成。
重置消费位点：以时间轴为坐标，在消息持久化存储的时间范围内，重新设置消费者分组对已订阅主题的消费进度，设置完成后消费者将接收设定时间点之后，由生产者发送到云消息队列 RocketMQ 版服务端的消息。
消息轨迹：在一条消息从生产者发出到消费者接收并处理过程中，由各个相关节点的时间、地点等数据汇聚而成的完整链路信息。通过消息轨迹，您能清晰定位消息从生产者发出，经由云消息队列 RocketMQ 版服务端，投递给消费者的完整链路，方便定位排查问题。
消息堆积：生产者已经将消息发送到云消息队列 RocketMQ 版的服务端，但由于消费者的消费能力有限，未能在短时间内将所有消息正确消费掉，此时在云消息队列 RocketMQ 版的服务端保存着未被消费的消息，该状态即消息堆积。
事务消息：事务消息是云消息队列 RocketMQ 版提供的一种高级消息类型，支持在分布式场景下保障消息生产和本地事务的最终一致性。
定时/延时消息：定时/延时消息是云消息队列 RocketMQ 版提供的一种高级消息类型，消息被发送至服务端后，在指定时间后才能被消费者消费。通过设置一定的定时时间可以实现分布式场景的延时调度触发效果。
顺序消息：顺序消息是云消息队列 RocketMQ 版提供的一种高级消息类型，支持消费者按照发送消息的先后顺序获取消息，从而实现业务场景中的顺序处理。

二、RocketMQ前期准备

首先需要下载相关.NET相关的SDK，然后在阿里云后台找到【实例用户名】【实例密码】【接入点链接信息】等信息，最后还需要创建【Group ID】和【Topic】用于给我们调用。

2.1-下载资源包及SDK

[西瓜程序猿]给正在看这篇文章的小伙伴提供了资源包，【ONSClient4CPP】文件夹里面包含使用RocketMQ阿里云版本要依赖的DLL文件，【RocketMQ_SDK】文件夹包含了.NET Framework使用RocketMQ阿里云版本要用到的SDK文件，【vcredistx64】文件夹包含了Visual C++ 2015运行时环境安装包，因为C++ DLL文件需要依赖这个，这个需要进行安装。还包含其他辅助的工具及代码。

可以访问下载（如果失效了，请联系我）。

下载地址（编码：xxxx）：xxxx
密码：xxxx

文件截图：

2.2-查询基本配置信息

（1）首先点击下面链接进入消息队列RocketMQ工作台，如果没有登录首先要进行登录。然后在【资源分布】里面找到要操作的地域列表，点击【地域名称】。

消息队列RocketMQ（阿里云版）：https://ons.console.aliyun.com/overview

（2）然后可以看到实例列表，找到要操作的实例，点击【详情】。

（3）然后在【运行信息】中找到【实例用户名】和【实例密码】，注意不是实例ID/实例名称。

（5）然后还在当前页面，往下翻到【TCP 协议接入点】中找到接入点和网络信息。如果大家需要在外网访问自行开通公网访问，好像需要另外付费。[西瓜程序猿]这边只能通过【VPC专有网络】访问，也就是只能在内网访问。所以我以VPC专有网络来介绍。

那我们就把必要的信息都集齐全了，分别是【实例用户名】【实例密码】【TCP 协议接入点连接】。

2.3-配置Topic和Group

那什么是Topic呢？云消息队列 RocketMQ 版中消息传输和存储的顶层容器，用于标识同一类业务逻辑的消息。主题通过TopicName来做唯一标识和区分。可以理解为不同的系统、不同的发布环境配置不同的Topic。然后来说一下如何配Topic和GroupID。

（1）在左侧导航栏找到【Topic管理】，然后点击【创建Topic】。名称和描述都是必填的，消息类型根据自己业务场景选择。[西瓜程序猿]这边要求消息按照顺序发送和消费，所以选择【顺序消息】。

（2）然后再来创建GroupID。一个 Group ID 代表一个 Consumer 实例群组。同一个消费者 Group ID 下所有的 Consumer 实例必须保证订阅的 Topic 一致，并且也必须保证订阅 Topic 时设置的过滤规则（Tag）一致。否则您的消息可能会丢失。

那我们就把必要的资源都创建好了，分别是【Topic名称】【GroupID】。
Topic名称：

GroupID：

二、RockeetMQ核心部分封装

官方开发文档：https://help.aliyun.com/zh/apsaramq-for-rocketmq/cloud-message-queue-rocketmq-5-x-series/developer-reference/release-notes-2?spm=a2c4g.11186623.0.0.36265238l85Omk

2.1-创建类库项目

（1）点击【创建新项目】，然后选择【类库(.NET Framework)】。

目录：

（2）然后新建一个【SDK】文件夹，将下载好的资源包里面文件夹【RocketMQ_SDK】的文件，复制到项目中【SDK】文件夹里面。
资源包：

项目：

（3）然后就安装相关的包，分别是【log4net】用来记录日志，【Newtonsoft.Json】用来做JSON序列化和反序列化。（如果自己项目中有日志系统和反序列化工具，也可以不安装，根据自己项目依赖公共辅助层去使用）
（4）创建了一个【Helper】文件夹写一个JSON反序列化的帮助类（根据自己业务需要创建）。
目录：

代码；

1. public class JsonUtility
2.     {
3.         /// <summary>
4.         /// 将实体类序列化为JSON
5.         /// </summary>
6.         /// <typeparam name="T"></typeparam>
7.         /// <param name="data"></param>
8.         /// <returns></returns>
9.         static public string SerializeJSON<T>(T data)
10.         {
11.             return Newtonsoft.Json.JsonConvert.SerializeObject(data);
12.         }
14.         /// <summary>
15.         /// 反序列化JSON
16.         /// </summary>
17.         /// <typeparam name="T"></typeparam>
18.         /// <param name="json"></param>
19.         /// <returns></returns>
20.         static public T DeserializeJSON<T>(string json)
21.         {
22.             return Newtonsoft.Json.JsonConvert.DeserializeObject<T>(json);
23.         }
25.         /// <summary>
26.         /// 将IEnumerable<T,V>序列化为JSON
27.         /// </summary>
28.         /// <param name="value"></param>
29.         /// <returns></returns>
30.         static public string SerializeDictionary(IEnumerable<KeyValuePair<string, string>> value)
31.         {
32.             return Newtonsoft.Json.JsonConvert.SerializeObject(value.Select(I => new { label = I.Key, value = I.Value }));
33.         }
34.     }

复制代码

（5）然后在创建一个【Attributes】文件夹。在里面新建两个Attribute特性，一个【ConsumerTagAttribute】用来区分Tag标签，另一个【EventTypeAttribute】用来区分事件类型。
目录：

代码：

1.     /// <summary>
2.     /// Tag标签
3.     /// </summary>
4.     public class ConsumerTagAttribute : Attribute
5.     {
6.         public string Tag { get; set; }
8.         public ConsumerTagAttribute(string tag)
9.         {
10.             Tag = tag;
11.         }
12.     }
16.   /// <summary>
17.     /// 事件类型
18.     /// </summary>
19.     public class EventTypeAttribute : Attribute
20.     {
21.         public string EventType { get; set; }
23.         public EventTypeAttribute(string eventType)
24.         {
25.             EventType = eventType;
26.         }
27.     }

复制代码

2.2-封装传输实体模型

然后我们需要设计生产者和消费者直接需要传输共同的消息时哪些。
目前想到的（如果有好的建议可以在评论区讨论哈）：

MessageId：消息id
Tag：对应RocketMQ中Tag
SendTime：发送时间
Source：消息来源
EventType：事件类型
Body：消息体

目录：

（1）创建一个【Models】文件夹，用来存相关的实体。然后创建【IQueueOnsCommonModel】生产者/消费者公共模型接口，然后创建【QueueOnsCommonModel】文件实现IQueueOnsCommonModel接口。
IQueueOnsCommonModel：

1. /// <summary>
2.     /// 生产者/消费者公共模型接口
3.     /// </summary>
4.     public interface IQueueOnsCommonModel
5.     {
6.         /// <summary>
7.         /// 消息id
8.         /// </summary>
9.         string MessageId { get; set; }
11.         /// <summary>
12.         /// 对应RocketMQ中Tag
13.         /// </summary>
14.         string Tag { get; set; }
16.         /// <summary>
17.         /// 发送时间
18.         /// </summary>
19.         DateTime SendTime { get; set; }
21.         /// <summary>
22.         /// 消息来源
23.         /// </summary>
24.         string Source { get; set; }
26.         /// <summary>
27.         /// 事件类型
28.         /// </summary>
29.         string EventType { get; set; }
31.         /// <summary>
32.         /// 消息体
33.         /// </summary>
34.         string Body { get; set; }
35.     }

复制代码

QueueOnsCommonModel：

1. /// <summary>
2.     /// 生产者/消费者公共模型实现
3.     /// </summary>
4.     public class QueueOnsCommonModel : IQueueOnsCommonModel
5.     {
6.         /// <summary>
7.         /// 消息id
8.         /// </summary>
9.         public string MessageId { get; set; }
11.         /// <summary>
12.         /// 对应RocketMQ中Tag
13.         /// </summary>
14.         public string Tag { get; set; }
16.         /// <summary>
17.         /// 发送时间
18.         /// </summary>
19.         public DateTime SendTime { get; set; }
21.         /// <summary>
22.         /// 消息来源
23.         /// </summary>
24.         public string Source { get; set; }
26.         /// <summary>
27.         /// 事件类型
28.         /// </summary>
29.         public string EventType { get; set; }
31.         /// <summary>
32.         /// 消息体
33.         /// </summary>
34.         public string Body { get; set; }
35.     }

复制代码

（2）创建一个【ONSPropertyConfigModel】文件，用来做配置文件的实体。

1.       /// <summary>
2.     /// RocketMQ配置属性
3.     /// </summary>
4.     public class ONSPropertyConfigModel
5.     {
6.         /// <summary>
7.         /// 设置为云消息队列 RocketMQ 版控制台实例详情页的实例用户名。
8.         /// </summary>
9.         public string AccessKey { get; set; }
11.         /// <summary>
12.         /// 设置为云消息队列 RocketMQ 版控制台实例详情页的实例密码。
13.         /// </summary>
14.         public string SecretKey { get; set; }
16.         /// <summary>
17.         /// 设置为您在云消息队列 RocketMQ 版控制台创建的Group ID。
18.         /// </summary>
19.         public string GroupId { get; set; }
21.         /// <summary>
22.         /// 您在云消息队列 RocketMQ 版控制台创建的Topic。
23.         /// </summary>
24.         public string Topics { get; set; }
26.         /// <summary>
27.         /// 设置为您从云消息队列 RocketMQ 版控制台获取的接入点信息，类似“rmq-cn-XXXX.rmq.aliyuncs.com:8080”
28.         /// </summary>
29.         public string NAMESRV_ADDR { get; set; }
31.         /// <summary>
32.         /// 消费者/生产者目标来源
33.         /// </summary>
34.         public string OnsClientCode { get; set; }
35.     }

复制代码

（3）然后创建一个【QueueTagConsts】文件，用来订单消息队列Tag常量，和一个【QueueOnsEventType】文件，用来定义事件类型。
目录：

QueueTagConsts：

1. /// <summary>
2.     /// 消息队列Tag常量定义
3.     /// 命名规范：项目名_自定义业务名_Tag
4.     /// </summary>
5.     public class QueueTagConsts
6.     {
7.         /// <summary>
8.         /// 测试Sample
9.         /// </summary>
10.         public const string XG_Blog_Sample_Tag = "XG_Blog_Sample_Tag";
11.     }

复制代码

QueueOnsEventType：

1.     /// <summary>
2.     /// 消息队列-事件类型
3.     /// </summary>
4.     public class QueueOnsEventType
5.     {
6.         /// <summary>
7.         /// RocketMQ测试
8.         /// </summary>
9.         public const string RocketMQ_TEST = "RocketMQ_TEST";
10.     }

复制代码

2.3-封装连接RocketMQ

创建一个【Core】文件夹，然后创建一个【IConsumerMsg】消费接口，和一个【QueueOnsProducer】文件用来封装RocketMQ生产者连接。
目录：

IConsumerMsg：

1. /// <summary>
2.     /// 消费接口
3.     /// </summary>
4.     public interface IConsumerMsg
5.     {
6.         void Consume(QueueOnsCommonModel model);
7.     }

复制代码

QueueOnsProducer：

1. /// <summary>
2.     /// 消息队列-RocketMQ生产者
3.     /// </summary>
4.     public class QueueOnsProducer
5.     {
6.         private static Producer _producer;
7.         private static PushConsumer _consumer;
8.         private readonly static ILog logger = LogManager.GetLogger(typeof(QueueOnsProducer));
9.         private static string Ons_Topic = "";
10.         private static string Ons_AccessKey = "";
11.         private static string Ons_SecretKey = "";
12.         private static string Ons_GroupId = "";
13.         private static string Ons_NameSrv = "";
14.         private static int Ons_ConsumptionPattern = 1;
15.         private static string Ons_Client_Code = "Test_RocketMQ_Producer";
16.         private const string Ons_LogPath = "C://rocket_mq_logs";
18.         public static string getOnsTopic
19.         {
20.             get
21.             {
22.                 return Ons_Topic;
23.             }
24.         }
26.         public static string getOnsClientCode
27.         {
28.             get
29.             {
30.                 return Ons_Client_Code;
31.             }
32.         }
34.         private static ONSFactoryProperty getFactoryPropertyProducer()
35.         {
36.             ONSFactoryProperty factoryInfo = new ONSFactoryProperty();
37.             factoryInfo.setFactoryProperty(ONSFactoryProperty.AccessKey, Ons_AccessKey);
38.             factoryInfo.setFactoryProperty(ONSFactoryProperty.SecretKey, Ons_SecretKey);
39.             factoryInfo.setFactoryProperty(ONSFactoryProperty.ConsumerId, Ons_GroupId);
40.             factoryInfo.setFactoryProperty(ONSFactoryProperty.ProducerId, Ons_GroupId);
41.             factoryInfo.setFactoryProperty(ONSFactoryProperty.PublishTopics, Ons_Topic);
42.             factoryInfo.setFactoryProperty(ONSFactoryProperty.NAMESRV_ADDR, Ons_NameSrv);
43.             factoryInfo.setFactoryProperty(ONSFactoryProperty.LogPath, Ons_LogPath);
44.             return factoryInfo;
45.         }
47.         private static ONSFactoryProperty getFactoryPropertyConsumer()
48.         {
49.             ONSFactoryProperty factoryInfo = new ONSFactoryProperty();
50.             factoryInfo.setFactoryProperty(ONSFactoryProperty.AccessKey, Ons_AccessKey);
51.             factoryInfo.setFactoryProperty(ONSFactoryProperty.SecretKey, Ons_SecretKey);
52.             factoryInfo.setFactoryProperty(ONSFactoryProperty.ConsumerId, Ons_GroupId);
53.             factoryInfo.setFactoryProperty(ONSFactoryProperty.PublishTopics, Ons_Topic);
54.             factoryInfo.setFactoryProperty(ONSFactoryProperty.NAMESRV_ADDR, Ons_NameSrv);
55.             factoryInfo.setFactoryProperty(ONSFactoryProperty.LogPath, Ons_LogPath);
56.             //消费模式（1:集群消费、2:广播消费）
57.             if (Ons_ConsumptionPattern == 1)
58.             {
59.                 factoryInfo.setFactoryProperty(ONSFactoryProperty.MessageModel, ONSFactoryProperty.CLUSTERING);
60.             }
61.             else if (Ons_ConsumptionPattern == 2)
62.             {
63.                 factoryInfo.setFactoryProperty(ONSFactoryProperty.MessageModel, ONSFactoryProperty.BROADCASTING);
64.             }
65.             return factoryInfo;
66.         }
68.         public static void CreateProducer(ONSPropertyConfigModel config)
69.         {
70.             if (config == null) { throw new ArgumentNullException("config is null"); }
71.             if (string.IsNullOrEmpty(config.AccessKey)) { throw new ArgumentNullException("AccessKey is null"); }
72.             if (string.IsNullOrEmpty(config.SecretKey)) { throw new ArgumentNullException("SecretKey is null"); }
73.             if (string.IsNullOrEmpty(config.GroupId)) { throw new ArgumentNullException("GroupId is null"); }
74.             if (string.IsNullOrEmpty(config.Topics)) { throw new ArgumentNullException("Topics is null"); }
75.             if (string.IsNullOrEmpty(config.NAMESRV_ADDR)) { throw new ArgumentNullException("NAMESRV_ADDR is null"); }
76.             if (string.IsNullOrEmpty(config.OnsClientCode)) { throw new ArgumentNullException("OnsClientCode is null"); }
78.             Ons_AccessKey = config.AccessKey;
79.             Ons_SecretKey = config.SecretKey;
80.             Ons_GroupId = config.GroupId;
81.             Ons_Topic = config.Topics;
82.             Ons_NameSrv = config.NAMESRV_ADDR;
83.             Ons_Client_Code = config.OnsClientCode;
84.             _producer = ONSFactory.getInstance().createProducer(getFactoryPropertyProducer());
85.         }
87.         public static void StartProducer()
88.         {
89.             if (_producer != null)
90.             {
91.                 _producer.start();
92.                 string msg = $"【{Ons_Topic}】-【{Ons_Client_Code}】：[{DateTime.Now}]生产者 启动 成功！";
93.                 logger.Info(msg);
94.             }
95.             else
96.             {
97.                 throw new ArgumentNullException("_producer is null，请先执行[CreateProducer]创建生产者后启动");
98.             }
99.         }
101.         public static void ShutdownProducer()
102.         {
103.             if (_producer != null)
104.             {
105.                 _producer.shutdown();
106.                 string msg = $"【{Ons_Topic}】-【{Ons_Client_Code}】：[{DateTime.Now}]生产者 已关闭连接！";
107.                 logger.Info(msg);
108.             }
109.         }
111.         public static string SendMessage(QueueOnsCommonModel model, string tag = "RegisterLog")
112.         {
113.             if (model == null) { throw new ArgumentNullException("model is null"); }
115.             model.SendTime = DateTime.Now;
116.             model.Source = Ons_Client_Code;
117.             var send_str = JsonUtility.SerializeJSON(model);
118.             byte[] bytes = Encoding.UTF8.GetBytes(send_str);
119.             string str_new_msg = Encoding.Default.GetString(bytes);
120.             logger.Info("【发送队列消息】消息内容：" + str_new_msg);
122.             string msg_key = model.MessageId;
123.             string msg_id = string.Empty;
124.             Message msg = new Message(Ons_Topic, tag, str_new_msg);
125.             msg.setKey(msg_key);
126.             try
127.             {
128.                 SendResultONS sendResult = _producer.send(msg);
129.                 msg_id = sendResult.getMessageId();
130.                 logger.Info("【发送队列消息】消息ID：" + msg_id);
131.             }
132.             catch (Exception ex)
133.             {
134.                 logger.Error($"【发送队列消息】发生异常了：{ex.Message}", ex);
135.                 throw ex;
136.             }
137.             return msg_id;
138.         }
140.         public static void CreatePushConsumer(ONSPropertyConfigModel config)
141.         {
142.             if (config == null) { throw new ArgumentNullException("config is null"); }
143.             if (string.IsNullOrEmpty(config.AccessKey)) { throw new ArgumentNullException("AccessKey is null"); }
144.             if (string.IsNullOrEmpty(config.SecretKey)) { throw new ArgumentNullException("SecretKey is null"); }
145.             if (string.IsNullOrEmpty(config.GroupId)) { throw new ArgumentNullException("GroupId is null"); }
146.             if (string.IsNullOrEmpty(config.Topics)) { throw new ArgumentNullException("Topics is null"); }
147.             if (string.IsNullOrEmpty(config.NAMESRV_ADDR)) { throw new ArgumentNullException("NAMESRV_ADDR is null"); }
148.             if (string.IsNullOrEmpty(config.OnsClientCode)) { throw new ArgumentNullException("OnsClientCode is null"); }
150.             // 集群消费。
151.             Ons_ConsumptionPattern = 1;
152.             // 广播消费。
153.             //Ons_ConsumptionPattern = 2;
155.             Ons_AccessKey = config.AccessKey;
156.             Ons_SecretKey = config.SecretKey;
157.             Ons_GroupId = config.GroupId;
158.             Ons_Topic = config.Topics;
159.             Ons_NameSrv = config.NAMESRV_ADDR;
160.             Ons_Client_Code = config.OnsClientCode;
161.             _consumer = ONSFactory.getInstance().createPushConsumer(getFactoryPropertyConsumer());
162.         }
164.         public static void SetPushConsumer(MessageListener listener, string subExpression = "*")
165.         {
166.             _consumer.subscribe(Ons_Topic, subExpression, listener);
167.         }
169.         public static void StartPushConsumer()
170.         {
171.             _consumer.start();
172.             string msg = $"【{Ons_Topic}】-【{Ons_Client_Code}】：[{DateTime.Now}]消费者 启动 成功！";
173.             logger.Info(msg);
174.         }
176.         public static void ShutdownPushConsumer()
177.         {
178.             if (_consumer != null)
179.             {
180.                 _consumer.shutdown();
181.                 string msg = $"【{Ons_Topic}】-【{Ons_Client_Code}】：[{DateTime.Now}]消费者 已关闭连接！";
182.                 logger.Info(msg);
183.             }
184.         }
185.     }

复制代码

三、生产端实现

3.1-创建生产者

3.1.1-创建MVC项目

（1）然后创建一个生产者，可以创建WebAPI/MVC/JOB（控制台应用程序）等等，那[西瓜程序猿]以MVC项目作为例子来介绍一下，创建一个名为【RocketMQ.Producer】项目。

运行测试一下：

3.1.2-项目依赖配置

阿里云提供的.NET版本是基于云消息队列 RocketMQ 版的CPP版本的托管封装，这样能保证.NET完全不依赖于Windows.NET公共库。内部采用C++多线程并发处理，保证.NET版本的高效稳定。

（1）底层的C++ DLL相关文件，以及Visual C++ 2015运行时环境安装包。如果没有安装Visual Studio 2015运行时环境，需要在资源包找到【vc_redist.x64.exe】文件进行安装。

（2）在使用Visual Studio（VS）开发.NET的应用程序和类库时，默认的目标平台为“Any CPU”。但是.NET SDK仅支持Windows 64-bit操作系统，所以需要自行设置。先右击【RocketMQ.Producer】项目，然后点击【属性】。

（3）点击左侧选项的【生成】，然后将目标平台改为【x64】。

（3）将资源包【ONSClient4CPP】文件夹里面所有的文件，复制到【bin】目录下。
资源包：

项目：

3.1.3-使用log4net

（1）使用lo4net输出日志，大家也可以用别的日志框架，记得在用到写入日志的地方自行进行修改。那[西瓜程序猿]使用log4net来介绍。我们在项目的根目录下创建一个文件为【log4net.config】。

（2）【log4net.config】内容如下。

1. <?xml version="1.0" encoding="utf-8"?>
2. <configuration>
3.         <configSections>
4.                 <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
5.         </configSections>
7.         <system.web>
8.                 <compilation debug="true" targetFramework="4.5.2" />
9.                 <httpRuntime targetFramework="4.5.2" />
10.         </system.web>
11.         <log4net>
12.                
13.                
14.                
15.                 <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender">
16.                        
17.                         <file value="log/error/error_" />
18.                        
19.                         <appendToFile value="true"/>
20.                        
21.                         <rollingStyle value="Date"/>
22.                        
23.                         <datePattern value="yyyy-MM-dd'.log'"/>
24.                        
25.                         <staticLogFileName value="false"/>
26.                        
27.                         <param name="MaxSizeRollBackups" value="100"/>
28.                        
29.                         <maximumFileSize value="50MB" />
30.                        
31.                         <layout type="log4net.Layout.PatternLayout">
32.                                
33.                                
34.                                
36.                                
37.                                
38.                                 <conversionPattern value="%n＝＝＝＝＝＝＝＝＝＝
39.                                   %n【日志级别】%-5level
40.                                   %n【记录时间】%date
41.                                   %n【执行时间】[%r]毫秒
42.                                   %n【出错文件】%F
43.                                   %n【出错行号】%L
44.                                   %n【出错的类】%logger 属性[%property{NDC}]
45.                                   %n【错误描述】%message
46.                                   %n【错误详情】%newline"/>
47.                         </layout>
48.                         <filter type="log4net.Filter.LevelRangeFilter,log4net">
49.                                 <levelMin value="ERROR" />
50.                                 <levelMax value="FATAL" />
51.                         </filter>
52.                 </appender>
54.                
55.                
56.                
57.                 <appender name="DebugAppender" type="log4net.Appender.RollingFileAppender">
58.                        
59.                         <file value="log/debug/debug_" />
60.                        
61.                         <appendToFile value="true"/>
62.                        
63.                         <rollingStyle value="Date"/>
64.                        
65.                         <datePattern value="yyyy-MM-dd'.log'"/>
66.                        
67.                         <staticLogFileName value="false"/>
68.                        
69.                         <param name="MaxSizeRollBackups" value="100"/>
70.                        
71.                         <maximumFileSize value="50MB" />
72.                        
73.                         <layout type="log4net.Layout.PatternLayout">
74.                                
75.                                
76.                                
78.                                
79.                                
80.                                 <conversionPattern value="%n＝＝＝＝＝＝＝＝＝＝
81.                                   %n【日志级别】%-2level
82.                                   %n【记录时间】%date
83.                                   %n【执行时间】[%r]毫秒
84.                                   %n【debug文件】%F
85.                                   %n【debug行号】%L
86.                                   %n【debug类】%logger 属性[%property{NDC}]
87.                                   %n【debug描述】%message"/>
88.                         </layout>
89.                         <filter type="log4net.Filter.LevelRangeFilter,log4net">
90.                                 <levelMin value="DEBUG" />
91.                                 <levelMax value="WARN" />
92.                         </filter>
93.                 </appender>
96.                
97.                
98.                
99.                 <appender name="INFOAppender" type="log4net.Appender.RollingFileAppender">
100.                        
101.                         <file value="log/info/info_" />
102.                        
103.                         <appendToFile value="true"/>
104.                        
105.                         <rollingStyle value="Date"/>
106.                        
107.                         <datePattern value="yyyy-MM-dd'.log'"/>
108.                        
109.                         <staticLogFileName value="false"/>
110.                        
111.                         <param name="MaxSizeRollBackups" value="100"/>
112.                        
113.                         <maximumFileSize value="50MB" />
114.                        
115.                         <layout type="log4net.Layout.PatternLayout">
116.                                
117.                                
118.                                
120.                                
121.                                
122.                                 <conversionPattern value="%n＝＝＝＝＝＝＝＝＝＝
123.                                   %n【日志级别】%-2level
124.                                   %n【记录时间】%date
125.                                   %n【执行时间】[%r]毫秒
126.                                   %n【info文件】%F
127.                                   %n【info行号】%L
128.                                   %n【info类】%logger 属性[%property{NDC}]
129.                                   %n【info描述】%message"/>
130.                         </layout>
131.                         <filter type="log4net.Filter.LevelRangeFilter,log4net">
132.                                 <levelMin value="INFO" />
133.                                 <levelMax value="WARN" />
134.                         </filter>
135.                 </appender>
137.                
138.                 <root>
139.                        
140.                         <level value="ALL" />
141.                         <appender-ref ref="DebugAppender" />
142.                         <appender-ref ref="ErrorAppender" />
143.                         <appender-ref ref="INFOAppender" />
144.                 </root>
145.         </log4net>
146. </configuration>

复制代码

（3）并且右击【log4net.config】文件，点击【属性】，然后将[复制到输出目录]设置为【始终复制】。

（4）然后安装log4net。在项目目录中右击【引用】，然后点击【管理NuGet程序包】

（5）然后点击浏览，搜索【log4net】，右侧点击安装即可。

（6）然后在【Global.asax】文件中注册log4net。

1.         protected void Application_Start()
2.         {
3.             XmlConfigurator.Configure(new System.IO.FileInfo(Server.MapPath("~/log4net.config")));
4.         }

复制代码

3.1.4-封装发送消息

（1）在当前项目新建一个【Services】文件夹，作为服务层。大家也可以将Services创建为单独的类库，然后在这个项目上去引入【RocketMQ.Core】，在用【RocketMQ.Producer】项目区引入【Services】。那[西瓜程序猿]为了方便就直接在当前项目写了。然后再【Services】文件夹里面创建【BaseProducerService】文件，用于封装生产者发送消息服务。
目录：

代码：

1. /// <summary>
2.     /// 生产者服务
3.     /// </summary>
4.     public class BaseProducerService
5.     {
6.         private readonly ILog logger = log4net.LogManager.GetLogger(typeof(BaseProducerService));
8.         public void SendQueueOnsProducer(string body, string msg_tag, string mgs_eventType)
9.         {
10.             if (string.IsNullOrEmpty(body)) { throw new ArgumentNullException("body is null"); }
11.             if (string.IsNullOrEmpty(msg_tag)) { throw new ArgumentNullException("msg_tag is null"); }
12.             if (string.IsNullOrEmpty(mgs_eventType)) { throw new ArgumentNullException("mgs_eventType is null"); }
14.             string ons_topic = QueueOnsProducer.getOnsTopic;
15.             string ons_client_code = QueueOnsProducer.getOnsClientCode;
17.             //TODO：这里需要生成唯一ID
18.             string businessId = "MQ_1001";
20.             logger.Info($"【发送RocketMQ消息队列消息】准备开始执行了：（消息key：{businessId}）（tag：{msg_tag}）（event_type：{mgs_eventType}）");
21.             logger.Info($"【发送RocketMQ消息队列消息】消息内容：{body}");
23.             // TODO：在这里可以持久化生产者消息
24.             logger.Info($"【发送RocketMQ消息队列消息】消息持久化成功！(消息主键id：{businessId})");
26.             Task.Run(() =>
27.             {
28.                 try
29.                 {
30.                     QueueOnsProducer.SendMessage(new QueueOnsCommonModel()
31.                     {
32.                         MessageId = businessId,
33.                         Tag = msg_tag,
34.                         EventType = mgs_eventType,
35.                         Body = body
36.                     }, msg_tag);
37.                     logger.Info($"【发送RocketMQ消息队列消息】消息发送成功！");
38.                 }
39.                 catch (Exception ex)
40.                 {
41.                     logger.Error($"【发送RocketMQ消息队列消息】发生异常：{ex.Message}", ex);
42.                 }
43.             });
44.         }
45.     }

复制代码

3.2-配置连接信息

（1）然后右击【RocketMQ.Producer】项目下，点击【引用】，然后将【RocketMQ.Core】项目勾选上确定。

（2）然后将前期准备的基本信息放在配置文件中。在【Web.config】文件进行配置。

代码：

1.    
2.    
3.     <add key="ons_access_key" value="xxx" />
4.    
5.     <add key="ons_secret_key" value="xxx" />
6.    
7.     <add key="ons_topic" value="XG_CXY_Test" />
8.    
9.     <add key="ons_groupId" value="XG_CXY_Group_Test" />
10.    
11.     <add key="ons_name_srv" value="xxx-xxx-xxx-xxx.rmq.aliyuncs.com:8080" />
12.    
13.     <add key="ons_client_code" value="XG_CXY_Producer_Develop" />

复制代码

（3）然后创建一个【Config】文件夹，写一个获得【ConfigGeter】配置文件的帮助类。

代码：

1.     /// <summary>
2.     /// 配置文件
3.     /// </summary>
4.     public class ConfigGeter
5.     {
6.         private static T TryGetValueFromConfig<T>(Func<string, T> parseFunc, Func<T> defaultTValueFunc, [CallerMemberName] string key = "", string supressKey = "")
7.         {
8.             try
9.             {
10.                 if (!string.IsNullOrWhiteSpace(supressKey))
11.                 {
12.                     key = supressKey;
13.                 }
15.                 var node = ConfigurationManager.AppSettings[key];
16.                 return !string.IsNullOrEmpty(node) ? parseFunc(node) : defaultTValueFunc();
17.             }
18.             catch (Exception ex)
19.             {
20.                 return default(T);
21.             }
22.         }
24.         #region 消息队列：RocketMQ
25.         /// <summary>
26.         /// 设置为云消息队列 RocketMQ 版控制台实例详情页的实例用户名。
27.         /// </summary>
28.         public static string ons_access_key
29.         {
30.             get
31.             {
32.                 return TryGetValueFromConfig(_ => _, () => string.Empty);
33.             }
34.         }
36.         /// <summary>
37.         /// 设置为云消息队列 RocketMQ 版控制台实例详情页的实例密码。
38.         /// </summary>
39.         public static string ons_secret_key
40.         {
41.             get
42.             {
43.                 return TryGetValueFromConfig(_ => _, () => string.Empty);
44.             }
45.         }
47.         /// <summary>
48.         ///  您在云消息队列 RocketMQ 版控制台创建的Topic。
49.         /// </summary>
50.         public static string ons_topic
51.         {
52.             get
53.             {
54.                 return TryGetValueFromConfig(_ => _, () => string.Empty);
55.             }
56.         }
58.         /// <summary>
59.         /// 设置为您在云消息队列 RocketMQ 版控制台创建的Group ID。
60.         /// </summary>
61.         public static string ons_groupId
62.         {
63.             get
64.             {
65.                 return TryGetValueFromConfig(_ => _, () => string.Empty);
66.             }
67.         }
69.         /// <summary>
70.         /// 设置为您从云消息队列 RocketMQ 版控制台获取的接入点信息，类似“rmq-cn-XXXX.rmq.aliyuncs.com:8080”。
71.         /// </summary>
72.         public static string ons_name_srv
73.         {
74.             get
75.             {
76.                 return TryGetValueFromConfig(_ => _, () => string.Empty);
77.             }
78.         }
80.         /// <summary>
81.         /// 消息来源（生产者/消费端客户端编码）
82.         /// </summary>
83.         public static string ons_client_code
84.         {
85.             get
86.             {
87.                 return TryGetValueFromConfig(_ => _, () => string.Empty);
88.             }
89.         }
90.         #endregion
91.     }

复制代码

3.3-启动生产者

3.3.1-MVC/WebAPI项目

在【Global.asax】文件Application_Start方法中创建生产者，主要就是从配置文件中获得配置信息，然后调用【QueueOnsProducer.CreateProducer】方法创建消息队列生产者，通过调用【QueueOnsProducer.StartProducer】方法来启动生产者。

代码：

1. protected void Application_Start()
2.         {
3.             //创建生产者[西瓜程序猿]
4.             string ons_access_key = ConfigGeter.ons_access_key;
5.             string ons_secret_key = ConfigGeter.ons_secret_key;
6.             string ons_topic = ConfigGeter.ons_topic;
7.             string ons_groupId = ConfigGeter.ons_groupId;
8.             string ons_name_srv = ConfigGeter.ons_name_srv;
9.             string ons_client_code = ConfigGeter.ons_client_code;
10.             QueueOnsProducer.CreateProducer(new ONSPropertyConfigModel()
11.             {
12.                 AccessKey = ons_access_key,
13.                 SecretKey = ons_secret_key,
14.                 Topics = ons_topic,
15.                 GroupId = ons_groupId,
16.                 NAMESRV_ADDR = ons_name_srv,
17.                 OnsClientCode = ons_client_code,
18.             });
19.             //启动生产者
20.             QueueOnsProducer.StartProducer();
21.         }

复制代码

3.3.2-JOB(控制台应用程序)项目

在【Program.cs】项目启动文件的Main方法中创建生产者，主要就是从配置文件中获得配置信息，然后调用【QueueOnsProducer.CreateProducer】方法创建消息队列生产者，通过调用【QueueOnsProducer.StartProducer】方法来启动生产者。

3.4-发送消息

（1）先设计好消息传输内容（Body）实体，比如我这边需要根据姓名/账号做一些异步业务处理，那我这笔就新建一个名为【RocketMQSampleModel】类。
目录：

代码：

1.     /// <summary>
2.     /// 发送RocketMQ测试消息实体
3.     /// </summary>
4.     public class RocketMQSampleModel
5.     {
6.         public string user_name { get; set; }
7.         public string user_account { get; set; }
8.     }

复制代码

（2）然后就开始创建具体的发送RocketMQ消息的服务，可以根据自己的业务去创建，那[西瓜程序猿]这边就创建一个名为【SampleProducerService】的发送RocketMQ消息服务，然后继承【BaseProducerService】类。
目录：

代码：

1. public class SampleProducerService : BaseProducerService
2.     {
3.         /// <summary>
4.         /// 发送RocketMQ测试消息
5.         /// </summary>
6.         /// <param name="model"></param>
7.         public void SendTestMessageHandle(RocketMQSampleModel model)
8.         {
9.             if (model == null) return;
10.             string msg_body = JsonUtility.SerializeJSON<RocketMQSampleModel>(model);
11.             if (msg_body != null)
12.             {
13.                 SendQueueOnsProducer(msg_body, QueueTagConsts.XG_Blog_Sample_Tag, QueueOnsEventType.RocketMQ_TEST);
14.             }
15.         }
16.     }

复制代码

（3）然后我们在Controller里面去调用一下发送消息。[西瓜程序猿]这里以【Home/Index】里面进行使用。
截图：

代码：

1. //调用消息队列
2.             new SampleProducerService().SendTestMessageHandle(new RocketMQSampleModel()
3.             {
4.                 user_name = "西瓜程序猿",
5.                 user_account = "admin"
6.             });

复制代码

（4）然后运行一下，看看能不能成功消息消息（默认就会执行到Home/Index）。[西瓜程序猿]这边需要先发布到服务器上才能调用，因为只能在服务器内网访问，那我这边发布一下。

注意：发布到服务器上后，也需要将资源包中的【ONSClient4CPP】所有文件拷贝到服务器站点的【bin】目录下。

（5）发布好了，然后运行一下，可以看到是成功了。

然后我们在来看看日志，提示发送成功了。

最后在去阿里云后台查询一下是否有这条消息记录。可以根据消息Key和消息ID两种方式进行查询。可以在后台看到是真正发送成功了。

博客对于图文有数量限制要求，那这一节先写到这里，持续更新中，下一章节有消费者的实现、防踩坑指南等等！
我是西瓜程序猿，感谢大家的阅读。编写不易，如果对大家有帮助，用您发财的小手点个赞和关注呗，非常感谢！有问题欢迎联系我一起学习与探讨~

原文链接：https://www.cnblogs.com/kimiliucn/p/17662052.html
下一章节：

来源:https://www.cnblogs.com/kimiliucn/archive/2023/08/28/17662052.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！