mengpo

README

mengpo（孟婆）

Golang默认值设置工具，支持功能

• 支持近乎所有的内置类型
  • int
  • int8
  • int32
  • int64
  • uint
  • uint8
  • uint32
  • uint64
  • bool
  • float32
  • float64
• 支持复杂类型
  • slice
  • map
  • struct
• 支持配置
  • 配置所使用的tag名称
• 支持复杂结构初始化值
  • 支持json初始化值设置
  • 支持更易于书写的初始化值
• 支持类型别名
• 支持指针类型
• 默认支持环境变量
• 支持完整的生命周期方法
  • Before

为什么要叫孟婆

按照本人的一惯作风，所有项目都在中国古代神话人物或者历史名人寻找和项目意义相近的神话人物或者历史人来做作为项目的名称，原因

• 去TMD崇洋媚外
• 致敬中华民族的先贤

孟婆作为阴司掌管生死轮回的大神，有将一切人物还原到最被的状态，这和设置默认值不谋而和，故而使用孟婆来命名项目是合适的

鸿蒙初开，世间分为天地人三界，天界最大掌管一切，人间即所谓的阳世人界，地即为阴曹地府。三界划定，无论天上地下，神仙阴官，俱都各司其职。孟婆从三界分开时便已在世上，她本为天界的一个散官。后因看到世人恩怨情仇无数，即便死了也不肯放下，就来到了阴曹地府的忘川河边，在奈何桥的桥头立起一口大锅，将世人放不下的思绪炼化成了孟婆汤让阴魂喝下，便忘记了生前的爱恨情仇，卸下了生前的包袱，走入下一个轮回。颇有中国传统思想中“人死如云散”，“一死百了”，“莫记已死之人恩怨”之类的意味。

使用方法

安装

安装非常简单，推荐使用go.mod来使用孟婆

package main

import `github.com/storezhang/mengpo`

func main() {
    // xxx
}

或者

go get github.com/storezhang/mengpo

简单使用

使用非常简单，只需要调用mengpo.Set就可以了

package main

import `github.com/storezhang/mengpo`

type testByNormal struct {
    Addr string `default:"127.0.0.1"`
    Port int    `default:"80"`
}

func main() {
    normal := new(testByNormal)
    if err := mengpo.Set(normal); nil != err {
        panic(err)
    }
}

配置标签

可以很方便的使用其它标签，方法

package main

import `github.com/storezhang/mengpo`

type testByTag struct {
    Addr string `test:"127.0.0.1"`
    Port int    `test:"80"`
}

func main() {
    tag := new(testByTag)
    if err := mengpo.Set(tag, mengpo.Tag(`test`)); nil != err {
        panic(err)
    }
}

配置复杂类型

可以使用json来配置复杂的类型，比如

• map
• slice
• struct

json写法支持使用单引号'来替换转义字符\"，这样在书写默认值json更容易

package main

import `github.com/storezhang/mengpo`

type testByJson struct {
    Orders []string `default:"['mqtts', 'mqtt', 'wss', 'ws']"`
    // 同样支持这样写
    // Orders []string `default:"[\"mqtts\", \"mqtt\", \"wss\", \"ws\"]"`
}

func main() {
    json := new(testByJson)
    if err := mengpo.Set(json); nil != err {
        panic(err)
    }
}

使用环境变量

孟婆支持使用环境变量来配置默认值

package main

import `github.com/storezhang/mengpo`

type testByEnv struct {
    Order string `default:"${ORDER}"`
    // 同样支持这种写法
    // Order string `default:"$ORDER"`
}

func main() {
    env := new(testByEnv)
    if err := mengpo.Set(env); nil != err {
        panic(err)
    }
}

配置生命周期方法

孟婆可以很方便的配置生命周期方法（生命周期方法都有默认实现），从而达到更大的扩展性

Before

Before在取出配置的默认值字符串后，进行默认值替换前被调用

package main

import `github.com/storezhang/mengpo`

type testByBefore struct {
    Order string `default:"${ORDER}"`
    // 同样支持这种写法
    // Order string `default:"$ORDER"`
}

func main() {
    env := new(testByBefore)
    if err := mengpo.Set(env, mengpo.Before(func(original string) string {
        return original
    })); nil != err {
        panic(err)
    }
}

注意，默认的Before方法是调用系统方法os.ExpandEnv解析环境变量

Documentation

Index

• func Before(before beforeFunc) *optionBefore
• func Set(ptr interface{}, opts ...option) (err error)
• func Settable(ptr interface{}) bool
• func Tag(tag string) *optionTag

Functions

func Before

func Before(before beforeFunc) *optionBefore

Before 配置生命周期前的操作

func Set

func Set(ptr interface{}, opts ...option) (err error)

Set 设置默认值

func Settable

func Settable(ptr interface{}) bool

Settable 是否可被设置默认值

func Tag

func Tag(tag string) *optionTag

Tag 配置标签