config

README

config

Package config is a Configuration file parser for INI format

包 config 是一个简洁方的,支持注释的Go语言配置文件解析器,类似于Windows下的INI文件.

配置文件形式为[section] 的节构成, 内部使用 name=value键值对 如果没有指定节,则默认放入名为[default]的节当中. "#"或";" 为注释的开头,可以放置于任意的单独一行中.

安装

    go get github.com/lxmgo/config

示例

请查看 conf.ini 文件作为使用示例

使用规范

配置文件支持 section 操作，key通过 section::key 的方式获取 示例配置文件:

    host = act.wiki
    port = 8080
    f64 = 64.1
    
    [mysql]
    mysql.dev.host = 127.0.0.1
    mysql.master.host = 114.114.114.114
    [mongodb]
    mongodb.dev.host = 127.0.0.2
    mongodb.master.host = 10.1.1.1
    mongodb.relase.host = 192.168.1.1
    [redis]
    redis.host = 127.0.0.3
    redis.key = key1,key2,key3
    [memcache]
    host = 127.0.0.4

加载配置文件:

    config, err := NewConfig("testdata/testini.ini")
    c.String("host")
    // result is string "act.wiki"
    
    c.Int64("port")
    // result is int64 8080
    
    c.Float64("f64")
    // result is float64 64.1
            
    c.String("mysql::mysql.dev.host")
    // result is string "127.0.0.1"
    
    c.String("mysql::mysql.master.host")
    // result is string "114.114.114.114"
    
    c.Strings("redis::redis.key")
    // result is []string{"key1","key2","key3"}
    
    c.String("memcache::host")
    // result is string "127.0.0.4"

config APIS:

    String(key string) string
    Strings(key string) []string
    Bool(key string) (bool, error)
    Int(key string) (int, error)
    Int64(key string) (int64, error)
    Float64(key string) (float64,error)
    Set(key string, value string) error

更多信息

• 所有字符解析均使用小写的!

Documentation

Index

• Variables
• type Config
  • func (c *Config) AddConfig(section string, option string, value string) bool
  • func (c *Config) Bool(key string) (bool, error)
  • func (c *Config) Float64(key string) (float64, error)
  • func (c *Config) Int(key string) (int, error)
  • func (c *Config) Int64(key string) (int64, error)
  • func (c *Config) Set(key string, value string) error
  • func (c *Config) String(key string) string
  • func (c *Config) Strings(key string) []string
• type ConfigInterface
  • func NewConfig(confName string) (ConfigInterface, error)

Variables

var (
	DEFAULT_SECTION     = "default"
	DEFAULT_COMMENT     = []byte{'#'}
	DEFAULT_COMMENT_SEM = []byte{';'}
)

Types

type Config

type Config struct {
	// map is not safe.
	sync.RWMutex
	// contains filtered or unexported fields
}

func (*Config) AddConfig

func (c *Config) AddConfig(section string, option string, value string) bool

AddConfig adds a new section->key:value to the configuration.

func (*Config) Bool

func (c *Config) Bool(key string) (bool, error)

func (*Config) Float64

func (c *Config) Float64(key string) (float64, error)

func (*Config) Int

func (c *Config) Int(key string) (int, error)

func (*Config) Int64

func (c *Config) Int64(key string) (int64, error)

func (*Config) Set

func (c *Config) Set(key string, value string) error

func (*Config) String

func (c *Config) String(key string) string

func (*Config) Strings

func (c *Config) Strings(key string) []string

type ConfigInterface

type ConfigInterface interface {
	String(key string) string
	Strings(key string) []string
	Bool(key string) (bool, error)
	Int(key string) (int, error)
	Int64(key string) (int64, error)
	Float64(key string) (float64, error)
	Set(key string, value string) error
}

func NewConfig

func NewConfig(confName string) (ConfigInterface, error)

NewConfig create an empty configuration representation.