# GO SDK Guide
# Getting Started
# Installing
To start using brcc sdk, install Go and run go get
:
$ go get https://github.com/baidu/brcc/brcc-go-sdk
This will retrieve the library and install the brcc-go-sdk
command line utility into
your $GOBIN
path.
# Importing brcc-go-sdk
import brcc "github.com/baidu/brcc/brcc-go-sdk"
# Initial SDK from toml configuraiton
- prepare brcc configuration
serverUrl = "brcc.baidu-int.com"
projectName = "brcc-go-client"
envName = "debug"
versionName = "1.0"
apiPassword = "123456"
enableCallback = true
callbackInterval = 300
requestTimeout = 5
enableCache = true
cacheDir = "/tmp/brcc"
save above configuration to local file. eg. "brcc.toml"
- initialize SDK
// 使用toml配置文件初始化brcc客户端, name为配置文件路径
name := "brcc.toml"
client, err := rcc.NewClientWithConf(name)
if err != nil {
panic(fmt.Sprintf("init brcc error: %v", err.Error()))
}
# Initial SDK from Conf struct
brccConf := &rcc.Conf{
ProjectName: "brcc-go-client",
EnvName: "debug",
ServerUrl: "brcc.baidu-int.com",
ApiPassword: "123456",
VersionName: "1.0",
EnableCallback: true,
CallbackIntervalInt: 300,
RequestTimeoutInt: 5,
EnableCache: true,
CacheDir: "/tmp/brcc",
}
client, err := rcc.NewClientWithConf(brccConf)
if err != nil {
panic(fmt.Sprintf("init brcc error: %v", err.Error()))
}
# get configuration items from brcc server.
// 获取远程配置
client.GetValue(key, defaultValue)
// 读取所有的key
client.GetAllKeys()
# bind with configuration items for struct type.
type Test struct {
A bool `brcc:"test.a"`
B int `brcc:"test.b"`
C string `brcc:"test.c"`
}
v := &Test{}
// 注入
client.Bind(v)
# dynamic watch configuration items update
// define update callback for Watch function
callback := func(ce *rcc.ChangeEvent) {
// 建议defer捕获协程panic
defer func() {
if r := recover(); r != nil {
fmt.Println("watch update callback panic")
}
}()
for key, change := range ce.Changes {
if change.ChangeType == rcc.MODIFY || change.ChangeType.rcc.ADD {
// key, change.NewValue, change.OldValue , change.ChangeType
}
}
}
client.Watch(callback)