config

package

v0.1.9 Latest Latest Go to latest Published: Sep 18, 2022 License: MIT Imports: 16 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

Documentation ¶

Overview ¶

Package config provides functions while implemented by Viper and gcfg. See more on https://pkg.go.dev/github.com/spf13/viper

Example ¶

Use global unique config instance

package main

import (
	"fmt"

	"github.com/lovelacelee/clsgo/v1/config"
	"github.com/lovelacelee/clsgo/v1/utils"
)

func clean() {
	utils.DeletePath("logs")
	utils.DeleteFiles(utils.Cwd(), "/*.yaml$")
	utils.DeleteFiles(utils.Cwd(), "/*.xml$")
}

func main() {
	// import "github.com/lovelacelee/clsgo/config"
	config.Init("clsgo")
	fmt.Print(config.Cfg.Get("project.name"))
	clean()
}

Output:

clsgo

Index ¶

func ClsConfig(filename string, projectname string, monitoring bool) (cfg *viper.Viper)
func ClsConfigDefault(cfg Config, name string, gen bool) error
func Get(pattern string, def ...interface{}) (x *gvar.Var)
func GetBoolWithDefault(cfg string, def bool) bool
func GetDurationWithDefault(cfg string, def time.Duration) time.Duration
func GetFloat32WithDefault(cfg string, def float32) float32
func GetFloat64WithDefault(cfg string, def float64) float64
func GetInt64WithDefault(cfg string, def int64) int64
func GetIntSliceWithDefault(cfg string, def []int) []int
func GetIntWithDefault(cfg string, def int) int
func GetStringSliceWithDefault(cfg string, def []string) []string
func GetStringWithDefault(cfg string, def string) string
func Init(project string)
func JsonDecode(data interface{}, options ...Options) (interface{}, error)
func JsonDecodeTo(data interface{}, v interface{}, options ...Options) (err error)
func JsonEncode(value interface{}) ([]byte, error)
func JsonEncodeString(value interface{}) (string, error)
func JsonIsValidDataType(dataType string) bool
func JsonMarshal(v interface{}) (marshaledBytes []byte, err error)
func JsonMarshalIndent(v interface{}, prefix, indent string) (marshaledBytes []byte, err error)
func JsonMustEncode(value interface{}) []byte
func JsonMustEncodeString(value interface{}) string
func JsonUnmarshal(data []byte, v interface{}) (err error)
func JsonValid(data interface{}) bool
func XmlDecode(content []byte) (map[string]interface{}, error)
func XmlDecodeWithoutRoot(content []byte) (map[string]interface{}, error)
func XmlEncode(m map[string]interface{}, rootTag ...string) ([]byte, error)
func XmlEncodeWithIndent(m map[string]interface{}, rootTag ...string) ([]byte, error)
func XmlToJson(content []byte) ([]byte, error)
type Config
type Json
type JsonFile
- func (obj *JsonFile) Load(path string) error
- func (obj *JsonFile) Parse(model interface{}) error
- func (obj *JsonFile) Save(model interface{}, filepath string) error
- func (obj *JsonFile) String() string
type Options
type XML
- func NewXML() *XML
- func XMLFile(file ...string) *XML
- func XMLString(s ...string) *XML
- func (xml *XML) AddTitle(node string, attrs ...string) *XML
- func (xml *XML) CreateElement(tag string, path string, value string, comment string, attrs ...XMLAttr) *XMLElement
- func (xml *XML) Dump(prefix, suffix string)
- func (xml *XML) Find(fmt string) *XMLElement
- func (xml *XML) FindAll(fmt string) []*XMLElement
- func (xml *XML) Get(tag string) *XMLElement
- func (xml *XML) GetAll(tag string) []*XMLElement
- func (xml *XML) Save(filenamepath ...string) error
- func (xml *XML) String() string
type XMLAttr
type XMLElement
- func NewElement(tag string, value string, attrs ...XMLAttr) *XMLElement

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ClsConfig ¶

func ClsConfig(filename string, projectname string, monitoring bool) (cfg *viper.Viper)

Param: <monitoring> will start a routine to watch file changes, and reload it. and the goroutine never ends. If <monitoring> is true and <filename> config file not exist, it will be create by default. <filename> does not include extension.

Example ¶

package main

import (
	"fmt"

	"github.com/lovelacelee/clsgo/v1/config"
	"github.com/lovelacelee/clsgo/v1/utils"
)

func clean() {
	utils.DeletePath("logs")
	utils.DeleteFiles(utils.Cwd(), "/*.yaml$")
	utils.DeleteFiles(utils.Cwd(), "/*.xml$")
}

func main() {
	cfg := config.ClsConfig("server", "http", true)
	fmt.Print(cfg.Get("project.name"))
	clean()
}

Output:

http

func ClsConfigDefault ¶

func ClsConfigDefault(cfg Config, name string, gen bool) error

With all necessary nodes

func Get ¶

func Get(pattern string, def ...interface{}) (x *gvar.Var)

Functions implemented using goframe, gvar returned