用Go自己實現配置文件熱加載功能
說到配置文件熱加載，這個功能在很多框架中都提供了，如beego，實現的效果就是當你修改文件後，會把你修改後的配置重新加載到配置文件中，而不用重啟程序，這個功能在日常中還是非常實用的，畢竟很多時候，線上的配置文件不是想改就能改的。
這次就自己實現一個配置文件的熱加載功能的包，並通過一個簡單的例子對完成的包進行使用驗證
配置文件熱加載包的是實現
其實整體的思路還是比較簡單的，當獲取配置文件內容後，會開啟一個goroutine，去 循環讀配置文件，當然這裏不可能不限制的一直循環，而是設置了一個定時器，定時去讀文件，根據文件的修改時間是否變化，從而確定是否重新reload配置文件
實現的config 包的文件結構為：
├── config.go
└── config_notify.go
config.go：代碼的主要處理邏輯
config_notify.go：主要定義了一個接口，用於當文件修改時間變化的時候執行回調
config_notify.go的代碼相對來說比較簡單，我們先看看這個代碼：
package config // 定義一個通知的接口 type Notifyer interface { Callback(*Config) }
這樣當我們實現了Callback這個方法的時候，我們就實現了Notifyer這個接口，具體的調用在後面會說
在config.go中我們頂一個了一個結構體：
type Config struct {
filename string
lastModifyTime int64
data map[string]string
rwLock sync.RWMutex
notifyList []Notifyer
}
結構體中主要包含幾個字段：
filename:配置文件名字
lastModifyTime:配置文件的最後修改時間
data:用於將從配置文件中讀取的內容存儲為map
rwlock:讀寫鎖
notifyList:用於將調用該包的程序追加到切片中，用於通知調用上面在config_notify.go定義的callback回調函數
關於讀取配置文件中的內容並存儲到map中，這裏定義了一個方法實現：
func (c *Config) parse()(m map[string]string,err error){ // 讀文件並或將文件中的數據以k/v的形式存儲到map中 m = make(map[string]string,1024) file,err := os.Open(c.filename) if err != nil{ return } var lineNo int reader := bufio.NewReader(file) for{ // 一行行的讀文件 line,errRet := reader.ReadString(‘\n‘) if errRet == io.EOF{ // 表示讀到文件的末尾 break } if errRet != nil{ // 表示讀文件出問題 err = errRet return } lineNo++ line = strings.TrimSpace(line) // 取出空格 if len(line) == 0 || line[0] == ‘\n‘ || line[0] == ‘+‘ || line[0] == ‘;‘{ // 當前行為空行或者是註釋行等 continue } arr := strings.Split(line,"=") // 通過=進行切割取出k/v結構 if len(arr) == 0{ fmt.Printf("invalid config,line:%d\n",lineNo) continue } key := strings.TrimSpace(arr[0]) if len(key) == 0{ fmt.Printf("invalid config,line:%d\n",lineNo) continue } if len(arr) == 1{ m[key] = "" continue } value := strings.TrimSpace(arr[1]) m[key] = value } return }
而最後我們就需要一個定時器，每隔一段時間判斷配置文件的最後修改時間是否變化，如果變化則重新讀取一次文件並將文件內容存儲到map中。
func (c *Config) reload(){ // 這裏啟動一個定時器，每5秒重新加載一次配置文件 ticker := time.NewTicker(time.Second*5) for _ = range ticker.C{ func(){ file,err := os.Open(c.filename) if err != nil{ fmt.Printf("open %s failed,err:%v\n",c.filename,err) return } defer file.Close() fileInfo,err := file.Stat() if err != nil{ fmt.Printf("stat %s failed,err:%v\n",c.filename,err) return } curModifyTime := fileInfo.ModTime().Unix() fmt.Printf("%v --- %v\n",curModifyTime,c.lastModifyTime) //判斷文件的修改時間是否大於最後一次修改時間 if curModifyTime > c.lastModifyTime{ m,err := c.parse() if err != nil{ fmt.Println("parse failed,err:",err) return } c.rwLock.Lock() c.data = m c.rwLock.Unlock() for _, n:=range c.notifyList{ n.Callback(c) } c.lastModifyTime = curModifyTime } }() } }
關於config完整的代碼地址：https://github.com/pythonsite/go_simple_code/tree/master/config
一個演示上述包的例子
這裏一個簡單的例子，代碼的邏輯也非常簡單就是寫一個循環從配置文件讀取配置信息，當然這裏是為了測試效果，寫成了循環。這裏有個問題需要註意，就是在配置文件中存放數據的時候應該是如下格式存儲
listen_addr = localhost server_port = 1000 # Nginx addr nginx_addr = 192.168.1.2:9090
測試代碼的主要結構如下：
├── config.conf
└── main.go
config.conf為配置文件
main.go 為主要測試代碼
type AppConfig struct { port int nginxAddr string } type AppconfigMgr struct { config atomic.Value } var appConfigMgr = &AppconfigMgr{} func(a *AppconfigMgr)Callback(conf *config.Config){ var appConfig = &AppConfig{} port,err := conf.GetInt("server_port") if err != nil{ fmt.Println("get port failed,err:",err) return } appConfig.port = port fmt.Println("port:",appConfig.port) nginxAddr,err := conf.GetString("nginx_addr") if err != nil{ fmt.Println("get nginx addr failed,err:",err) return } appConfig.nginxAddr = nginxAddr fmt.Println("nginx addr :",appConfig.nginxAddr) appConfigMgr.config.Store(appConfig) } func run(){ for { // 每5秒打印一次數據，查看自己更改配置文件後是否可以熱刷新 appConfig := appConfigMgr.config.Load().(*AppConfig) fmt.Println("port:",appConfig.port) fmt.Println("nginx addr:",appConfig.nginxAddr) time.Sleep(5* time.Second) } } func main() { conf,err := config.NewConfig("/Users/zhaofan/go_project/src/go_dev/13/config_test/config.conf") if err != nil{ fmt.Println("parse config failed,err:",err) return } //打開文件獲取內容後，將自己加入到被通知的切片中 conf.AddNotifyer(appConfigMgr) var appConfig = &AppConfig{} appConfig.port,err = conf.GetInt("server_port") if err != nil{ fmt.Println("get port failed,err:",err) return } fmt.Println("port:",appConfig.port) appConfig.nginxAddr,err = conf.GetString("nginx_addr") if err != nil{ fmt.Println("get nginx addr failed,err:",err) return } fmt.Println("nginx addr:",appConfig.nginxAddr) appConfigMgr.config.Store(appConfig) run() }
上面代碼中有一段代碼非常重要：
func(a *AppconfigMgr)Callback(conf *config.Config){ var appConfig = &AppConfig{} port,err := conf.GetInt("server_port") if err != nil{ fmt.Println("get port failed,err:",err) return } appConfig.port = port fmt.Println("port:",appConfig.port) nginxAddr,err := conf.GetString("nginx_addr") if err != nil{ fmt.Println("get nginx addr failed,err:",err) return } appConfig.nginxAddr = nginxAddr fmt.Println("nginx addr :",appConfig.nginxAddr) appConfigMgr.config.Store(appConfig) }
這裏我們實現了Callback方法，同時就實現了我們在config包中定義的那個接口
測試效果如下，當我們更改配置文件後，程序中的配置文件也被重新加載
完整的測試代碼地址：https://github.com/pythonsite/go_simple_code/tree/master/config_test
用Go自己實現配置文件熱加載功能