2 Star 23 Fork 5

Stan / windmq

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

windmq - MQTT快速开发脚手架

star fork

介绍

springboot快速接入MQTT,一个方法注解就搞定消息处理

开发背景

之前做一个硬件项目用到mqtt,处理设备上传的数据

部署产线环境是阿里云,测试用的EMQ都需要支持,就有了这个项目

此项目整合springboot部分和topic规则搬运了一个项目,刚接触这个,十分感谢前辈的经验https://gitee.com/yezhihao/mqtt-sample

关于共享订阅的高可用兼容,如果有方案还望各位不吝赐教

功能

  • MQTT客户端登录凭证分配(ACL支持阿里云\EMQ目前只支持账号密码,可自定义实现)
  • 适合低端设备的查表加密协议非必须(详情见: com.stanwind.wmqtt.security.TableMsgEncrypt)
  • 高可用部署(多实例不同clientID上线,EMQ有提供共享订阅,但是阿里云只能靠规则引擎转发MQ,我们线上使用全盘负责机制,谁发命令谁处理)
  • 异步消息处理池,消息顺序处理(CPU核心数*2 + 1)
  • Topic注解匹配消息处理,支持模糊匹配(正则实现,可取topic路径参数)和精确匹配

默认建议规则

  • 对客户端发送的TOPIC均以 IOT_CLIENT/xxx形式 (配置可修改)
  • 对服务端发送的TOPIC均以 IOT_SERVER/xxx形式 (配置可修改)
  • 加密行需在payload开头2 byte表示采用哪一行数据进行加密 (若启用加密则IOT开头的topic均会加密,详见:com.stanwind.wmqtt.security.IotDeviceMessageEncrypt)
  • 为兼容阿里云 clientId均以GID_DEVICE@@@开头 (配置可修改)
  • Server采用签名登录,阿里云环境下Client分配的账号密码使用token登录,鉴权信息有效时长12小时
  • topic中{instanceId}表示匹配当前实例ID,{deviceId}表示匹配当前设备序列号(详情: com.stanwind.wmqtt.MqttConfig)

springboot支持版本

  • 2.0.X.RELEASE

项目仓库

<dependency>
  <groupId>com.stanwind</groupId>
  <artifactId>spring-boot-windmq</artifactId>
  <version>1.1.2-RELEASE</version>
</dependency>

样例工程

https://gitee.com/sense7/windmq-demo.git

参考依赖

<!-- windmq dependency -->
<dependency>
  <groupId>com.stanwind</groupId>
  <artifactId>spring-boot-windmq</artifactId>
  <version>1.1.0-RELEASE</version>
</dependency>

<!-- MQTT -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-integration</artifactId>
<dependency>
  <groupId>org.springframework.integration</groupId>
  <artifactId>spring-integration-mqtt</artifactId>
  <exclusions>
    <exclusion>
      <artifactId>org.eclipse.paho.client.mqttv3</artifactId>
      <groupId>org.eclipse.paho</groupId>
    </exclusion>
  </exclusions>
</dependency>
<!-- 1.2.0 版本有bug -->
<dependency>
  <groupId>org.eclipse.paho</groupId>
  <artifactId>org.eclipse.paho.client.mqttv3</artifactId>
  <version>1.2.1</version>
</dependency>

启用windmq

@EnableWindMQ
@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

使用样例

  • 临时订阅/取消(注入WMHolder)
void addTopic(String... topic);
void addTopic(String topic, int qos);
void addTopics(String[] topic, int[] qos);
void removeTopic(String... topic);
  • 消息发送 IMessageService
/**
 * 发送消息给device 需要payload Class上有@Topic
 * @param deviceId
 * @param payload
 */
void notify(String deviceId, Object payload);

/**
 * 发送消息到topic
 * @param topic
 * @param payload
 */
void notifyToTopic(String topic, Object payload);

/**
 * 同步确认发送消息给设备
 * @param deviceId
 * @param payload
 * @return
 */
MqttResponse request(String deviceId, MqttRequest payload);

/**
 * 同步确认发送消息给设备
 * @param deviceId
 * @param payload
 * @param timeout 等待超时 ms
 * @return
 */
MqttResponse request(String deviceId, MqttRequest payload, long timeout);

/**
 * 响应同步消息
 * @param message
 * @return
 */
boolean response(Message<MqttResponse> message);

/**
* 客户端请求通用回复
* @param messageId
* @param deviceId
* @param result
*/
void sendCommonResponse(Long messageId, String deviceId, Integer result);

/**
* 客户端请求通用回复
* @param messageId
* @param deviceId
*/
void sendCommonResponse(Long messageId, String deviceId);
  • 消息处理
@TopicHandler(topic = "$SYS/brokers/{node}/clients/{deviceId}/connected")
public void connected(MQTTMsg msg) {
    ClientReqVO clientReqVO = JSONObject.parseObject(msg.getPayload().toString(), ClientReqVO.class);
    process(clientReqVO);
}
  • 获取路径参数
@Service
public class DemoHandler extends BaseTopicHandler {
    @TopicHandler(topic = "IOT_SERVER/ping/{instanceId}/{taskId}/{param1}")
    public void uploadPingData(MQTTMsg msg) {
        String taskId = getParam("taskId");
        String param1 = getParam("param1");
        //或
        MqttContext.getContext().getParams().getOrDefault("taskId", null);
    }
}
  • 高可用方案(临时订阅处理完取消) 路径中需要有instanceId参数用于判断是否当前实例发出,根据全盘托管机制,标志谁发出命令,谁处理客户端消息

例: Server 要求客户端往topic IOT_SERVER/log/{instanceId}/{taskId}发送日志数据

//拿到初始化的配置 内有生成的instanceId
@Resource
private MqttConfig mqttConfig;

//随机生成的任务id
String taskId = "abcd";
String topic = "IOT_SERVER/log/{instanceId}/{taskId}".replace("{taskId}", taskId).replace("{instanceId}", mqttConfig.getInstanceId());
//订阅监听客户端回写数据
wmHolder.addTopic(topic);
//发送消息告知客户端往哪里写日志数据
messageService.notify(cli, request);
@TopicHandler(topic = "IOT_SERVER/log/{instanceId}/{taskId}")
public void uploadLogData(MQTTMsg msg) {
    if (!currentHandle()) {
        log.debug("非当前实例任务: [{}]", msg);
        return;
    }

    if (接收完毕) {
        //取消订阅
        wmHolder.removeTopic(msg.getTopic());
    }
}
  • 生成客户端链接数据
@Autowired
private MqttConfig mqttConfig;
@Autowired
private WMHolder holder;
public MqttConnVO generateMqttConnConfig(String sn) throws Exception {
    String r = mqttConfig.getAclRead().replaceAll(DEVICE_ID, stcUtil.sn2cli(sn));
    String w = mqttConfig.getAclWrite().replaceAll(DEVICE_ID, stcUtil.sn2cli(sn));
    MQTTClientConnData connData = holder.getClientConnData(Utils.splitToList(r), Utils.splitToList(w));
    MqttConnVO vo = new MqttConnVO();
    //缺省外网地址则返回统一地址 否则返回外网地址
    vo.setUris(ArrayUtils.isEmpty(mqttConfig.getPubServerURIs()) ? mqttConfig.getServerURIs() : mqttConfig.getPubServerURIs());
    vo.setReadTopics(r);
    vo.setWriteTopics(w);
    vo.setEnc(mqttConfig.getEncTable());
    vo.setEncSize(mqttConfig.getEncCount());
    BeanUtils.copyProperties(connData, vo);
    log.info("{} 获取mqtt: {}", sn, vo);

    return vo;
}

@Data
public class MqttConnVO implements Serializable {
    private static final long serialVersionUID = 1L;
    private String[] uris;
    private Long expire;
    private String username;
    private String password;
    private String readTopics;
    private String writeTopics;
    private String enc;
    private Integer encSize;
}

使用建议

  • 配置参见bootstrap.yml
  • 测试环境使用EMQ,产线使用阿里云

更新日志

  • Ver 1.1.2
  1. EMQX的jwtKey使用专门字段
  2. EMQX支持客户端在线状态查询
  3. 客户端授权过期时间配置化
  • Ver 1.1.1
  1. 非正则匹配主动获取topic参数导致的NPE问题
  2. EMQX的jwt方式简单支持
  • Ver 1.1
  1. 合并ClientApi和SettingFactory,统一管理鉴权数据
  2. ProducerHolder更名 WMHolder,加入获取客户端鉴权数据接口,能更方便的充当全局工具类使用
  • Ver 1.0.1
  1. 实现同topic下消息顺序到达同线程处理
  • Ver 1.0
  1. 实现mqtt的topic路由处理
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

🎉 基于springboot快速开发处理MQTT消息的库。支持低端设备快速加解密; 支持阿里云、EMQTT;高可用部署; ACL Token。 展开 收起
Java
Apache-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/sense7/windmq.git
git@gitee.com:sense7/windmq.git
sense7
windmq
windmq
v1.1.2

搜索帮助