mm_mqtt_server 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026 Admin
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,3 +1,160 @@
-# Temporary Holding Version
+# mm_mqtt_server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+MQTT 代理服务器入站端口模块。继承 [mm_corejs](https://gitee.com/qiuwenwu91/mm_corejs) 的 `Mod` 基类，基于 [aedes](https://www.npmjs.com/package/aedes) 实现 MQTT Broker，提供连接管理、消息处理管道与 JSON-RPC 2.0 消息插件，可脱离完整框架独立运行。
+
+- 入口：`index.js`（CommonJS）
+- 导出：`MqttServer`（代理模块）、`MessagePlugin`（JSON-RPC 消息插件）
+- 运行时依赖：`mm_corejs`、`aedes`
+- 测试覆盖率：100%（`jest.config.js` 四项阈值）
+
+## 特性
+
+- **标准 Broker**：`net.Server` + `aedes` 监听 TCP 1883，支持订阅、发布、QoS 0-2 与保留消息。
+- **认证策略**：`allow_anonymous` 放行匿名连接；配置 `username` 后校验用户名与口令，失败以 `returnCode 5` 拒绝。
+- **消息管道**：入站发布消息经 `Handle` 的 `before / check / main / render` 阶段处理，管道产出 `{ topic, payload }` 时由代理重新发布（可用于改写、应答）；`getHandle()` 可注册主题守卫等钩子。
+- **连接管理**：`Store` 登记在线客户端，支持 `publish / closeClient / listClients（条件查询与分页）/ hasClient / setClientOptions`。
+- **JSON-RPC 2.0 插件**：`MessagePlugin` 挂载后接管 RPC 形态报文，应答发布到「请求主题 + 后缀」，支持通知回推、主动推送与服务器反向调用客户端方法。
+- **选项透传**：连接级 `options`（user_id / device_id / agent_id 等）随每条入站消息透传给管道钩子与 RPC 处理函数，适配多用户 / 多设备 / 多智能体场景。
+
+## 安装
+
+```bash
+npm install mm_mqtt_server
+```
+
+## 环境要求
+
+- Node.js >= 22.5.0
+- 模块规范：CommonJS
+
+## 快速开始
+
+```js
+'use strict';
+
+const { MqttServer, MessagePlugin } = require('mm_mqtt_server');
+
+/** 最小 Server 容器：满足 Base 契约即可（见 example/demo.js 完整实现） */
+const server = {
+  services: new Map(),
+  getService(name) { return this.services.get(name); },
+  hasService(name) { return this.services.has(name); },
+  setService(name, instance) { this.services.set(name, instance); return this; },
+  getManager() { return undefined; },
+  hasManager() { return false; }
+};
+
+const mqtt = new MqttServer(server, { name: 'mqtt_server', host: '127.0.0.1', port: 1883 });
+
+// 主题守卫：check 阶段产出即短路
+mqtt.getHandle().on('check', (ctx, params) => {
+  if (params.topic.startsWith('blocked/')) return { dropped: true };
+}, 100, 'guard');
+
+// JSON-RPC 插件
+const rpc = new MessagePlugin({ reply_suffix: '/response', qos: 0 });
+mqtt.use(rpc);
+rpc.addMethod('sum', (params, extra) => ({ sum: params.reduce((a, b) => a + b, 0), from: extra.topic }));
+
+// 事件
+mqtt.on('connection', (client) => mqtt.setClientOptions(client.id, { device_id: 'd1' }));
+mqtt.on('message', (client_id, info) => console.log(client_id, info.topic, info.payload));
+mqtt.on('subscribe', (client_id, topics) => console.log(client_id, topics));
+mqtt.on('close', (client_id) => console.log('断开', client_id));
+mqtt.on('error', (err) => console.error(err.message));
+
+await mqtt.init();
+await mqtt.start();
+
+// 主动操作
+await mqtt.run({}, { action: 'publish', topic: 'mm/test', payload: 'hello' });
+await mqtt.run({}, { action: 'list_clients' });
+
+await mqtt.stop();
+await mqtt.dispose();
+```
+
+## 服务器配置（config）
+
+顶层 `config` 字段即服务器设置，`init` 阶段统一校验。
+
+| 字段 | 类型 | 默认值 | 说明 |
+| --- | --- | --- | --- |
+| `name` | string | `'mqtt_server'` | 模块名称（必填） |
+| `host` | string | `'0.0.0.0'` | 监听地址 |
+| `port` | integer | `1883` | 监听端口（1-65535） |
+| `allow_anonymous` | boolean | `true` | 未配置 `username` 时放行匿名连接 |
+| `username` | string | `''` | 认证用户名，非空时启用口令认证 |
+| `password` | string | `''` | 认证口令 |
+
+## API
+
+### MqttServer
+
+| 成员 | 说明 |
+| --- | --- |
+| `run(ctx, params)` | 主动操作入口，`params.action` 派发：`publish`（需 `topic`，可带 `payload` / `qos` / `retain`）、`close_client`（需 `client_id`）、`list_clients`（可选 `query` 条件查询） |
+| `publish(topic, payload, opts)` | 代理端发布消息（进入正常路由，订阅者可收到），返回是否成功 |
+| `closeClient(client_id)` | 关闭指定客户端连接，返回是否发起 |
+| `listClients(query)` | 在线客户端列表（`{ id, address }`），支持 Store 条件 / 分页 / keyword |
+| `hasClient(client_id)` | 是否在线 |
+| `setClientOptions(client_id, options)` | 绑定连接级选项（`null` 清空），随入站消息透传 |
+| `use(plugin)` | 挂载插件（需实现 `bind(server)`） |
+| `getHandle()` | 消息管道，注册 `before / check / main / render` 等钩子；产出 `{ topic, payload }` 时代理重发 |
+| `getAddress()` | 实际监听地址，未启动为 `null` |
+
+### 事件
+
+| 事件 | 参数 | 触发时机 |
+| --- | --- | --- |
+| `connection` | `(client)` | 客户端接入，`client` 为 `{ id, address }` |
+| `message` | `(client_id, info)` | 入站发布消息经管道内置 `emit_message` 钩子分发，`info` 为 `{ topic, payload, qos, retain }` |
+| `subscribe` | `(client_id, topics)` | 客户端订阅主题 |
+| `unsubscribe` | `(client_id, topics)` | 客户端取消订阅 |
+| `close` | `(client_id)` | 客户端断开 |
+| `error` | `(err)` | TCP / broker / 管道钩子错误 |
+
+### 消息管道
+
+每条入站发布消息以 `{ client_id, topic, payload, qos, retain }` 为 `params`、连接级 `options` 为第三参进入管道：
+
+```
+before → check → main（业务钩子按 sort 依次执行）→ render
+```
+
+产出 `{ topic, payload }` 时由代理重新发布该消息；代理自身重发的报文 `client` 为空，不再进入管道，因此无回环。
+
+## MessagePlugin（JSON-RPC 2.0）
+
+挂载后接管 RPC 形态报文（非 RPC 消息透传给业务钩子）：
+
+```js
+const rpc = new MessagePlugin({ reply_suffix: '/response', push_prefix: 'rpc/push', call_prefix: 'rpc/call', qos: 0, retain: false });
+mqtt.use(rpc);
+rpc.addMethod('echo', (params, extra, options) => params); // extra.client_id / extra.topic
+```
+
+| 成员 | 说明 |
+| --- | --- |
+| `addMethod(name, handler)` / `delMethod(name)` / `listMethods(query)` | 方法表管理，处理函数签名 `(params, extra, options)` |
+| `push(client_id, data, options)` | 发布数据到 `options.topic`（缺省 `push_prefix/client_id`），客户端订阅即接收 |
+| `call(client_id, method, params, options)` | 发布 JSON-RPC 请求到 `options.topic`（缺省 `call_prefix/client_id`）并等待客户端反馈，`options.timeout_ms` 缺省 30000 |
+| `bind(server)` / `isBound()` | 挂载与状态查询 |
+
+协议行为：请求（含 `id`）应答发布到「请求主题 + `reply_suffix`」；通知（无 `id`）处理函数有返回值时，把服务器发起的通知 `{ jsonrpc, method, params }` 发布到应答主题；客户端把响应形态报文（含 `result` / `error`、无 `method`）发布回 RPC 主题即结算对应的反向调用。
+
+## 示例
+
+```bash
+npm run demo   # 启动 MQTT 代理演示服务器（127.0.0.1:1883），见 example/demo.js
+```
+
+## 测试
+
+```bash
+npm test       # jest --coverage，四项覆盖率阈值均为 100%
+```
+
+## 许可证
+
+ISC

package/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const MqttServer = require('./lib/mqtt_server');
+const MessagePlugin = require('./lib/message');
+
+module.exports = {
+  MqttServer,
+  MessagePlugin
+};

package/lib/message.js

@@ -0,0 +1,197 @@
+'use strict';
+
+const { JsonRpc } = require('mm_corejs');
+
+/**
+ * 默认应答主题后缀
+ */
+const DEFAULT_REPLY_SUFFIX = '/response';
+
+/**
+ * 默认主动推送主题前缀（完整主题为 前缀/客户端ID）
+ */
+const DEFAULT_PUSH_PREFIX = 'rpc/push';
+
+/**
+ * 默认反向调用主题前缀（完整主题为 前缀/客户端ID，客户端订阅后接收调用请求）
+ */
+const DEFAULT_CALL_PREFIX = 'rpc/call';
+
+/**
+ * MessagePlugin —— JSON-RPC 2.0 消息插件（mm_mqtt_server 的可选业务组件）。
+ *
+ * 职责：
+ *   1. 方法表：内部持有 JsonRpc 核心，addMethod / delMethod / listMethods 登记可调用方法；
+ *   2. 管道挂载：bind(mqtt) 后向消息管道注册 main 钩子 "json_rpc"（sort 100，
+ *      先于内置 emit_message 执行），命中 JSON-RPC 请求时产出重发描述
+ *      { topic: 请求主题 + reply_suffix, payload: 响应 JSON }，由代理发布应答；
+ *   3. 通知回推：通知（无 id）处理函数返回非 undefined 结果时，产出服务器发起的
+ *      通知对象 { jsonrpc, method, params: result } 并发布到应答主题；无结果或出错时
+ *      不产出；非 JSON-RPC 消息（解析失败、缺 jsonrpc 字段）透传，控制权交还管道；
+ *   4. 主动推送：push(client_id, data, options) 发布到 options.topic
+ *      （缺省为 push_prefix/client_id），处理函数或客户端可在任意时刻
+ *      （如异步任务完成后）向订阅该主题的客户端回推结果；
+ *   5. 反向调用：call(client_id, method, params, options) 发布 JSON-RPC 请求到
+ *      options.topic（缺省为 call_prefix/client_id）并等待反馈；客户端把响应
+ *      （含 result/error、无 method）发布回 RPC 服务主题，入站时被优先识别并结算；
+ *   6. 无回环：代理重发的应答 client 为空，不进入消息管道。
+ *
+ * 用法：
+ *   const mqtt = new MqttServer(server, { name: 'mqtt_server', port: 1883 });
+ *   const rpc = new MessagePlugin({ reply_suffix: '/response', push_prefix: 'rpc/push' });
+ *   mqtt.use(rpc);
+ *   rpc.addMethod('echo', (params) => params);
+ *   await mqtt.init();
+ *   await mqtt.start();
+ */
+class MessagePlugin {
+  /**
+   * JSON-RPC 协议核心
+   */
+  #rpc = new JsonRpc();
+
+  /**
+   * 已挂载的 MqttServer 实例，未挂载时为 null
+   */
+  #server = null;
+
+  /**
+   * 应答策略配置
+   */
+  #config = {
+    reply_suffix: DEFAULT_REPLY_SUFFIX,
+    push_prefix: DEFAULT_PUSH_PREFIX,
+    call_prefix: DEFAULT_CALL_PREFIX,
+    qos: 0,
+    retain: false
+  };
+
+  /**
+   * 构造函数
+   * @param {Object} [config] 应答策略配置，含 reply_suffix / push_prefix / call_prefix / qos / retain
+   */
+  constructor(config = {}) {
+    this.#config = { ...this.#config, ...config };
+  }
+
+  /**
+   * 挂载到 MqttServer 的消息管道，注册内置 main 钩子
+   * @param {Object} server 具备 getHandle() 的 MqttServer 实例
+   * @returns {MessagePlugin} 当前实例
+   * @throws {TypeError} server 不具备 getHandle 方法时
+   */
+  bind(server) {
+    if (!server || typeof server.getHandle !== 'function') {
+      throw new TypeError('[MessagePlugin] server must provide getHandle()');
+    }
+    this.#server = server;
+    server.getHandle().on('main', (ctx, params, options) => {
+      return this._execute(ctx, params, options);
+    }, 100, 'json_rpc');
+    return this;
+  }
+
+  /**
+   * 判断是否已挂载
+   * @returns {boolean} 是否已挂载到 MqttServer
+   */
+  isBound() {
+    return this.#server !== null;
+  }
+
+  /**
+   * 登记 RPC 方法
+   * @param {string} name 方法名
+   * @param {Function} handler 处理函数，签名 handler(params, extra, options)，extra 含 client_id 与 topic，options 为管道请求选项
+   * @returns {MessagePlugin} 当前实例
+   */
+  addMethod(name, handler) {
+    this.#rpc.addMethod(name, handler);
+    return this;
+  }
+
+  /**
+   * 删除 RPC 方法
+   * @param {string} name 方法名
+   * @returns {boolean} 是否删除成功
+   */
+  delMethod(name) {
+    return this.#rpc.delMethod(name);
+  }
+
+  /**
+   * 列出 RPC 方法（支持 Store 条件查询与分页）
+   * @param {Object} [query] 查询条件，缺省时列出全部
+   * @returns {Array<Object>} 方法列表，含 name
+   */
+  listMethods(query) {
+    return this.#rpc.listMethods(query);
+  }
+
+  /**
+   * 主动推送：发布数据到指定主题（缺省为 push_prefix/client_id，客户端订阅后接收）
+   * @param {string} client_id 目标客户端 ID，用于组装缺省主题
+   * @param {string|Object} data 待推送数据，对象时 JSON 序列化
+   * @param {Object} [options] 推送选项，含 topic（覆盖缺省主题）
+   * @returns {Promise<boolean>} 是否发布成功
+   * @throws {Error} 插件尚未挂载到服务器时
+   */
+  push(client_id, data, options = {}) {
+    if (!this.#server) throw new Error('[MessagePlugin] not bound to a server');
+    const config = this.#config;
+    const topic = options.topic || `${config.push_prefix}/${client_id}`;
+    const payload = typeof data === 'string' ? data : JSON.stringify(data);
+    return this.#server.publish(topic, payload, { qos: config.qos, retain: config.retain });
+  }
+
+  /**
+   * 实时调用客户端方法：发布 JSON-RPC 请求并等待客户端反馈 result
+   * @param {string} client_id 目标客户端 ID，用于组装缺省调用主题
+   * @param {string} method 客户端方法名
+   * @param {*} [params] 调用参数
+   * @param {Object} [options] 选项，含 topic（覆盖缺省调用主题）与 timeout_ms（缺省 30000）
+   * @returns {Promise<*>} 客户端反馈的 result；错误响应、送达失败或超时时 reject
+   * @throws {Error} 插件尚未挂载到服务器时
+   */
+  call(client_id, method, params, options = {}) {
+    if (!this.#server) throw new Error('[MessagePlugin] not bound to a server');
+    const config = this.#config;
+    const topic = options.topic || `${config.call_prefix}/${client_id}`;
+    /** 发送函数：把调用请求发布到调用主题 */
+    const send = (request) => this.#server.publish(topic, JSON.stringify(request), { qos: config.qos, retain: false });
+    return this.#rpc.call(send, method, params, options);
+  }
+
+  /**
+   * 内置 main 钩子逻辑：优先识别客户端反馈，其次执行 RPC 请求并产出应答重发描述
+   * @param {Object} ctx 执行上下文
+   * @param {Object} params 消息参数，含 client_id / topic / payload
+   * @param {Object} [options] 管道请求选项（连接级，如 user_id / device_id / agent_id），透传给处理函数
+   * @returns {Promise<Object|undefined>} 重发描述 { topic, payload, qos, retain }；反馈、透传与无结果通知时为 undefined
+   */
+  async _execute(ctx, params, options) {
+    if (this.#rpc.acceptResponse(params.payload)) return undefined;
+    const extra = { client_id: params.client_id, topic: params.topic };
+    const response = await this.#rpc.handle(params.payload, extra, options);
+    if (response === undefined) return undefined;
+    return this._buildReply(params.topic, response);
+  }
+
+  /**
+   * 组装应答重发描述
+   * @param {string} topic 请求主题
+   * @param {Object} response 响应对象
+   * @returns {Object} 重发描述，payload 为响应 JSON 字符串
+   */
+  _buildReply(topic, response) {
+    const config = this.#config;
+    return {
+      topic: `${topic}${config.reply_suffix}`,
+      payload: JSON.stringify(response),
+      qos: config.qos,
+      retain: config.retain
+    };
+  }
+}
+
+module.exports = MessagePlugin;

package/lib/mqtt_server.js

@@ -0,0 +1,572 @@
+'use strict';
+
+const net = require('net');
+const { Aedes } = require('aedes');
+const { Mod, Handle, Store } = require('mm_corejs');
+
+/**
+ * 服务器设置校验 schema（校验对象为顶层 config）
+ */
+const SERVER_SCHEMA = {
+  type: 'object',
+  properties: {
+    host: { type: 'string', min_length: 1 },
+    port: { type: 'integer', minimum: 1, maximum: 65535 },
+    allow_anonymous: { type: 'boolean' },
+    username: { type: 'string' },
+    password: { type: 'string' }
+  }
+};
+
+/**
+ * MqttServer —— MQTT 代理服务器（入站端口模块）。
+ *
+ * 继承 mm_corejs 的 Mod：生命周期由 Lifecycle 模板方法驱动，
+ * 调用参数校验由 config.params 声明式定义；
+ * 服务器设置（host / port / allow_anonymous / username / password）为顶层 config 字段，
+ * 在 onInit 阶段按 SERVER_SCHEMA 统一校验。
+ *
+ * 职责：
+ *   1. 监听：onStart 创建 aedes broker 与 net.Server，按 host / port 监听 MQTT 连接；
+ *   2. 连接管理：#clients 使用 Store 登记在线客户端（主键 id，支持条件查询与分页）；
+ *   3. 消息管道：入站发布消息经 Handle 的 before/check/main/render 阶段处理，
+ *      内置 main 钩子发 message 事件保持兼容；管道产出 { topic, payload } 时
+ *      由代理重新发布该消息；getHandle() 可注册自定义钩子（如主题黑名单）；
+ *   4. 事件分发：connection / message / subscribe / unsubscribe / close / error；
+ *   5. 主动操作：run(ctx, params) 按 params.action 派发 publish / close_client / list_clients。
+ *
+ * 用法：
+ *   const mqtt = new MqttServer(server, { name: 'mqtt_server', host: '127.0.0.1', port: 1883 });
+ *   mqtt.getHandle().on('check', (ctx, params) => {
+ *     if (params.topic.startsWith('blocked/')) return { dropped: true };
+ *   }, 100, 'guard');
+ *   mqtt.on('message', (client_id, info) => console.log(client_id, info.topic, info.payload));
+ *   await mqtt.init();
+ *   await mqtt.start();
+ *   await mqtt.run({}, { action: 'publish', topic: 'mm/test', payload: 'hello' });
+ */
+class MqttServer extends Mod {
+  /**
+   * 模块默认配置
+   */
+  static config = {
+    name: 'mqtt_server',
+    title: 'MQTT代理服务器模块',
+    description: '基于 aedes 的 MQTT 代理：管理客户端连接、主题订阅与消息路由',
+    version: '1.0.0',
+    host: '0.0.0.0',
+    port: 1883,
+    allow_anonymous: true,
+    username: '',
+    password: '',
+    options: {},
+    params: {
+      type: 'object',
+      required: ['action'],
+      properties: {
+        action: { type: 'string', enum: ['publish', 'close_client', 'list_clients'] },
+        client_id: { type: 'string', min_length: 1 },
+        topic: { type: 'string', min_length: 1 },
+        payload: { type: 'string' },
+        qos: { type: 'integer', minimum: 0, maximum: 2 },
+        retain: { type: 'boolean' },
+        query: { type: 'object' }
+      }
+    }
+  };
+
+  /**
+   * aedes broker 实例
+   */
+  #broker = null;
+
+  /**
+   * 底层 TCP 服务器实例
+   */
+  #server = null;
+
+  /**
+   * 连接注册表：Store 存储，主键 id、名称字段 name
+   */
+  #clients = new Store({ key: 'id', name: 'name' });
+
+  /**
+   * 消息处理管道（before/check/main/render/error/success/after）
+   */
+  #handle = new Handle();
+
+  // ---------- 生命周期钩子 ----------
+  /**
+   * 初始化钩子：校验服务器设置并装配消息管道
+   */
+  async onInit() {
+    await this._validateConfig();
+    this._initHandle();
+  }
+
+  /**
+   * 启动钩子：创建 broker 与 TCP 服务器并开始监听
+   */
+  async onStart() {
+    const broker = await this._createBroker();
+    this.#broker = broker;
+    this._bindBrokerEvents(broker);
+    const server = net.createServer((stream) => broker.handle(stream));
+    this.#server = server;
+    await this._listen(server);
+    server.on('error', (err) => this._emitError(err));
+  }
+
+  /**
+   * 停止钩子：断开全部客户端，关闭 TCP 服务器与 broker
+   */
+  async onStop() {
+    this._closeAllClients();
+    await this._closeServer();
+    await this._closeBroker();
+  }
+
+  /**
+   * 释放钩子：清空连接注册表
+   */
+  async onDispose() {
+    this.#clients.clear();
+  }
+
+  // ---------- 执行入口 ----------
+  /**
+   * 模块主逻辑：按 action 派发操作
+   * @param {Object} ctx 执行上下文
+   * @param {Object} params 调用参数，含 action 及操作所需字段
+   * @param {Object} options 合并后的选项
+   * @returns {Promise<Object>} 操作结果
+   */
+  async main(ctx, params, options) {
+    const action = params.action;
+    if (action === 'publish') return this._actionPublish(params);
+    if (action === 'close_client') return this._actionCloseClient(params);
+    return this._actionListClients(params);
+  }
+
+  /**
+   * 执行代理发布操作：消息进入正常路由，订阅者会收到
+   * @param {Object} params 调用参数，含 topic / payload / qos / retain
+   * @returns {Promise<Object>} 操作结果
+   */
+  async _actionPublish(params) {
+    this._requireTopic(params);
+    const success = await this.publish(params.topic, params.payload, params);
+    return { action: 'publish', topic: params.topic, success };
+  }
+
+  /**
+   * 执行关闭客户端操作
+   * @param {Object} params 调用参数，含 client_id
+   * @returns {Object} 操作结果
+   */
+  _actionCloseClient(params) {
+    this._requireClientId(params);
+    const success = this.closeClient(params.client_id);
+    return { action: 'close_client', client_id: params.client_id, success };
+  }
+
+  /**
+   * 执行列出客户端操作
+   * @param {Object} params 调用参数，可含 query 查询条件（Store 条件/分页）
+   * @returns {Object} 操作结果，clients 为在线客户端列表
+   */
+  _actionListClients(params) {
+    return { action: 'list_clients', clients: this.listClients(params.query) };
+  }
+
+  // ---------- 公开操作 ----------
+  /**
+   * 代理端发布消息到指定主题
+   * @param {string} topic 主题
+   * @param {string|Buffer} payload 消息内容
+   * @param {Object} opts 发布选项，含 qos 与 retain
+   * @returns {Promise<boolean>} 是否发布成功
+   */
+  publish(topic, payload, opts = {}) {
+    const broker = this.#broker;
+    if (!broker) return Promise.resolve(false);
+    const packet = this._buildPacket(topic, payload, opts);
+    return new Promise((resolve, reject) => {
+      broker.publish(packet, (err) => {
+        if (err) {
+          reject(err);
+          return;
+        }
+        resolve(true);
+      });
+    });
+  }
+
+  /**
+   * 关闭指定客户端连接
+   * @param {string} client_id 客户端 ID
+   * @returns {boolean} 是否发起关闭
+   */
+  closeClient(client_id) {
+    const entry = this.#clients.getById(client_id);
+    if (!entry) return false;
+    entry.client.close();
+    return true;
+  }
+
+  /**
+   * 列出在线客户端（支持 Store 条件查询与分页）
+   * @param {Object} [query] 查询条件，缺省时列出全部
+   * @returns {Array<Object>} 客户端信息列表，含 id 与 address
+   */
+  listClients(query) {
+    return this.#clients.list(query).map((entry) => ({ id: entry.id, address: entry.address }));
+  }
+
+  /**
+   * 绑定连接级选项（如 user_id / device_id / agent_id），入站消息将作为管道 options 透传给钩子与 RPC 处理函数
+   * @param {string} client_id 客户端 ID
+   * @param {Object|null} options 选项对象，null 时清空
+   * @returns {boolean} 是否设置成功（客户端不在线时失败）
+   */
+  setClientOptions(client_id, options) {
+    const entry = this.#clients.getById(client_id);
+    if (!entry) return false;
+    entry.options = options || null;
+    return true;
+  }
+
+  /**
+   * 读取连接级选项，未绑定时返回空对象
+   * @param {string} client_id 客户端 ID
+   * @returns {Object} 连接级选项
+   */
+  _clientOptions(client_id) {
+    const entry = this.#clients.getById(client_id);
+    if (!entry || !entry.options) return {};
+    return entry.options;
+  }
+
+  /**
+   * 判断客户端是否在线
+   * @param {string} client_id 客户端 ID
+   * @returns {boolean} 是否在线
+   */
+  hasClient(client_id) {
+    return !!this.#clients.getById(client_id);
+  }
+
+  /**
+   * 挂载插件：调用 plugin.bind(this)，由插件自行向管道注册钩子；
+   * 如 MessagePlugin 挂载后接管 JSON-RPC 请求并应答到请求主题 + 后缀
+   * @param {Object} plugin 具备 bind(server) 方法的插件实例
+   * @returns {MqttServer} 当前实例
+   * @throws {TypeError} plugin 不具备 bind 方法时
+   */
+  use(plugin) {
+    if (!plugin || typeof plugin.bind !== 'function') {
+      throw new TypeError(`${this._label()} plugin must provide bind()`);
+    }
+    plugin.bind(this);
+    return this;
+  }
+
+  /**
+   * 获取消息处理管道，供外部注册 before/check/main 等钩子；
+   * 钩子产出 { topic, payload } 时由代理重新发布该消息
+   * @returns {Handle} 消息管道实例
+   */
+  getHandle() {
+    return this.#handle;
+  }
+
+  /**
+   * 获取实际监听地址
+   * @returns {Object|null} 监听地址信息，未启动时为 null
+   */
+  getAddress() {
+    const server = this.#server;
+    return server ? server.address() : null;
+  }
+
+  // ---------- broker 装配 ----------
+  /**
+   * 创建 aedes broker 并装配认证器
+   * @returns {Promise<Object>} broker 实例
+   */
+  async _createBroker() {
+    const broker = await Aedes.createBroker({
+      authenticate: (client, username, password, done) => {
+        this._authenticate(client, username, password, done);
+      }
+    });
+    return broker;
+  }
+
+  /**
+   * 把 broker 事件映射为模块事件，并维护连接注册表
+   * @param {Object} broker aedes broker 实例
+   */
+  _bindBrokerEvents(broker) {
+    broker.on('client', (client) => {
+      this.#clients.delById(client.id);
+      this.#clients.add({
+        id: client.id,
+        name: client.id,
+        address: this._remoteAddress(client),
+        client
+      });
+      this._safeEmit('connection', this._clientInfo(client));
+    });
+    broker.on('clientDisconnect', (client) => {
+      const existed = this.#clients.delById(client.id);
+      if (existed) this._safeEmit('close', client.id);
+    });
+    broker.on('publish', (packet, client) => {
+      if (!client) return;
+      this._handlePublish(client, packet).catch((err) => this._emitError(err));
+    });
+    broker.on('subscribe', (subscriptions, client) => {
+      const topics = subscriptions.map((item) => item.topic);
+      this._safeEmit('subscribe', client.id, topics);
+    });
+    broker.on('unsubscribe', (topics, client) => {
+      this._safeEmit('unsubscribe', client.id, topics);
+    });
+    broker.on('clientError', (client, err) => this._emitError(err));
+    broker.on('connectionError', (client, err) => this._emitError(err));
+  }
+
+  /**
+   * 入站发布消息经管道处理：错误上抛，产出 { topic, payload } 时代理重发
+   * @param {Object} client aedes client 实例
+   * @param {Object} packet aedes 发布报文
+   * @returns {Promise<void>} 无返回值
+   */
+  async _handlePublish(client, packet) {
+    const params = {
+      client_id: client.id,
+      topic: packet.topic,
+      payload: packet.payload.toString('utf8'),
+      qos: packet.qos,
+      retain: packet.retain
+    };
+    const ctx = { client_id: client.id };
+    const done = await this.#handle.run(ctx, params, this._clientOptions(client.id));
+    if (done.error) this._emitError(done.error);
+    if (this._isRepublish(done.result)) {
+      await this.publish(done.result.topic, done.result.payload, done.result);
+    }
+  }
+
+  /**
+   * 判断管道产出是否为待重发的发布描述（须含 topic 与 payload）
+   * @param {*} result 管道产出的结果
+   * @returns {boolean} 是否为发布描述
+   */
+  _isRepublish(result) {
+    if (result === null || typeof result !== 'object') return false;
+    return !!result.topic && result.payload !== undefined;
+  }
+
+  // ---------- 认证 ----------
+  /**
+   * 认证回调：匿名开关与用户名口令校验
+   * @param {Object} client aedes client 实例
+   * @param {string|undefined} username 用户名
+   * @param {Buffer|undefined} password 口令
+   * @param {Function} done 回调，签名 done(err, success)
+   */
+  _authenticate(client, username, password, done) {
+    if (this._checkAnonymous()) {
+      done(null, true);
+      return;
+    }
+    if (!username) {
+      done(this._authError('username required'), false);
+      return;
+    }
+    if (this._checkCredential(username, password)) {
+      done(null, true);
+      return;
+    }
+    done(this._authError('bad username or password'), false);
+  }
+
+  /**
+   * 判断是否放行匿名连接
+   * @returns {boolean} 是否放行
+   */
+  _checkAnonymous() {
+    const anonymous = this.config.allow_anonymous && !this.config.username;
+    return anonymous;
+  }
+
+  /**
+   * 校验用户名与口令
+   * @param {string} username 用户名
+   * @param {Buffer|undefined} password 口令
+   * @returns {boolean} 是否匹配
+   */
+  _checkCredential(username, password) {
+    const user_ok = username === this.config.username;
+    const pass_ok = String(password ?? '') === this.config.password;
+    return user_ok && pass_ok;
+  }
+
+  /**
+   * 构造认证错误对象
+   * @param {string} message 错误信息
+   * @returns {Error} 带 returnCode 的错误
+   */
+  _authError(message) {
+    const err = new Error(message);
+    err.returnCode = 5;
+    return err;
+  }
+
+  // ---------- 数据组装 ----------
+  /**
+   * 构造 broker 发布报文
+   * @param {string} topic 主题
+   * @param {string|Buffer} payload 消息内容
+   * @param {Object} opts 发布选项，含 qos 与 retain
+   * @returns {Object} aedes 发布报文
+   */
+  _buildPacket(topic, payload, opts) {
+    return {
+      cmd: 'publish',
+      topic,
+      payload: Buffer.from(String(payload)),
+      qos: opts.qos || 0,
+      retain: opts.retain || false
+    };
+  }
+
+  /**
+   * 提取客户端信息
+   * @param {Object} client aedes client 实例
+   * @returns {Object} 含 id 与 address 的信息
+   */
+  _clientInfo(client) {
+    return {
+      id: client.id,
+      address: this._remoteAddress(client)
+    };
+  }
+
+  /**
+   * 获取远端地址字符串
+   * @param {Object} client aedes client 实例
+   * @returns {string} 形如 ip:port 的地址
+   */
+  _remoteAddress(client) {
+    const conn = client.conn;
+    if (!conn || !conn.remoteAddress) return '';
+    return `${conn.remoteAddress}:${conn.remotePort}`;
+  }
+
+  // ---------- 监听与清理 ----------
+  /**
+   * 等待 TCP 服务器监听成功
+   * @param {Object} server net.Server 实例
+   * @returns {Promise<void>} 无返回值
+   */
+  _listen(server) {
+    const host = this.config.host;
+    const port = this.config.port;
+    return new Promise((resolve, reject) => {
+      server.once('error', reject);
+      server.listen({ host, port }, () => {
+        server.removeListener('error', reject);
+        resolve();
+      });
+    });
+  }
+
+  /**
+   * 断开全部客户端连接并清空注册表
+   */
+  _closeAllClients() {
+    for (const entry of this.#clients.list()) {
+      entry.client.close();
+    }
+    this.#clients.clear();
+  }
+
+  /**
+   * 关闭底层 TCP 服务器
+   * @returns {Promise<void>} 无返回值
+   */
+  _closeServer() {
+    const server = this.#server;
+    this.#server = null;
+    if (!server) return Promise.resolve();
+    return new Promise((resolve) => {
+      server.close(resolve);
+    });
+  }
+
+  /**
+   * 关闭 aedes broker
+   * @returns {Promise<void>} 无返回值
+   */
+  _closeBroker() {
+    const broker = this.#broker;
+    this.#broker = null;
+    if (!broker) return Promise.resolve();
+    return new Promise((resolve) => {
+      broker.close(resolve);
+    });
+  }
+
+  // ---------- 消息管道 ----------
+  /**
+   * 装配内置管道钩子：main 发 message 事件保持向后兼容
+   */
+  _initHandle() {
+    this.#handle.on('main', (ctx, params) => {
+      this._safeEmit('message', params.client_id, {
+        topic: params.topic,
+        payload: params.payload,
+        qos: params.qos,
+        retain: params.retain
+      });
+    }, 1000, 'emit_message');
+  }
+
+  // ---------- 校验辅助 ----------
+  /**
+   * 校验顶层 config 中的服务器设置
+   * @returns {Promise<void>} 无返回值
+   * @throws {Error} 校验不通过时
+   */
+  async _validateConfig() {
+    const tip = await this._validate(this.config, SERVER_SCHEMA);
+    if (tip) throw new Error(`${this._label()} invalid config: ${tip}`);
+  }
+
+  /**
+   * 断言调用参数含 client_id
+   * @param {Object} params 调用参数
+   * @throws {Error} 缺少 client_id 时
+   */
+  _requireClientId(params) {
+    if (!params.client_id) {
+      throw new Error(`${this._label()} params.client_id required`);
+    }
+  }
+
+  /**
+   * 断言调用参数含 topic
+   * @param {Object} params 调用参数
+   * @throws {Error} 缺少 topic 时
+   */
+  _requireTopic(params) {
+    if (!params.topic) {
+      throw new Error(`${this._label()} params.topic required`);
+    }
+  }
+}
+
+module.exports = MqttServer;

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "mm_mqtt_server",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "MQTT 代理服务器入站端口模块，基于 aedes，继承 mm_corejs 的 Mod 基类，支持独立运行。",
+  "keywords": [
+    "超级美眉",
+    "入站端口",
+    "mm_mod",
+    "mm_in_port",
+    "mm_receiver",
+    "mqtt",
+    "broker",
+    "aedes",
+    "server"
+  ],
+  "license": "ISC",
+  "author": "qww",
+  "type": "commonjs",
+  "main": "index.js",
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "engines": {
+    "node": ">=22.5.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitee.com/qiuwenwu91/mm_mqtt_server.git"
+  },
+  "homepage": "https://gitee.com/qiuwenwu91/mm_mqtt_server",
+  "bugs": {
+    "url": "https://gitee.com/qiuwenwu91/mm_mqtt_server/issues"
+  },
+  "scripts": {
+    "start": "node example/demo.js",
+    "demo": "node example/demo.js",
+    "test": "jest --coverage"
+  },
+  "dependencies": {
+    "aedes": "^1.2.0",
+    "mm_corejs": "^1.1.0"
+  },
+  "devDependencies": {
+    "jest": "^30.5.2"
+  }
+}