RocketMQ源码如何在本地运行

﹏ヽ暗。殇╰゛Y 2023-10-01 10:41 19阅读 0赞

## 一、背景 ##

为什么要本地运行源码呢？前一段时间遇到一个问题，每次系统自动呼叫三方运力（美团、蜂鸟、达达之类）的时候，总是会重复呼叫两次；最后排查发现是RocketMQ Consumer消费超时，进而导致重复消费，昨天在复习RocketMQ的时候，很神奇的就深入到消费的核心逻辑里了…（这里的故事下篇文章见）。理完Broker和Consumer的源码后也得出了一些结论，但需要加点日志跑一跑源码，让结论不是盖棺而论；所以就有了今天的故事。

## 二、下载源码 ##

源码地址：[https://github.com/Saint9768/rocketmq/releases/tag/rocketmq-all-4.8.0][https_github.com_Saint9768_rocketmq_releases_tag_rocketmq-all-4.8.0]；PS：带有注释的RocketMQ-4.8.0版本的源码。

官网源码在这：[https://github.com/apache/rocketmq/archive/refs/tags/rocketmq-all-4.8.0.zip][https_github.com_apache_rocketmq_archive_refs_tags_rocketmq-all-4.8.0.zip]

源码导入到Idea中的整体目录结构，张这个样：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_14_color_FFFFFF_t_70_g_se_x_16]  
文件路径为：`/Users/zhouxin/ideaWorkplace/rocketmq`。

## 三、添加日志并启动 ##

### 1、添加日志 ###

#### 1）在哪里加日志？ ####

我们知道NameServer的启动类是`NamesrvStartup`和Broker的启动类是`BrokerStartup`，分别看一下他们的main()方法：  
（1）在NamesrvStartup\#main()方法套娃的`createNamesrvController()`方法中可以看到有一个引入`/conf/logback_namesrv.xml`文件的操作：  
![在这里插入图片描述][7168233dfe8e4db19c0557608c71a11f.png]  
（2）BrokerStartup\#main()方法也一样：  
![在这里插入图片描述][9b62fa2ecfc54ad7815a960f43426ce7.png]  
上两图中有`指定日志文件的地址`，这里大家根据自己的源码项目所在项目位置自定义。

#### 2）logback日志配置文件出处 ####

先去官网下载个RocketMQ可执行程序：[https://rocketmq.apache.org/dowloading/releases/][https_rocketmq.apache.org_dowloading_releases]。

解压rocketmq-all-4.8.0-bin-release.zip文件，然后进入到`./rocketmq-all-4.8.0-bin-release/conf`目录下，可以看到`logback_broker.xml`、`logback_namesrv.xml`两个文件：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16]  
把它俩copy到我们源码的根目录下的conf文件夹中，即`/Users/zhouxin/ideaWorkplace/rocketmq/conf`目录下；

#### 3）日志输出位置 ####

`logback_broker.xml`中配置Broker日志文件的默认位置为：`${user.home}/logs/rocketmqlogs/broker_default.log`：  
![在这里插入图片描述][000d8c13bb8f442da54efd0271b20d5e.png]

在我本机user.home为`/Users/zhouxin`，所以日志文件的位置为：`/Users/zhouxin/logs/rocketmqlogs/broker_default.log`。

同样的NameServer的日志文件位置为：`${user.home}/logs/rocketmqlogs/namesrv_default_default.log`；

![在这里插入图片描述][d000ded8f8d945bd9189b4872fdb70bf.png]

### 2、启动 ###

先运行NameServer再运行Broker即可。

#### 1）先启动namesrv ####

NameServer启动类：`org.apache.rocketmq.namesrv.NamesrvStartup`，进入直接运行main()方法即可；  
运行的时候发现直接就停了，控制台输出如下：

Please set the ROCKETMQ_HOME variable in your environment to match the location of the RocketMQ installation

![在这里插入图片描述][f8aa5ca520634b1881198e47732a79fb.png]  
全局搜一下`ROCKETMQ_HOME`这个字符串，找到在NamesrvStartup中的位置：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 1]  
原来我们设置RocketmqHome的位置不对，我们把它往上挪一挪；  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 2]  
再次启动，运行正常：  
![在这里插入图片描述][c9d455e7a77740c09a34a9247969809e.png]

**或者我们可以选择直接在Environment variables中配置ROCKETMQ\_HOME：**

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 3]  
也是一样的效果：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 4]

#### 2）再启动Broker ####

启动之前我们先把代码中RocketmqHome的配置往上挪一挪（因为和上面我们启动NameServer的时候存在同样的`ROCKETMQ_HOME不存在的问题`）：  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 5]

**接着配置Broker的启动信息：**  
broker的启动类为`org.apache.rocketmq.broker.BrokerStartup`，添加程序运行参数`-n 127.0.0.1:9876 autoCreateTopicEnable=true`，然后运行即可。

-n 127.0.0.1:9876 autoCreateTopicEnable=true

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 6]  
**最后运行main()方法，结果如下：**  
![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 7]

### 3、发送消息验证 ###

OK，可以发送成功。  
![在这里插入图片描述][c4882881b7db45069d851384172f2041.png]

[https_github.com_Saint9768_rocketmq_releases_tag_rocketmq-all-4.8.0]: https://github.com/Saint9768/rocketmq/releases/tag/rocketmq-all-4.8.0
[https_github.com_apache_rocketmq_archive_refs_tags_rocketmq-all-4.8.0.zip]: https://github.com/apache/rocketmq/archive/refs/tags/rocketmq-all-4.8.0.zip
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_14_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/b916385aaa4b4c6c8ff3d8f1eb948907.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5qWg546W5p-S,size_14,color_FFFFFF,t_70,g_se,x_16
[7168233dfe8e4db19c0557608c71a11f.png]: https://img-blog.csdnimg.cn/7168233dfe8e4db19c0557608c71a11f.png
[9b62fa2ecfc54ad7815a960f43426ce7.png]: https://img-blog.csdnimg.cn/9b62fa2ecfc54ad7815a960f43426ce7.png
[https_rocketmq.apache.org_dowloading_releases]: https://rocketmq.apache.org/dowloading/releases/
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/7be0fdb95f474a86b9848d6ca77cd729.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5qWg546W5p-S,size_20,color_FFFFFF,t_70,g_se,x_16
[000d8c13bb8f442da54efd0271b20d5e.png]: https://img-blog.csdnimg.cn/000d8c13bb8f442da54efd0271b20d5e.png
[d000ded8f8d945bd9189b4872fdb70bf.png]: https://img-blog.csdnimg.cn/d000ded8f8d945bd9189b4872fdb70bf.png
[f8aa5ca520634b1881198e47732a79fb.png]: https://img-blog.csdnimg.cn/f8aa5ca520634b1881198e47732a79fb.png
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/3bbc6259bb0a4875928a5d01f162a5b8.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5qWg546W5p-S,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/ea5cd068d2794488bff5abf5776d06e9.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5qWg546W5p-S,size_20,color_FFFFFF,t_70,g_se,x_16
[c9d455e7a77740c09a34a9247969809e.png]: https://img-blog.csdnimg.cn/c9d455e7a77740c09a34a9247969809e.png
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/c639dcec8b7e46fcb136680046285549.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5qWg546W5p-S,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 4]: https://img-blog.csdnimg.cn/84dcef03bb7b490f814d69d2336f1039.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5qWg546W5p-S,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 5]: https://img-blog.csdnimg.cn/33b3dfa47d5b41c88c97c62d89929191.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5qWg546W5p-S,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 6]: https://img-blog.csdnimg.cn/02e7a47b410c4f79b5fea87ce4f44bc8.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5qWg546W5p-S,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5qWg546W5p-S_size_20_color_FFFFFF_t_70_g_se_x_16 7]: https://img-blog.csdnimg.cn/d28e4ed7baed48bda0473b6c1e65e8aa.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5qWg546W5p-S,size_20,color_FFFFFF,t_70,g_se,x_16
[c4882881b7db45069d851384172f2041.png]: https://img-blog.csdnimg.cn/c4882881b7db45069d851384172f2041.png