Go微服务项目配置文件的定义和读取示例详解


Posted in Golang onJune 21, 2022

前言

我们在写应用时,基本都会用到配置文件,从各种 shellnginx 等,都有自己的配置文件。虽然这没有太多难度,但是配置项一般相对比较繁杂,解析、校验也会比较麻烦。本文就给大家讲讲我们是怎么简化配置文件的定义和解析的。

场景

如果我们要写一个 Restful API 的服务,配置项大概有如下内容:

  • Host,侦听的 IP,如果不填,默认用 0.0.0.0
  • Port,侦听的端口,必填,只能是数字,大于等于80,小于65535
  • LogMode,日志模式,只能选 file 或者 console
  • Verbose,看是否输出详细日志,可选,默认为 false
  • MaxConns,允许的最大并发连接数,默认 10000
  • Timeout,超时设置,默认 3s
  • CpuThreshold,设置 CPU 使用率触发系统降载的阈值,默认 9001000m 表示 100%

之前我们用 json 做配置文件,但是 json 有个问题,无法加注释,所以我们后来切换到了 yaml 格式。

接下来让我们看看借助 go-zero 怎么来方便的的定义和解析这样的配置文件~

定义配置

首先,我们需要将上述配置需求定义到 Go 结构体里,如下:

RestfulConf struct {
    Host         string        `json:",default=0.0.0.0"`
    Port         int           `json:",range=[80,65535)"`
    LogMode      string        `json:",options=[file,console]"`
    Verbose      bool          `json:",optional"`
    MaxConns     int           `json:",default=10000"`
    Timeout      time.Duration `json:",default=3s"`
    CpuThreshold int64         `json:",default=900,range=[0:1000]"`
}
复制代码

可以看到,我们对每个配置项都有一定的定义和限制,其中一些定义如下:

  • default,配置没填的话,使用该默认值,可以看到其中的 3s 会自动解析成 time.Duration 类型
  • optional,此项可以不配置,没有的话,用类型零值
  • range,限定数字类型,需要在给定的范围内
  • options,限制配置的值只能是给出的这几个之一

并且,一些属性可以叠加使用,比如:

  • defaultrange 一起使用,就可以既增加了范围限制,又提供了默认值
  • defaultoptions 一起使用,就可以既增加了可选项限制,又提供了默认值

配置文件

因为我们在定义配置的时候,给了很多的默认值,还有使用 optional 指定为可选,所以我们的配置文件里的配置项就相对比较少了,能用默认值的就不用写了,如下:

# 因为很多都有默认值,所以只需要写需要指定值和没有默认值的
Port: 8080
LogMode: console
# 可以读取环境变量的值
MaxBytes: ${MAX_BYTES}
复制代码

这里有个注意点,如果配置项的 value 全部是数字,而你定义的配置类型是 string,比如有人测试密码经常用 123456,但是密码一般会定义为 string,配置就要写成如下(只是举个例子哈,密码一般不建议裸写到配置文件里):

Password: "123456"
复制代码

这里的双引号不能少,少了会报 type mismatch 之类的错误,因为 yaml 解析器会把不带双引号的 123456 解析成 int

加载配置文件

我们有了配置定义(config.go)和配置文件(config.yaml),接下来就是加载配置文件了,加载配置文件有三种方式:

  • 必须加载成功,否则程序退出,我们一般这么用,如果配置不对,程序就无法继续了
// 有错误直接退出程序
var config RestfulConf
conf.MustLoad("config.yaml", &config)
复制代码

go-zero 自带的 goctl 生成的默认代码也是使用 MustLoad 来加载配置文件的

  • 加载配置,并自行判断是否有 error
// 自己判断并处理 error
var config RestfulConf
// 为了更简洁,这里的 LoadConfig 后续会改为 Load,LoadConfig 已被标记为 Deprecated
if err := conf.LoadConfig("config.yaml", &config); err != nil {
    log.Fatal(err)
}
复制代码
  • 加载配置并读取环境变量
// 自动读取环境变量
var config RestfulConf
conf.MustLoad(configFile, &config, conf.UseEnv())
复制代码

这里为啥我们需要显式指定 conf.UseEnv(),因为如果默认读取的话,可能在配置里大家写特定字符的时候就需要 escape 了,所以默认不读取环境变量,这个设计也欢迎大家多提提建议哈

实现原理

我们在实现类似 yaml/json 解析的时候一般会直接使用 encoding/json 或者对应的 yaml 库,但是对于 go-zero 来说,我们需要在 unmarshal 的时候有更精确的控制,这就需要我们自己定制 yaml/json 的解析了,完整的代码实现在:

配置文件代码:github.com/zeromicro/g…

yaml/json 解析代码:github.com/zeromicro/g…

这里也充分展示了 reflect 的用法,以及复杂场景下如何通过单元测试保证代码的正确性。

总结

我一直比较推荐 Fail Fast 的思想,我们在加载配置文件的时候也是这样,一旦有错误,立马退出,这样运维在部署服务时就会及时发现问题,因为进程压根起不来。

go-zero 的所有服务的配置项都是通过这样的方式来加载和自动验证的,包括我写的很多工具的配置也是基于此来实现的,希望能对你有所帮助!

项目地址

github.com/zeromicro/g…

以上就是Go项目配置文件的定义和读取示例详解的详细内容,更多关于Go配置文件定义读取的资料请关注三水点靠木其它相关文章!

Golang 相关文章推荐
Golang 实现超大文件读取的两种方法
Apr 27 Golang
goland 清除所有的默认设置操作
Apr 28 Golang
golang 比较浮点数的大小方式
May 02 Golang
golang日志包logger的用法详解
May 05 Golang
浅谈golang package中init方法的多处定义及运行顺序问题
May 06 Golang
基于Golang 高并发问题的解决方案
May 08 Golang
golang生成vcf通讯录格式文件详情
Mar 25 Golang
Go语言grpc和protobuf
Apr 13 Golang
golang定时器
Apr 14 Golang
Golang jwt身份认证
Apr 20 Golang
Go gorilla securecookie库的安装使用详解
Aug 14 Golang
Go本地测试解耦任务拆解及沟通详解Go本地测试的思路沟通的重要性总结
Jun 21 #Golang
Go 内联优化让程序员爱不释手
Jun 21 #Golang
GoFrame框架数据校验之校验结果Error接口对象
Jun 21 #Golang
GoFrame基于性能测试得知grpool使用场景
Jun 21 #Golang
Golang gRPC HTTP协议转换示例
Go Grpc Gateway兼容HTTP协议文档自动生成网关
Jun 16 #Golang
Go gRPC进阶教程gRPC转换HTTP
Jun 16 #Golang
You might like
转生史莱姆:萌王第一次撸串开心到飞起,哥布塔撸串却神似界王神
2018/11/30 日漫
php异常处理使用示例
2014/02/25 PHP
一端时间轮换的广告
2006/06/26 Javascript
Javascript的构造函数和constructor属性
2010/01/09 Javascript
input输入框的自动匹配(原生代码)
2013/03/19 Javascript
js中的for如何实现foreach中的遍历
2014/05/31 Javascript
jquery中添加属性和删除属性
2015/06/03 Javascript
JavaScript实现下拉列表框数据增加、删除、上下排序的方法
2015/08/11 Javascript
JQuery实现左右滚动菜单特效
2015/09/28 Javascript
JS函数的几种定义方式分析
2015/12/17 Javascript
Jquery实现纵向横向菜单
2016/01/24 Javascript
JavaScript动态添加css样式和script标签
2016/07/19 Javascript
微信小程序开发教程-手势解锁实例
2017/01/06 Javascript
利用JavaScript缓存远程窃取Wi-Fi密码的思路详解
2018/11/05 Javascript
微信小程序canvas.drawImage完全显示图片问题的解决
2018/11/30 Javascript
vue实现后台管理权限系统及顶栏三级菜单显示功能
2019/06/19 Javascript
解决layer图标icon不加载的问题
2019/09/04 Javascript
微信小程序request请求封装,验签代码实例
2019/12/04 Javascript
js实现超级玛丽小游戏
2020/03/18 Javascript
[01:55]2014DOTA2国际邀请赛 BBC正赛第一天总结
2014/07/10 DOTA
[04:16]完美世界DOTA2联赛PWL S2 集锦第一期
2020/11/23 DOTA
Python GAE、Django导出Excel的方法
2008/11/24 Python
简单介绍python封装的基本知识
2019/08/10 Python
Python实现微信中找回好友、群聊用户撤回的消息功能示例
2019/08/23 Python
Python基于模块Paramiko实现SSHv2协议
2020/04/28 Python
实例讲解CSS3中的box-flex弹性盒属性布局
2016/06/09 HTML / CSS
英国奢侈品网站:MatchesFashion
2016/12/16 全球购物
机械电子工程专业推荐信范文
2013/11/20 职场文书
施工资料员岗位职责
2014/01/06 职场文书
做一个有道德的人活动实施方案
2014/08/23 职场文书
向国旗敬礼活动总结范文2014
2014/09/27 职场文书
人身损害赔偿协议书格式
2014/11/01 职场文书
2015年中学体育教师工作总结
2015/10/23 职场文书
MySQL中的隐藏列的具体查看
2021/09/04 MySQL
SpringBoot系列之MongoDB Aggregations用法详解
2022/02/12 MongoDB
jdbc中自带MySQL 连接池实践示例
2022/07/23 MySQL