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语言map与string的相互转换的实现
Apr 07 Golang
基于go interface{}==nil 的几种坑及原理分析
Apr 24 Golang
golang 接口嵌套实现复用的操作
Apr 29 Golang
解决Go gorm踩过的坑
Apr 30 Golang
golang DNS服务器的简单实现操作
Apr 30 Golang
解决Golang中goroutine执行速度的问题
May 02 Golang
Go timer如何调度
Jun 09 Golang
go web 预防跨站脚本的实现方式
Jun 11 Golang
实现GO语言对数组切片去重
Apr 20 Golang
Golang 入门 之url 包
May 04 Golang
Go本地测试解耦任务拆解及沟通详解Go本地测试的思路沟通的重要性总结
Jun 21 Golang
Go语言测试库testify使用学习
Jul 23 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
如何给phpadmin一个保护
2006/10/09 PHP
php数组函数序列之in_array() - 查找数组中是否存在指定值
2011/11/07 PHP
php编写批量生成不重复的卡号密码代码
2015/05/14 PHP
程序员的表白神器“520”大声喊出来
2016/05/20 PHP
thinkPHP实现签到功能的方法
2017/03/15 PHP
PHP 进度条函数的简单实例
2017/09/19 PHP
一些常用的JavaScript函数(json)附详细说明
2011/05/25 Javascript
JS Array创建及concat()split()slice()的使用方法
2016/06/03 Javascript
jQueryUI DatePicker 添加时分秒
2016/06/04 Javascript
javascript insertAfter()定义与用法示例
2016/07/25 Javascript
Highcharts+NodeJS搭建数据可视化平台示例
2017/01/01 NodeJs
jQuery插件zTree实现更新根节点中第i个节点名称的方法示例
2017/03/08 Javascript
干货!教大家如何选择Vue和React
2017/03/13 Javascript
AngularJS1.X学习笔记2-数据绑定详解
2017/04/01 Javascript
详解微信小程序 template添加绑定事件
2017/06/23 Javascript
vue-cli项目代理proxyTable配置exclude的方法
2018/09/20 Javascript
vue实现移动端项目多行文本溢出省略
2020/07/29 Javascript
[40:03]Liquid vs Optic 2018国际邀请赛淘汰赛BO3 第一场 8.21
2018/08/22 DOTA
Python爬取京东的商品分类与链接
2016/08/26 Python
Python高级特性与几种函数的讲解
2019/03/08 Python
Python面向对象程序设计之私有属性及私有方法示例
2019/04/08 Python
Python3.6+Django2.0以上 xadmin站点的配置和使用教程图解
2019/06/04 Python
Django实现发送邮件功能
2019/07/18 Python
python scrapy重复执行实现代码详解
2019/12/28 Python
python程序如何进行保存
2020/07/03 Python
css3实现平移效果(transfrom:translate)的示例
2020/11/13 HTML / CSS
FLOS美国官网:意大利高级照明工艺的传奇
2018/08/07 全球购物
印度尼西亚手表和包包商店:Urban Icon
2019/12/12 全球购物
全球才华横溢工匠的家居装饰、珠宝和礼物:NOVICA
2021/01/22 全球购物
解释一下抽象方法和抽象类
2016/08/27 面试题
优秀党员转正的自我评价
2013/10/06 职场文书
室内设计专业学生的自我评价分享
2013/11/27 职场文书
初三学习决心书
2014/03/11 职场文书
司机个人年终总结
2015/03/03 职场文书
Vue3 Composition API的使用简介
2021/03/29 Vue.js
详解CocosCreator消息分发机制
2021/04/16 Javascript