【功能完善】IoT: 更新 Vert.x 版本至 4.5.1,新增 EMQX 插件及其相关配置,重构 MQTT 插件以支持 Vert.x MQTT 服务器,优化插件启动和停止逻辑,更新插件描述信息。

This commit is contained in:
安浩浩 2025-01-15 22:37:07 +08:00
parent deab8c1cc6
commit 890d304340
10 changed files with 508 additions and 41 deletions

View File

@ -626,6 +626,12 @@
<artifactId>vertx-web</artifactId>
<version>${vertx.version}</version>
</dependency>
<!-- Vert.x MQTT 模块 -->
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-mqtt</artifactId>
<version>${vertx.version}</version>
</dependency>
</dependencies>
</dependencyManagement>

View File

@ -0,0 +1,6 @@
plugin.id=emqx-plugin
plugin.class=cn.iocoder.yudao.module.iot.plugin.EmqxPlugin
plugin.version=0.0.1
plugin.provider=ahh
plugin.dependencies=
plugin.description=emqx-plugin-0.0.1

View File

@ -0,0 +1,164 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="
http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>yudao-module-iot-plugin</artifactId>
<groupId>cn.iocoder.boot</groupId>
<version>${revision}</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<packaging>jar</packaging>
<artifactId>yudao-module-iot-emqx-plugin</artifactId>
<name>${project.artifactId}</name>
<description>
物联网 插件模块 - emqx 插件
</description>
<properties>
<!-- 插件相关 -->
<plugin.id>emqx-plugin</plugin.id>
<plugin.class>cn.iocoder.yudao.module.iot.plugin.EmqxPlugin</plugin.class>
<plugin.version>0.0.1</plugin.version>
<plugin.provider>ahh</plugin.provider>
<plugin.description>emqx-plugin-0.0.1</plugin.description>
<plugin.dependencies/>
</properties>
<build>
<plugins>
<!-- DOESN'T WORK WITH MAVEN 3 (I defined the plugin metadata in properties section)
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>properties-maven-plugin</artifactId>
<version>1.0-alpha-2</version>
<executions>
<execution>
<phase>initialize</phase>
<goals>
<goal>read-project-properties</goal>
</goals>
<configuration>
<files>
<file>plugin.properties</file>
</files>
</configuration>
</execution>
</executions>
</plugin>
-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.6</version>
<executions>
<execution>
<id>unzip jar file</id>
<phase>package</phase>
<configuration>
<target>
<unzip src="target/${project.artifactId}-${project.version}.${project.packaging}"
dest="target/plugin-classes"/>
</target>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.3</version>
<configuration>
<descriptors>
<descriptor>
src/main/assembly/assembly.xml
</descriptor>
</descriptors>
<appendAssemblyId>false</appendAssemblyId>
</configuration>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>attached</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.4</version>
<configuration>
<archive>
<manifestEntries>
<Plugin-Id>${plugin.id}</Plugin-Id>
<Plugin-Class>${plugin.class}</Plugin-Class>
<Plugin-Version>${plugin.version}</Plugin-Version>
<Plugin-Provider>${plugin.provider}</Plugin-Provider>
<Plugin-Description>${plugin.description}</Plugin-Description>
<Plugin-Dependencies>${plugin.dependencies}</Plugin-Dependencies>
</manifestEntries>
</archive>
</configuration>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</build>
<dependencies>
<!-- 其他依赖项 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- PF4J Spring 集成 -->
<dependency>
<groupId>org.pf4j</groupId>
<artifactId>pf4j-spring</artifactId>
<scope>provided</scope>
</dependency>
<!-- 项目依赖 -->
<dependency>
<groupId>cn.iocoder.boot</groupId>
<artifactId>yudao-module-iot-api</artifactId>
<version>${revision}</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
<scope>provided</scope>
</dependency>
<!-- Vert.x 核心依赖 -->
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-core</artifactId>
</dependency>
<!-- Vert.x Web 模块 -->
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-web</artifactId>
</dependency>
<!-- MQTT -->
<dependency>
<groupId>org.eclipse.paho</groupId>
<artifactId>org.eclipse.paho.client.mqttv3</artifactId>
</dependency>
</dependencies>
</project>

View File

@ -0,0 +1,31 @@
<assembly>
<id>plugin</id>
<formats>
<format>zip</format>
</formats>
<includeBaseDirectory>false</includeBaseDirectory>
<dependencySets>
<dependencySet>
<useProjectArtifact>false</useProjectArtifact>
<scope>runtime</scope>
<outputDirectory>lib</outputDirectory>
<includes>
<include>*:jar:*</include>
</includes>
</dependencySet>
</dependencySets>
<!--
<fileSets>
<fileSet>
<directory>target/classes</directory>
<outputDirectory>classes</outputDirectory>
</fileSet>
</fileSets>
-->
<fileSets>
<fileSet>
<directory>target/plugin-classes</directory>
<outputDirectory>classes</outputDirectory>
</fileSet>
</fileSets>
</assembly>

View File

@ -0,0 +1,45 @@
package cn.iocoder.yudao.module.iot.plugin;
import cn.iocoder.yudao.module.iot.api.ServiceRegistry;
import cn.iocoder.yudao.module.iot.api.device.DeviceDataApi;
import lombok.extern.slf4j.Slf4j;
import org.pf4j.Plugin;
import org.pf4j.PluginWrapper;
import javax.annotation.Resource;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
@Slf4j
public class EmqxPlugin extends Plugin {
private ExecutorService executorService;
@Resource
private DeviceDataApi deviceDataApi;
public EmqxPlugin(PluginWrapper wrapper) {
super(wrapper);
this.executorService = Executors.newSingleThreadExecutor();
}
@Override
public void start() {
log.info("EmqxPlugin.start()");
if (executorService.isShutdown() || executorService.isTerminated()) {
executorService = Executors.newSingleThreadExecutor();
}
deviceDataApi = ServiceRegistry.getService(DeviceDataApi.class);
if (deviceDataApi == null) {
log.error("未能从 ServiceRegistry 获取 DeviceDataApi 实例,请确保主程序已正确注册!");
return;
}
}
@Override
public void stop() {
log.info("EmqxPlugin.stop()");
}
}

View File

@ -147,20 +147,11 @@
<version>${lombok.version}</version>
<scope>provided</scope>
</dependency>
<!-- Vert.x 核心依赖 -->
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-core</artifactId>
</dependency>
<!-- Vert.x Web 模块 -->
<!-- Vert.x Web -->
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-web</artifactId>
</dependency>
<!-- MQTT -->
<dependency>
<groupId>org.eclipse.paho</groupId>
<artifactId>org.eclipse.paho.client.mqttv3</artifactId>
<version>4.5.11</version>
</dependency>
</dependencies>
</project>

View File

@ -1,6 +1,7 @@
plugin.id=mqtt-plugin
plugin.description=Vert.x MQTT plugin
plugin.class=cn.iocoder.yudao.module.iot.plugin.MqttPlugin
plugin.version=0.0.1
plugin.version=1.0.0
plugin.requires=
plugin.provider=ahh
plugin.dependencies=
plugin.description=mqtt-plugin-0.0.1
plugin.license=Apache-2.0

View File

@ -145,10 +145,11 @@
<version>${lombok.version}</version>
<scope>provided</scope>
</dependency>
<!-- MQTT -->
<!-- Vert.x MQTT -->
<dependency>
<groupId>org.eclipse.paho</groupId>
<artifactId>org.eclipse.paho.client.mqttv3</artifactId>
<groupId>io.vertx</groupId>
<artifactId>vertx-mqtt</artifactId>
<version>4.5.11</version>
</dependency>
</dependencies>
</project>

View File

@ -1,45 +1,36 @@
package cn.iocoder.yudao.module.iot.plugin;
import cn.iocoder.yudao.module.iot.api.ServiceRegistry;
import cn.iocoder.yudao.module.iot.api.device.DeviceDataApi;
import lombok.extern.slf4j.Slf4j;
import org.pf4j.Plugin;
import org.pf4j.PluginWrapper;
import javax.annotation.Resource;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
@Slf4j
public class MqttPlugin extends Plugin {
private ExecutorService executorService;
@Resource
private DeviceDataApi deviceDataApi;
private MqttServerExtension mqttServerExtension;
public MqttPlugin(PluginWrapper wrapper) {
super(wrapper);
this.executorService = Executors.newSingleThreadExecutor();
}
@Override
public void start() {
log.info("MqttPlugin.start()");
if (executorService.isShutdown() || executorService.isTerminated()) {
executorService = Executors.newSingleThreadExecutor();
}
deviceDataApi = ServiceRegistry.getService(DeviceDataApi.class);
if (deviceDataApi == null) {
log.error("未能从 ServiceRegistry 获取 DeviceDataApi 实例,请确保主程序已正确注册!");
return;
}
log.info("MQTT Plugin started.");
mqttServerExtension = new MqttServerExtension();
mqttServerExtension.startMqttServer();
}
@Override
public void stop() {
log.info("MqttPlugin.stop()");
log.info("MQTT Plugin stopped.");
if (mqttServerExtension != null) {
mqttServerExtension.stopMqttServer().onComplete(ar -> {
if (ar.succeeded()) {
log.info("Stopped MQTT Server successfully");
} else {
log.error("Failed to stop MQTT Server: {}", ar.cause().getMessage());
}
});
}
}
}

View File

@ -0,0 +1,231 @@
package cn.iocoder.yudao.module.iot.plugin;
import io.netty.handler.codec.mqtt.MqttProperties;
import io.netty.handler.codec.mqtt.MqttQoS;
import io.vertx.core.Future;
import io.vertx.core.Vertx;
import io.vertx.core.buffer.Buffer;
import io.vertx.mqtt.MqttEndpoint;
import io.vertx.mqtt.MqttServer;
import io.vertx.mqtt.MqttServerOptions;
import io.vertx.mqtt.MqttTopicSubscription;
import io.vertx.mqtt.messages.MqttDisconnectMessage;
import io.vertx.mqtt.messages.MqttPublishMessage;
import io.vertx.mqtt.messages.MqttSubscribeMessage;
import io.vertx.mqtt.messages.MqttUnsubscribeMessage;
import io.vertx.mqtt.messages.codes.MqttSubAckReasonCode;
import lombok.extern.slf4j.Slf4j;
import org.pf4j.Extension;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
/**
* 根据官方示例整合常见 MQTT 功能到 PF4J Extension 类中
*/
@Slf4j
@Extension
public class MqttServerExtension {
private Vertx vertx;
private MqttServer mqttServer;
/**
* 启动 MQTT 服务端
* 可根据需要决定是否启用 SSL/TLSWebSocket多实例部署等
*/
public void startMqttServer() {
// 初始化 Vert.x
vertx = Vertx.vertx();
// ========== 如果需要 SSL/TLS请参考下面注释启用注释并替换端口证书路径等 ==========
// MqttServerOptions options = new MqttServerOptions()
// .setPort(8883)
// .setKeyCertOptions(new PemKeyCertOptions()
// .setKeyPath("./src/test/resources/tls/server-key.pem")
// .setCertPath("./src/test/resources/tls/server-cert.pem"))
// .setSsl(true);
// ========== 如果需要 WebSocket请设置 setUseWebSocket(true) ==========
// options.setUseWebSocket(true);
// ========== 默认不启用 SSL 的示例 ==========
MqttServerOptions options = new MqttServerOptions()
.setPort(1883)
.setHost("0.0.0.0")
.setUseWebSocket(false); // 如果需要 WebSocket请改为 true
mqttServer = MqttServer.create(vertx, options);
// 指定 endpointHandler处理客户端连接等
mqttServer.endpointHandler(endpoint -> {
handleClientConnect(endpoint);
handleDisconnect(endpoint);
handleSubscribe(endpoint);
handleUnsubscribe(endpoint);
handlePublish(endpoint);
handlePing(endpoint);
});
// 启动监听
mqttServer.listen(ar -> {
if (ar.succeeded()) {
log.info("MQTT server is listening on port {}", mqttServer.actualPort());
} else {
log.error("Error on starting the server", ar.cause());
}
});
}
/**
* 优雅关闭 MQTT 服务端
*/
public Future<Void> stopMqttServer() {
if (mqttServer != null) {
return mqttServer.close().onComplete(ar -> {
if (ar.succeeded()) {
log.info("MQTT server closed.");
if (vertx != null) {
vertx.close();
log.info("Vert.x instance closed.");
}
} else {
log.error("Failed to close MQTT server: {}", ar.cause().getMessage());
}
});
}
return Future.succeededFuture();
}
// ==================== 以下为官方示例中常见事件的处理封装 ====================
/**
* 处理客户端连接 (CONNECT)
*/
private void handleClientConnect(MqttEndpoint endpoint) {
// 打印 CONNECT 的主要信息
log.info("MQTT client [{}] request to connect, clean session = {}",
endpoint.clientIdentifier(), endpoint.isCleanSession());
if (endpoint.auth() != null) {
log.info("[username = {}, password = {}]", endpoint.auth().getUsername(), endpoint.auth().getPassword());
}
log.info("[properties = {}]", endpoint.connectProperties());
if (endpoint.will() != null) {
log.info("[will topic = {}, msg = {}, QoS = {}, isRetain = {}]",
endpoint.will().getWillTopic(),
new String(endpoint.will().getWillMessageBytes()),
endpoint.will().getWillQos(),
endpoint.will().isWillRetain());
}
log.info("[keep alive timeout = {}]", endpoint.keepAliveTimeSeconds());
// 接受远程客户端的连接
endpoint.accept(false);
}
/**
* 处理客户端主动断开 (DISCONNECT)
*/
private void handleDisconnect(MqttEndpoint endpoint) {
endpoint.disconnectMessageHandler((MqttDisconnectMessage disconnectMessage) -> {
log.info("Received disconnect from client [{}], reason code = {}",
endpoint.clientIdentifier(), disconnectMessage.code());
});
}
/**
* 处理客户端订阅 (SUBSCRIBE)
*/
private void handleSubscribe(MqttEndpoint endpoint) {
endpoint.subscribeHandler((MqttSubscribeMessage subscribe) -> {
List<MqttSubAckReasonCode> reasonCodes = new ArrayList<>();
for (MqttTopicSubscription s : subscribe.topicSubscriptions()) {
log.info("Subscription for {} with QoS {}", s.topicName(), s.qualityOfService());
// 将客户端请求的 QoS 转换为返回给客户端的 reason code可能是错误码或实际 granted QoS
reasonCodes.add(MqttSubAckReasonCode.qosGranted(s.qualityOfService()));
}
// 回复 SUBACKMQTT 5.0 时可指定 reasonCodesproperties
endpoint.subscribeAcknowledge(subscribe.messageId(), reasonCodes, MqttProperties.NO_PROPERTIES);
});
}
/**
* 处理客户端取消订阅 (UNSUBSCRIBE)
*/
private void handleUnsubscribe(MqttEndpoint endpoint) {
endpoint.unsubscribeHandler((MqttUnsubscribeMessage unsubscribe) -> {
for (String topic : unsubscribe.topics()) {
log.info("Unsubscription for {}", topic);
}
// 回复 UNSUBACKMQTT 5.0 时可指定 reasonCodesproperties
endpoint.unsubscribeAcknowledge(unsubscribe.messageId());
});
}
/**
* 处理客户端发布的消息 (PUBLISH)
*/
private void handlePublish(MqttEndpoint endpoint) {
// 接收 PUBLISH 消息
endpoint.publishHandler((MqttPublishMessage message) -> {
String payload = message.payload().toString(Charset.defaultCharset());
log.info("Received message [{}] on topic [{}] with QoS [{}]",
payload, message.topicName(), message.qosLevel());
// 根据不同 QoS回复客户端
if (message.qosLevel() == MqttQoS.AT_LEAST_ONCE) {
endpoint.publishAcknowledge(message.messageId());
} else if (message.qosLevel() == MqttQoS.EXACTLY_ONCE) {
endpoint.publishReceived(message.messageId());
}
});
// 如果 QoS = 2需要处理 PUBREL
endpoint.publishReleaseHandler(messageId -> {
endpoint.publishComplete(messageId);
});
}
/**
* 处理客户端 PINGREQ
*/
private void handlePing(MqttEndpoint endpoint) {
endpoint.pingHandler(v -> {
// 这里仅做日志, PINGRESP 已自动发送
log.info("Ping received from client [{}]", endpoint.clientIdentifier());
});
}
// ==================== 如果需要服务端向客户端发布消息可用以下示例 ====================
/**
* 服务端主动向已连接的某个 endpoint 发布消息的示例
* 如果使用 MQTT 5.0可以传递更多消息属性
*/
public void publishToClient(MqttEndpoint endpoint, String topic, String content) {
endpoint.publish(topic,
Buffer.buffer(content),
MqttQoS.AT_LEAST_ONCE, // QoS 自行选择
false,
false);
// 处理 QoS 1 QoS 2 ACK
endpoint.publishAcknowledgeHandler(messageId -> {
log.info("Received PUBACK from client [{}] for messageId = {}", endpoint.clientIdentifier(), messageId);
}).publishReceivedHandler(messageId -> {
endpoint.publishRelease(messageId);
}).publishCompletionHandler(messageId -> {
log.info("Received PUBCOMP from client [{}] for messageId = {}", endpoint.clientIdentifier(), messageId);
});
}
// ==================== 如果需要多实例部署用于多核扩展可参考以下思路 ====================
// 例如在宿主应用或插件中循环启动多个 MqttServerExtension 实例或使用 Vert.x deployVerticle:
// DeploymentOptions options = new DeploymentOptions().setInstances(10);
// vertx.deployVerticle(() -> new MyMqttVerticle(), options);
}