夜雨聆风学习资料网

ARTICLE · 1359192

Cordis 加载器、插件组与服务隔离

Cordis 加载器、插件组与服务隔离

目录

  1. 加载器:从配置文件到插件树  
  2. 插件组:loader:group  
  3. 服务隔离  3.1 基本用法  3.2 具名隔离域  
  4. 服务拦截  
  5. 模块热替换(HMR)  
  6. 小结参考文献

手动用 ctx.plugin() 逐个组装插件适合开发调试,而生产应用需要把「装了哪些插件、各自什么配置」沉淀为一份可编辑的配置文件,并在运行时把它还原成一棵插件树——这就是加载器(Loader)的职责。本文介绍加载器的配置形态,以及建立在其上的插件组、服务隔离、服务拦截与热替换。框架整体介绍见 [[Cordis:一个 TypeScript 插件框架]]。

1. 加载器:从配置文件到插件树

加载器能力由官方包 @cordisjs/plugin-loader 提供,维护一棵运行时插件树,并以服务形式暴露 API(ctx.loader)。配套的 @cordisjs/plugin-include 为加载器提供 YAML/JSON 配置文件 include 支持,@cordisjs/plugin-group 提供嵌套插件分组能力。

配置文件(如 cordis.yml)是一个插件条目的列表,每个条目至少包含插件名:

  • 1
-name:cordis-plugin-example

条目还可以携带配置、启停状态等字段。加载器读取列表,逐项解析 npm 包、应用配置并挂到插件树上;配置变化时,受影响的插件按 [[Cordis 插件生命周期与状态机]] 的规则回滚重载。

2. 插件组:loader:group

loader:group 是 CLI 内置插件,提供插件组能力。它的配置项是一个数组,表示组内要加载的插件:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
-label:databasename:loader:groupconfig:-name:'@minatojs/driver-mysql'disabled:true-name:'@minatojs/driver-sqlite'-name:'@minatojs/driver-postgres'disabled:true-label:servername:loader:groupconfig:-name:'@cordisjs/server'config:port:5140-name:'@cordisjs/server-static'config:root:data/public

上面的配置启用了两个 loader:group 实例,分别以 database 和 server 作为标签。使用插件组可以方便地组织插件,好处包括:

  • 分组显示、收起和展开
  • 一键启用和停用某个分组
  • 对整个分组进行服务隔离与拦截

与插件组相关的还有「插件包」:把一组子插件打包发布,一次安装即可齐活(例如为对话插件同时装上 author、context 等子插件),或实现基于数据库的配置管理。

3. 服务隔离

3.1 基本用法

服务隔离描述这样一种场景:多个插件依赖同一个服务,但希望不同的插件使用不同的服务实例。例如希望某些数据存到 MySQL,另一些存到本地 SQLite。此时可以用隔离域实现——对插件组声明 isolate,让组内插件看到独立的服务实例:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
-name:loader:groupisolate:database:trueconfig:-name:'@minatojs/driver-mysql'# 其他插件-name:loader:groupisolate:database:trueconfig:-name:'@minatojs/driver-sqlite'# 其他插件

两个组各自拥有独立的 database 服务实例,互不干扰。

3.2 具名隔离域

隔离还可以带名字。多个插件只要声明同一个隔离域名,就会共享同一份服务实例;未声明的插件继续使用默认(全局)实例:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
-name:'@minatojs/driver-mysql'-name:'@minatojs/driver-sqlite'isolate:database:sqlite# 其他插件,默认情况下使用 MySQL-name:custom-pluginisolate:database:sqlite# 使用 SQLite

4. 服务拦截

服务拦截解决另一类常见需求:多个插件依赖同一个服务,但希望分别定制服务行为。例如很多插件都用 http 服务发请求,但希望某些插件走代理、另一些有更长的超时:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
-name:plugin-aintercept:http:proxy:http://localhost:7890-name:plugin-bintercept:http:timeout:60000

拦截不替换服务实例,只是在服务的配置读取层为特定插件叠一层覆盖值。

5. 模块热替换(HMR)

@cordisjs/plugin-hmr 为加载器管理的插件提供模块热替换能力:源码变更后只替换受影响的插件模块,不必重启整个应用。配合插件组的组织方式,每个子模块享受独立热重载(参见 [[Cordis 入门:构建你的第一个插件]] 的嵌套插件一节)。需要说明的是,上游文档中 HMR 的实现原理与手动控制两节尚未完成,细节待官方补充;在 [[Cordis:一个 TypeScript 插件框架]] 译文的「易变配置」一节,还能看到加载器在不重启应用的情况下提交配置变更的相关机制。

6. 小结

  • 加载器把配置文件还原为运行时插件树,配置变化驱动插件回滚重载
  • loader:group 让插件按组管理:分组显示、一键启停、整组隔离与拦截
  • isolate(含具名隔离域)解决「同名服务多实例」,intercept 解决「同服务不同定制」
  • HMR 插件提供模块级热替换,是开发期迭代效率的关键

参考文献

[1] 服务隔离与拦截(Cordis 官方文档):https://github.com/cordiverse/docs/blob/main/zh-CN/guide/loader/service.md

[2] 插件组与插件包(Cordis 官方文档):https://github.com/cordiverse/docs/blob/main/zh-CN/guide/loader/group.md

[3] 模块热替换(Cordis 官方文档):https://github.com/cordiverse/docs/blob/main/zh-CN/guide/loader/hmr.md

[4] 插件生命周期(Cordis 官方文档·指南):https://github.com/cordiverse/docs/blob/main/zh-CN/guide/advanced/lifecycle.md

回首页,搜索你想要的文档

在首页搜索框输入关键词,快速定位资料

文库首页搜索指引 立即搜索

相关学习资料