跳到主要内容

生命周期

概述​

插件的生命周期是指插件在 ONES 中从上传到卸载整个阶段的完整过程。从插件上传至 ONES 实例开始，插件的状态流转如下图所示。插件的状态会在用户进行安装、启用等操作时发生改变。而在插件状态改变时会运行生命周期函数，开发者可以在生命周期函数添加自己的代码来实现业务逻辑。

生命周期方法​

插件的生命周期方法分为组织级别和团队级别两种，根据插件的类型在生命周期中调用对应的方法，其中团队级别的生命周期方法是：Install, Enable, Disable, UnInstall, Upgrade而组织级别的生命周期方法是：OrgInstall, OrgEnable,OrgDisable, OrgUnInstall, OrgUpgrade。

使用生命周期方法​

生命周期方法声明在插件工程的/backend/src/index.ts文件中，每个插件工程在初始化时，会预先生成生命周期函数的模版。

方法模版：

backend/src/index.ts
// Method called when the team level plugin is being installed.
export async function Install(request: PluginRequest) {
  Logger.info('[Plugin] Install')
}

// Method called when the team level plugin is being launched.
export async function Enable(request: PluginRequest) {
  Logger.info('[Plugin] Enable')
}

// Method called when the team level plugin is being suspended.
export function Disable(request: PluginRequest) {
  Logger.info('[Plugin] Disable')
}

// Method called when the team level plugin is being uninstalled.
export function UnInstall(request: PluginRequest) {
  Logger.info('[Plugin] UnInstall')
}

// Method called when the team level plugin is being upgraded.
export function Upgrade(oldPluginInfo: any, request: PluginRequest) {
  const oldVersion = oldPluginInfo.version
  Logger.info('[Plugin] Upgrade', 'old version:', oldVersion)
}

// Method called when the organization level plugin is being installed.
export async function OrgInstall(
  request: PluginRequest,
  teamUUIDList: string[],
  firstInstall: boolean,
) {
  Logger.info('[Plugin] OrgInstall')
}

// Method called when the organization level plugin is being launched.
export function OrgEnable(
  request: PluginRequest,
  teamUUIDList: string[],
): void | string[] | Promise<string[]> {
  Logger.info('[Plugin] OrgEnable')
  return []
}

// Method called when the organization level plugin is being suspended.
export function OrgDisable(
  request: PluginRequest,
  teamUUIDList: string[],
): void | string[] | Promise<string[]> {
  Logger.info('[Plugin] OrgDisable')
  return []
}

// Method called when the organization level plugin is being uninstalled.
export function OrgUnInstall(request: PluginRequest, teamUUIDList: string[]) {
  Logger.info('[Plugin] OrgUnInstall')
}

// Method called when the organization level plugin is being upgraded.
export function OrgUpgrade(oldPluginInfo: any, request: PluginRequest, teamUUIDList: string[]) {
  Logger.info('[Plugin] OrgUpgrade')
}

插件生命周期方法参数介绍：

名称类型说明
requestPluginRequestrequest.parsedHeaders["Accept-Language"] 中包含 ONES 系统当前语言（多语言相关）信息。
orgUUIDstring待生效的组织UUID。
teamUUIDListstring[]待生效的团队UUID 列表。
oldPluginInfoanyoldPluginInfo.version为旧插件的版本信息, 只在升级方法中存在。

注意事项​

  1. 不应该在生命周期方法中执行耗时较久的操作。

生命周期与功能扩展​

插件如果使用了功能扩展，那么插件生命周期操作与功能扩展操作存在绑定关系，如下表所示：

生命周期操作私有部署SaaS
安装-开启实例级别功能扩展
卸载-关闭实例级别功能扩展
启用开启实例、组织级别功能扩展开启组织级别功能扩展
停用关闭实例、组织级别功能扩展关闭组织级别功能扩展
信息

如果需要更新功能扩展的funcs、slots等信息，可通过升级插件的方式进行更新。

最后于 更新