java 轉 go 遇到 Apollo ?讓 agollo 來幫你平滑遷移

Introduction

agollo 是Apollo的 Golang 客戶端

Apollo（阿波羅）是攜程框架部門研發的分佈式配置中心，可以集中化管理應用不一樣環境、不一樣集羣的配置，配置修改後可以實時推送到應用端，而且具有規範的權限、流程治理等特性，適用於微服務配置管理場景。

若是在使用 golang 重構 java 的過程當中，使用到了分佈式配置中心 Apollo，那麼最快的方式就是使用原來的配置，保持最平滑的遷移，這個時候你就須要一個 Apollo 的 golang 客戶端，agollo 能夠是你的一個選擇。

使用指南

1.1.環境要求

• Go 1.11+ (最好使用Go 1.12)

1.2.依賴

1.2.1.使用 go get 方式

go get -u github.com/zouyx/agollo/v3@latest
複製代碼

1.2.2.使用 go mod 方式

go.mod

require github.com/zouyx/agollo/v3 latest
複製代碼

執行

go mod tidy
複製代碼

import

import (
	"github.com/zouyx/agollo/v3"
)
複製代碼

FAQ

• 爲何要加+incompatible
• go.mod不能下載agollo的解決方法

1.3.必要設置

Apollo 客戶端依賴於 AppId，Environment 等環境信息來工做，因此請確保閱讀下面的說明而且作正確的配置：

• main ： your application
• app.properties (必要) ： 鏈接服務端必要配置
• seelog.xml（非必要）

1.3.1.配置

加載優先級：

1. 類配置
2. 環境變量指定配置文件
3. 默認（app.properties）配置文件

1.3.1.1.類配置

會覆蓋app.properties中配置，在調用Start方法以前調用

readyConfig:=&AppConfig{
		AppId:"test1",
		Cluster:"dev1",
		NamespaceName:"application1",
		Ip:"localhost:8889",
	}

	InitCustomConfig(func() (*AppConfig, error) {
		return readyConfig,nil
	})
複製代碼

類配置 agollo 的 demo:

package main

import (
	"fmt"
	"github.com/zouyx/agollo/v3"
	"github.com/zouyx/agollo/v3/env/config"
)

func InitAgolloConfig() error {
	readyConfig := &config.AppConfig{
		AppID:         "test",
		Cluster:       "default",
		NamespaceName: "application",
		IP:            "localhost:8080",
	}
	agollo.InitCustomConfig(func() (*config.AppConfig, error) {
		return readyConfig, nil
	})
	err := agollo.Start()
	if err != nil {
		fmt.Errorf("%v", err)
		return err
	}

	return nil
}

func main(){
    //Init Apollo
	err := config.InitAgolloConfig()
	if err != nil {
		fmt.Errorf("初始化Apollo失敗", err)
		panic(err)
	}
    fmt.Println("初始化Apollo配置成功")
    
    //Use your apollo key to test
    value := agollo.GetStringValue("key", "")
    fmt.Println(value)
}

複製代碼

1.3.1.2.環境變量指定配置文件

Linux/Mac

export AGOLLO_CONF=/a/conf.properties
複製代碼

Windows

set AGOLLO_CONF=c:/a/conf.properties
複製代碼

配置文件內容與app.properties內容同樣

1.3.1.3.文件配置 - app.properties

1.開發:請確保 app.properties 文件存在於workingdir目錄下

2.打包後:請確保 app.properties 文件存在於與打包程序同級目錄下，參考1.3.必要配置。

目前只支持json形式，其中字段包括：

• appId ：應用的身份信息，是從服務端獲取配置的一個重要信息。

• cluster ：須要鏈接的集羣，默認default

• namespaceName ：命名空間，默認：application（具體定義參考：namespace）,多namespace使用英文逗號分割， 非key/value配置（json,properties,yml等），則配置爲：namespace.文件類型。如：namespace.json

• ip ：Apollo的CONFIG_SERVICE的ip，非META_SERVICE地址

配置例子以下：

通常配置

{
    "appId": "test",
    "cluster": "dev",
    "namespaceName": "application",
    "ip": "localhost:8888"
}
複製代碼

多namespace配置

{
    "appId": "test",
    "cluster": "dev",
    "namespaceName": "application, applications1",
    "ip": "localhost:8888"
}
複製代碼

非key/value namespace配置

{
    "appId": "test",
    "cluster": "dev",
    "namespaceName": "application.json,a.yml",
    "ip": "localhost:8888"
}
複製代碼

1.4日誌組件

參考:

• 自定義日誌組件
• 使用seelog日誌組件

啓動方式

• 異步啓動 agollo

場景：啓動程序不依賴加載Apollo的配置。

func main() {
	 go agollo.Start()
}
複製代碼

• 同步啓動 agollo（v1.2.0+）

場景：啓動程序依賴加載 Apollo 的配置。例：初始化程序基礎配置。

func main() {
	 agollo.Start()
}
複製代碼

• 啓動 agollo - 自定義 logger 控件

func main() {
	 agollo.StartWithLogger(loggerInterface)
}
複製代碼

• 啓動 agollo - 自定義 cache 控件 (v1.7.0+)

func main() {
	 agollo.StartWithCache(cacheInterface)
}
複製代碼

• 啓動 agollo - 自定義各類控件 (v1.8.0+)

func main() {
    agollo.SetLogger(loggerInterface)
	agollo.SetCache(cacheInterface)
	agollo.Start()
}
複製代碼

• 監聽變動事件（阻塞）

func main() {
	event := agollo.ListenChangeEvent()
	changeEvent := <-event
	bytes, _ := json.Marshal(changeEvent)
	fmt.Println("event:", string(bytes))
}
複製代碼

基本方法

• String

agollo.GetStringValue(Key,DefaultValue)
複製代碼

• Int

agollo.GetIntValue(Key,DefaultValue)
複製代碼

• Float

agollo.GetFloatValue(Key,DefaultValue)
複製代碼

• Bool

agollo.GetBoolValue(Key,DefaultValue)
複製代碼

切換namespace獲取配置

• 根據namespace獲取配置

config := agollo.GetConfig(namespace)
複製代碼

• String

config.GetStringValue(Key,DefaultValue)
複製代碼

• Int

config.GetIntValue(Key,DefaultValue)
複製代碼

• Float

config.GetFloatValue(Key,DefaultValue)
複製代碼

• Bool

config.GetBoolValue(Key,DefaultValue)
複製代碼

自定義日誌組件

複製如下代碼至項目中，並在其中引用日誌組件的方法進行打印 log

type DefaultLogger struct {
}

func (this *DefaultLogger)Debugf(format string, params ...interface{})  {
	
}

func (this *DefaultLogger)Infof(format string, params ...interface{}) {

}


func (this *DefaultLogger)Warnf(format string, params ...interface{}) error {
	return nil
}

func (this *DefaultLogger)Errorf(format string, params ...interface{}) error {
	return nil
}


func (this *DefaultLogger)Debug(v ...interface{}) {

}
func (this *DefaultLogger)Info(v ...interface{}){

}

func (this *DefaultLogger)Warn(v ...interface{}) error{
	return nil
}

func (this *DefaultLogger)Error(v ...interface{}) error{
	return nil
}
複製代碼

啓動

func main() {
   agollo.SetLogger(&DefaultLogger{})
   agollo.Start()
}
複製代碼

自定義緩存組件

聲明自定義緩存組件

//DefaultCache 默認緩存
type DefaultCache struct {
	defaultCache sync.Map
}

//Set 獲取緩存
func (d *DefaultCache)Set(key string, value []byte, expireSeconds int) (err error)  {
	d.defaultCache.Store(key,value)
	return nil
}

//EntryCount 獲取實體數量
func (d *DefaultCache)EntryCount() (entryCount int64){
	count:=int64(0)
	d.defaultCache.Range(func(key, value interface{}) bool {
		count++
		return true
	})
	return count
}

//Get 獲取緩存
func (d *DefaultCache)Get(key string) (value []byte, err error){
	v, ok := d.defaultCache.Load(key)
	if !ok{
		return nil,errors.New("load default cache fail")
	}
	return v.([]byte),nil
}

//Range 遍歷緩存
func (d *DefaultCache)Range(f func(key, value interface{}) bool){
	d.defaultCache.Range(f)
}

//Del 刪除緩存
func (d *DefaultCache)Del(key string) (affected bool) {
	d.defaultCache.Delete(key)
	return true
}

//Clear 清除全部緩存
func (d *DefaultCache)Clear() {
	d.defaultCache=sync.Map{}
}

//DefaultCacheFactory 構造默認緩存組件工廠類
type DefaultCacheFactory struct {

}

//Create 建立默認緩存組件
func (d *DefaultCacheFactory) Create()CacheInterface {
	return &DefaultCache{}
}
複製代碼

使用自定義緩存

agollo.SetCache(&DefaultCacheFactory{})
agollo.Start()
複製代碼

---

• 項目地址: github.com/zouyx/agoll…

​ 官方資訊*最新技術*獨家解讀