插件系统

重要提示：Yumeri框架目前处于快速迭代阶段，本文档中的API可能随时发生变化。请始终以GitHub仓库中的最新代码为准：https://github.com/yumerijs/yumeri

插件系统概述

作为模块化Web应用构建平台，Yumeri的各个操作都通过插件完成。插件系统是Yumeri的核心，提供了强大的扩展能力，使开发者能够根据需求灵活组合各种功能模块。

插件的定义

插件的默认形式是npm包，包名前缀为yumeri-plugin-，用于识别此为Yumeri的插件。例如，yumeri-plugin-console是Yumeri的控制台插件。

内置插件

Yumeri框架自带了几个基础插件：

1. yumeri-plugin-console：控制台插件，提供日志和调试功能
2. yumeri-plugin-echo：回显插件，用于测试和演示

插件的使用

配置插件

在Yumeri项目中使用插件，需要在config.yml文件中进行配置。打开项目的config.yml，在插件配置部分加上自己需要的插件配置，重启Yumeri便可加载。

示例配置：

plugins:
  yumeri-plugin-console:
    value1: 123
  my-custom-plugin:  # 自定义插件

插件加载顺序

在开发模式下，插件会优先从plugins文件夹下的ts源代码加载。如果本地plugins文件夹中没有找到对应插件，Yumeri会尝试从node_modules中加载。在生产环境，Yumeri只会从node_modules中加载

插件的工作原理

Yumeri插件系统基于依赖注入和模块化设计，每个插件都可以提供特定的功能，并且可以与其他插件进行交互。插件的生命周期由Yumeri核心管理，包括初始化、启用和禁用等阶段。

插件的生命周期

1. 加载：Yumeri启动时，会根据配置加载所需的插件
2. 初始化：调用插件的apply方法，进行初始化
3. 运行：插件在Yumeri运行期间提供功能
4. 禁用：当不再需要插件时，调用插件的disable方法进行清理

插件开发

关于如何开发自己的Yumeri插件，请参考插件基础章节，那里提供了详细的插件开发指南和示例。

加载插件

创建上下文

一般而言，每一个插件应对应一个 Context 实例，Context 实例可由已存在的 Context 实例派生，或从新构造。

const ctx1 = new Context(core, 'plugin1');
const ctx2 = ctx1.fork('plugin2');

当进行 Context 对象的 dispose 的时候，他会自动递归删除下层 Context。

创建配置对象

插件启用前需要先传递配置，所以需要创建一个 Config 对象：

const config1 = new Config('plugin', {
  config1: 'hello',
  config2: 'world!',
});

启用插件

最后一步，调用 Core 暴露的 API进行插件的加载：

const plugin = require('./plugin');
core.config(plugin, ctx, config);

注入依赖

插件上下文可以通过注入依赖来为插件提供服务：

ctx.inject('database', database)
// 或者在创建时批量注入
const injections: Record<string, any> = {
  database,
  logger,
};
const ctx = new Context(core, 'plugin', injections)