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协程池模拟实现群发邮件功能
May 02 Golang
goland设置颜色和字体的操作
May 05 Golang
Go 自定义package包设置与导入操作
May 06 Golang
golang fmt格式“占位符”的实例用法详解
Jul 04 Golang
Go语言基础map用法及示例详解
Nov 17 Golang
如何利用golang运用mysql数据库
Mar 13 Golang
golang操作rocketmq的示例代码
Apr 06 Golang
Go语言安装并操作redis的go-redis库
Apr 14 Golang
golang的文件创建及读写操作
Apr 14 Golang
Golang ort 中的sortInts 方法
Apr 24 Golang
Golang解析JSON对象
Apr 30 Golang
Golang 入门 之url 包
May 04 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多线程异步请求的3种方法
2014/01/17 PHP
php实现斐波那契数列的简单写法
2014/07/19 PHP
PHP中常用的输出函数总结
2014/09/22 PHP
PHP循环遍历数组的3种方法list()、each()和while总结
2014/11/19 PHP
JQUERY复选框CHECKBOX全选,取消全选
2008/08/30 Javascript
Javascript 实现TreeView CheckBox全选效果
2010/01/11 Javascript
Extjs中使用extend(js继承) 的代码
2012/03/15 Javascript
JavaScript知识点总结(六)之JavaScript判断变量数据类型
2016/05/31 Javascript
举例讲解jQuery对DOM元素的向上遍历、向下遍历和水平遍历
2016/07/07 Javascript
js 实现一些跨浏览器的事件方法详解及实例
2016/10/27 Javascript
Json按某个键的值进行排序
2016/12/22 Javascript
简单的渐变轮播插件
2017/01/12 Javascript
使用vue-cli3新建一个项目并写好基本配置(推荐)
2019/04/24 Javascript
使用异步controller与jQuery实现卷帘式分页
2019/06/18 jQuery
vue中js判断长时间不操作界面自动退出登录(推荐)
2020/01/22 Javascript
js验证密码强度解析
2020/03/18 Javascript
python中的内置函数getattr()介绍及示例
2014/07/20 Python
Python正则表达式常用函数总结
2017/06/24 Python
解决python文件字符串转列表时遇到空行的问题
2017/07/09 Python
详解python 拆包可迭代数据如tuple, list
2017/12/29 Python
在python中获取div的文本内容并和想定结果进行对比详解
2019/01/02 Python
Django 开发环境配置过程详解
2019/07/18 Python
Python shutil模块用法实例分析
2019/10/02 Python
使用css3实现超炫的loading加载动画效果
2014/05/07 HTML / CSS
adidas美国官网:adidas US
2016/09/21 全球购物
欧洲最大的滑雪假期供应商之一:Sunweb Holidays
2018/01/06 全球购物
银行求职推荐信范文
2013/11/30 职场文书
大学系主任推荐信范文
2013/12/24 职场文书
计算机数据库专业职业生涯规划书
2014/02/08 职场文书
股权收购意向书
2014/04/01 职场文书
机关干部四风问题自查报告及整改措施
2014/10/26 职场文书
2014年客房服务员工作总结
2014/11/18 职场文书
2015年惩防体系建设工作总结
2015/05/22 职场文书
导游词之珠海轮廓
2019/10/25 职场文书
python中的被动信息搜集
2021/04/29 Python
Python 如何利用ffmpeg 处理视频素材
2021/11/27 Python