跳到主要内容

插件自定义配置

适用环境SaaS
私有部署

要求​

ONES
v3.6.0+

概述​

通过下面两种方式，插件可以使用该能力在配置中心 -> 插件管理下自定义添加插件的配置项：

  1. 基本信息 选项卡

每个插件的详情页面中包含了配置项的值。在插件未启用时，可以修改配置项的值。 配置项的类型支持单行，多行文本，密码文本三种类型，其中如果有必填项，且没有填写，则无法启用插件。

并且插件后端可以通过调用 API 获取插件自定义配置项的数据。

  1. 新建选项卡

你可以在日志选项卡前面添加一个插槽。在插槽中你需要自定义渲染配置页面，并确定如何存储和获取这些配置数据。

这个选项卡只有在插件启用后才能访问。

使用​

1. 在基本信息选项卡中添加​

给插件添加自定义配置项​

插件配置项字段说明

属性说明类型必填默认值
key唯一标识string是
type配置类型
Input: 单行输入框
TextArea: 多行输入框
Password: 密码输入框		string是
required是否必填boolean否false
label别名string否key
value默认值string否

在插件配置文件plugin.yaml下的config字段添加需要的内容，即可为插件新增配置项cexampleConfigKey，类型为单行输入框。

config/plugin.yaml
service:
  config:
    - key: exampleConfigKey
      label: my example key
      type: Input

插件后端获取插件自定义配置项​

通过调用 SDK 方法获取​

通过@ones-op/node-ability包的Plugin.getPluginConfig()直接获取插件配置

import { Plugin } from '@ones-op/node-ability'

export async function configurationPageTest1() {
  const teamUUID = 'xxx'
  const configs = await Plugin.getPluginConfig(teamUUID)
}
警告

Plugin.getPluginConfig的第一个参数为teamUUID，并且必填

通过 ONES 接口访问 获取​

按以下代码及参数构造fetchONES入参进行接口访问，即可从返回值中获取插件配置项相关信息。

备注

注意，需要将返回参数转成 json 格式，然后从 json 数组中获取到配置项的相关信息。

import { fetchONES } from '@ones-op/node-fetch'

export async function configurationPageTest2() {
  const response = await fetchONES({
    path: `/team/${globalThis.onesEnv.teamUUID}`,
    method: 'POST',
    headers: {
      'Ones-Plugin-Id': ['built_in_apis'],
      'Ones-Check-Point': ['team'],
      'Ones-Check-Id': [`${globalThis.onesEnv.teamUUID}`],
      'AbilityName': ['ConfigList'],
    },
    body: {
      instance_id: `${globalThis.onesEnv.instanceId}`,
      team_uuid: `${globalThis.onesEnv.teamUUID}`,
      organization_uuid: `${globalThis.onesEnv.organizationUUID}`,
    },
  })
  //@ts-ignore
  const byteBody = response?.body || {}
  console.log(byteBody)

  const stringBody = byteBody.toString()
  const JSONBody = JSON.parse(stringBody)

  for (let i = 0; i < JSONBody.length; i++) {
    Logger.info(JSONBody[i]['arg_key']) //获取配置项的key值
    Logger.info(JSONBody[i]['arg_value']) //获取配置项的value值
  }

  return {
    body: response?.body.toString(),
  }
}

2. 在新建选项卡中添加​

在插件工程目录下执行 npx op add module 指令，并选择：settings。

执行完成后，会在 plugin.yaml 配置文件的 modules 属性下新增一段配置。配置如下：

modules:
  - id: settings-1cGv
    title: Settings
    moduleType: settings
    entry: modules/settings-1cGv/index.html

现在你可以开始编写你的配置页面了。

常见问题​

  • 插件升级并修改原来的声明过的插件配置没有生效

    插件升级时不支持修改已有的插件配置声明，具体可参考插件升级。

最后于 更新