在IDEA中debug RocketMQ NameSrv、Broker、Producer、Consumer

从RocketMQ的git仓库clone下代码后，就可以开始debug啦。

1、debug NameSrv

直接运行NamesrvStartup#main会报如下错误，原因是没有设置ROCKET_HOME

NameSrv启动报错.png

默认的设置方式是：从JVM参数（rocketmq.home.dir）中获取，如果获取不到从系统环境变量（ROCKETMQ_HOME）中获取

private String rocketmqHome = System.getProperty(MixAll.ROCKETMQ_HOME_PROPERTY, System.getenv(MixAll.ROCKETMQ_HOME_ENV));

在VM options配上-Drocketmq.home.dir即可

IDEA VM options配置.png

再次启动，报错：

无logback日志配置报错.png

将代码路径下distribution/conf/logback_namesrv.xml复制到你设置的 ${ROCKET_HOME}/conf/logback_namesrv.xml这个文件是日志相关的配置，默认的日志会写到$ {user.home}/logs/rocketmqlogs，对于windows系统，是在
C:\Users${user}\logs\rocketmqlogs再次启动，成功：

NameSrv启动成功.png

总结：

设置JVM参数：-Drocketmq.home.dir
复制logback_namesrv.xml到${ROCKET_HOME}/conf/logback_namesrv.xml

2、debug Broker

跟debug NameSrv类似，配上-Drocketmq.home.dir，复制logback_broker.xml到${ROCKET_HOME}/conf/logback_broker.xml日志所在目录与NameSrv相同，启动成功显示如下：

Broker启动成功.png

这里有个坑，虽然上面显示成功了，但实际还需要额外配置NameSrv地址，否则后面运行example.quickstart.Producer#main会报错，报错信息可见第3部分 debug Producer配置NameSrv地址：JVM参数：- rocketmq.namesrv.addr=127.0.0.1:9876 （这里也有3种方法配置，见第3部分 debug Producer）

3、debug Producer

直接执行example.quickstart.Producer#main会报如下错误，原因是没有配置name server地址：

No name server address报错.png

有3种方法可以配置name server地址：

DefaultMQProducer#setNamesrvAddr
JVM参数：- rocketmq.namesrv.addr=127.0.0.1:9876
系统环境变量：NAMESRV_ADDR

我们使用第2种配置再次启动：

No route info of this topic报错.png

原因是第2步启动broker的时候，我们漏配了NameSrv地址，配置后重新启动Broker，再次启动Producer，可以发送正常了。

到这步后，可发现${user.home}\store\config\topics.json中多了TopicTest，并且多了3个文件夹，这3个文件夹里存储的消息文件、索引文件等。

store目录结构.png

总结：

正确配置NameSrv，启动
正确配置Broker，启动
配置NameSrv地址，启动Producer

4、debug Consumer

只需要配置NameSrv地址，即可