diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index a0e523856e..0d52bf7ac3 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -174,8 +174,8 @@ module.exports = { text: '更新与迁移', isGroup: true, children: [ - '/api/changelog.md', '/api/migration.md', + '/api/releases/v4.1.md', ], }], diff --git a/docs/api/changelog.md b/docs/api/changelog.md deleted file mode 100644 index 741732ebb2..0000000000 --- a/docs/api/changelog.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebarDepth: 1 -externalIcon: false ---- - -# v4 更新日志 diff --git a/docs/api/index.md b/docs/api/index.md index 268c6b1dc2..f5e43d8c1f 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -47,5 +47,5 @@ sidebarDepth: 0 ## 更新与迁移 -- [更新日志](./changelog.md) -- [从旧版本迁移](./migration.md) +- [从 v3 迁移](./migration.md) +- [v4.1 版本介绍](./releases/v4.1.md) diff --git a/docs/api/releases/v4.1.md b/docs/api/releases/v4.1.md new file mode 100644 index 0000000000..a2f26c46fb --- /dev/null +++ b/docs/api/releases/v4.1.md @@ -0,0 +1,42 @@ +--- +sidebarDepth: 2 +--- + +# v4.1 版本介绍 + +- [v4.0.1](https://github.com/koishijs/koishi/releases/tag/4.0.1) +- [v4.1.0](https://github.com/koishijs/koishi/releases/tag/4.1.0) + +## 插件与热重载优化 + +在这个版本中我们优化了插件的加载方式。一方面我们缓解了 service 监听器数量很容易超过限制导致内存泄漏警告的问题,另一方面热重载导致的内存泄漏和加载错误的问题也得到了修复。 + +除此以外,我们还要隆重介绍 Koishi v4 的热重载功能。它将拥有许多全新的特性: + +### 细粒度的模块依赖分析 + +过去的热重载功能会将任何文件变动都扩展到根插件 (即配置文件中声明的插件),并重载扩散路径上的每一个文件。而新的依赖分析工具能够将文件变动引发的副作用具体计算到每一个模块,因此部分变动在到达某个子插件时就会停止扩散,从而在大型插件中获得更好的开发体验。 + +为了实现这种优化,我们假设每个插件模块的导出都是原子的。换言之,如果一个模块的导出恰好是正在运行的插件,那么这个插件将是模块导出的唯一用途,在插件被加载以外的任何地方不会用到这个模块的导出。对于正确使用模块化进行开发的项目,达成这个约定并不困难。事实上,插件如果有任何其他需要提供的功能,也都可以通过 Service API 实现。 + +如果某些插件实在难以满足这个约定,我们也提供了额外的方案。开发者要么不将插件作为模块的导出 (比如作为导出的一部分),要么在插件中手动声明 `sideEffect`。两种方法都能规避依赖分析工具的优化,从而实行保守的热重载策略。 + +### 热重载与配置管理的联动 + +在过去,插件热重载与插件管理 (@koishijs/plugin-manager) 是作为独立的功能开发的。当它们同时启用时可能会遇到一些问题。当插件管理器修改了静态的配置文件 (例如 koishi.config.yaml) 时,热重载机制可能检测不到变动;但当我们将静态配置文件纳入依赖分析,又会导致配置管理器明明只修改了一个插件的配置,却会导致整个应用被重新启动 (因为配置文件的依赖优先级是最高的)。 + +这次更新我们针对这个问题提供了统一的解决方案。首先插件管理器将只针对静态配置文件的场景生效,其次当启用了热重载功能时,一旦需要修改配置文件,插件管理器将不再触发插件变动,交由依赖分析工具处理改动过的配置文件。开发者得以同时使用插件管理器和热重载功能,获得更好的开发体验。 + +### 更多细节优化 + +新版本中我们还支持了新的配置项 `config.watch.debounce`,用于控制热重载的触发频率。默认情况下文件变动 100ms 之后才会触发热重载,解决了强迫症程序员频繁保存带来的高频率热重载问题。以及我们还加入了对 json 配置文件的写入支持 (不过有了 yaml 真的会有人用 json 吗)。 + +## 更多的控制台插件 + +在这个版本中我们优化了控制台系统,并将部分功能单独发布为新的插件。它们包括: + +- [@koishijs/plugin-dataview](../../plugins/console/dataview.md) (来自 status 插件) +- [@koishijs/plugin-insight](../../plugins/console/insight.md) (来自 manager 插件) +- [@koishijs/plugin-logger](../../plugins/console/logger.md) (来自 status 插件) + +目前仍有数个官方控制台插件正在计划中,将于接下来的版本发布,它们将进一步丰富 Koishi 的控制台功能。