# ๐ mica mqtt
[](https://github.com/lets-mica/mica-mqtt/actions)
[](https://mvnrepository.com/artifact/net.dreamlu/mica-mqtt-codec/)
[](https://oss.sonatype.org/content/repositories/snapshots/net/dreamlu/mica-mqtt-codec/)
[](https://gitee.com/596392912/mica-mqtt/stargazers)
[](https://github.com/lets-mica/mica-mqtt)
[](https://www.codacy.com/gh/lets-mica/mica-mqtt/dashboard?utm_source=github.com&utm_medium=referral&utm_content=lets-mica/mica-mqtt&utm_campaign=Badge_Grade)
[](https://github.com/lets-mica/mica-mqtt/blob/master/LICENSE)
---
English | [็ฎไฝไธญๆ](README.md)
`mica-mqtt` is a **low-latency** and **high-performance** `mqtt` Internet of Things component. For more usage details, please refer to the **mica-mqtt-example** module.
## ๐ฑ Use Cases
- Internet of Things (cloud-based MQTT broker)
- Internet of Things (edge messaging communication)
- Group IM
- Message push
- Easy-to-use MQTT client
## ๐ Advantages
- Ordinary yet not monotonous, simple yet not lackluster.
- Manual transmission (more conducive to secondary development or expansion).
- A newborn calf; infinite possibilities.
## โจ Features
- [x] Support for MQTT v3.1, v3.1.1, and v5.0 protocols.
- [x] Support for WebSocket MQTT sub-protocol (compatible with mqtt.js).
- [x] Support for HTTP REST API, see [HTTP API Documentation](docs/http-api.md) for details.
- [x] Support for MQTT client.
- [x] Support for MQTT server.
- [x] Support for MQTT Will messages.
- [x] Support for MQTT Retained messages.
- [x] Support for custom message (MQ) processing and forwarding to achieve clustering.
- [x] MQTT client **Alibaba Cloud MQTT**ใ**HuaWei MQTT** connection demo.
- [x] Support for GraalVM compilation into native executable programs.
- [x] Support for rapid access to Spring Boot projects.
- [x] Support for integration with Prometheus + Grafana for monitoring.
- [x] Cluster implementation based on Redis pub/sub, see [mica-mqtt-broker module](mica-mqtt-broker) for details.
## ๐ฑ To-do
- [ ] Optimize the processing of MQTT sessions and support v5.0
- [ ] Implement rule engine based on easy-rule + druid sql parsing.
## ๐จ Default Ports
| Port | Protocol | Description |
| ---- | --------------- | -------------------------------- |
| 1883 | tcp | MQTT TCP port |
| 8083 | http, websocket | HTTP API and WebSocket MQTT port |
**Demo Address**: mqtt.dreamlu.net, same ports๏ผusername: mica password: mica
## ๐ฆ๏ธ Dependencies
### Spring Boot Project
**Client:**
```xml
net.dreamlu
mica-mqtt-client-spring-boot-starter
${mica-mqtt.version}
```
**Configuration Details**: [mica-mqtt-client-spring-boot-starter Documentation](starter/mica-mqtt-client-spring-boot-starter/README.md)
**Server:**
```xml
net.dreamlu
mica-mqtt-server-spring-boot-starter
${mica-mqtt.version}
```
**Configuration Details**: [mica-mqtt-server-spring-boot-starter Documentation](starter/mica-mqtt-server-spring-boot-starter/README.md)
### Non-Spring Boot Project
### Client
```xml
net.dreamlu
mica-mqtt-client
${mica-mqtt.version}
```
**Configuration Details**: [mica-mqtt-client Documentation](mica-mqtt-client/README.md)
### Server
```xml
net.dreamlu
mica-mqtt-server
${mica-mqtt.version}
```
**Configuration Details**: [mica-mqtt-server Documentation](mica-mqtt-server/README.md)
## ๐ Documentation
- [Introduction to MQTT, mqttx, and mica-mqtt **Video**](https://b23.tv/VJ8yc7v)
- [Getting Started with mica-mqtt](example/README.md)
- [jfinal-mica-mqtt-client Documentation](starter/jfinal-mica-mqtt-client/README.md)
- [jfinal-mica-mqtt-server Documentation](starter/jfinal-mica-mqtt-server/README.md)
- [mica-mqtt HTTP API Documentation](docs/http-api.md)
- [Frequently Asked Questions about mica-mqtt Usage](https://gitee.com/596392912/mica-mqtt/issues/I45GO7)
- [mica-mqtt Release Versions](CHANGELOG.md)
- [MQTT Protocol Documentation](https://github.com/mcxiaoke/mqtt)
## ๐ก References
- [Netty Codec MQTT](https://github.com/netty/netty/tree/4.1/codec-mqtt)
- [jmqtt](https://github.com/Cicizz/jmqtt)
- [iot-mqtt-server](https://gitee.com/recallcode/iot-mqtt-server)
- [Netty MQTT Client](https://github.com/jetlinks/netty-mqtt-client)
## ๐๏ธ MQTT Client Tools
- [Mqttx: An Elegant Cross-platform MQTT 5.0 Client Tool](https://mqttx.app/)
- [MQTT WebSocket Debugging](http://tools.emqx.io/)
- [MQTT.fx MQTT Client](http://mqttfx.org/)
## ๐ป Open Source Recommendations
- `Avue`: A Vue-based configurable front-end framework: [https://gitee.com/smallweigit/avue](https://gitee.com/smallweigit/avue)
- `Pig`: Microservice framework featured on CCTV (architectural essential): [https://gitee.com/log4j/pig](https://gitee.com/log4j/pig)
- `SpringBlade`: Enterprise-level solution (essential for enterprise development): [https://gitee.com/smallc/SpringBlade](https://gitee.com/smallc/SpringBlade)
- `smart-mqtt`: High-performance MQTT broker (surpassing EMQX): [https://gitee.com/smartboot/smart-mqtt](https://gitee.com/smartboot/smart-mqtt)
- `IJPay`: Payment SDK, making payment accessible: [https://gitee.com/javen205/IJPay](https://gitee.com/javen205/IJPay)
- `JustAuth`: The most comprehensive third-party login open-source library ever: [https://github.com/zhangyd-c/JustAuth](https://github.com/zhangyd-c/JustAuth)
- `spring-boot-demo`: Spring Boot in-depth learning in practice: [https://github.com/xkcoding/spring-boot-demo](https://github.com/xkcoding/spring-boot-demo)
## ๐ Acknowledgements
Thanks to JetBrains for providing a free open-source license:
[](https://www.jetbrains.com/?from=mica-mqtt)
Thanks to **VIP members** of `DreamLuTech` for their strong support. For more **VIP** information, please visit: [https://www.dreamlu.net/vip/index.html](https://www.dreamlu.net/vip/index.html)
## ๐ฑ WeChat
**JAVA Architecture Diary**, daily recommended exciting content!