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 相关文章推荐
Go Gin实现文件上传下载的示例代码
Apr 02 Golang
Go语言切片前或中间插入项与内置copy()函数详解
Apr 27 Golang
goland 清除所有的默认设置操作
Apr 28 Golang
golang 如何用反射reflect操作结构体
Apr 28 Golang
Golang 如何实现函数的任意类型传参
Apr 29 Golang
golang slice元素去重操作
Apr 30 Golang
Go语言空白表示符_的实例用法
Jul 04 Golang
入门学习Go的基本语法
Jul 07 Golang
Golang表示枚举类型的详细讲解
Sep 04 Golang
Golang 字符串的常见操作
Apr 19 Golang
Golang jwt身份认证
Apr 20 Golang
Go本地测试解耦任务拆解及沟通详解Go本地测试的思路沟通的重要性总结
Jun 21 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
php 字符串中的\n换行符无效、不能换行的解决方法
2014/04/02 PHP
php从memcache读取数据再批量写入mysql的方法
2014/12/29 PHP
RR vs IO BO3 第二场2.13
2021/03/10 DOTA
Javascript 强制类型转换函数
2009/05/17 Javascript
jquery.boxy弹出框(后隔N秒后自动隐藏/自动跳转)
2013/01/15 Javascript
自定义的一个简单时尚js下拉选择框
2013/11/20 Javascript
JavaScript弹出新窗口后向父窗口输出内容的方法
2015/04/06 Javascript
fastclick插件导致日期(input[type="date"])控件无法被触发该如何解决
2015/11/09 Javascript
整理Javascript数组学习笔记
2015/11/29 Javascript
两种JavaScript的AES加密方式(可与Java相互加解密)
2016/08/02 Javascript
原生js实现ajax方法(超简单)
2016/09/20 Javascript
BootStrap表单验证实例代码
2017/01/13 Javascript
JavaScript设计模式之单例模式详解
2017/06/09 Javascript
JavaScript事件冒泡与事件捕获实例分析
2018/08/01 Javascript
深入理解 Koa 框架中间件原理
2018/10/18 Javascript
vue自定义指令用法经典实例小结
2019/03/16 Javascript
详解无限滚动插件vue-infinite-scroll源码解析
2019/05/12 Javascript
微信小程序换肤功能实现代码(思路详解)
2020/08/25 Javascript
[01:46]新英雄登场
2019/09/10 DOTA
Python制作Windows系统服务
2017/03/25 Python
django 常用orm操作详解
2017/09/13 Python
Python实现八皇后问题示例代码
2018/12/09 Python
Python爬虫 bilibili视频弹幕提取过程详解
2019/07/31 Python
Python实现将蓝底照片转化为白底照片功能完整实例
2019/12/13 Python
浅谈python3 构造函数和析构函数
2020/03/12 Python
python的flask框架难学吗
2020/07/31 Python
Python读写锁实现实现代码解析
2020/11/28 Python
python爬虫scrapy基于CrawlSpider类的全站数据爬取示例解析
2021/02/20 Python
HTML5中的Scoped属性使用实例
2014/04/23 HTML / CSS
露营世界:Camping World
2017/02/02 全球购物
购买正版游戏和游戏激活码:Green Man Gaming
2019/11/06 全球购物
武汉英思工程科技有限公司–ORACLE面试测试题目
2012/04/30 面试题
中专生毕业自我鉴定
2013/11/01 职场文书
创业计划书的内容步骤和要领
2014/01/04 职场文书
教师三严三实心得体会
2014/10/11 职场文书
python opencv检测直线 cv2.HoughLinesP的实现
2021/06/18 Python