开发者工具 IDE

沙盒环境

抖音云

产品介绍

快速开始

场景指南

操作指南

开发指南

SDK参考

配置中心SDK

产品动态

产品计费

常见问题

OpenAPI调试台

配置中心SDK

我的收藏

Go

安装SDK

◦

下载抖音云配置中心 Go SDK，请使用最新版本。

go get github.com/bytedance/douyincloud-configcenter-sdk-go

◦

引入配置中心 Go SDK。


import "github.com/bytedance/douyincloud-configcenter-sdk-go/base"

使用SDK初始化客户端，初始化Client实例后，才可以向配置中心服务发送请求。初始化代码如下：

◦

直接初始化。

// 默认初始化（默认轮询时间为60s，超时时间为5s）
sdkClient, err := base.Start()
if err != nil {
   panic(err)
}

◦

设置轮询时间、超时时间的初始化。

config := base.NewClientConfig() // 设置向配置中心发送请求的超时时间
config.SetTimeout(1 * time.Second) //设置轮询时间，最短为10s。设置参数小于10s则返回err
config.SetUpdateInterval(10 * time.Second)
sdkClient, err := base.StartWithConfig(config)
if err != nil {
   panic(err)
}

◦

使用API调用配置中心。

value, err := sdkClient.Get("key_name")

SDK API 说明

方法名	功能	使用示例
Get	根据key获取一个配置，当key不存在时返回error	`sdkClient, err := base.Start() value, err := sdkClient.Get("key_name")`
RefreshConfig	立刻从云端获取最新配置，并刷新本地缓存	`sdkClient, err := base.Start() err := sdkClient.UpdateCache()`

Java

安装SDK。

◦

在 pom.xml 或者 settings.xml 中添加抖音云仓库。

<repositories>
  <repository>
    <id>douyincloud</id>
    <name>douyincloud</name>
    <url>https://artifacts-cn-beijing.volces.com/repository/douyincloud/</url>
  </repository>
</repositories>

◦

在 pom.xml 中添加 Maven 依赖。

<dependency>
  <groupId>org.bytedance.douyincloud</groupId>
   <artifactId>configcenter</artifactId>
   <version>1.0.1</version>
</dependency>

◦

重新拉取依赖即可完成安装。

注意事项：使用国内镜像源时只代理“central”的中央仓库，不要使用“*”代理所有的仓库。

使用SDK。

直接使用 API 调用配置中心，简洁高效，无需依赖其他框架。

DefaultConfig config = DycConfigCenter.getDycConfig();
String res = config.getStringValue("key_name", "default_value");

SDK API 说明

方法名

功能

使用示例

getStringValue

根据key获取一个配置，获取失败，则返回传入的默认值

DefaultConfig config  = DycConfigCenter.getDycConfig();
String res = config.getStringValue("key_name", "default_value");

refreshConfig

立刻从云端获取最新配置，并刷新本地缓存

DefaultConfig config  = DycConfigCenter.getDycConfig();
config.refreshConfig();

Php

安装SDK从github 下载Php SDK。

将dycConfigCenter目录及其目录下的文件拷贝到自己的项目中。

在dockerfile中，需要对dycConfigCenter目录下douYinCloudConfig.php文件赋予可修改的权限，以便配置出现修改时更新最新配置值保存在本地；例如：

chmod -R 777 /opt/application/dycConfigCenter/douYinCloudConfig.php

在启动脚本 /opt/application/run.sh 中，在项目服务的命令启动前添加如下命令：

php ./configStart.php &

在项目中需要使用配置中心的地方将dycConfigCenter/DycConfig.php 使用php的require语句加载进项目中，之后即可正常使用Php的SDK。

require('/opt/application/dycConfigCenter/DycConfig.php');

使用SDK初始化SDK。

// 默认初始化（默认轮询时间为60s，超时时间为5s）
$dycConfigClient = new DycConfigClient();
$dycConfigClient->startLoop();
// interval_refresh_time 轮询时间，单位s，最短可设置为10s， request_timeout 超时时间，单位s
$config = array("interval_refresh_time" => 60, "request_timeout" => 5);
$dycConfigClient = new DycConfigClient($config);
$dycConfigClient->startLoop();

使用API获取配置。

$key = "key1";
$config = new DycConfig();
$value = $config->getStringValue($key, "default");

SDK API 说明

方法名	功能	使用示例
getStringValue	根据key获取一个配置，获取失败，则返回传入的默认值	`$key = "key1"; $config = new DycConfig(); $value = $config->getStringValue($key, "default");`
refreshConfig	立刻从云端获取最新配置，并刷新本地缓存	`$config = new DycConfig(); $config->refreshConfig();`