Skip to content

document-zh.md

Latest commit

 

History

History
222 lines (152 loc) · 7.93 KB

document-zh.md

File metadata and controls

222 lines (152 loc) · 7.93 KB
Raw

动态配置插件介绍

简体中文 | English

本文档主要介绍动态配置插件以及该插件的使用方法

功能

该插件基于Sermant配置中心能力实现动态配置，可在运行时将配置刷新到宿主应用，其优先级将高于环境变量配置。

当前插件插件支持SpringCloud应用，需配合注解@Value, @ConfigurationProperties以及@RefreshScope使用

使用说明

版本要求

SpringCloud: Edgware.SR2及以上的版本

环境准备

（1）准备配置中心环境（Zookeeper/Kie）

（2）打包编译Sermant，可参考Sermant源码编译

配置插件

（1）修改配置中心（可选）

修改配置文件${javaagent路径}/config/config.properties, 修改配置中心类型与地址，如下位置：

# 配置中心地址， 根据配置中心地址配置
dynamic.config.server_address=127.0.0.1:2181
# 配置中心类型， 支持KIE与ZOOKEEPER
dynamic.config.dynamic_config_type=ZOOKEEPER

（2）配置动态配置插件

修改配置文件${javaagent路径}/pluginPackage/dynamic-config/config/config.yaml, 配置如下：

dynamic.config.plugin:
  enableCseAdapter: true # 是否开启适配CSE
  enableDynamicConfig: true # 是否开启动态配置插件
  enableOriginConfigCenter: false # 是否开启原配置中心, 默认关闭
  #sourceKeys: sourceKey #针对指定键生效

配置说明：

配置项 配置说明
enableCseAdapter 当配置为true时, 会根据ServiceMeta指定的应用配置，服务配置以及自定义标签配置三种类型进行配置订阅；当为false时，只会根据服务名进行订阅，即对键为service, 值为"宿主服务名（即spring.application.name获取）"
enableDynamicConfig 动态配置开关，仅当配置为true时，动态配置才会生效
enableOriginConfigCenter 是否开启原配置中心, 默认不开启。当前仅支持Zookeeper与Nacos配置中心（基于SpringCloud Config实现）
sourceKeys 当需要指定的配置键生效时，可配置该值，例如只是想读取application.yaml，否则默认会读取所有的配置；多个键使用,隔开。

发布配置

发布配置有以下两种方式：

（1）通过Sermant后台服务发布配置

（2）直接通过配置中心发布配置

下面将分别介绍这两种发布方式操作流程

通过Sermant后台服务发布配置

1、首先需编译启动backend模块

2、调用backend接口/publishConfig发布配置， 该接口参数如下:

配置参数 说明
key 配置键
group 配置的标签组
content 配置内容，即具体的规则配置，配置插件仅支持yaml格式

动态配置主要基于group进行匹配配置订阅，该标签组由多个键值对组成，根据适配开关配置enableCseAdapter的不同，group的值将会有所区别，如下：

（1）若关闭适配，即enableCseAdapter: false

​ 此时注册插件将根据宿主应用的服务名进行订阅, 即配置的spring.applicaton.name, 若此时配置的服务名为DynamicConfigDemo, 那么对应的group的值为service=DynamicConfigDemo， 其中键service是固定的, 值DynamicConfigDemo由宿主服务名决定

（2）若开启适配, 即enableCseAdapter: true

​ 此时将根据应用配置，服务配置以及自定义配置三项数据进行配置同时订阅， 而这三类配置可参考${javaagent路径}/pluginPackage/config.properties, 相关配置如下：

# 服务app名称
service.meta.application=default
# 服务版本
service.meta.version=1.0.0
# serviceComb 命名空间
service.meta.project=default
# 环境
service.meta.environment=development
# 自定义标签，按需配置，用于后续的配置订阅
service.meta.customLabel=public
service.meta.customLabelValue=default
  • 应用配置：由service.meta.application与service.meta.environment组成， 对应的group为app=default&environment=development
  • 服务配置：由service.meta.application、service.meta.environment以及服务名组成，此处服务即spring.application.name, 对应的group为app=default&environment=development&service=DynamicConfigDemo
  • 自定义配置：由service.meta.customLabel与service.meta.customLabelValue组成， 对应的group为public=default

以上为group的配置介绍，下面说明content配置，当前动态配置仅支持yaml格式, 例如配置如下内容:

server:
  port: 8004
sermant: sermant
spring:
  application:
    name: DynamicConfigDemo
  cloud:
    zookeeper:
      enabled: true

针对key配置无特殊要求，但需要注意的是，若您配置了sourceKeys配置项，仅当key与sourceKeys匹配时才会生效

通过配置中心发布配置

不同的配置中心配置方式都不同， 以下分别说明Zookeeper与Kie配置中心的配置方式

Kie配置中心

KIE发布配置需通过其自身API发布，其接口为http://ip:30110/v1/default/kie/kv, 配置内容如下:

{
	"key": "test",
	"value": "limitRefreshPeriod: \"1000\"\nname: hello\nrate: \"2\"\n",
	"labels": {
		"app": "discovery",
		"environment": "testing"
	},
	"status": "enabled"
}

以上配置key与labels分别与通过Sermant后台服务发布配置的key与group相对应，若对KIE请求不了解，可参考api文档

Zookeeper配置中心

Zookeeper配置发布则需基于命令行配置，即zkServer, 其路径由通过Sermant后台服务发布配置的key与group组成， 即/group/key, 其值即为content。例如发布一个配置：

当前服务名为DynamicConfigDemo,对应的group为service=DynamicConfigDemo, 指定的key为test, content为sermant: sermant, 那么发布的命令为

# create /group/key content
create /service=DynamicConfigDemo/test "sermant: sermant"

部署应用

准备好demo应用，例如xxx.jar, 参考如下启动命令如下:

#根据配置enableCseAdapter按需调整
java -javaagent:${agent路径}\sermant-agent-x.x.x\agent\sermant-agent.jar=appName=DynamicConfigDemo -Dspring.application.name=DynamicConfigDemo -Ddynamic.config.plugin.enableDynamicConfig=true -Ddynamic.config.plugin.enableCseAdapter=false -jar xxx.jar

以下示范@Value注解使用，@ConfigurationProperties注解同理

/**
 * @Value配置示范
 * 需配合注解@RefreshScope
 */
@Component
@RefreshScope
public class ValueConfig {
    @Value("${sermant}")
    private Object sermant;

    @Value("${server.port}")
    private int port;

    @Value("${spring.application.name}")
    private String name;

    @Override
    public String toString() {
        return "ValueConfig{" +
            "test=" + test +
            ", dubbo=" + dubbo +
            ", sermant=" + sermant +
            ", port=" + port +
            ", name='" + name + '\'' +
            '}';
    }

    public Object getSermant() {
        return sermant;
    }

    public Object getDubbo() {
        return dubbo;
    }

    public Object getTest() {
        return test;
    }
}

验证

尝试发布更新配置，再次访问demo应用，观察配置是否刷新，控制台是否有输出Refresh Keys日志。

返回Sermant说明文档