Setting Up a Debugging Environment for RocketMQ Source Code in IntelliJ IDEA

Hello, I am Wukong. Recently I have been exploring the RocketMQ message queue and decided to set up a local debugging environment for its source code.

1. Obtain the Source Code

Download the source from the official GitHub releases page (e.g., rocketmq-rocketmq-all-4.9.2 ). If GitHub is slow, reply with RocketMQ源码 to get a Baidu Netdisk link.

2. Import the Project

Open the downloaded project in IntelliJ IDEA. The main modules include broker (Broker code), client (Producer/Consumer), common , distribution (deployment scripts), remoting (Netty‑based network), store (message storage), and others.

3. Start the NameServer

3.1 Configure Startup Parameters

In IDEA, locate the NameSrvStartup run configuration and open Edit Configurations .

3.2 Set Environment Variable

Create a ROCKETMQ_HOME environment variable pointing to a local folder (e.g., /Users/wukong/00.Study/_workspace/rocketmq/ROCKETMQ_HOME).

3.3 Copy Configuration Files

Under ROCKETMQ_HOME create conf, logs, and store directories, then copy broker.conf, logback_namesrv.xml, and logback_broker.xml from the source distribution folder into conf.

3.4 Adjust Logback Files

Replace all occurrences of ${user.home} with the absolute path of ROCKETMQ_HOME in both logback_namesrv.xml and logback_broker.xml.

3.5 Modify Broker Configuration

# This is the NameServer address
namesrvAddr=127.0.0.1:9876
brokerIP1=192.168.10.197
# Storage paths (replace with your ROCKETMQ_HOME path)
storePathRootDir=<your ROCKETMQ_HOME>/store
storePathCommitLog=<your ROCKETMQ_HOME>/store/commitlog
storePathConsumeQueue=<your ROCKETMQ_HOME>/store/consumequeue
storePathIndex=<your ROCKETMQ_HOME>/store/index
storeCheckpoint=<your ROCKETMQ_HOME>/store/checkpoint
abortFile=<your ROCKETMQ_HOME>/store/abort

3.6 Launch the NameServer

Run the NameSrvStartup configuration in debug mode. IDEA will use the ROCKETMQ_HOME directory automatically. The console should show messages like:

Connected to the target VM, address: '127.0.0.1:52115', transport: 'socket'
The Name Server boot success. serializeType=JSON

4. Start the Broker

4.1 Configure Broker Startup Parameters

Add a program argument pointing to the broker configuration file, e.g., -c <your ROCKETMQ_HOME>/conf/broker.conf, and run in debug mode.

4.2 Launch the Broker

The console will display:

Connected to the target VM, address: '127.0.0.1:52279', transport: 'socket'
The broker[broker-a, 192.168.10.197:10911] boot success. serializeType=JSON and name server is 127.0.0.1:9876

4.3 Check Logs

Inspect logs/broker.log or logs/namesrv.log for detailed startup information.

5. Test Message Sending

Use the example Producer.java and Consumer.java under the example module. Update the NameServer address to "127.0.0.1:9876" in both files, then run the producer and consumer classes from IDEA. The producer should report a successful send, and the consumer should display a received message (shown as ASCII codes).

With these steps, the local RocketMQ source debugging environment is fully configured.

Future articles will cover installing and using the RocketMQ console UI.