leikao / agollo

agollo is a golang client for ctrip apollo config center 🚀

agollo is a golang client for apollo 🚀

Simple chinese

简体中文

Feature

• Multiple namespace support
• Fail tolerant
• Realtime change notification
• Unmarshal

Required

go 1.9 or later

Installation

    go get -u github.com/philchia/agollo

Usage

1, Start

Start use default app.properties config file

    agollo.Start()

Start use given config file path

    agollo.StartWithConfFile(name)

Start with given conf struct

    agollo.StartWithConf(yourConf)

2, Subscribe updates

WatchUpdate, deprecated

    events := agollo.WatchUpdate()
    changeEvent := <-events
    bytes, _ := json.Marshal(changeEvent)
    fmt.Println("event:", string(bytes))

Or watch any change with OnConfigChange

	agollo.OnConfigChange(func(e *agollo.ChangeEvent) {
        bytes, _ := json.Marshal(e)
        fmt.Println("event:", string(bytes))
	})

3, Get config using multi-method

Get apollo values

    // default namespace: application
    agollo.GetStringValue(Key, defaultValue)
    // user specify namespace
    agollo.GetStringValueWithNameSpace(namespace, key, defaultValue)

Get namespace file contents

    agollo.GetNameSpaceContent(namespace, defaultValue)

Get all keys

    agollo.GetAllKeys(namespace)

Unmarshal

There is a config in apollo like this:

So our meta-config should like:

{
    "appId": "001",
    "cluster": "default",
    "namespaceNames": ["application","dnspod1","dnspod2.yaml","db"],
    "ip": "localhost:8080"
}

At last, we make a structure to get all the config

package main

import (
	"fmt"
	"log"

	"github.com/philchia/agollo"
)

type config struct {
    // dns
    DNS1 struct {
        ID     string `mapstructure:"id"`
        Token  string `mapstructure:"token"`
        Domain string `mapstructure:"domain"`
    } `mapstructure:"dnspod1"`
    DNS2 struct {
        ID     int    `mapstructure:"id"`
        Token  string `mapstructure:"token"`
        Domain string `mapstructure:"domain"`
    } `mapstructure:"dnspod2.yaml"`

    // DB
    DB struct {
        DSN     string `mapstructure:"dsn"`
        MaxConn string `mapstructure:"max_conn"`
    } `mapstructure:"db"`
}

func main(){
    agollo.Start()

    // first
    var c config
    agollo.Unmarshal(&c)
    fmt.Printf("%v", c)

    // watch
	agollo.OnConfigChange(func(e *agollo.ChangeEvent) {
		var c config
		agollo.Unmarshal(&c)
		fmt.Println(c)
	})
}