mm_admin 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,15 @@
1
+ ISC License
2
+
3
+ Copyright (c) 2026 Admin
4
+
5
+ Permission to use, copy, modify, and/or distribute this software for any
6
+ purpose with or without fee is hereby granted, provided that the above
7
+ copyright notice and this permission notice appear in all copies.
8
+
9
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
10
+ REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11
+ AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
12
+ INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13
+ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
14
+ OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15
+ PERFORMANCE OF THIS SOFTWARE.
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  # mm_admin
2
2
 
3
- 管理器实例池模块。按名称缓存管理器实例(如同作用域的缓存、会话、通道管理器),提供同步/异步获取、实例创建钩子与删除清空,供各 `xxxAdmin()` 统一对外出口复用。
3
+ 管理器实例池模块。按名称缓存管理器实例(如同作用域的缓存、会话、通道管理器),提供同步/异步获取、实例创建钩子与删除清空;模块入口另提供全局注册表(`reg` / `unreg` / `list` / `setSecret`),统一管理各模块的 Admin 实例,供各 `xxxAdmin()` 统一对外出口复用。
4
4
 
5
5
  ## 项目信息
6
6
 
7
- - **当前版本**: 1.0.0
7
+ - **当前版本**: 1.1.0
8
8
  - **依赖**: 无
9
9
  - **运行环境**: Node.js(使用私有字段 `#map`,需 Node.js 12+)
10
10
  - **Gitee地址**: https://gitee.com/qiuwenwu91/mm_admin
@@ -17,6 +17,8 @@
17
17
  - `getAsync` 支持实例创建钩子 `onCreate`,新实例创建后执行异步初始化,已存在实例不再执行
18
18
  - `setClass` / `setServer` / `onCreate` 只允许设置一次,重复设置抛错,防止运行期被篡改
19
19
  - 提供 `has` / `del` / `clear` / `keys` / `values` / `size` 完整管理方法,`clear` 支持链式调用
20
+ - 全局注册表按名称管理 Admin 实例,**建议优先使用 `reg(name)` 实例化**,同名只创建一次,便于统一枚举与注销
21
+ - 注销受默认密钥保护:`setSecret` 仅可设置一次,未设置密钥时 `unreg` 始终失败
20
22
 
21
23
  ## 安装
22
24
 
@@ -27,7 +29,7 @@ npm install mm_admin
27
29
  ## 基本使用
28
30
 
29
31
  ```javascript
30
- const { Admin } = require('mm_admin');
32
+ const { reg } = require('mm_admin');
31
33
 
32
34
  // 1. 定义被管理的类,构造参数为 (config, server)
33
35
  class CacheManager {
@@ -38,9 +40,10 @@ class CacheManager {
38
40
  }
39
41
  }
40
42
 
41
- // 2. 创建管理器并绑定被管理的类与服务器
42
- const admin = new Admin({ debug: true }, { tag: 'server' });
43
+ // 2. 优先通过全局注册表获取 Admin 实例,同名只创建一次
44
+ const admin = reg('cache');
43
45
  admin.setClass(CacheManager);
46
+ admin.setServer({ tag: 'server' });
44
47
 
45
48
  // 3. 按名称获取实例,同名实例只创建一次
46
49
  const cache = admin.get('cache:a', { ttl: 60 });
@@ -68,8 +71,12 @@ admin.clear(); // 返回管理器自身
68
71
  | 导出 | 签名 | 返回值 | 说明 |
69
72
  | --- | --- | --- | --- |
70
73
  | Admin | `Admin` | `Class` | 管理器类,见下文 |
74
+ | reg | `reg(name)` | `Admin` | 注册并返回指定名称的 Admin 实例,同名只创建一次,重复注册返回已存在的实例;`name` 为空时抛错。**建议优先用 `reg()` 而非 `new Admin()`,便于全局统一管理** |
75
+ | unreg | `unreg(name, secret?)` | `boolean` | 注销指定名称的 Admin 实例;需提供与默认密钥一致的密钥(缺省时使用默认密钥),未设置默认密钥时始终返回 `false` |
76
+ | setSecret | `setSecret(key)` | `boolean` | 设置注销默认密钥,只允许设置一次;密钥为空或已设置时返回 `false` |
77
+ | list | `list()` | `string[]` | 按注册顺序返回全部已注册的 Admin 实例名称 |
71
78
 
72
- > 各业务模块建议参照 `mm_container` 的用法:模块入口创建一个 `Admin` 实例并 `setClass` 绑定自身管理类,再导出 `xxxAdmin(name, config?)` 函数统一对外提供实例。
79
+ > 各业务模块建议:入口用 `reg('模块名')` 获取全局唯一的 Admin 并 `setClass` 绑定自身管理类,再导出 `xxxAdmin(name, config?)` 函数统一对外提供实例;需要枚举或回收各模块 Admin 时,统一走 `list()` / `unreg()`。
73
80
 
74
81
  ### 构造函数
75
82
 
@@ -119,7 +126,7 @@ const admin = new Admin(config?, server?);
119
126
  npm run demo
120
127
  ```
121
128
 
122
- 示例代码见 `example/demo.js`,会依次演示实例池缓存、配置生效规则、异步创建钩子、遍历删除与清空。
129
+ 示例代码见 `example/demo.js`,会依次演示全局注册、实例池缓存、配置生效规则、异步创建钩子、遍历删除与密钥注销。
123
130
 
124
131
  ## 测试
125
132
 
@@ -127,10 +134,15 @@ npm run demo
127
134
  npm test
128
135
  ```
129
136
 
130
- 使用 jest 运行,覆盖构造、类/服务器/钩子的一次性设置、同步与异步获取、缓存与配置规则、删除清空遍历等场景。覆盖率阈值为 100%(语句、分支、函数、行)。
137
+ 使用 jest 运行,覆盖构造、类/服务器/钩子的一次性设置、同步与异步获取、缓存与配置规则、删除清空遍历,以及全局注册表的注册、枚举与密钥注销等场景。覆盖率阈值为 100%(语句、分支、函数、行)。
131
138
 
132
139
  ## 更新日志
133
140
 
141
+ ### 1.1.0
142
+
143
+ - 新增全局注册表:`reg(name)` 注册 Admin 实例(同名只创建一次)、`unreg(name, secret?)` 密钥保护注销、`list()` 枚举名称、`setSecret(key)` 一次性设置默认密钥
144
+ - 文档与示例建议优先使用 `reg()` 实例化,便于统一管理
145
+
134
146
  ### 1.0.0
135
147
 
136
148
  - 提供 `Admin` 管理器类:`setClass` / `getClass` / `setServer` / `getServer` / `onCreate` / `setConfig`
package/example/demo.js CHANGED
@@ -1,6 +1,6 @@
1
1
  'use strict';
2
2
 
3
- const { Admin } = require('../index');
3
+ const { reg, unreg, setSecret, list } = require('../index');
4
4
 
5
5
  /**
6
6
  * 示例管理器类
@@ -39,17 +39,22 @@ class CacheManager {
39
39
  }
40
40
 
41
41
  /**
42
- * 使用示例:演示 Admin 的实例池缓存、创建钩子与删除清空
42
+ * 使用示例:演示 reg 统一注册、Admin 实例池缓存、创建钩子与注销
43
43
  */
44
44
  async function runDemo() {
45
- const admin = new Admin({ debug: true }, { tag: 'server' });
45
+ console.log('=== 统一注册 ===');
46
+ const admin = reg('cache');
47
+ console.log(' 同名重复注册返回同一实例: ' + (reg('cache') === admin));
48
+ reg('session');
49
+ console.log(' 已注册实例: ' + JSON.stringify(list()));
50
+
51
+ console.log('=== 基础实例池 ===');
46
52
  admin.setClass(CacheManager);
53
+ admin.setServer({ tag: 'server' });
47
54
  admin.onCreate(async (manager) => {
48
55
  await Promise.resolve();
49
56
  manager.ready = true;
50
57
  });
51
-
52
- console.log('=== 基础实例池 ===');
53
58
  const cache_a = admin.get('cache:a', { ttl: 60 });
54
59
  console.log(' 配置: ' + JSON.stringify(cache_a.config));
55
60
  console.log(' 服务器: ' + JSON.stringify(cache_a.server));
@@ -73,6 +78,13 @@ async function runDemo() {
73
78
  console.log(' del 不存在的名称: ' + admin.del('cache:x'));
74
79
  admin.clear();
75
80
  console.log(' clear 后 size: ' + admin.size);
81
+
82
+ console.log('=== 注销实例 ===');
83
+ console.log(' 未设置密钥注销 session: ' + unreg('session'));
84
+ console.log(' 设置默认密钥: ' + setSecret('demo-secret'));
85
+ console.log(' 密钥错误注销 session: ' + unreg('session', 'wrong'));
86
+ console.log(' 密钥正确注销 session: ' + unreg('session'));
87
+ console.log(' 剩余实例: ' + JSON.stringify(list()));
76
88
  }
77
89
 
78
90
  runDemo();
package/index.js CHANGED
@@ -2,6 +2,69 @@
2
2
 
3
3
  const Admin = require('./lib/admin');
4
4
 
5
+ const registry = new Map();
6
+ let secret_key = '';
7
+
8
+ /**
9
+ * 注册指定名称的 Admin 实例
10
+ * 同名实例只创建一次,重复注册返回已存在的实例。
11
+ * @param {string} name 实例名称
12
+ * @returns {Admin} 实例
13
+ * @throws {Error} 名称为空时抛错
14
+ */
15
+ function reg(name) {
16
+ if (!name) {
17
+ throw new Error('实例名称不能为空');
18
+ }
19
+ let admin = registry.get(name);
20
+ if (!admin) {
21
+ admin = new Admin();
22
+ registry.set(name, admin);
23
+ }
24
+ return admin;
25
+ }
26
+
27
+ /**
28
+ * 注销指定名称的 Admin 实例
29
+ * 需提供与默认密钥一致的密钥;未设置默认密钥时始终注销失败。
30
+ * @param {string} name 实例名称
31
+ * @param {string} secret 密钥,缺省时使用默认密钥
32
+ * @returns {boolean} 是否注销成功
33
+ */
34
+ function unreg(name, secret) {
35
+ const key = secret === undefined ? secret_key : secret;
36
+ if (!secret_key || key !== secret_key) {
37
+ return false;
38
+ }
39
+ return registry.delete(name);
40
+ }
41
+
42
+ /**
43
+ * 设置默认密钥
44
+ * 只允许设置一次,密钥为空或已设置时返回 false。
45
+ * @param {string} key 密钥
46
+ * @returns {boolean} 是否设置成功
47
+ */
48
+ function setSecret(key) {
49
+ if (!key || secret_key) {
50
+ return false;
51
+ }
52
+ secret_key = key;
53
+ return true;
54
+ }
55
+
56
+ /**
57
+ * 获取所有已注册的 Admin 实例名称
58
+ * @returns {string[]} 实例名称数组,按注册顺序排列
59
+ */
60
+ function list() {
61
+ return [...registry.keys()];
62
+ }
63
+
5
64
  module.exports = {
6
- Admin
65
+ Admin,
66
+ reg,
67
+ unreg,
68
+ setSecret,
69
+ list
7
70
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "mm_admin",
3
- "version": "1.0.0",
4
- "description": "管理器实例池模块,基于 Map 按名称缓存管理器实例,提供同步/异步获取、创建钩子、删除与清空(setClass/get/del/clear/keys/values)。",
3
+ "version": "1.1.0",
4
+ "description": "管理器实例池模块,基于 Map 按名称缓存管理器实例,提供同步/异步获取、创建钩子、删除与清空(setClass/get/del/clear/keys/values),并通过全局注册表统一管理 Admin 实例(reg/unreg/list/setSecret)。",
5
5
  "keywords": [
6
6
  "mm_mod",
7
7
  "mm_infra",