mm_machine 3.5.3 → 3.5.5

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/README.md CHANGED
@@ -571,7 +571,7 @@ mm_machine 模块系统基于以下核心设计理念:
571
571
  ## 依赖
572
572
 
573
573
  - mm_config: ^1.1.4
574
- - mm_hot_reload: ^1.0.5
574
+ - mm_loader: 脚本加载与热更新
575
575
  - mm_expand: 用于路径处理和文件操作
576
576
 
577
577
  ## 许可证
@@ -0,0 +1,69 @@
1
+ const path = require('path');
2
+ const { Manager, MODE } = require('../index.js');
3
+
4
+ /**
5
+ * 使用示例入口
6
+ * @description 演示 mm_machine 的模块注册、生命周期、方法调用、选项读写与销毁流程
7
+ * @returns {Promise<void>} 无返回值
8
+ */
9
+ async function runDemo() {
10
+ // 1. 创建管理器,指定模块目录与检索文件名
11
+ let manager = new Manager({
12
+ name: 'example_manager',
13
+ title: '示例管理器',
14
+ description: 'mm_machine 使用示例',
15
+ dir: path.join(__dirname, 'modules'),
16
+ filename: 'manager.json',
17
+ mode: MODE.PRODUCTION
18
+ });
19
+
20
+ console.log('=== 1. 扫描并注册模块 ===');
21
+ await manager.update();
22
+ console.log('模块数量:', manager.getInfos().length);
23
+ console.log('模块名称:', manager.getInfos().map((info) => info.name).join(', '));
24
+
25
+ // 2. 按生命周期顺序加载、初始化、启动所有模块
26
+ console.log('\n=== 2. 加载 / 初始化 / 启动 ===');
27
+ await manager.runAll('load');
28
+ await manager.runAll('init');
29
+ await manager.runAll('start');
30
+
31
+ let mod = manager.getMod('hello');
32
+ console.log('模块状态:', mod.getState(), '是否已加载:', mod.isLoaded(), '是否已初始化:', mod.isInited());
33
+
34
+ // 3. 调用模块方法
35
+ console.log('\n=== 3. 调用模块方法 ===');
36
+ console.log('manager.main 调用 greet:', await manager.main('hello', 'greet', '世界'));
37
+ console.log('manager.callMod 调用 greet:', await manager.callMod('hello', 'greet', 'mm_machine'));
38
+ console.log('manager.main(null) 广播 main:', await manager.main(null, 'main', 1, 'demo'));
39
+ console.log('doSmart 调用 greet:', await mod.doSmart('greet', '开发者'));
40
+
41
+ // 4. 查询模块信息
42
+ console.log('\n=== 4. 查询模块信息 ===');
43
+ console.log('getInfo:', manager.getInfo('hello').description);
44
+ console.log('getList("问候"):', manager.getList('问候').map((item) => item.config.name).join(', '));
45
+
46
+ // 5. 读写模块选项(config.options 是 schema,getOption 获取的是值)
47
+ console.log('\n=== 5. 读写模块选项 ===');
48
+ console.log('当前 greeting:', mod.getOption('greeting'));
49
+ mod.setOption('greeting', '您好');
50
+ console.log('修改后 greeting:', mod.getOption('greeting'));
51
+ // 恢复默认值,保证示例可重复执行
52
+ mod.setOption('greeting', '你好');
53
+
54
+ // 6. 单模块生命周期:停止 -> 卸载 -> 销毁
55
+ console.log('\n=== 6. 停止 / 卸载 / 销毁 ===');
56
+ await mod.do('stop');
57
+ console.log('停止后状态:', mod.getState());
58
+ await mod.do('unload');
59
+ console.log('卸载后状态:', mod.getState(), '是否已加载:', mod.isLoaded());
60
+ await mod.do('destroy');
61
+ console.log('销毁后状态:', mod.getState());
62
+
63
+ console.log('\n示例执行完成。');
64
+ }
65
+
66
+ runDemo().catch((err) => {
67
+ console.error('示例执行失败:', err);
68
+ process.exitCode = 1;
69
+ });
@@ -0,0 +1,50 @@
1
+ /**
2
+ * 问候模块脚本
3
+ * @description 模块脚本中的函数会被挂载为模块方法,非函数值会被挂载为模块数据
4
+ */
5
+ module.exports = {
6
+ /**
7
+ * 初始化
8
+ * @returns {Promise<void>} 无返回值
9
+ */
10
+ async _init() {
11
+ this.log('info', '问候模块初始化完成');
12
+ },
13
+ /**
14
+ * 启动
15
+ * @returns {Promise<void>} 无返回值
16
+ */
17
+ async _start() {
18
+ this.log('info', '问候模块已启动');
19
+ },
20
+ /**
21
+ * 停止
22
+ * @returns {Promise<void>} 无返回值
23
+ */
24
+ async _stop() {
25
+ this.log('info', '问候模块已停止');
26
+ },
27
+ /**
28
+ * 销毁
29
+ * @returns {Promise<void>} 无返回值
30
+ */
31
+ async _destroy() {
32
+ this.log('info', '问候模块已销毁');
33
+ },
34
+ /**
35
+ * 问候
36
+ * @param {string} name 被问候者名称
37
+ * @returns {Promise<string>} 问候语
38
+ */
39
+ async greet(name) {
40
+ return `${this.getOption('greeting')},${name}!`;
41
+ },
42
+ /**
43
+ * 主逻辑
44
+ * @param {...any} args 参数列表
45
+ * @returns {Promise<string>} 执行结果
46
+ */
47
+ async main(...args) {
48
+ return `问候模块执行 main,参数:${JSON.stringify(args)}`;
49
+ }
50
+ };
@@ -0,0 +1,24 @@
1
+ {
2
+ // 模块名称,必填
3
+ "name": "hello",
4
+ // 模块标题
5
+ "title": "问候模块",
6
+ // 模块描述
7
+ "description": "mm_machine 使用示例中的问候模块",
8
+ // 主脚本文件路径
9
+ "main": "./index.js",
10
+ // 模块作用域
11
+ "scope": "server",
12
+ // 模块状态,1表示启用
13
+ "state": 1,
14
+ // 模块排序
15
+ "sort": 10,
16
+ // 是否结束
17
+ "end": false,
18
+ // 选项 schema,按 default 生成选项值
19
+ "options": {
20
+ "greeting": {
21
+ "default": "你好"
22
+ }
23
+ }
24
+ }
package/index.js CHANGED
@@ -1,7 +1,7 @@
1
- const { Mod } = require('./lib/mod.js');
1
+ const { Mod, addModMethods } = require('./lib/mod.js');
2
2
  const { Drive, MODE } = require('./lib/drive.js');
3
- const { Manager } = require('./lib/manager.js');
3
+ const Manager = require('./lib/manager.js');
4
4
 
5
5
  module.exports = {
6
- Mod, Drive, Manager, MODE
6
+ Mod, Drive, Manager, MODE, addModMethods
7
7
  };