@gct-paas/core 0.1.4-dev.11 → 0.1.4-dev.12

package/es/modules/mqtt/mqtt-client.mjs

@@ -1,262 +1,229 @@
-import mqtt from 'mqtt';
-import { MqttConnectionStatus } from './enums/mqtt-status.enum.mjs';
-import { MQTT_DEFAULT_CONNECT_OPTIONS, MQTT_CLIENT_EVENT } from './constants/mqtt.const.mjs';
-
-class MqttClient {
-  /** 客户端唯一标识 */
-  instanceId;
-  /** 连接 URL（即 brokerUrl） */
-  url;
-  /** 内部 mqtt.js 客户端实例 */
-  _client = null;
-  /** 当前连接状态 */
-  _status = MqttConnectionStatus.DISCONNECTED;
-  /** topic -> 消息回调集合 */
-  _subscriptions = /* @__PURE__ */ new Map();
-  /** 用户注册的连接级事件监听器集合 */
-  _eventListeners = {
-    connect: /* @__PURE__ */ new Set(),
-    disconnect: /* @__PURE__ */ new Set(),
-    reconnect: /* @__PURE__ */ new Set(),
-    error: /* @__PURE__ */ new Set()
-  };
-  /** 内部保存的连接选项 */
-  _options;
-  /**
-   * 创建 MQTT 客户端实例
-   *
-   * @param instanceId 实例唯一标识
-   * @param options 连接选项
-   */
-  constructor(instanceId, url, options) {
-    if (!instanceId) {
-      throw new Error("MqttClient: instanceId 不能为空");
-    }
-    if (!url) {
-      throw new Error("MqttClient: url 不能为空");
-    }
-    if (!options.clientId) {
-      throw new Error("MqttClient: options.clientId 不能为空");
-    }
-    this.instanceId = instanceId;
-    this.url = url;
-    this._options = {
-      ...options,
-      keepalive: options.keepalive ?? MQTT_DEFAULT_CONNECT_OPTIONS.keepalive,
-      connectTimeout: options.connectTimeout ?? MQTT_DEFAULT_CONNECT_OPTIONS.connectTimeout,
-      reconnectPeriod: options.reconnectPeriod ?? MQTT_DEFAULT_CONNECT_OPTIONS.reconnectPeriod,
-      clean: options.clean ?? MQTT_DEFAULT_CONNECT_OPTIONS.clean
-    };
-  }
-  /** 获取当前连接状态 */
-  get status() {
-    return this._status;
-  }
-  /**
-   * 建立 MQTT 连接
-   *
-   * @description 若当前已连接或正在连接中则不重复建链
-   */
-  connect() {
-    if (this._status === MqttConnectionStatus.CONNECTED || this._status === MqttConnectionStatus.CONNECTING) {
-      return;
-    }
-    this._status = MqttConnectionStatus.CONNECTING;
-    this._client = mqtt.connect(this.url, this._options);
-    this._bindClientEvents();
-  }
-  /**
-   * 断开 MQTT 连接
-   *
-   * @description 主动断开并停止 mqtt.js 内置重连
-   */
-  disconnect() {
-    if (!this._client) {
-      this._status = MqttConnectionStatus.DISCONNECTED;
-      return;
-    }
-    this._status = MqttConnectionStatus.DISCONNECTING;
-    this._client.end(false, {}, () => {
-      this._status = MqttConnectionStatus.DISCONNECTED;
-      this._emitEvent(MQTT_CLIENT_EVENT.DISCONNECT);
-    });
-  }
-  /**
-   * 订阅一个或多个主题
-   *
-   * @param topics 主题或主题数组
-   * @param callback 消息回调函数
-   * @returns 取消订阅函数
-   */
-  subscribe(topics, callback) {
-    const topicList = Array.isArray(topics) ? topics : [topics];
-    topicList.forEach((topic) => {
-      if (!this._subscriptions.has(topic)) {
-        this._subscriptions.set(topic, /* @__PURE__ */ new Set());
-        if (this._client && this._status === MqttConnectionStatus.CONNECTED) {
-          this._client.subscribe(topic);
-        }
-      }
-      this._subscriptions.get(topic).add(
-        callback
-      );
-    });
-    return () => this.unsubscribe(topicList);
-  }
-  /**
-   * 取消订阅一个或多个主题
-   *
-   * @param topics 主题或主题数组
-   */
-  unsubscribe(topics) {
-    const topicList = Array.isArray(topics) ? topics : [topics];
-    topicList.forEach((topic) => {
-      this._subscriptions.delete(topic);
-      if (this._client && this._status === MqttConnectionStatus.CONNECTED) {
-        this._client.unsubscribe(topic);
-      }
-    });
-  }
-  /**
-   * 向指定主题发布消息
-   *
-   * @param topic 目标主题
-   * @param payload 消息内容
-   * @param options 发布选项
-   * @returns Promise，发布成功后 resolve
-   */
-  publish(topic, payload, options) {
-    return new Promise((resolve, reject) => {
-      if (!this._client || this._status !== MqttConnectionStatus.CONNECTED) {
-        reject(
-          new Error(
-            `MqttClient [${this.instanceId}]: 尚未建立连接，无法发布消息`
-          )
-        );
-        return;
-      }
-      const publishOptions = {
-        qos: options?.qos ?? 0,
-        retain: options?.retain ?? false
-      };
-      this._client.publish(topic, payload, publishOptions, (err) => {
-        if (err) {
-          reject(err);
-        } else {
-          resolve();
-        }
-      });
-    });
-  }
-  /**
-   * 监听连接级事件
-   *
-   * @param event 事件名
-   * @param listener 监听函数
-   */
-  on(event, listener) {
-    this._eventListeners[event].add(listener);
-  }
-  /**
-   * 取消监听连接级事件
-   *
-   * @param event 事件名
-   * @param listener 监听函数
-   */
-  off(event, listener) {
-    this._eventListeners[event].delete(
-      listener
-    );
-  }
-  // ─────────────────────────────────────────────
-  // 私有方法
-  // ─────────────────────────────────────────────
-  /**
-   * 绑定 mqtt.js 内部事件
-   *
-   * @private
-   */
-  _bindClientEvents() {
-    if (!this._client) return;
-    this._client.on("connect", (_connack) => {
-      this._status = MqttConnectionStatus.CONNECTED;
-      this._emitEvent(MQTT_CLIENT_EVENT.CONNECT);
-    });
-    this._client.on("reconnect", () => {
-      this._status = MqttConnectionStatus.RECONNECTING;
-      this._emitEvent(MQTT_CLIENT_EVENT.RECONNECT);
-    });
-    this._client.on("error", (err) => {
-      this._emitEvent(MQTT_CLIENT_EVENT.ERROR, err);
-    });
-    this._client.on("close", () => {
-      if (this._status !== MqttConnectionStatus.DISCONNECTING) {
-        this._status = MqttConnectionStatus.DISCONNECTED;
-      }
-    });
-    this._client.on("message", (topic, payload) => {
-      this._dispatchMessage(topic, payload);
-    });
-  }
-  /**
-   * 向所有已订阅该 topic 的回调函数分发消息
-   *
-   * @private
-   * @param topic 消息主题
-   * @param payload 消息内容
-   */
-  _dispatchMessage(topic, payload) {
-    const callbacks = this._subscriptions.get(topic);
-    if (callbacks) {
-      callbacks.forEach((cb) => cb(topic, payload));
-    }
-    this._subscriptions.forEach((cbSet, pattern) => {
-      if (pattern !== topic && this._matchTopic(pattern, topic)) {
-        cbSet.forEach((cb) => cb(topic, payload));
-      }
-    });
-  }
-  /**
-   * MQTT 通配符主题匹配
-   *
-   * @private
-   * @param pattern 订阅时使用的通配符 pattern（支持 + 和 #）
-   * @param topic 实际消息的主题
-   */
-  _matchTopic(pattern, topic) {
-    const patternSegments = pattern.split("/");
-    const topicSegments = topic.split("/");
-    for (let i = 0; i < patternSegments.length; i++) {
-      const p = patternSegments[i];
-      if (p === "#") {
-        return true;
-      }
-      if (p !== "+" && p !== topicSegments[i]) {
-        return false;
-      }
-    }
-    return patternSegments.length === topicSegments.length;
-  }
-  /**
-   * 触发连接级事件
-   *
-   * @private
-   * @param event 事件名
-   * @param arg 可选参数（如 Error）
-   */
-  _emitEvent(event, arg) {
-    if (event === MQTT_CLIENT_EVENT.ERROR && arg) {
-      this._eventListeners.error.forEach(
-        (fn) => fn(arg)
-      );
-    } else if (event === MQTT_CLIENT_EVENT.CONNECT) {
-      this._eventListeners.connect.forEach((fn) => fn());
-    } else if (event === MQTT_CLIENT_EVENT.DISCONNECT) {
-      this._eventListeners.disconnect.forEach((fn) => fn());
-    } else if (event === MQTT_CLIENT_EVENT.RECONNECT) {
-      this._eventListeners.reconnect.forEach((fn) => fn());
-    }
-  }
-}
-
+import { MQTT_CLIENT_EVENT, MQTT_DEFAULT_CONNECT_OPTIONS } from "./constants/mqtt.const.mjs";
+import { MqttConnectionStatus } from "./enums/mqtt-status.enum.mjs";
+import mqtt from "mqtt";
+//#region src/modules/mqtt/mqtt-client.ts
+/**
+* MQTT 客户端
+*
+* @description 封装单个 MQTT 连接，提供连接、断连、订阅、取消订阅、发布等功能。
+* 重连逻辑完全委托给 mqtt.js 内置机制（reconnectPeriod），本类仅负责
+* 状态同步、消息分发与事件转发。
+*
+* @export
+* @class MqttClient
+* @implements {IMqttClient}
+*/
+var MqttClient = class {
+	/** 客户端唯一标识 */
+	instanceId;
+	/** 连接 URL（即 brokerUrl） */
+	url;
+	/** 内部 mqtt.js 客户端实例 */
+	_client = null;
+	/** 当前连接状态 */
+	_status = MqttConnectionStatus.DISCONNECTED;
+	/** topic -> 消息回调集合 */
+	_subscriptions = /* @__PURE__ */ new Map();
+	/** 用户注册的连接级事件监听器集合 */
+	_eventListeners = {
+		connect: /* @__PURE__ */ new Set(),
+		disconnect: /* @__PURE__ */ new Set(),
+		reconnect: /* @__PURE__ */ new Set(),
+		error: /* @__PURE__ */ new Set()
+	};
+	/** 内部保存的连接选项 */
+	_options;
+	/**
+	* 创建 MQTT 客户端实例
+	*
+	* @param instanceId 实例唯一标识
+	* @param options 连接选项
+	*/
+	constructor(instanceId, url, options) {
+		if (!instanceId) throw new Error("MqttClient: instanceId 不能为空");
+		if (!url) throw new Error("MqttClient: url 不能为空");
+		if (!options.clientId) throw new Error("MqttClient: options.clientId 不能为空");
+		this.instanceId = instanceId;
+		this.url = url;
+		this._options = {
+			...options,
+			keepalive: options.keepalive ?? MQTT_DEFAULT_CONNECT_OPTIONS.keepalive,
+			connectTimeout: options.connectTimeout ?? MQTT_DEFAULT_CONNECT_OPTIONS.connectTimeout,
+			reconnectPeriod: options.reconnectPeriod ?? MQTT_DEFAULT_CONNECT_OPTIONS.reconnectPeriod,
+			clean: options.clean ?? MQTT_DEFAULT_CONNECT_OPTIONS.clean
+		};
+	}
+	/** 获取当前连接状态 */
+	get status() {
+		return this._status;
+	}
+	/**
+	* 建立 MQTT 连接
+	*
+	* @description 若当前已连接或正在连接中则不重复建链
+	*/
+	connect() {
+		if (this._status === MqttConnectionStatus.CONNECTED || this._status === MqttConnectionStatus.CONNECTING) return;
+		this._status = MqttConnectionStatus.CONNECTING;
+		this._client = mqtt.connect(this.url, this._options);
+		this._bindClientEvents();
+	}
+	/**
+	* 断开 MQTT 连接
+	*
+	* @description 主动断开并停止 mqtt.js 内置重连
+	*/
+	disconnect() {
+		if (!this._client) {
+			this._status = MqttConnectionStatus.DISCONNECTED;
+			return;
+		}
+		this._status = MqttConnectionStatus.DISCONNECTING;
+		this._client.end(false, {}, () => {
+			this._status = MqttConnectionStatus.DISCONNECTED;
+			this._emitEvent(MQTT_CLIENT_EVENT.DISCONNECT);
+		});
+	}
+	/**
+	* 订阅一个或多个主题
+	*
+	* @param topics 主题或主题数组
+	* @param callback 消息回调函数
+	* @returns 取消订阅函数
+	*/
+	subscribe(topics, callback) {
+		const topicList = Array.isArray(topics) ? topics : [topics];
+		topicList.forEach((topic) => {
+			if (!this._subscriptions.has(topic)) {
+				this._subscriptions.set(topic, /* @__PURE__ */ new Set());
+				if (this._client && this._status === MqttConnectionStatus.CONNECTED) this._client.subscribe(topic);
+			}
+			this._subscriptions.get(topic).add(callback);
+		});
+		return () => this.unsubscribe(topicList);
+	}
+	/**
+	* 取消订阅一个或多个主题
+	*
+	* @param topics 主题或主题数组
+	*/
+	unsubscribe(topics) {
+		(Array.isArray(topics) ? topics : [topics]).forEach((topic) => {
+			this._subscriptions.delete(topic);
+			if (this._client && this._status === MqttConnectionStatus.CONNECTED) this._client.unsubscribe(topic);
+		});
+	}
+	/**
+	* 向指定主题发布消息
+	*
+	* @param topic 目标主题
+	* @param payload 消息内容
+	* @param options 发布选项
+	* @returns Promise，发布成功后 resolve
+	*/
+	publish(topic, payload, options) {
+		return new Promise((resolve, reject) => {
+			if (!this._client || this._status !== MqttConnectionStatus.CONNECTED) {
+				reject(/* @__PURE__ */ new Error(`MqttClient [${this.instanceId}]: 尚未建立连接，无法发布消息`));
+				return;
+			}
+			const publishOptions = {
+				qos: options?.qos ?? 0,
+				retain: options?.retain ?? false
+			};
+			this._client.publish(topic, payload, publishOptions, (err) => {
+				if (err) reject(err);
+				else resolve();
+			});
+		});
+	}
+	/**
+	* 监听连接级事件
+	*
+	* @param event 事件名
+	* @param listener 监听函数
+	*/
+	on(event, listener) {
+		this._eventListeners[event].add(listener);
+	}
+	/**
+	* 取消监听连接级事件
+	*
+	* @param event 事件名
+	* @param listener 监听函数
+	*/
+	off(event, listener) {
+		this._eventListeners[event].delete(listener);
+	}
+	/**
+	* 绑定 mqtt.js 内部事件
+	*
+	* @private
+	*/
+	_bindClientEvents() {
+		if (!this._client) return;
+		this._client.on("connect", (_connack) => {
+			this._status = MqttConnectionStatus.CONNECTED;
+			this._emitEvent(MQTT_CLIENT_EVENT.CONNECT);
+		});
+		this._client.on("reconnect", () => {
+			this._status = MqttConnectionStatus.RECONNECTING;
+			this._emitEvent(MQTT_CLIENT_EVENT.RECONNECT);
+		});
+		this._client.on("error", (err) => {
+			this._emitEvent(MQTT_CLIENT_EVENT.ERROR, err);
+		});
+		this._client.on("close", () => {
+			if (this._status !== MqttConnectionStatus.DISCONNECTING) this._status = MqttConnectionStatus.DISCONNECTED;
+		});
+		this._client.on("message", (topic, payload) => {
+			this._dispatchMessage(topic, payload);
+		});
+	}
+	/**
+	* 向所有已订阅该 topic 的回调函数分发消息
+	*
+	* @private
+	* @param topic 消息主题
+	* @param payload 消息内容
+	*/
+	_dispatchMessage(topic, payload) {
+		const callbacks = this._subscriptions.get(topic);
+		if (callbacks) callbacks.forEach((cb) => cb(topic, payload));
+		this._subscriptions.forEach((cbSet, pattern) => {
+			if (pattern !== topic && this._matchTopic(pattern, topic)) cbSet.forEach((cb) => cb(topic, payload));
+		});
+	}
+	/**
+	* MQTT 通配符主题匹配
+	*
+	* @private
+	* @param pattern 订阅时使用的通配符 pattern（支持 + 和 #）
+	* @param topic 实际消息的主题
+	*/
+	_matchTopic(pattern, topic) {
+		const patternSegments = pattern.split("/");
+		const topicSegments = topic.split("/");
+		for (let i = 0; i < patternSegments.length; i++) {
+			const p = patternSegments[i];
+			if (p === "#") return true;
+			if (p !== "+" && p !== topicSegments[i]) return false;
+		}
+		return patternSegments.length === topicSegments.length;
+	}
+	/**
+	* 触发连接级事件
+	*
+	* @private
+	* @param event 事件名
+	* @param arg 可选参数（如 Error）
+	*/
+	_emitEvent(event, arg) {
+		if (event === MQTT_CLIENT_EVENT.ERROR && arg) this._eventListeners.error.forEach((fn) => fn(arg));
+		else if (event === MQTT_CLIENT_EVENT.CONNECT) this._eventListeners.connect.forEach((fn) => fn());
+		else if (event === MQTT_CLIENT_EVENT.DISCONNECT) this._eventListeners.disconnect.forEach((fn) => fn());
+		else if (event === MQTT_CLIENT_EVENT.RECONNECT) this._eventListeners.reconnect.forEach((fn) => fn());
+	}
+};
+//#endregion
 export { MqttClient };