kiyonlin / gopkg

some golang package encapsulations or useful utils

gopkg

some golang package encapsulations or useful utils

env

基于viper的包装

加载配置文件

配置文件支持JSON, TOML, YAML, HCL, 和 Java properties config files

// 不带后缀的配置文件名称
// 只有配置文件名称则使用当前路径
env.Load(configName, filePaths...)

读取配置文件里的值

使用

• Get(key string, defaultValue ...interface{}) : interface{} (是GetValue的别名)
• GetValue(key string, defaultValue ...interface{}) : interface{}

可以读取配置文件中的值。

可以提供一个默认值，当配置文件中没有提供key对应的值时，使用这个默认值。

也可以直接获取配置信息的具体类型(也支持设置默认值):

• GetBool(key string, defaultValue ...bool) : bool
• GetFloat64(key string, defaultValue ...float64) : float64
• GetInt(key string, defaultValue ...int) : int
• GetString(key string, defaultValue ...string) : string
• GetStringMap(key string, defaultValue ...map[string]interface{}) : map[string]interface{}
• GetStringMapString(key string, defaultValue ...map[string]string) : map[string]string
• GetStringSlice(key string, defaultValue ...[]string) : []string
• GetTime(key string, defaultValue ...time.Time) : time.Time
• GetDuration(key string, defaultValue ...time.Duration) : time.Duration

获取所有配置可以使用 AllSettings() : map[string]interface{}

例子

使用toml格式的配置文件

# This is a TOML document.

title = "TOML Example"

[database]
server = "192.168.1.1"
ports = [ 8001, 8001, 8002 ]
connection_max = 5000
enabled = true

GetString("title") // (returns "TOML Example")
GetString("database.server", "127.0.0.1") // (returns "192.168.1.1")
GetString("database.username", "root") // (returns "root")
GetString("database.password") // (returns "")

fileutil

文件操作工具

• FileExists(path string)判断文件是否存在
• EnsureDir(dirName string, mode ...os.FileMode)保证目录存在，可以自行指定文件mode
• FilePath(dirName, fileName string)根据路径和文件名生成文件路径，保证其存在

do

指定key一段时间内是否需要操作，可以设定过期时间

• ShouldDo(d time.Duration, key string)
• ShouldDof(d time.Duration, format string, v ...interface{}) key使用格式化
• SetExpires(t time.Time, key string)
• SetExpiresf(t time.Time, format string, v ...interface{}) key使用格式化
• Clear(key string)
• Clearf(format string, v ...interface{}) key使用格式化
• SyncDone(done chan<- struct{}) 非阻塞发送done消息

cacheutil

缓存工具

• StoreJson(v interface{}, cacheFilePath string)缓存结构体到指定json文件中
• LoadJson(v interface{}, cacheFilePath string)加载json文件内容到结构体中
• StoreGob(v interface{}, cacheFilePath string)缓存结构体到指定二进制文件中
• LoadGob(v interface{}, cacheFilePath string)加载二进制文件内容到结构体中