# 配置读取

举个例子
配置注入
更多格式的配置文件
设计思路

在 Gone 中提供了通过内置Goners读取配置文件的方法，默认支持的配置文件格式为.properties。

# 举个例子

例子的代码源代码可以在这里 (opens new window)找到。

# 1. 创建mod

go mod init use-config

# 2. 添加配置文件

mkdir config
touch config/default.properties

config/default.properties 文件内容如下：

my.conf.int=10
my.conf.int8=130
my.conf.float64=10.222
my.conf.string=config test
my.conf.bool=true
my.conf.duration=10h
my.conf.sub.x=100x
my.conf.sub.y=200y
my.conf.subs[0].x=0000x
my.conf.subs[0].y=0000y
my.conf.subs[1].x=1111x
my.conf.subs[1].y=1111y

# 3. 添加代码

touch main.go

main.go 文件内容如下：

package main
import (
	"fmt"
	"github.com/gone-io/gone"
	"github.com/gone-io/gone/goner/config"
	"time"
)
type SubConf struct {
	X string `properties:"x"`
	Y string `properties:"y"`
}
type UseConfig struct {
	gone.Flag
	int      int           `gone:"config,my.conf.int"`
	int8     int8          `gone:"config,my.conf.int8"`
	printInt *int          `gone:"config,my.conf.int8"` //指针 指向int
	float64  float64       `gone:"config,my.conf.float64"`
	string   string        `gone:"config,my.conf.string"`
	bool     bool          `gone:"config,my.conf.bool"`
	duration time.Duration `gone:"config,my.conf.duration"`
	defaultV string        `gone:"config,my.conf.default,default=ok"`
	sub *SubConf `gone:"config,my.conf.sub"` //指针，指向结构体
	subs []SubConf `gone:"config,my.conf.subs"` //数组
}
func (g *UseConfig) AfterRevive() gone.AfterReviveError {
	fmt.Printf("int=%d\n", g.int)
	fmt.Printf("int8=%d\n", g.int8)
	fmt.Printf("printInt=%d\n", *g.printInt)
	fmt.Printf("float64=%f\n", g.float64)
	fmt.Printf("string=%s\n", g.string)
	fmt.Printf("bool=%t\n", g.bool)
	fmt.Printf("duration=%v\n", g.duration)
	fmt.Printf("defaultV=%s\n", g.defaultV)
	fmt.Printf("sub.x=%v\n", g.sub)
	fmt.Printf("subs=%v\n", g.subs)
	return nil
}
func main() {
	gone.Run(func(cemetery gone.Cemetery) error {
		_ = config.Priest(cemetery)
		cemetery.Bury(&UseConfig{})
		return nil
	})
}

# 4. 运行

go mod tidy
go run main.go

运行结果如下：

int=10
int8=-126
printInt=130
float64=10.222000
string=config test
bool=true
duration=10h0m0s
defaultV=ok
sub.x=&{100x 200y}
subs=[{0000x 0000y} {1111x 1111y}]

# 配置注入

从例子中可以看到，配置项也可以通过“依赖注入”到Goner。

# 使用的标签格式

配置注入的标签格式如下：

gone:"config,${key},default=${defaultValue}"

其中含义如下:

标签名依然为gone
config为固定值，表示该属性为配置
${key}为配置在配置文件中的key
default=${defaultValue}用于指定默认值，可以省略；${defaultValue}为默认值；如果没有指定默认值；如果配置文件中缺少对应key，则会报错

# 支持注入的数据类型

在核心概念-Goner (opens new window)中，我们讲到Goner可以被注入到其他结构体的属性上；这里，配置作为一种特殊情况，也可以被注入到其他结构体的属性上，他的实现是通过的Vampire（吸血鬼） (opens new window)，如果感觉兴趣，可以看这部分源代码 (opens new window)。

属性支持的类型，列举如下：

基础类型
- 布尔型：bool
- 整数类型：int, int64, int32, int16, int8
- 非负整数类型：uint, uint64, uint32, uint16, uint8
- 浮点型：float64, float32
- 字符串类型：string

提示

整数类型和非负整数类型，需要注意数据结构表示的数的范围，数字过大可能会溢出；比如int8表示的范围是-128 ~ 127，如果用其接收一个大于127的配置就会发生溢出（配置128将得到-128）。

time.Duration 为方便时间的解析，支持了time.Duration类型的配置，可以使用下面的单位：
- ns 纳秒
- us 微秒
- ms 毫秒
- s 秒
- m 分钟
- h 小时

在例子中，my.conf.duration=10h单位为h，表示10个小时；1h10m10s则表示1小时10分10秒。

提示

实现采用的time.ParseDuration，所以可以参考：https://pkg.go.dev/time#ParseDuration (opens new window)

结构体类型在例子中，给出了配置结构体的类型，需要满足如下规则：
- 结构体中需要配置的属性为公开的，即大写字母打头
- 使用properties标签指定属性的名字
- 支持嵌套

说明：在例子中UseConfig的属性sub要读取的配置key为my.conf.sub；sub的类型为SubConf，标注了属性X的配置名为properties:"x"，那么sub.X的值将读取配置项my.conf.sub.x。

数组类型配置的注入支持Slice类型，Slice的元素目前只支持结构体、结构体的指针；配置的key形式如下：

${injectConfigkey}[${index}].${structAttributeName}

说明

${injectConfigkey}为待注入项的key
${index}为数组下标
${structAttributeName}为被注入结构体的属性上的properties标注的值

指针类型支持被注入属性的类型为指针。

# 配置文件

# 配置文件目录

配置文件存放的目录由三部分决定：

可执行文件和程序当前工作路径
相对配置目录相对配置目录默认是config，可以通过启动传参--conf $configDir来改变

举个例子，如果编译后的gone程序保存为/app/gone-app，我们进入/home/degfy目录运行：

cd /home/degfy/
/app/gone-app

并没有通过传参修改相对配置目录，那么该程序的配置目录为：

/app/config
/home/degfy/config

# 默认配置文件路径

沿用前面的例子，配置文件的路径为：

/app/config/default.properties
/home/degfy/config/default.properties 这个两个配置文件中的配置为默认配置，是不随环境改变而改变的。

# 环境相关配置文件路径

开发过程中，我们一般会分环境配置，一般情况会分为：

local 本地开发环境
dev 线上开发环境
test 线上测试环境
prod 生成环境

我们可以通过环境变量ENV或者在启动时传参--nev $env来指定当前环境，如果都没有设置，默认环境是local。沿用前面的例子，与环境相关的配置文件为：

/app/config/local.properties
/home/degfy/config/local.properties

# 配置加载的顺序

从前面，我们可以得知我们启动时会存在4个配置文件，他们的加载顺序如下：

/app/config/default.properties
/app/config/local.properties
/home/degfy/config/default.properties
/home/degfy/config/local.properties

如果这些配置文件中存在相同的配置项，后加载的值会先加载的值。也就是环境相关的配置会覆盖默认的配置，当前运行路径的配置会覆盖程序所在目录的配置。

最佳实践

将所有配置放到默认配置文件中；在环境相关配置文件中根据环境的需要进行覆盖；
配置的设计应该尽量少，推荐采用“约定优配置”思路来进行设计，尽量设计默认值；
为了使代码“开箱可用”，推荐在local.properties中设置完整的配置，让程序不需要任何其他的配置就能运行，让其他小伙伴clone代码后就能丝滑启动程序。

# 更多格式的配置文件

在v1.x版本，我们将github.com/spf13/viper封装为了 goner/viper，可以支持市面上大多数配置文件格式：.json、 .toml、 .yaml、 .yml、 .properties、 .props、 .prop、 .hcl、 .tfvars、 .dotenv、 .env、 .ini。

# 如何使用？

只需要使用gone_viper.Priest将相关的Goners提前注册到Gone：

func main() {
	gone.Run(func(cemetery gone.Cemetery) error {
		// 注册 viper 相关的 Goners
		_ = gone_viper.Priest(cemetery)
		_ = config.Priest(cemetery)
		cemetery.Bury(&UseConfig{})
		return nil
	})
}

# 相名不同后缀，只会读取一个

比如同时存在 default.json 和 default.toml，只会读取配置文件的后缀为 .json 的配置；配置文件读取顺序为：.json、 .toml、 .yaml、 .yml、 .properties、 .props、 .prop、 .hcl、 .tfvars、 .dotenv、 .env、 .ini。

# 配置文件读取顺序

${程序所在目录}/config/default.*
${程序所在目录}/config/${环境值}.*
${当前工作路径}/config/default.*
${当前工作路径}/config/${环境值}.*
${指定配置目录}/default.*
${指定配置目录}/${环境值}.*

# 设计思路

goner/config 的设计分成两部分，依赖注入部分和配置读取部分；依赖注入部分在goner/config/config.go中实现，配置读取部分做了接口抽象gone.Configure，方便后续扩展从其他介质读取配置，在goner/config中默认只支持读取.properties格式的配置文件。

github.com/spf13/viper为了能读取多种配置文件，引入了许多依赖，大多数情况不是必须的，我们不希望将这些依赖直接引入到goner/config包中。后续，我们还打算提供一些链接配置中心的组件。

← 如何使用内置Goners? 使用goner/gin提供Web服务 →