用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:%dn",lineNo)
continue
}
key := strings.TrimSpace(arr[0])
if len(key) == 0{
fmt.Printf("invalid config,line:%dn",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:%vn",c.filename,err)
return
}
defer file.Close()
fileInfo,err := file.Stat()
if err != nil{
fmt.Printf("stat %s failed,err:%vn",c.filename,err)
return
}
curModifyTime := fileInfo.ModTime().Unix()
fmt.Printf("%v --- %vn",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
- mysql之基本语法
- mysql之索引的工作机制
- Mysql之锁与事务
- 独家 | 教你实现数据集多维可视化(附代码)
- NoSQL | Redis、Memcache、MongoDB特点、区别以及应用场景
- cf--------(div1)1A. Theatre Square
- 离线网页制作器(beta1.0)
- uva---(11549)CALCULATOR CONUNDRUM
- CF---(452)A. Eevee
- MySQL排序内部原理探秘
- Uva----------(11078)Open Credit System
- 学习HTML5之塔克大战(详细记录)
- 学习HTML5之新特性标签一览(详细)
- poj----(1251)Jungle Roads(最小生成树)
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法