# 概述

插件管理功能用于维护插件元数据,定义路由级别的自定义属性、插件级别的自定义配置信息。创建的插件用于路由管理设置时启用,当网关接受请求匹配路由规则时会触发启用的插件逻辑执行,插件逻辑中可获取到自定义的属性数据。

# 插件列表

菜单位置:网关管理 > 插件管理。点击菜单后进入插件管理列表页面,如图所示。

manager_plugin_list_query

# 新增插件

点击 新增 按钮弹出新增窗口,如图所示。

manager_plugin_add_1

manager_plugin_add_2

插件名称:插件名称由英文字母、下划线或数字组成,不能以数字开头,长度不能超过50个字符,必填;

插件描述:插件的简要描述,长度不能超过50个字符,必填;

默认执行顺序:插件的默认执行顺序,按从小到大排序,值越小越先执行,取值范围0~255,必填;

表单定义:路由级别的自定义属性,在路由管理配置启用插件时前端会将表单定义转化为表单输入界面,更多信息请查看路由管理介绍。表单规范说明如下:

/*
* plugin_config_design
* 动态插件参考结构
* */

const pluginConfig = [
  {
	/* 必有字段 */
	"field": "inputVal",
	"label": "输入框",
	"component": "input", // input, select, radio, checkbox,
	"dataType": "string", // number(long, double), string, boolean, array
	/* 可选字段 */
	"desc": "字段的说明文字",
	"placeholder": "placeholder文字",
	"default": "Aa123", // 初始默认值
	"options": [ // for select, radio, checkbox
	  {
		"label": "选项1",
		"value": 1  // number(long, double), string, boolean,
	  },
	  {
		"label": "选项2",
		"value": 2
	  }
	],
	"rules": [ // min|max / range / length / regex pattern
	  { "required": true, "message": "输入框不能为空", "trigger": "change" }, // required 必填
	  // { "min": 3, "ma x": 5, "message": "长度在 3 到 5 个字符", "trigger": "change" }, // range 长度范围(for dataType:"string")
	  // { "len": 8, "message": "长度需 8 个字符", "trigger": "change" }, // length 长度限制(for dataType:"string")
	  // { "type": "number", "message": "请输入数字类型"}, // for dataType:"number" 校验数值
	  // { "type": "integer", "message": "请输入整数数值", "trigger": "change" }, // for dataType:"long" 校验整数
	  // { "type": "float", "message": "请输入浮点数数值", "trigger": "change" }, // for dataType:"double" 校验浮点数
	  { "pattern": "^[A-Za-z\\d]+$", "message": "只能是字母或数字", "trigger": "change" } // regex pattern正则
	]
  },
  {
	"field": "selectVal",
	"label": "选择器",
	"component": "select",
	"dataType": "number",
	"options": [
	  {
		"label": "选项1",
		"value": 1
	  },
	  {
		"label": "选项2",
		"value": 2
	  },
	  {
		"label": "选项3",
		"value": 3
	  }
	],
	"desc": "选择器的说明文字",
	"placeholder": "请选择",
	"rules": [
	  { "required": true, "message": "选择器不能为空", "trigger": "change" }
	]
  },
  {
	"field": "radioVal",
	"label": "单选框",
	"component": "radio",
	"dataType": "boolean",
	"default": true,
	"options": [
	  {
		"label": "是",
		"value": true
	  },
	  {
		"label": "否",
		"value": false
	  }
	],
	"desc": "单选框的说明文字",
	"rules": [
	  { "required": true, "message": "请选择单选框", "trigger": "change" }
	]
  },
  {
	"field": "checkboxVal",
	"label": "多选框",
	"component": "checkbox",
	"dataType": "array",
	"options": [
	  {
		"label": "选项1",
		"value": 11
	  },
	  {
		"label": "选项2",
		"value": 22
	  },
	  {
		"label": "选项3",
		"value": 33
	  }
	],
	"desc": "多选框的说明文字",
	"rules": [
	  { "required": true, "message": "请选择多选框", "trigger": "change" }
	]
  }
];

// TODO 注意!!
//  组件 "checkbox" 的dataType = "array"
//  组件 "radio/select" 的实际值类型等于options内的value值类型

自定义配置:插件级别的自定义配置信息,插件逻辑中可获取到该信息。

# 编辑插件

点击 编辑 按钮弹出编辑窗口,如图所示。

manager_plugin_edit_1

manager_plugin_edit_2

# 删除插件

点击 删除 按钮弹出删除确认窗口,如图所示。

manager_plugin_delete_1

manager_plugin_delete_2

点击 确定 按钮后删除插件,如果插件存在关联的路由配置时,需要将关联的路由配置全部删除后才能删除插件。

上次更新: 2020-11-9 11:50