viperKit

Documentation

Overview

Package viperKit

支持的配置文件格式（详见viper.go）: "yaml", "yml", "json", "toml", "hcl", "tfvars", "dotenv", "env", "properties", "props", "prop", "ini"

Index

• func GetContentType(path string) string
• func IsContentTypeSupported(contentType string) bool
• func MarshalToFile(obj interface{}, target string) error
• func PolyfillContentType(contentType string) string
• func Read(data []byte, configType string, defaultMap map[string]interface{}) (*viper.Viper, error)
• func ReadFile(filePath string, defaultMap map[string]interface{}) (*viper.Viper, error)
• func Unmarshal(content []byte, configType string, defaultMap map[string]interface{}, ...) (*viper.Viper, error)
• func UnmarshalFromData(data *Data, defaultMap map[string]interface{}, ptr interface{}) (*viper.Viper, error)
• func UnmarshalFromFile(filePath string, defaultMap map[string]interface{}, ptr interface{}) (*viper.Viper, error)
• func UnmarshalProperties(content []byte, ptr interface{}) error
• type Data
  • func NewDataFromFile(path string) (*Data, error)

Functions

func GetContentType

func GetContentType(path string) string

func IsContentTypeSupported

func IsContentTypeSupported(contentType string) bool

IsContentTypeSupported

@param extName "json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "tfvars", "dotenv", "env", "ini"

func MarshalToFile

func MarshalToFile(obj interface{}, target string) error

MarshalToFile

Deprecated: 不建议用此方法， (1) 转换为 .yaml 还是用 yamlKit 吧;

(2) 转换为 .properties 有问题.

@param obj 如果为nil，将返回error

func PolyfillContentType

func PolyfillContentType(contentType string) string

PolyfillContentType

e.g.

extname := ".JSON"
fmt.Println(viperKit.PolyfillContentType(extname)) // "json"

@param extName "json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "tfvars", "dotenv", "env", "ini"

func Read

func Read(data []byte, configType string, defaultMap map[string]interface{}) (*viper.Viper, error)

func ReadFile

func ReadFile(filePath string, defaultMap map[string]interface{}) (*viper.Viper, error)

func Unmarshal

func Unmarshal(content []byte, configType string, defaultMap map[string]interface{}, ptr interface{}) (*viper.Viper, error)

Unmarshal 读取配置文本内容，并反序列化.

@param configType 配置文件的类型（不区分大小写，详见viper.go）："yaml", "yml", "json", "toml", "hcl", "tfvars", "dotenv", "env", "properties", "props", "prop", "ini" @param defaultMap 默认值，可以为nil @param ptr 指针，且不能为nil

func UnmarshalFromData

func UnmarshalFromData(data *Data, defaultMap map[string]interface{}, ptr interface{}) (*viper.Viper, error)

func UnmarshalFromFile

func UnmarshalFromFile(filePath string, defaultMap map[string]interface{}, ptr interface{}) (*viper.Viper, error)

UnmarshalFromFile 读取配置文件，并反序列化.

Deprecated: 反序列化.yaml文件，先用 yamlKit.UnmarshalFromFile 替换 viperKit.UnmarshalFromFile，原因: https://github.com/spf13/viper/issues/1769

PS: (1) 配置文件 和 defaultMap 中，key首字母的大小写无所谓，都支持； (2) 支持配置文件的格式：JSON, TOML, HCL, .env, .yaml, .properties.

@param filePath 配置文件的路径（绝对路径 和 相对路径 都支持），内部会判断文件是否存在 @param defaultMap （可以为nil） 默认值；key如果有多层的话，用"."分隔，e.g. "WoService.LowerLimit" @param ptr （不能为nil） 指针

func UnmarshalProperties

func UnmarshalProperties(content []byte, ptr interface{}) error

UnmarshalProperties Deprecated: 反序列化后，key中的大写字母会被转换为小写字母.

Types

type Data

type Data struct {
	// Content 配置文件的内容
	Content []byte `json:"data" yaml:"data"`

	// Type 配置文件的类型，"yaml", "yml", "json", "toml", "hcl", "tfvars", "dotenv", "env", "properties", "props", "prop", "ini"
	Type string `json:"type" yaml:"type"`
}

Data 配置文件的数据.

func NewDataFromFile

func NewDataFromFile(path string) (*Data, error)