tachybase_todo/docs/en-US/api/server/plugin.md

49 lines
1.0 KiB
Markdown
Raw Normal View History

# Plugin
2022-11-13 23:00:59 +08:00
## 概览
2022-11-13 23:00:59 +08:00
Nocobase 中的插件为 `Class` 的形式。如需自定义插件,需要继承 `Plugin` 类。
```typescript
import { Plugin } from '@nocobase/server';
class MyPlugin extends Plugin {
2022-11-13 23:00:59 +08:00
// ...
}
app.plugin(MyPlugin, { name: 'my-plugin' });
```
2022-11-13 23:00:59 +08:00
## 插件生命周期
2022-11-13 23:00:59 +08:00
每个插件都包含生命周期方法,你可以重写这些方法,以便于在运行过程中特定的阶段执行这些方法。
生命周期方法将由 `Application` 在特定阶段调用,可参考 [`Application`生命周期](./application.md)。
### `beforeLoad()`
2022-11-13 23:00:59 +08:00
插件加载前,如事件或类注册,在此可访问核心接口,其他插件此阶段不可用。
### `load()`
2022-11-13 23:00:59 +08:00
加载插件,配置之类。在 `load` 中可调用其他插件实例,而在 `beforeLoad` 中是不行的。
### `install()`
插件安装逻辑,如初始化数据
2022-11-13 23:00:59 +08:00
### `afterAdd()`
插件 add/addStatic 之后
### `afterEnable()`
插件激活之后的逻辑
### `afterDisable()`
插件禁用之后的逻辑
### `remove()`
2022-11-13 23:00:59 +08:00
用于实现插件删除逻辑