您的位置:首页 > 教程 > 其他脚本 > Go微服务项目配置文件的定义和读取示例详解

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

2022-06-21 11:06:15 来源:易采站长站 作者:

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

目录
前言场景定义配置配置文件加载配置文件实现原理总结

V5h站长之家-易采站长站-Easck.Com

前言

V5h站长之家-易采站长站-Easck.Com

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

V5h站长之家-易采站长站-Easck.Com

场景

如果我们要写一个>

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

    之前我们用 json 做配置文件,但是 json 有个问题,无法加注释,所以我们后来切换到了 yaml 格式。V5h站长之家-易采站长站-Easck.Com

    接下来让我们看看借助 go-zero 怎么来方便的的定义和解析这样的配置文件~V5h站长之家-易采站长站-Easck.Com

    V5h站长之家-易采站长站-Easck.Com

    定义配置

    首先,我们需要将上述配置需求定义到>

    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]"`
    }
    

    可以看到,我们对每个配置项都有一定的定义和限制,其中一些定义如下:V5h站长之家-易采站长站-Easck.Com

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

      并且,一些属性可以叠加使用,比如:V5h站长之家-易采站长站-Easck.Com

        default 和 range 一起使用,就可以既增加了范围限制,又提供了默认值default 和 options 一起使用,就可以既增加了可选项限制,又提供了默认值

        V5h站长之家-易采站长站-Easck.Com

        配置文件

        因为我们在定义配置的时候,给了很多的默认值,还有使用>

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

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

        Password: "123456"
        

        这里的双引号不能少,少了会报 type mismatch 之类的错误,因为yaml解析器会把不带双引号的 123456 解析成 int。V5h站长之家-易采站长站-Easck.Com

        V5h站长之家-易采站长站-Easck.Com

        加载配置文件

        我们有了配置定义(config.go)和配置文件(config.yaml),接下来就是加载配置文件了,加载配置文件有三种方式:V5h站长之家-易采站长站-Easck.Com

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

          go-zero 自带的 goctl 生成的默认代码也是使用 MustLoad 来加载配置文件的V5h站长之家-易采站长站-Easck.Com

            加载配置,并自行判断是否有 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 了,所以默认不读取环境变量,这个设计也欢迎大家多提提建议哈V5h站长之家-易采站长站-Easck.Com

              V5h站长之家-易采站长站-Easck.Com

              实现原理

              我们在实现类似>

              配置文件代码:github.com/zeromicro/g…V5h站长之家-易采站长站-Easck.Com

              yaml/json 解析代码:github.com/zeromicro/g…V5h站长之家-易采站长站-Easck.Com

              这里也充分展示了 reflect 的用法,以及复杂场景下如何通过单元测试保证代码的正确性。V5h站长之家-易采站长站-Easck.Com

              V5h站长之家-易采站长站-Easck.Com

              总结

              我一直比较推荐>

              go-zero 的所有服务的配置项都是通过这样的方式来加载和自动验证的,包括我写的很多工具的配置也是基于此来实现的V5h站长之家-易采站长站-Easck.Com

              项目地址 github.com/zeromicro/g…V5h站长之家-易采站长站-Easck.Com

              更多关于Go配置文件定义读取的资料请关注易采站长站其它相关文章!希望能对你有所帮助!V5h站长之家-易采站长站-Easck.Com

              如有侵权,请联系QQ:279390809 电话:15144810328

相关文章

  • 使用Go基于WebSocket构建千万级视频直播弹幕系统的代码详解

    使用Go基于WebSocket构建千万级视频直播弹幕系统的代码详解

    (1)业务复杂度介绍 开门见山,假设一个直播间同时500W人在线,那么1秒钟1000条弹幕,那么弹幕系统的推送频率就是: 500W * 1000条/秒=50亿条/秒 ,想想B站2019跨年晚会那次弹幕系统得是
    2020-07-08
  • golang中import cycle not allowed解决的一种思路

    golang中import cycle not allowed解决的一种思路

    发现问题 项目中碰到了一些问题,使用了指针函数的思路来解决相应问题 在实际项目中,因为两个项目互相引了对方的一些方法,导致了循环引用的错误,原本可以使用http的请求来解
    2019-11-10
  • 从go语言中找&和*区别详解

    从go语言中找&和*区别详解

    *和的区别 : 是取地址符号 , 即取得某个变量的地址 , 如 ; a*是指针运算符 , 可以表示一个变量是指针类型 , 也可以表示一个指针变量所指向的存储单元 , 也就是这个地址所存储的值 . 从
    2020-06-23
  • Go语言中利用http发起Get和Post请求的方法示例

    Go语言中利用http发起Get和Post请求的方法示例

    关于 HTTP 协议 HTTP(即超文本传输协议)是现代网络中最常见和常用的协议之一,设计它的目的是保证客户机和服务器之间的通信。 HTTP 的工作方式是客户机与服务器之间的 “请求-应答
    2019-11-10
  • golang如何实现mapreduce单进程版本详解

    golang如何实现mapreduce单进程版本详解

    前言 MapReduce作为hadoop的编程框架,是工程师最常接触的部分,也是除去了网络环境和集群配 置之外对整个Job执行效率影响很大的部分,所以很有必要深入了解整个过程。元旦放假的第一天
    2019-11-10
  • Go打包二进制文件的实现

    Go打包二进制文件的实现

    背景 众所周知,go语言可打包成目标平台二进制文件是其一大优势,如此go项目在服务器不需要配置go环境和依赖就可跑起来。 操作 需求:打包部署到centos7 笔者打包环境:mac os 方法:
    2020-03-11
  • GO语言实现简单的目录复制功能

    GO语言实现简单的目录复制功能

    本文实例讲述了GO语言实现简单的目录复制功能。分享给大家供大家参考。具体实现方法如下: 创建一个独立的 goroutine 遍历文件,主进程负责写入数据。程序会复制空目录,也可以设
    2019-11-10
  • golang中定时器cpu使用率高的现象详析

    golang中定时器cpu使用率高的现象详析

    前言: 废话少说,上线一个用golang写的高频的任务派发系统,上线跑着很稳定,但有个缺点就是当没有任务的时候,cpu的消耗也在几个百分点。 平均值在3%左右的cpu使用率。你没有任务
    2019-11-10