Awesome
Apache RocketMQ MQTT
A new MQTT protocol architecture model, based on which RocketMQ can better support messages from terminals such as IoT devices and Mobile APP. Based on the RocketMQ message unified storage engine, it supports both MQTT terminal and server message sending and receiving.The entire project design refer to MQTT overview.
Architecture
The relevant architecture design is introduced in RIP-33. The queue model of MQTT needs to be based on the light message queue, For the design of the specific light message queue, please refer to the RIP-28(LMQ)-wiki of RocketMQ.
Get Started
Prerequisites
The queue model of MQTT needs to be based on the light message queue feature (RIP-28) of RocketMQ. RocketMQ has only supported this feature since version 4.9.3. Please ensure that the installed version of RocketMQ already supports this feature.
For the quick start of light message queue, please refer to Example_LMQ of RocketMQ. For example, set the following parameters to true in broker.conf
enableLmq = true
enableMultiDispatch = true
Build Requirements
The current project requires JDK 1.8.x. When building on MAC arm64 the recommended JDK 1.8 must be based on 386 architecture or use Maven flag -Dos.arch=x86_64 when building with Maven.
- Clone
git clone https://github.com/apache/rocketmq-mqtt
- Build the package
cd rocketmq-mqtt
mvn -Prelease-all -DskipTests clean install -U
- Config
cd distribution/target/
cd conf
Some important configuration items in the service.conf configuration file
| Config Key | Instruction |
|---|---|
| username | used for auth |
| secretKey | used for auth |
| NAMESRV_ADDR | specify namesrv address |
| eventNotifyRetryTopic | notify event retry topic |
| clientRetryTopic | client retry topic |
| metaAddr | meta all nodes ip:port. Same as membersAddress in meta.config |
And some configuration items in the meta.conf configuration file
| Config Key | Instruction |
|---|---|
| selfAddress | meta cur node ip:port, e.g. 192.168.0.1:8080 |
| membersAddress | meta all nodes ip:port, e.g. 192.168.0.1:8080,192.168.0.2:8080,192.168.0.3:8080 |
-
CreateTopic
create all first-level topics, including eventNotifyRetryTopic and clientRetryTopic in the configuration file above.
sh mqadmin updatetopic -c {cluster} -t {topic} -n {namesrv}
- Initialize Meta
- Configure Gateway Node List
sh mqadmin updateKvConfig -s LMQ -k LMQ_CONNECT_NODES -v {ip1,ip2} -n {namesrv}
- Configure the first-level topic list
sh mqadmin updateKvConfig -s LMQ -k ALL_FIRST_TOPICS -v {topic1,topic2} -n {namesrv}
- Configure a list of wildcard characters under each first-level topic
sh mqadmin updateKvConfig -s LMQ -k {topic} -v {topic/+} -n {namesrv}
- Start Process
cd bin
sh meta.sh start
sh mqtt.sh start
Example
The mqtt-example module has written basic usage example code, which can be used for reference
Protocol Version
The currently supported protocol version is MQTT 3.1.1.
Authentication
At present, an implementation based on the HmacSHA1 signature algorithm is provided by default, Refer to AuthManagerSample. Users can customize other implementations to meet the needs of businesses to flexibly verify resources and identities.
Meta Persistence
At present, meta data storage and management is simply implemented through the kvconfig mechanism of namesrv by default, Refer to MetaPersistManagerSample. Users can customize other implementations.
License
Apache License, Version 2.0 Copyright (C) Apache Software Foundation.