env 中实现自定义 options 和 api

最新推荐文章于 2025-06-15 12:23:36 发布
原创 最新推荐文章于 2025-06-15 12:23:36 发布 · 918 阅读 · 13 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #前端 #数据库

env 这个库提供的 Parse() 使用的是默认参数

如果你需要自定义参数的话，env 这个库提供了一个 ParseWithOptions()，可以传入自定义的 options

Options 的参数有：

  • Environment：传入环境变量的 map，用来代替 os.Environment()
  • TagName：用来替代 env，json tag 默认是 env
  • PrefixTagName: 用来替代 envPrefix
  • DefaultValueTagName：用来替代 envDefault
  • RequiredIfNoDef：如果未声明 envDefault，则将所有 env 字段设置为必填
  • OnSet：允许在解析过程中插入钩子，并在设置值时执行某些操作
  • Prefix：被用于环境变量的前面
  • UseFieldNameByDefault：当 env 字段缺失是，是否应默认使用字段名称
  • FuncMap：自定义类型转换函数

如果传入自定义 options，ParseWithOptions() 函数需要完成 customOptions 和 defaultOptions 的合并

如果有传入的属性，需要使用传入的属性，如果没有传入的属性，就用默认的属性

options 合并交给了 mergeOptions 函数

go

代码解读

复制代码

func customOptions(opts Options) Options { defOpts := defaultOptions() mergeOptions[Options](&defOpts, &opts) return defOpts }

mergeOptions

mergeOptions 函数的作用是用来合并 defaultOptions 和 customOptions

接收两个参数 target、source，其中 target 是 defaultOptions，source 是 customOptions

把 defaultOptions 作为 target 是因为 defaultOptions 有所有的属性，如果 source 中某些属性有值，只需要把 target 中对应的值给更新了

主要的逻辑是：

  1. 如果 targetField 可以设置，并且 sourceField 不是零值，就把 sourceField 的值更新到 targetField
  2. 如果是 map 类型的字段，我们应该是合并 map，而不是替换 map
    1. 遍历 sourceFiled 的 map，将 sourceFiled 的每一项设置到 targetField

go

代码解读

复制代码

func mergeOptions(target, source *Option) { targetPtr := reflect.ValueOf(target).Elem() sourcePtr := reflect.ValueOf(source).Elem() targetType := targetPtr.Type() for i := 0; i < targetPtr.NumField(); i++ { targetField := targetPtr.Field(i) sourceField := sourcePtr.FieldByName(targetType.Field(i).Name) // 如果 targetField 可以设置，并且 sourceField 不是零值，就把 sourceField 的值更新到 targetField if targetField.CanSet() && !isZero(sourceField) { switch targetField.Kind() { case reflect.Map: // 遍历 sourceFiled 的 map，将 sourceFiled 的每一项设置到 targetField if !sourceField.IsZero() { iter := sourceField.MapRange() for iter.Next() { targetField.SetMapIndex(iter.Key(), iter.Value()) } } default: targetField.Set(sourceField) } } } }

零值判断

零值判断分为基本类型和引用类型

引用类型判断是不是 nil，基本类型用 reflect.Zero() 判断

go

代码解读

复制代码

func isZero(v reflect.Value) bool { switch v.Kind() { case reflect.Func, reflect.Map, reflect.Slice: return v.IsNil() default: zero := reflect.Zero(v.Type()) return v.Interface() == zero.Interface() } }

Environment 和 TagName

Environment 的作用是可以自己传入环境变量，会覆盖 os.Environment()

tagName 默认是 env，可以指定自己想要的 tag

go

代码解读

复制代码

func TestSetenvAndTagOptsChain(t *testing.T) { type config struct { Key1 string `mytag:"KEY1,required"` Key2 int `mytag:"KEY2,required"` } envs := map[string]string{ "KEY1": "VALUE1", "KEY2": "3", } cfg := config{} isNoErr(t, ParseWithOptions(&cfg, Options{TagName: "mytag", Environment: envs})) isEqual(t, "VALUE1", cfg.Key1) isEqual(t, 3, cfg.Key2) }

RequiredIfNoDef

RequiredIfNoDef 默认是 false，如果设置为 true，那么设置了 env tag 的字段是必传

go

代码解读

复制代码

func TestRequiredIfNoDefOption(t *testing.T) { type Tree struct { Fruit string `env:"FRUIT"` } type config struct { Name string `env:"NAME"` Genre string `env:"GENRE" envDefault:"Unknown"` Tree } var cfg config t.Run("missing", func(t *testing.T) { err := ParseWithOptions(&cfg, Options{RequiredIfNoDef: true}) isErrorWithMessage(t, err, `env: required environment variable "NAME" is not set; required environment variable "FRUIT" is not set`) isTrue(t, errors.Is(err, VarIsNotSetError{})) t.Setenv("NAME", "John") err = ParseWithOptions(&cfg, Options{RequiredIfNoDef: true}) isErrorWithMessage(t, err, `env: required environment variable "FRUIT" is not set`) isTrue(t, errors.Is(err, VarIsNotSetError{})) }) t.Run("all set", func(t *testing.T) { t.Setenv("NAME", "John") t.Setenv("FRUIT", "Apple") // should not trigger an error for the missing 'GENRE' env because it has a default value. isNoErr(t, ParseWithOptions(&cfg, Options{RequiredIfNoDef: true})) }) }

Prefix

prefix 指定的名字将用于环境变量的前面

go

代码解读

复制代码

func TestComplePrefix(t *testing.T) { type Config struct { Home string `env:"HOME"` } type ComplexConfig struct { Foo Config `envPrefix:"FOO_"` Clean Config Bar Config `envPrefix:"BAR_"` Blah string `env:"BLAH"` } cfg := ComplexConfig{} isNoErr(t, ParseWithOptions(&cfg, Options{ Prefix: "T_", Environment: map[string]string{ "T_FOO_HOME": "/foo", "T_BAR_HOME": "/bar", "T_BLAH": "blahhh", "T_HOME": "/clean", }, })) isEqual(t, "/foo", cfg.Foo.Home) isEqual(t, "/bar", cfg.Bar.Home) isEqual(t, "/clean", cfg.Clean.Home) isEqual(t, "blahhh", cfg.Blah) }

FuncMap

FuncMap 的作用是用于转换自定义类型

go

代码解读

复制代码

func TestParseCustomMapType(t *testing.T) { type custommap map[string]bool type config struct { SecretKey custommap `env:"SECRET_KEY"` } t.Setenv("SECRET_KEY", "somesecretkey:1") var cfg config isNoErr(t, ParseWithOptions(&cfg, Options{FuncMap: map[reflect.Type]ParserFunc{ reflect.TypeOf(custommap{}): func(_ string) (interface{}, error) { return custommap(map[string]bool{}), nil }, }})) } func TestParseMapCustomKeyType(t *testing.T) { type CustomKey string type config struct { SecretKey map[CustomKey]bool `env:"SECRET"` } t.Setenv("SECRET", "somesecretkey:1") var cfg config isNoErr(t, ParseWithOptions(&cfg, Options{FuncMap: map[reflect.Type]ParserFunc{ reflect.TypeOf(CustomKey("")): func(value string) (interface{}, error) { return CustomKey(value), nil }, }})) }

DefaultValueTagName

DefaultValueTagName：如果指定了 DefaultValueTagName 默认值将会从 DefaultValueTagName 指定的 json tag 中取，如果没有指定从 envDefault 中取

go

代码解读

复制代码

func TestParseWithOptionsRenamedDefault(t *testing.T) { type config struct { Str string `env:"STR" envDefault:"foo" myDefault:"bar"` } cfg := &config{} isNoErr(t, ParseWithOptions(cfg, Options{DefaultValueTagName: "myDefault"})) isEqual(t, "bar", cfg.Str) isNoErr(t, Parse(cfg)) isEqual(t, "foo", cfg.Str) }

PrefixTagName

PrefixTagName：如果指定了 PrefixTagName 用来替代 envPrefix

go

代码解读

复制代码

func TestParseWithOptionsRenamedPrefix(t *testing.T) { type Config struct { Str string `env:"STR"` } type ComplexConfig struct { Foo Config `envPrefix:"FOO_" myPrefix:"BAR_"` } t.Setenv("FOO_STR", "101") t.Setenv("BAR_STR", "202") t.Setenv("APP_BAR_STR", "303") cfg := &ComplexConfig{} isNoErr(t, ParseWithOptions(cfg, Options{PrefixTagName: "myPrefix"})) isEqual(t, "202", cfg.Foo.Str) isNoErr(t, ParseWithOptions(cfg, Options{PrefixTagName: "myPrefix", Prefix: "APP_"})) isEqual(t, "303", cfg.Foo.Str) isNoErr(t, Parse(cfg)) isEqual(t, "101", cfg.Foo.Str) }

UseFieldNameByDefault

UseFieldNameByDefault 如果没有指定 env，则默认使用字段名

go

代码解读

复制代码

func TestNoEnvKey(t *testing.T) { type Config struct { Foo string FooBar string HTTPPort int bar string } var cfg Config isNoErr(t, ParseWithOptions(&cfg, Options{ UseFieldNameByDefault: true, Environment: map[string]string{ "FOO": "fooval", "FOO_BAR": "foobarval", "HTTP_PORT": "10", }, })) isEqual(t, "fooval", cfg.Foo) isEqual(t, "foobarval", cfg.FooBar) isEqual(t, 10, cfg.HTTPPort) isEqual(t, "", cfg.bar) }

组合字段名

将字段名拼接成 HTTP_PORT 这样的格式

  1. unicode.IsUpper(c) 检查当前字符是不是大写
  2. rune(input[i+1]) 取出当前字符的下一个，rune(input[i-1]) 取出当前字符的上一个
  3. 如果当前字符是大写，并且前一个或者后一个字符是小写，那么应该用 _ 连接

go

代码解读

复制代码

const underscore rune = '_' func toEnvName(input string) string { var output []rune for i, c := range input { if c == underscore { continue } // if len(output) > 0 && unicode.IsUpper(c) { if len(input) > i+1 { peek := rune(input[i+1]) if unicode.IsLower(peek) || unicode.IsLower(rune(input[i-1])) { output = append(output, underscore) } } } output = append(output, unicode.ToUpper(c)) } return string(output) }

OnSet

允许在解析过程中插入钩子，并在设置值时执行某些操作

go

代码解读

复制代码

func TestHook(t *testing.T) { type config struct { Something string `env:"SOMETHING" envDefault:"important"` Another string `env:"ANOTHER"` Nope string Inner struct{} `envPrefix:"FOO_"` } cfg := &config{} t.Setenv("ANOTHER", "1") type onSetArgs struct { tag string key interface{} isDefault bool } var onSetCalled []onSetArgs isNoErr(t, ParseWithOptions(cfg, Options{ OnSet: func(tag string, value interface{}, isDefault bool) { onSetCalled = append(onSetCalled, onSetArgs{tag, value, isDefault}) }, })) isEqual(t, "important", cfg.Something) isEqual(t, "1", cfg.Another) isEqual(t, 2, len(onSetCalled)) isEqual(t, onSetArgs{"SOMETHING", "important", true}, onSetCalled[0]) isEqual(t, onSetArgs{"ANOTHER", "1", false}, onSetCalled[1]) }

导出 API

在我们之前学习的时候，我们已经知道了 Parse 和 ParseWithOptions 这两个函数，那么它还有其他什么函数吗

  • Parse：将 os.Environment() 中的环境变量解析成一个类型
  • ParseWithOptions：将当前的 os.Environment() 环境变量根据自定义 options 解析成一个类型
  • ParseAs：通过泛型，将 os.Environment() 中的环境变量解析成一个类型
  • ParseAsWithOptions：通过泛型，将当前的 os.Environment() 环境变量根据自定义 options 解析成一个类型
  • Must：如果解析出错，会 panic
  • GetFieldParams：获取 env 的解析项
  • GetFieldParamsWithOptions：通过自定义 options，获取 env 的解析项

ParseAs

ParseAs 函数的作用和 Prase 函数差不多

区别是 ParseAs 返回两个参数，一个是解析后的结构体，一个是 error，而 Parse 是通过指针的形式解析

go

代码解读

复制代码

func ParseAs[T any]() (T, error) { var t T err := Parse(&t) return t, err }

测试用例

go

代码解读

复制代码

type Conf struct { Foo string `env:"FOO" envDefault:"bar"` } func TestParseAs(t *testing.T) { config, err := ParseAs[Conf]() isNoErr(t, err) isEqual(t, "bar", config.Foo) } func TestMultipleTagOptions(t *testing.T) { type TestConfig struct { URL *url.URL `env:"URL,init,unset"` } t.Run("unset", func(t *testing.T) { cfg, err := ParseAs[TestConfig]() isNoErr(t, err) isEqual(t, &url.URL{}, cfg.URL) }) t.Run("empty", func(t *testing.T) { t.Setenv("URL", "") cfg, err := ParseAs[TestConfig]() isNoErr(t, err) isEqual(t, &url.URL{}, cfg.URL) }) t.Run("set", func(t *testing.T) { t.Setenv("URL", "https://github.com/caarlos0") cfg, err := ParseAs[TestConfig]() isNoErr(t, err) isEqual(t, &url.URL{Scheme: "https", Host: "github.com", Path: "/caarlos0"}, cfg.URL) isEqual(t, "", os.Getenv("URL")) }) }

ParseAsWithOptions

ParseAsWithOptions 函数和 ParseWithOptions 类似，区别是 ParseAsWithOptions 是将解析后的值通过返回值返回出来

go

代码解读

复制代码

func ParseAsWithOptions[T any](opts Options) (T, error) { var t T err := ParseWithOptions(&t, opts) return t, err }

测试用例

go

代码解读

复制代码

func TestParseAsWithOptions(t *testing.T) { config, err := ParseAsWithOptions[Conf](Options{ Environment: map[string]string{ "FOO": "not bar", }, }) isNoErr(t, err) isEqual(t, "not bar", config.Foo) }

Must

如果 err 不为 nil，则会触发 panic；否则返回 t

go

代码解读

复制代码

func Must[T any](t T, err error) T { if err != nil { panic(err) } return t }

测试用例

go

代码解读

复制代码

func TestMust(t *testing.T) { t.Run("error", func(t *testing.T) { defer func() { err := recover() isErrorWithMessage(t, err.(error), `env: required environment variable "FOO" is not set`) }() conf := Must(ParseAs[ConfRequired]()) isEqual(t, "", conf.Foo) }) t.Run("success", func(t *testing.T) { t.Setenv("FOO", "bar") conf := Must(ParseAs[ConfRequired]()) isEqual(t, "bar", conf.Foo) }) }

GetFieldParamsWithOptions 和 GetFieldParams

go

代码解读

复制代码

func GetFieldParams(v interface{}) ([]FieldParams, error) { return GetFieldParamsWithOptions(v, defaultOptions()) } func GetFieldParamsWithOptions(v interface{}, opts Options) ([]FieldParams, error) { var result []FieldParams err := parseInternal( v, func(_ reflect.Value, _ reflect.StructField, _ Options, fieldParams FieldParams) error { if fieldParams.OwnKey != "" { result = append(result, fieldParams) } return nil }, customOptions(opts), ) if err != nil { return nil, err } return result, nil }

测试用例

go

代码解读

复制代码

type FieldParamsConfig struct { Simple []string `env:"SIMPLE"` WithoutEnv string privateWithEnv string `env:"PRIVATE_WITH_ENV"` //nolint:unused WithDefault string `env:"WITH_DEFAULT" envDefault:"default"` Required string `env:"REQUIRED,required"` File string `env:"FILE,file"` Unset string `env:"UNSET,unset"` NotEmpty string `env:"NOT_EMPTY,notEmpty"` Expand string `env:"EXPAND,expand"` NestedConfig struct { Simple []string `env:"SIMPLE"` } `envPrefix:"NESTED_"` } func TestGetFieldParams(t *testing.T) { var config FieldParamsConfig params, err := GetFieldParams(&config) isNoErr(t, err) expectedParams := []FieldParams{ {OwnKey: "SIMPLE", Key: "SIMPLE"}, {OwnKey: "WITH_DEFAULT", Key: "WITH_DEFAULT", DefaultValue: "default", HasDefaultValue: true}, {OwnKey: "REQUIRED", Key: "REQUIRED", Required: true}, {OwnKey: "FILE", Key: "FILE", LoadFile: true}, {OwnKey: "UNSET", Key: "UNSET", Unset: true}, {OwnKey: "NOT_EMPTY", Key: "NOT_EMPTY", NotEmpty: true}, {OwnKey: "EXPAND", Key: "EXPAND", Expand: true}, {OwnKey: "SIMPLE", Key: "NESTED_SIMPLE"}, } isTrue(t, len(params) == len(expectedParams)) isTrue(t, areEqual(params, expectedParams)) }

Chainlit接入FastGpt接口快速实现自定义用户聊天界面
洛阳泰山的博客
08-21 2554
由于fastgpt只提供了一个分享用的网页应用，网页访问地址没法自定义，虽然可以接入等开源应用。但是如果我们想直接给客户应用，还需要客户去设置配置，里面还有很多我们不想展示给客户的东西怎么办？于是，我使用Chainlit实现了一个无缝快速接入fastgpt实现自定义用户使用界面的应用，代码清晰简单。还可以自定义logo、欢迎语、网站图标等。
【HPA】华为云CCE根据Prometheus Adapter 自定义custom和external业务指标，实现业务Pod自动扩缩容（更新：2024.4.1）
CN_Eden
04-01 807
到目前为止，我们准备好了Exporter、Prometheus、Adapter，接下来是最关键的一步，也是核心步骤，我们把他们串一起从上面原理图分析，可以得到下面的图。
Create-React-App .env文件自定义配置
jyn15159的博客
04-28 2708
React项目build打包时不生成 sourceMap（.map）文件 打包项目，主要的目的是为了，压缩代码，加快数据的传输，减少 http 请求，从而优化前端页面的性能。 脚手架，默认情况下，打包项目的过程中，都会生成 souceMap（.map）文件。 sourceMap 会增加打包以后的文件的体积，对于一些需求是轻量级的项目而言，sourceMap 有点多余。 添加.env文件修改变量 配置 node.js 运行时候的环境变量，传入 GENERATE_SOURCEMAP 值为 false。 1.
.env.development（开发环境）、.env.prodction（正式环境）、自定义环境
热门推荐
qq_42855675的博客
03-01 2万+
文章目录1.配置文件：2.命名规则3.关于文件的加载使用自定义环境 1.配置文件：       .env.development：开发环境下的配置文件       .env.production：生产环境下的配置文件 2.命名规则       属性必须以VUE_APP_开头。 #开发环境下的配置文件 VUE_APP_ENV=dev
vue使用process.env搭建自定义运行环境
GeniusXYT的博客
04-12 5114
一、vue-cli项目下默认有三种模式： development：在 vue-cli-service serve 时使用。 production：在 vue-cli-service build 和 vue-cli-service test:e2e 时使用。 test：在 vue-cli-service test:unit 时使用。 对应的 NODE_ENV 值分别为 development、production、test。 二、可以通过环境文件来指定环境变量，环境文件有一下几个类型： .env： 在所
VUE项目使用.env配置多种环境
櫆溟的博客
03-15 1万+
VUE项目使用.env配置多种环境
go template函数，变量等语法示例
学亮编程手记
08-29 1290
另外一种方式是使用创建自定义的函数,它创建一个全局的函数，可以在整个应用中使用。FuncMap通过将函数名映射到函数上。注意映射的函数必须只有一个返回值，或者有两个返回值但是第二个是error类型。123456789}},这个函数检查用户是否有某个权限，它会被保存在FuncMap中。注意自定义的函数必须在调用之前创建。这个函数在模板中的使用如下：1需要传入.User和feature-a参数。我们前面实现的自定义方法需要依赖.User。...
5、理解与自定义可浏览API功能
最新发布
2w3e4r5t6y的博客
06-15 37
本文详细介绍了Django REST框架中的可浏览API功能，包括如何使用它进行各种HTTP请求（GET、POST、PUT、OPTIONS、DELETE），以及其工作原理。同时，还探讨了如何自定义可浏览API的外观和功能，例如修改样式、添加JavaScript功能等。最后，分享了一些最佳实践，如使用环境变量配置和添加详细的错误信息，以提升API的安全性和用户体验。
plugable-dashboard:该仪表板可通过身份验证和自定义功能插入具有HTTP请求（CRUD）的任何api中
03-31
正在建设中。 合作！ 可插拔仪表板Api 路线图 形式 表格类型 切换|| 类型=开关 代码|| 类型=代码 杰森|| 类型= json 图片预览|| 类型=图像 上传文件 选择动态远程选项| type = dynamicSelect（多个= true） ...
pytest构建和测试FastAPI CURD API
止语的博客
06-06 1712
pytest FastAPI CRUD API REST API
Go-Golang模板语言和FuncMap功能的简单演示
08-13
Golang模板语言和FuncMap功能的简单演示
Vue中.env.development与.env.production环境自定义参数相关
qq_30255701的博客
06-10 2265
vue中有关.env;.env.development,.env.production的相关介绍 参考连接：https://blog.youkuaiyun.com/w405722907/article/details/94720868 https://www.cnblogs.com/song-zmin/p/11818918.html 1，关于文件名：必须以如下方式命名，不要乱起名，也无需专门手动控制加载哪个文件 .env 全局默认配置文件，不论什么环境都会加载合并 .env.development 开发环境下的配置文件
func map＜ T ＞ 闭包遍历(SwiftUI 中文文档手册 教程含源码）
iCloudEnd的博客
01-20 388
func map< T > 返回一个数组，其中包含在序列的元素上映射给定闭包的结果 func map<T>(_ transform: (Int) throws -> T) rethrows -> [T] 参考代码 在此示例中，首先使用映射将数组中的名称转换为小写字符串，然后计算其字符。 let cast = ["Vivien", "Marlon", "Kim", "Karl"] let lowercaseNames = cast.map { $0.lowercased(
env 设置自定义变量
coujia5571的博客
08-18 1416
export是将自定义变量变成系统环境变量； 如果一定要撤销一个已经export了的变量，那么有两种方法： unset VAR_NAME export VARNAME= 后一种就是在“＝”后边什么都不写链接:http:/...
golang 使用template funcmap的规则
weixin_30892037的博客
03-11 768
http://stackoverflow.com/questions/10199219/go-template-function http://stackoverflow.com/questions/15209236/multiple-templates-with-funcmap https://groups.google.com/forum/#!topic/golang-nuts/0Q-r_...
自定义process.env.NODE_ENV的值
高先生的猫
09-01 4541
项目初始化的时候，通常默认会有两个版本，开发环境和生产环境, 开发环境下：NODE_ENV=development(默认) 生产环境下：NODE_ENV=production(默认) 生产环境下，给测试测的时候，要请求测试环境的API；等测试环境没啥问题的时候，发布到正式，这时候要请求的API是正式环境的。那么生产环境下可能需要两种情况的打包命令，开发环境也一样（每次手动去改api，这样也可以，但是很累啊) 那么，我们可以在package.json中给NODE_ENV添加新值 vue-cli3初始化
内置函数 map(func,list) 的部分使用
dengxw00的博客
05-13 1123
1、map可以根据提供的函数对指定序列做映射，它接受一个函数f和一个list,并通过把函数f以此作用在list上的每个元素，然后返回一个新的list,map函数的入参也可以是多个.注意这个函数一定要有返回值。不然就会返回新的list 类似[None, None, None, None, None, None, None, None, None] 2、Python2 与 Python3 的使用区别...
C#自定义身份验证实现详解
资源摘要信息:"在软件开发领域中，'自定义身份'是一个重要的概念，它通常指的是创建可以满足特定应用程序需求的用户身份验证和授权机制。在.NET框架中，尤其是C#语言开发的环境中，'Custom Identity'通常是指对ASP...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值