mm_machine 3.5.7 → 5.0.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/README.md +52 -3
- package/index.js +2 -2
- package/lib/drive.js +26 -86
- package/lib/manager.js +219 -29
- package/lib/mod.js +2 -2
- package/lib/script_protocol.js +150 -0
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -494,6 +494,29 @@ mm_machine 模块系统基于以下核心设计理念:
|
|
|
494
494
|
6. **执行方法**:根据应用需求,执行模块的特定方法(如 main)
|
|
495
495
|
7. **监听文件变化**:在热更新模式下,监听文件变化并自动重新加载模块
|
|
496
496
|
|
|
497
|
+
#### 目录监听与热重载
|
|
498
|
+
|
|
499
|
+
`update(dir)` 完成后会对检索目录开启一次递归监听(经 mm_loader 的 `Loader.watch`,配置文件与 `.js` 脚本的变更按扩展名分流):
|
|
500
|
+
|
|
501
|
+
- 所有管理器默认共享 mm_loader 的同一个加载器实例(`loadAdmin(config.use_scope || 'os')`),避免重复扫描、重复监听与重复加载
|
|
502
|
+
- 管理器把自己的清单文件名登记为加载器类型:类型键为文件名去掉 `.json` 后缀(`manager.json` → `manager`),已存在的类型不覆盖
|
|
503
|
+
- 需要独立加载器时,用 `use_scope` 指定另一共享作用域(按 `scope@目录` 派生独立实例)
|
|
504
|
+
|
|
505
|
+
| 变更 | 模式要求 | 行为 |
|
|
506
|
+
| --- | --- | --- |
|
|
507
|
+
| 配置文件新增 | 任意 | 按配置文件注册模块,非懒加载时立即加载 |
|
|
508
|
+
| 配置文件修改 | `mode >= 2`(热更新配置) | 同步配置快照并应用到模块(触发 `_onConfigChange` 钩子与 `config:change` 事件),`main` 指向变化时重载脚本 |
|
|
509
|
+
| 配置文件删除 | 任意 | 注销模块(停止 → 卸载 → 移除记录) |
|
|
510
|
+
| 配置文件修改 | `mode < 2` | 注销后重新注册模块 |
|
|
511
|
+
| 脚本文件删除 | `mode = 3 / 4`(热重载脚本) | 是受管模块的入口:注销模块并失效自身 require 缓存;非入口:仅失效自身 require 缓存 |
|
|
512
|
+
| 脚本新增/重建 | `mode = 3 / 4` | 同目录存在同名配置文件时补注册,非懒加载时立即加载 |
|
|
513
|
+
| 脚本内容修改 | `mode = 3 / 4` | 是受管模块的入口:管理器重载脚本(清 require 缓存后重新加载并重挂方法);非入口:仅失效自身 require 缓存 |
|
|
514
|
+
|
|
515
|
+
- 脚本变更按**入口精确匹配**:只有变更文件是某个受管模块的入口脚本才触发重载/注销;公共脚本(com/lib 等)变化只失效自身的 require 缓存,不追溯引用方,引用方下次加载即拿到新代码
|
|
516
|
+
- 脚本事件只在热重载模式(`MODE.HOT_RELOAD` / `MODE.HOT_BOTH`)下纳入监听,生产与仅热更新配置模式不扫描脚本,避免无谓开销
|
|
517
|
+
- 热更新不依赖 `mm_hot_reload`:配置与脚本的变化均由管理器的目录监听(mm_loader)统一接管;`mm_hot_reload` 仅供函数自行应用其他模块时选用
|
|
518
|
+
- 调用 `unwatch()` 可关闭全部目录监听
|
|
519
|
+
|
|
497
520
|
### 数据流向
|
|
498
521
|
|
|
499
522
|
模块间的数据流转遵循以下规则:
|
|
@@ -553,6 +576,30 @@ mm_machine 模块系统基于以下核心设计理念:
|
|
|
553
576
|
|
|
554
577
|
## 更新日志
|
|
555
578
|
|
|
579
|
+
### v4.1.0
|
|
580
|
+
|
|
581
|
+
- 配置加载器改为共享:`_getLoader()` 默认取 mm_loader 实例池中的同一个 `Loader`(`loadAdmin(config.use_scope || 'os')`),不再为每个管理器各建实例
|
|
582
|
+
- 清单类型按文件名推导登记:`manager.json` → `manager`,通过 `addType` 幂等注册进共享实例,已存在的类型不覆盖
|
|
583
|
+
- `_getLoader()` 直接取 mm_loader 实例池中的 `Loader`,不再自行缓存引用;需要独立实例时用 `config.use_scope` 指定另一共享作用域
|
|
584
|
+
- `_watchDir` 保存回调引用,`unwatch` 按回调从共享实例上摘除,不影响其他调用方的监听
|
|
585
|
+
- `_findFiles` 改用 `Loader.scan`(物理扫描唯一入口),保证 `update` 能看到新增/删除的文件
|
|
586
|
+
- 依赖 mm_loader ^3.0.0
|
|
587
|
+
|
|
588
|
+
### v4.0.0
|
|
589
|
+
|
|
590
|
+
- 热更新收敛到管理器:mm_loader 移除脚本变更总线与缓存树工具(`subscribeScriptChanges` / `findImporters` / `clearScriptTree` 等),管理器直接监听 `Loader.watch` 的脚本回调
|
|
591
|
+
- 脚本变更改为入口精确匹配:只有变更文件是受管模块入口才触发重载/注销,公共脚本变化仅失效自身 require 缓存
|
|
592
|
+
- `_watchDir` 复用同一个 Loader:配置回调与脚本回调一次 watch 分流,删除独立的脚本订阅路径
|
|
593
|
+
- 依赖 mm_loader ^2.0.0
|
|
594
|
+
|
|
595
|
+
### v3.6.0
|
|
596
|
+
|
|
597
|
+
- 移除对 `mm_hot_reload` 的依赖:配置与脚本热更新全部由管理器目录监听(mm_loader)接管,`mm_hot_reload` 回归为函数自行应用其他模块时的可选工具
|
|
598
|
+
- 修正 `Drive.setConfig`:`config` 为共享配置记录的 getter,改为原地深合并(原先 `conf()` 重新赋值为静默无效操作,热更新配置从未真正写入模块)
|
|
599
|
+
- 热更新配置模式下,配置变化同步应用到模块(触发 `_onConfigChange` 钩子与 `config:change` 事件),`main` 指向变化时重载脚本
|
|
600
|
+
- 热重载模式下,脚本内容变化由管理器重载(清缓存后重新 require 并重挂方法)
|
|
601
|
+
- 移除 `Drive.watchConfig`、`_loadHotReload`,`_handleHotReload` 更名为 `_applyConfigUpdate`
|
|
602
|
+
|
|
556
603
|
### v1.0.0 (初始版本)
|
|
557
604
|
|
|
558
605
|
- 基础模块管理功能
|
|
@@ -570,9 +617,11 @@ mm_machine 模块系统基于以下核心设计理念:
|
|
|
570
617
|
|
|
571
618
|
## 依赖
|
|
572
619
|
|
|
573
|
-
- mm_config: ^
|
|
574
|
-
-
|
|
575
|
-
-
|
|
620
|
+
- mm_config: ^2.5.3
|
|
621
|
+
- mm_helper: ^1.0.3
|
|
622
|
+
- mm_loader: ^3.0.0(目录监听与配置/脚本热更新)
|
|
623
|
+
- mm_mod: ^1.0.6
|
|
624
|
+
- mm_tpl: ^2.7.3
|
|
576
625
|
|
|
577
626
|
## 许可证
|
|
578
627
|
|
package/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
const { Mod,
|
|
1
|
+
const { Mod, addMethods } = require('./lib/mod.js');
|
|
2
2
|
const { Drive, MODE } = require('./lib/drive.js');
|
|
3
3
|
const Manager = require('./lib/manager.js');
|
|
4
4
|
|
|
5
5
|
module.exports = {
|
|
6
|
-
Mod, Drive, Manager, MODE,
|
|
6
|
+
Mod, Drive, Manager, MODE, addMethods
|
|
7
7
|
};
|
package/lib/drive.js
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
const path = require('path');
|
|
2
|
-
const { conf } = require('mm_config');
|
|
3
2
|
const { getTpl } = require('mm_tpl');
|
|
4
|
-
const { hotReloadAdmin } = require('mm_hot_reload');
|
|
5
3
|
const {
|
|
6
4
|
string,
|
|
7
5
|
fullname,
|
|
@@ -19,20 +17,6 @@ const {
|
|
|
19
17
|
} = require('mm_helper');
|
|
20
18
|
const { Mod } = require('./mod');
|
|
21
19
|
|
|
22
|
-
// 热重载管理器,按作用域惰性创建,避免模块加载时立即启动文件监听
|
|
23
|
-
let hot_reload_admin = null;
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* 获取热重载管理器
|
|
27
|
-
* @returns {object} 热重载管理器实例
|
|
28
|
-
*/
|
|
29
|
-
function getHotReload() {
|
|
30
|
-
if (!hot_reload_admin) {
|
|
31
|
-
hot_reload_admin = hotReloadAdmin('server');
|
|
32
|
-
}
|
|
33
|
-
return hot_reload_admin;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
20
|
const MODE = {
|
|
37
21
|
// 生产模式
|
|
38
22
|
PRODUCTION: 1,
|
|
@@ -134,39 +118,15 @@ Drive.prototype.applyConfig = function (file, config) {
|
|
|
134
118
|
};
|
|
135
119
|
|
|
136
120
|
/**
|
|
137
|
-
*
|
|
138
|
-
* @
|
|
139
|
-
* @returns {object|null} 热更新管理器加载的配置,未开启热更新时返回 null
|
|
140
|
-
*/
|
|
141
|
-
Drive.prototype.watchConfig = function (file) {
|
|
142
|
-
if (!file) return null;
|
|
143
|
-
if (this.mode >= MODE.HOT_CONFIG) {
|
|
144
|
-
return getHotReload().load(file, (config) => {
|
|
145
|
-
this._handleHotReload(config);
|
|
146
|
-
});
|
|
147
|
-
}
|
|
148
|
-
return null;
|
|
149
|
-
};
|
|
150
|
-
|
|
151
|
-
/**
|
|
152
|
-
* 设置配置
|
|
121
|
+
* 设置配置(配置由管理器读取后传入)
|
|
122
|
+
* @description config 是共享配置记录的 getter,只能原地合并,不可整体替换
|
|
153
123
|
* @param {object} config 配置对象
|
|
154
124
|
* @returns {object} 配置项
|
|
155
125
|
*/
|
|
156
126
|
Drive.prototype.setConfig = function (config) {
|
|
157
127
|
if (config) {
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
this.config = conf(
|
|
161
|
-
{
|
|
162
|
-
...this.config,
|
|
163
|
-
...config
|
|
164
|
-
},
|
|
165
|
-
this.config_file
|
|
166
|
-
);
|
|
167
|
-
} else {
|
|
168
|
-
Object.assign(this.config, config);
|
|
169
|
-
}
|
|
128
|
+
// 深合并进共享配置记录
|
|
129
|
+
this._setConfig(config);
|
|
170
130
|
}
|
|
171
131
|
var file = this.config.main;
|
|
172
132
|
if (file) {
|
|
@@ -399,16 +359,10 @@ Drive.prototype._remove = function () {
|
|
|
399
359
|
if (!file) return;
|
|
400
360
|
|
|
401
361
|
try {
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
let file_name = require.resolve(file);
|
|
407
|
-
if (require.cache[file_name]) {
|
|
408
|
-
require.cache[file_name] = null;
|
|
409
|
-
delete require.cache[file_name];
|
|
410
|
-
}
|
|
411
|
-
}
|
|
362
|
+
// 先 resolve:文件不存在时保留原有的报错语义,且不抛出
|
|
363
|
+
let file_name = require.resolve(file);
|
|
364
|
+
// 失效入口自身的 require 缓存,重新加载时读到新代码
|
|
365
|
+
delete require.cache[file_name];
|
|
412
366
|
} catch (err) {
|
|
413
367
|
this.log('error', `移除加载的脚本模块失败`, err);
|
|
414
368
|
}
|
|
@@ -518,26 +472,18 @@ Drive.prototype._getScriptTpl = function () {
|
|
|
518
472
|
};
|
|
519
473
|
|
|
520
474
|
/**
|
|
521
|
-
*
|
|
522
|
-
*
|
|
523
|
-
*
|
|
475
|
+
* 加载脚本文件
|
|
476
|
+
* @description 统一通过 require 加载;脚本变化的重载由上层目录监听触发,
|
|
477
|
+
* 本方法只负责读取最新脚本并挂载方法
|
|
524
478
|
* @returns {object | null} 加载的模块对象
|
|
525
479
|
*/
|
|
526
480
|
Drive.prototype.loadScript = function () {
|
|
527
481
|
let file = this._getScriptFile();
|
|
528
482
|
if (!file) return null;
|
|
529
483
|
try {
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
});
|
|
534
|
-
this._setMainMethod(cs);
|
|
535
|
-
return cs;
|
|
536
|
-
} else {
|
|
537
|
-
let cs = require(file);
|
|
538
|
-
this._setMainMethod(cs);
|
|
539
|
-
return cs;
|
|
540
|
-
}
|
|
484
|
+
let cs = require(file);
|
|
485
|
+
this._setMainMethod(cs);
|
|
486
|
+
return cs;
|
|
541
487
|
} catch (err) {
|
|
542
488
|
this.log('error', '加载脚本文件失败', this._wrapError(err));
|
|
543
489
|
return null;
|
|
@@ -582,6 +528,13 @@ Drive.prototype.newConfig = function (file) {
|
|
|
582
528
|
this.config.name = this._getName(file);
|
|
583
529
|
this.config.scope = this._getScope(file);
|
|
584
530
|
}
|
|
531
|
+
// 归属信息:app 与注册域一致(scope 即应用名),plugin 取路径中的插件段,应用级资源为空
|
|
532
|
+
if (!this.config.app) {
|
|
533
|
+
this.config.app = this._getScope(file) || 'os';
|
|
534
|
+
}
|
|
535
|
+
if (this.config.plugin === undefined) {
|
|
536
|
+
this.config.plugin = string.between(file.replace(/\\/g, '/'), 'plugin/', '/') || '';
|
|
537
|
+
}
|
|
585
538
|
this._createConfigFile(file);
|
|
586
539
|
};
|
|
587
540
|
|
|
@@ -697,7 +650,7 @@ Drive.prototype.loadFile = function (file, name) {
|
|
|
697
650
|
|
|
698
651
|
if (!text) return null;
|
|
699
652
|
|
|
700
|
-
let config =
|
|
653
|
+
let config = loadJson(filename);
|
|
701
654
|
let final_config = this._findConfigByName(config, name);
|
|
702
655
|
return final_config;
|
|
703
656
|
} catch (err) {
|
|
@@ -706,21 +659,6 @@ Drive.prototype.loadFile = function (file, name) {
|
|
|
706
659
|
}
|
|
707
660
|
};
|
|
708
661
|
|
|
709
|
-
/**
|
|
710
|
-
* 加载配置文件(JSON5 语法),热更新模式下同时注册文件监听
|
|
711
|
-
* @param {string} file 完整文件路径
|
|
712
|
-
* @returns {object | Array | null | undefined} 配置对象
|
|
713
|
-
*/
|
|
714
|
-
Drive.prototype._loadHotReload = function (file) {
|
|
715
|
-
if (!file) return null;
|
|
716
|
-
if (this.mode >= MODE.HOT_CONFIG) {
|
|
717
|
-
return getHotReload().load(file, (config) => {
|
|
718
|
-
this._handleHotReload(config);
|
|
719
|
-
});
|
|
720
|
-
}
|
|
721
|
-
return loadJson(file);
|
|
722
|
-
};
|
|
723
|
-
|
|
724
662
|
/**
|
|
725
663
|
* 根据名称在配置数组中查找配置项
|
|
726
664
|
* @param {object | Array} config 配置对象或数组
|
|
@@ -733,12 +671,14 @@ Drive.prototype._findConfigByName = function (config, name) {
|
|
|
733
671
|
};
|
|
734
672
|
|
|
735
673
|
/**
|
|
736
|
-
*
|
|
674
|
+
* 应用更新后的配置
|
|
675
|
+
* @description 由上层目录监听在配置文件变化时调用:
|
|
676
|
+
* 合并配置、调用 _onConfigChange 钩子、触发事件并按需重载脚本
|
|
737
677
|
* @param {object} config 配置对象
|
|
738
678
|
* @returns {object} 配置对象
|
|
739
679
|
* @private
|
|
740
680
|
*/
|
|
741
|
-
Drive.prototype.
|
|
681
|
+
Drive.prototype._applyConfigUpdate = function (config) {
|
|
742
682
|
var old_script = this.script_file;
|
|
743
683
|
var old_config = { ...this.config };
|
|
744
684
|
this.setConfig(config);
|
package/lib/manager.js
CHANGED
|
@@ -1,8 +1,35 @@
|
|
|
1
|
+
const path = require('path');
|
|
1
2
|
const { Manager: Core } = require('mm_mod');
|
|
2
|
-
const { hasDir, hasFile, fullname, basename, dirname } = require('mm_helper');
|
|
3
|
-
const {
|
|
4
|
-
const { Mod,
|
|
3
|
+
const { hasDir, hasFile, fullname, basename, dirname, string } = require('mm_helper');
|
|
4
|
+
const { loadAdmin } = require('mm_loader');
|
|
5
|
+
const { Mod, addMethods } = require('./mod.js');
|
|
5
6
|
const { Drive, MODE } = require('./drive.js');
|
|
7
|
+
const { resolveScriptFile, reloadScript } = require('./script_protocol.js');
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* 归一化文件路径为可比较键(绝对路径 + 小写)
|
|
11
|
+
* @param {string} file 文件路径
|
|
12
|
+
* @returns {string} 可比较键
|
|
13
|
+
* @private
|
|
14
|
+
*/
|
|
15
|
+
function _normPath(file) {
|
|
16
|
+
return path.resolve(String(file)).toLowerCase();
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* 失效单个脚本文件的 require 缓存
|
|
21
|
+
* @description 文件不存在或从未加载时静默跳过
|
|
22
|
+
* @param {string} file 脚本文件路径
|
|
23
|
+
* @returns {void}
|
|
24
|
+
* @private
|
|
25
|
+
*/
|
|
26
|
+
function _clearScriptCache(file) {
|
|
27
|
+
try {
|
|
28
|
+
delete require.cache[require.resolve(file)];
|
|
29
|
+
} catch {
|
|
30
|
+
// 无法解析的模块本就不在缓存中
|
|
31
|
+
}
|
|
32
|
+
}
|
|
6
33
|
|
|
7
34
|
/**
|
|
8
35
|
* 管理器类
|
|
@@ -79,6 +106,11 @@ class Manager extends Core {
|
|
|
79
106
|
* @type {string}
|
|
80
107
|
*/
|
|
81
108
|
scope: 'server',
|
|
109
|
+
/**
|
|
110
|
+
* 共享实例作用域,取用其他模块 xxxAdmin 实例时使用(loadAdmin 等),缺省 'os'
|
|
111
|
+
* @type {string}
|
|
112
|
+
*/
|
|
113
|
+
use_scope: '',
|
|
82
114
|
/**
|
|
83
115
|
* 忽略目录数组
|
|
84
116
|
* @type {Array}
|
|
@@ -191,19 +223,41 @@ Manager.prototype.getTplDir = function () {
|
|
|
191
223
|
|
|
192
224
|
/**
|
|
193
225
|
* 获取配置加载器
|
|
226
|
+
* @description 直接取 mm_loader 实例池中的共享 Loader(键为 use_scope@目录,缺省 'os'),
|
|
227
|
+
* 同目录同作用域天然是同一个实例,本管理器不再另存一份引用;
|
|
228
|
+
* 一个加载器只负责一个目录,不同目录由实例池各自派生;
|
|
229
|
+
* use_scope 一并写入加载器配置,使加载器下传的扫描器与监听器落在同一作用域。
|
|
230
|
+
* 并把本管理器清单类型登记进该实例:类型键为 filename 去掉 .json 后缀
|
|
231
|
+
* (manager.json → manager,与默认 app → app.json 同构),已存在的类型不覆盖;
|
|
232
|
+
* 脚本监听由 _watchDir 是否传 script_callback 决定(回调驱动),不再配置实例
|
|
233
|
+
* @param {string} [dir] 检索目录,缺省回退 config.dir
|
|
194
234
|
* @returns {Loader} 配置加载器
|
|
195
235
|
* @private
|
|
196
236
|
*/
|
|
197
|
-
Manager.prototype._getLoader = function () {
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
237
|
+
Manager.prototype._getLoader = function (dir) {
|
|
238
|
+
const scope = this.config.use_scope || 'os';
|
|
239
|
+
const target = dir || this.config.dir || '';
|
|
240
|
+
const key = target ? path.resolve(target) : '';
|
|
241
|
+
const loader = loadAdmin(scope, { dir: key, use_scope: scope });
|
|
242
|
+
const filename = this.config.filename;
|
|
243
|
+
if (filename) {
|
|
244
|
+
const type = filename.replace(/\.json$/i, '');
|
|
245
|
+
if (type && !loader.config.resources[type]) {
|
|
246
|
+
loader.addType(type, filename, false);
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
return loader;
|
|
250
|
+
};
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* 是否需要响应脚本文件变化
|
|
254
|
+
* @description 仅热重载(3)与热更新+重载(4)模式由驱动重载脚本,其余模式不响应
|
|
255
|
+
* @returns {boolean} 需要响应返回true
|
|
256
|
+
* @private
|
|
257
|
+
*/
|
|
258
|
+
Manager.prototype._isScriptHot = function () {
|
|
259
|
+
let mode = this.config.mode;
|
|
260
|
+
return mode === MODE.HOT_RELOAD || mode === MODE.HOT_BOTH;
|
|
207
261
|
};
|
|
208
262
|
|
|
209
263
|
// ==== 模块管理接口 ====
|
|
@@ -282,6 +336,22 @@ Manager.prototype._readModConfig = function (config_file, config = {}) {
|
|
|
282
336
|
if (!mod_config.dir && config_file) {
|
|
283
337
|
mod_config.dir = dirname(config_file);
|
|
284
338
|
}
|
|
339
|
+
// 归属信息:app 为所属应用(声明值优先,兼作注册域),plugin 为所属插件(应用级资源为空),
|
|
340
|
+
// scope 为注册域(与管理器域一致的推导口径,即该资源配置到 require(module).admin 的哪个域)。
|
|
341
|
+
// 旧版 update(dir) 全量扫描注册(如 xxx_web 网关镜像)不经过 load_resources/_addResource,
|
|
342
|
+
// 归属信息统一在这里兜底注入
|
|
343
|
+
if (config_file) {
|
|
344
|
+
const norm_path = String(config_file).replace(/\\/g, '/');
|
|
345
|
+
if (mod_config.app === undefined || mod_config.app === '') {
|
|
346
|
+
mod_config.app = string.between(norm_path, 'app/', '/') || 'os';
|
|
347
|
+
}
|
|
348
|
+
if (mod_config.plugin === undefined) {
|
|
349
|
+
mod_config.plugin = string.between(norm_path, 'plugin/', '/') || '';
|
|
350
|
+
}
|
|
351
|
+
if (mod_config.scope === undefined || typeof mod_config.scope === 'boolean') {
|
|
352
|
+
mod_config.scope = mod_config.app;
|
|
353
|
+
}
|
|
354
|
+
}
|
|
285
355
|
return mod_config;
|
|
286
356
|
};
|
|
287
357
|
|
|
@@ -308,14 +378,12 @@ Manager.prototype.newMod = function (config_file, config, script) {
|
|
|
308
378
|
}
|
|
309
379
|
mod.mode = this.config.mode;
|
|
310
380
|
|
|
311
|
-
// 仅 Drive
|
|
381
|
+
// 仅 Drive 子类提供配置文件应用能力,Mod 子类(如 api、event、plugin)构造时已持有完整配置
|
|
382
|
+
// 配置与脚本的热更新由目录监听统一负责(见 _applyChangesAsync / _applyScriptChangesAsync)
|
|
312
383
|
if (mod_config && config_file) {
|
|
313
384
|
if (typeof mod.applyConfig === 'function') {
|
|
314
385
|
mod.applyConfig(config_file, mod_config);
|
|
315
386
|
}
|
|
316
|
-
if (typeof mod.watchConfig === 'function') {
|
|
317
|
-
mod.watchConfig(config_file);
|
|
318
|
-
}
|
|
319
387
|
}
|
|
320
388
|
|
|
321
389
|
if (script) {
|
|
@@ -489,7 +557,7 @@ Manager.prototype.update = async function (dir, clear = true) {
|
|
|
489
557
|
}
|
|
490
558
|
|
|
491
559
|
await this.updateAfter(search_dir);
|
|
492
|
-
//
|
|
560
|
+
// 检索目录开启监听:配置文件变化增量维护模块,脚本变化重载归属驱动(热重载模式)
|
|
493
561
|
this._watchDir(search_dir);
|
|
494
562
|
} catch (err) {
|
|
495
563
|
this.log('error', '更新配置失败', err);
|
|
@@ -510,7 +578,9 @@ Manager.prototype._findFiles = async function (dir) {
|
|
|
510
578
|
if (!hasDir(dir)) {
|
|
511
579
|
return [];
|
|
512
580
|
}
|
|
513
|
-
|
|
581
|
+
// scan 是物理扫描唯一入口:每次都拿最新清单(mm_scanner 缓存无变化时不重复遍历),
|
|
582
|
+
// update 语义要求看到新增/删除的文件
|
|
583
|
+
let files = this._getLoader(dir).scan();
|
|
514
584
|
let filename = this.config.filename;
|
|
515
585
|
if (!filename) {
|
|
516
586
|
return files;
|
|
@@ -520,20 +590,31 @@ Manager.prototype._findFiles = async function (dir) {
|
|
|
520
590
|
|
|
521
591
|
// ==== 目录监听 ====
|
|
522
592
|
/**
|
|
523
|
-
*
|
|
524
|
-
* @description
|
|
593
|
+
* 监听目录中配置文件与脚本文件的变化
|
|
594
|
+
* @description 只扫描一次,之后由文件事件增量维护模块:配置变更走 _applyChanges,
|
|
595
|
+
* 脚本变更走 _applyScriptChanges(仅热重载模式订阅)。
|
|
596
|
+
* 监听由 mm_loader 提供,底层 Scanner 按目录共享句柄并自带防抖,
|
|
597
|
+
* 多个管理器监听同一目录不会重复挂句柄
|
|
525
598
|
* @param {string} dir 目录路径
|
|
526
599
|
* @private
|
|
527
600
|
*/
|
|
528
601
|
Manager.prototype._watchDir = function (dir) {
|
|
529
602
|
if (!dir || this._dir_watchers.has(dir)) return;
|
|
530
603
|
if (!hasDir(dir)) return;
|
|
531
|
-
let
|
|
532
|
-
let
|
|
604
|
+
let hot = this._isScriptHot();
|
|
605
|
+
let loader = this._getLoader(dir);
|
|
606
|
+
let config_callback = (changes) => {
|
|
533
607
|
this._applyChanges(changes);
|
|
534
|
-
}
|
|
608
|
+
};
|
|
609
|
+
let script_callback = hot
|
|
610
|
+
? (changes) => {
|
|
611
|
+
this._applyScriptChanges(changes);
|
|
612
|
+
}
|
|
613
|
+
: undefined;
|
|
614
|
+
let success = loader.watch(config_callback, script_callback);
|
|
535
615
|
if (success) {
|
|
536
|
-
|
|
616
|
+
// 保存回调引用:unwatch 时只摘本管理器的监听,不影响共享实例上其他调用方
|
|
617
|
+
this._dir_watchers.set(dir, { loader, config_callback, script_callback });
|
|
537
618
|
}
|
|
538
619
|
};
|
|
539
620
|
|
|
@@ -571,6 +652,12 @@ Manager.prototype._applyChangesAsync = async function (changes) {
|
|
|
571
652
|
|
|
572
653
|
if (change.type === 'change' && info && hot) {
|
|
573
654
|
this._syncInfo(info, change.file);
|
|
655
|
+
// 同步应用新配置到模块:合并配置、触发 _onConfigChange 钩子与 config:change 事件,
|
|
656
|
+
// main 指向的脚本路径变化时由模块自行重载脚本
|
|
657
|
+
let mod = this.getMod(info.name);
|
|
658
|
+
if (mod && typeof mod._applyConfigUpdate === 'function') {
|
|
659
|
+
mod._applyConfigUpdate(this._readModConfig(change.file));
|
|
660
|
+
}
|
|
574
661
|
continue;
|
|
575
662
|
}
|
|
576
663
|
|
|
@@ -607,12 +694,115 @@ Manager.prototype._syncInfo = function (info, file) {
|
|
|
607
694
|
};
|
|
608
695
|
|
|
609
696
|
/**
|
|
610
|
-
*
|
|
697
|
+
* 应用脚本文件变更
|
|
698
|
+
* @param {object[]} changes 变更列表,每项含 type 与 file
|
|
699
|
+
* @private
|
|
700
|
+
*/
|
|
701
|
+
Manager.prototype._applyScriptChanges = function (changes) {
|
|
702
|
+
this._applyScriptChangesAsync(changes).catch((err) => {
|
|
703
|
+
this.log('error', '应用脚本文件变更失败', err);
|
|
704
|
+
});
|
|
705
|
+
};
|
|
706
|
+
|
|
707
|
+
/**
|
|
708
|
+
* 按变更列表增量维护脚本所属模块
|
|
709
|
+
* @description 脚本删除时注销模块;脚本内容变化时按「入口精确匹配」重载:
|
|
710
|
+
* 变更文件就是某个受管模块的入口脚本才重载该模块,其余文件
|
|
711
|
+
* (com/lib 等公共脚本)只失效自身缓存,不追溯引用方。
|
|
712
|
+
* 入口形态与重载协议见 script_protocol.js
|
|
713
|
+
* @param {object[]} changes 变更列表,每项含 type 与 file
|
|
714
|
+
* @returns {Promise<number>} 本次重载的驱动数量
|
|
715
|
+
* @private
|
|
716
|
+
*/
|
|
717
|
+
Manager.prototype._applyScriptChangesAsync = async function (changes) {
|
|
718
|
+
if (!this._isScriptHot()) return 0;
|
|
719
|
+
let lazy = this.config.lazy_load;
|
|
720
|
+
let hits = 0;
|
|
721
|
+
|
|
722
|
+
for (let change of changes) {
|
|
723
|
+
try {
|
|
724
|
+
let info = this._getInfoByScript(change.file);
|
|
725
|
+
|
|
726
|
+
if (change.type === 'unlink') {
|
|
727
|
+
if (info) {
|
|
728
|
+
this.log('warn', `脚本已删除,注销模块 ${info.name}: ${change.file}`);
|
|
729
|
+
await this.unregMod(info.name);
|
|
730
|
+
}
|
|
731
|
+
// 文件已删,缓存里的旧模块也要失效,避免下次 require 命中幽灵代码
|
|
732
|
+
_clearScriptCache(change.file);
|
|
733
|
+
continue;
|
|
734
|
+
}
|
|
735
|
+
|
|
736
|
+
// 入口精确命中:重载该模块并更新存储的 mod 与 config
|
|
737
|
+
if (info) {
|
|
738
|
+
let mod = this.getMod(info.name);
|
|
739
|
+
if (mod) {
|
|
740
|
+
reloadScript(mod, resolveScriptFile(mod));
|
|
741
|
+
hits += 1;
|
|
742
|
+
}
|
|
743
|
+
continue;
|
|
744
|
+
}
|
|
745
|
+
|
|
746
|
+
// 非入口文件(公共脚本等):只失效自身缓存
|
|
747
|
+
_clearScriptCache(change.file);
|
|
748
|
+
|
|
749
|
+
// 脚本重建或新增:同目录存在配置文件时补注册
|
|
750
|
+
let config_file = this._getConfigByScript(change.file);
|
|
751
|
+
if (!config_file) continue;
|
|
752
|
+
let mod = this.regMod(config_file);
|
|
753
|
+
if (mod && !lazy) {
|
|
754
|
+
await this.loadMod(mod.config.name);
|
|
755
|
+
}
|
|
756
|
+
} catch (err) {
|
|
757
|
+
this.log('error', '处理脚本变更失败: ' + change.file, err);
|
|
758
|
+
}
|
|
759
|
+
}
|
|
760
|
+
|
|
761
|
+
this._sort();
|
|
762
|
+
return hits;
|
|
763
|
+
};
|
|
764
|
+
|
|
765
|
+
/**
|
|
766
|
+
* 按脚本文件路径获取模块信息
|
|
767
|
+
* @param {string} file 脚本文件路径
|
|
768
|
+
* @returns {object|null} 模块信息,未注册时返回null
|
|
769
|
+
* @private
|
|
770
|
+
*/
|
|
771
|
+
Manager.prototype._getInfoByScript = function (file) {
|
|
772
|
+
let target = _normPath(file);
|
|
773
|
+
for (let info of this.configs) {
|
|
774
|
+
let mod = this.getMod(info.name);
|
|
775
|
+
let entry = mod ? resolveScriptFile(mod) : '';
|
|
776
|
+
if (entry && _normPath(entry) === target) {
|
|
777
|
+
return info;
|
|
778
|
+
}
|
|
779
|
+
}
|
|
780
|
+
return null;
|
|
781
|
+
};
|
|
782
|
+
|
|
783
|
+
/**
|
|
784
|
+
* 按脚本文件路径查找同目录的配置文件
|
|
785
|
+
* @description 脚本重建后据此补注册;已注册或配置文件不存在时返回null
|
|
786
|
+
* @param {string} file 脚本文件路径
|
|
787
|
+
* @returns {string|null} 配置文件路径
|
|
788
|
+
* @private
|
|
789
|
+
*/
|
|
790
|
+
Manager.prototype._getConfigByScript = function (file) {
|
|
791
|
+
let filename = this.config.filename;
|
|
792
|
+
if (!filename) return null;
|
|
793
|
+
let config_file = path.join(path.dirname(file), filename);
|
|
794
|
+
if (this._getInfoByFile(config_file)) return null;
|
|
795
|
+
return hasFile(config_file) ? config_file : null;
|
|
796
|
+
};
|
|
797
|
+
|
|
798
|
+
/**
|
|
799
|
+
* 关闭本管理器的全部目录监听
|
|
800
|
+
* @description 按保存的回调引用从共享 Loader 上摘除,不影响其他调用方的监听
|
|
611
801
|
* @returns {void}
|
|
612
802
|
*/
|
|
613
803
|
Manager.prototype.unwatch = function () {
|
|
614
|
-
for (let
|
|
615
|
-
loader.unwatch();
|
|
804
|
+
for (let [dir, entry] of this._dir_watchers) {
|
|
805
|
+
entry.loader.unwatch(entry.config_callback, entry.script_callback);
|
|
616
806
|
}
|
|
617
807
|
this._dir_watchers.clear();
|
|
618
808
|
};
|
|
@@ -1178,6 +1368,6 @@ Manager.prototype._logModError = function (name, method, error) {
|
|
|
1178
1368
|
* 复用模块类的调度与生命周期能力
|
|
1179
1369
|
* @description Manager 继承 mm_mod.Manager,需要将 mm_machine 的 Mod 原型成员复制到 Manager 原型
|
|
1180
1370
|
*/
|
|
1181
|
-
|
|
1371
|
+
addMethods(Manager);
|
|
1182
1372
|
|
|
1183
1373
|
module.exports = Manager;
|
package/lib/mod.js
CHANGED
|
@@ -1049,7 +1049,7 @@ Mod.prototype.getDir = function () {
|
|
|
1049
1049
|
* @param {Function} cs 目标类
|
|
1050
1050
|
* @returns {Function} 目标类
|
|
1051
1051
|
*/
|
|
1052
|
-
function
|
|
1052
|
+
function addMethods(cs) {
|
|
1053
1053
|
if (typeof cs !== 'function') {
|
|
1054
1054
|
throw new TypeError('参数(cs)必须是类');
|
|
1055
1055
|
}
|
|
@@ -1064,5 +1064,5 @@ function addModMethods(cs) {
|
|
|
1064
1064
|
|
|
1065
1065
|
module.exports = {
|
|
1066
1066
|
Mod,
|
|
1067
|
-
|
|
1067
|
+
addMethods
|
|
1068
1068
|
};
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* 驱动脚本入口解析与重载协议
|
|
5
|
+
*
|
|
6
|
+
* @description mm_machine 的受管驱动有两套形态:
|
|
7
|
+
* - Drive 系(Drive / App / Plugin / Cmd):script_file、reloadScript()
|
|
8
|
+
* - Mod 系脚本驱动(Api / Event / Service / Pendant):_getScriptFile()、
|
|
9
|
+
* load() 把脚本方法挂到实例 this.main 上
|
|
10
|
+
* 管理器判断「某个脚本属于哪个驱动」以及「如何让它生效」时走本模块,
|
|
11
|
+
* 新增一种驱动类型只需注册适配器,不必修改管理器或宿主。
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
const path = require('path');
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* 入口解析器:从驱动实例推导入口脚本路径,取不到返回空串
|
|
18
|
+
* @type {Array<function(object): string>}
|
|
19
|
+
*/
|
|
20
|
+
const ENTRY_RESOLVERS = [
|
|
21
|
+
(drive) => drive.file || '',
|
|
22
|
+
(drive) => drive.script_file || '',
|
|
23
|
+
(drive) => {
|
|
24
|
+
if (typeof drive._getScriptFile !== 'function') return '';
|
|
25
|
+
try {
|
|
26
|
+
return drive._getScriptFile() || '';
|
|
27
|
+
} catch {
|
|
28
|
+
return '';
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
// Pendant 等驱动 getDir() 返回空串,目录只保存在 config.dir;
|
|
32
|
+
// 直接用 getDir() 会把入口误解析到进程 cwd 下的同名文件
|
|
33
|
+
(drive) => {
|
|
34
|
+
const main = drive.config && drive.config.main;
|
|
35
|
+
if (!main) return '';
|
|
36
|
+
let dir = (drive.config && drive.config.dir) || '';
|
|
37
|
+
if (!dir && typeof drive.getDir === 'function') {
|
|
38
|
+
try {
|
|
39
|
+
dir = drive.getDir() || '';
|
|
40
|
+
} catch {
|
|
41
|
+
return '';
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
return dir ? path.resolve(dir, main) : '';
|
|
45
|
+
}
|
|
46
|
+
];
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* 重载器:命中条件 + 执行动作,按注册顺序取第一个匹配
|
|
50
|
+
* @type {Array<{test: function(object): boolean, run: function(object): *}>}
|
|
51
|
+
*/
|
|
52
|
+
const RELOADERS = [
|
|
53
|
+
{ test: (d) => typeof d.reloadScript === 'function', run: (d) => d.reloadScript() },
|
|
54
|
+
// 普通 Mod 的 load 是生命周期方法,额外要求 _setMainMethod 避免误触
|
|
55
|
+
{
|
|
56
|
+
test: (d) => typeof d._setMainMethod === 'function' && typeof d.load === 'function',
|
|
57
|
+
run: (d) => d.load()
|
|
58
|
+
}
|
|
59
|
+
];
|
|
60
|
+
|
|
61
|
+
const DEFAULT_ENTRY_RESOLVERS = [...ENTRY_RESOLVERS];
|
|
62
|
+
const DEFAULT_RELOADERS = [...RELOADERS];
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* 注册入口解析器(扩展点)
|
|
66
|
+
* @param {function(object): string} resolver 返回入口路径或空串
|
|
67
|
+
* @param {boolean} [first=false] 插到队首优先匹配
|
|
68
|
+
* @returns {boolean} 注册成功返回 true
|
|
69
|
+
*/
|
|
70
|
+
function registerEntryResolver(resolver, first = false) {
|
|
71
|
+
if (typeof resolver !== 'function') return false;
|
|
72
|
+
if (first) ENTRY_RESOLVERS.unshift(resolver);
|
|
73
|
+
else ENTRY_RESOLVERS.push(resolver);
|
|
74
|
+
return true;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* 注册重载器(扩展点)
|
|
79
|
+
* @param {function(object): boolean} test 是否适用于该驱动
|
|
80
|
+
* @param {function(object): *} run 执行重载
|
|
81
|
+
* @param {boolean} [first=false] 插到队首优先匹配
|
|
82
|
+
* @returns {boolean} 注册成功返回 true
|
|
83
|
+
*/
|
|
84
|
+
function registerReloader(test, run, first = false) {
|
|
85
|
+
if (typeof test !== 'function' || typeof run !== 'function') return false;
|
|
86
|
+
const item = { test, run };
|
|
87
|
+
if (first) RELOADERS.unshift(item);
|
|
88
|
+
else RELOADERS.push(item);
|
|
89
|
+
return true;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* 恢复默认适配器
|
|
94
|
+
* @returns {void}
|
|
95
|
+
*/
|
|
96
|
+
function resetAdapters() {
|
|
97
|
+
ENTRY_RESOLVERS.splice(0, ENTRY_RESOLVERS.length, ...DEFAULT_ENTRY_RESOLVERS);
|
|
98
|
+
RELOADERS.splice(0, RELOADERS.length, ...DEFAULT_RELOADERS);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* 取驱动入口脚本的绝对路径
|
|
103
|
+
* @param {object} drive 驱动实例
|
|
104
|
+
* @returns {string} 绝对路径,取不到返回空串
|
|
105
|
+
*/
|
|
106
|
+
function resolveScriptFile(drive) {
|
|
107
|
+
if (!drive) return '';
|
|
108
|
+
for (const resolve of ENTRY_RESOLVERS) {
|
|
109
|
+
let file = '';
|
|
110
|
+
try {
|
|
111
|
+
file = resolve(drive) || '';
|
|
112
|
+
} catch {
|
|
113
|
+
file = '';
|
|
114
|
+
}
|
|
115
|
+
if (file) return path.resolve(file);
|
|
116
|
+
}
|
|
117
|
+
return '';
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
/**
|
|
121
|
+
* 重载驱动脚本
|
|
122
|
+
* @description 失效入口自身的 require 缓存后重新加载;只清 require.cache 不够,
|
|
123
|
+
* Mod 系驱动把方法挂在实例上,必须重新 load 才能换掉旧函数引用
|
|
124
|
+
* @param {object} drive 驱动实例
|
|
125
|
+
* @param {string} file 入口绝对路径
|
|
126
|
+
* @returns {*} 驱动重载结果
|
|
127
|
+
*/
|
|
128
|
+
function reloadScript(drive, file) {
|
|
129
|
+
try {
|
|
130
|
+
delete require.cache[require.resolve(file)];
|
|
131
|
+
} catch {
|
|
132
|
+
// 缓存清理失败不阻断重载,驱动自身仍会重新 require
|
|
133
|
+
}
|
|
134
|
+
for (const item of RELOADERS) {
|
|
135
|
+
try {
|
|
136
|
+
if (item.test(drive)) return item.run(drive);
|
|
137
|
+
} catch {
|
|
138
|
+
return null;
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
return null;
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
module.exports = {
|
|
145
|
+
resolveScriptFile,
|
|
146
|
+
reloadScript,
|
|
147
|
+
registerEntryResolver,
|
|
148
|
+
registerReloader,
|
|
149
|
+
resetAdapters
|
|
150
|
+
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mm_machine",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.0.0",
|
|
4
4
|
"description": "A flexible Node.js plugin mechanism system for dynamic loading, management and execution of modules. Supports hot reload, lifecycle management, and modern JavaScript features.",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -41,9 +41,8 @@
|
|
|
41
41
|
"dependencies": {
|
|
42
42
|
"@prettier/sync": "^0.6.1",
|
|
43
43
|
"mm_config": "^2.5.3",
|
|
44
|
-
"mm_hot_reload": "^1.5.3",
|
|
45
44
|
"mm_helper": "^1.0.3",
|
|
46
|
-
"mm_loader": "^
|
|
45
|
+
"mm_loader": "^4.0.0",
|
|
47
46
|
"mm_mod": "^1.0.6",
|
|
48
47
|
"mm_tpl": "^2.7.3"
|
|
49
48
|
},
|