1
0
mirror of https://github.com/astaxie/beego.git synced 2024-12-23 15:50:49 +00:00

Add global instance for config module

This commit is contained in:
Ming Deng 2020-10-24 21:24:31 +08:00
parent 02234dc503
commit 45260e4119
2 changed files with 219 additions and 0 deletions

115
core/config/global.go Normal file
View File

@ -0,0 +1,115 @@
// Copyright 2020
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package config
import (
"github.com/astaxie/beego/core/logs"
)
// We use this to simply application's development
// for most users, they only need to use those methods
var globalInstance Configer
func init() {
// Ignore this error
err := InitGlobalInstance("ini", "config/app.conf")
if err != nil {
logs.Warn("init global config instance failed. If you donot use this, just ignore it. ", err)
}
}
// InitGlobalInstance will ini the global instance
// If you want to use specific implementation, don't forget to import it.
// e.g. _ import "github.com/astaxie/beego/core/config/etcd"
// err := InitGlobalInstance("etcd", "someconfig")
func InitGlobalInstance(name string, cfg string) error {
var err error
globalInstance, err = NewConfig(name, cfg)
return err
}
// support section::key type in given key when using ini type.
func Set(key, val string) error {
return globalInstance.Set(key, val)
}
// support section::key type in key string when using ini and json type; Int,Int64,Bool,Float,DIY are same.
func String(key string) (string, error) {
return globalInstance.String(key)
}
// get string slice
func Strings(key string) ([]string, error) {
return globalInstance.Strings(key)
}
func Int(key string) (int, error) {
return globalInstance.Int(key)
}
func Int64(key string) (int64, error) {
return globalInstance.Int64(key)
}
func Bool(key string) (bool, error) {
return globalInstance.Bool(key)
}
func Float(key string) (float64, error) {
return globalInstance.Float(key)
}
// support section::key type in key string when using ini and json type; Int,Int64,Bool,Float,DIY are same.
func DefaultString(key string, defaultVal string) string {
return globalInstance.DefaultString(key, defaultVal)
}
// get string slice
func DefaultStrings(key string, defaultVal []string) []string {
return globalInstance.DefaultStrings(key, defaultVal)
}
func DefaultInt(key string, defaultVal int) int {
return globalInstance.DefaultInt(key, defaultVal)
}
func DefaultInt64(key string, defaultVal int64) int64 {
return globalInstance.DefaultInt64(key, defaultVal)
}
func DefaultBool(key string, defaultVal bool) bool {
return globalInstance.DefaultBool(key, defaultVal)
}
func DefaultFloat(key string, defaultVal float64) float64 {
return globalInstance.DefaultFloat(key, defaultVal)
}
// DIY return the original value
func DIY(key string) (interface{}, error) {
return globalInstance.DIY(key)
}
func GetSection(section string) (map[string]string, error) {
return globalInstance.GetSection(section)
}
func Unmarshaler(prefix string, obj interface{}, opt ...DecodeOption) error {
return globalInstance.Unmarshaler(prefix, obj, opt...)
}
func Sub(key string) (Configer, error) {
return globalInstance.Sub(key)
}
func OnChange(key string, fn func(value string)) {
globalInstance.OnChange(key, fn)
}
func SaveConfigFile(filename string) error {
return globalInstance.SaveConfigFile(filename)
}

104
core/config/global_test.go Normal file
View File

@ -0,0 +1,104 @@
// Copyright 2020
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package config
import (
"os"
"testing"
"github.com/stretchr/testify/assert"
)
func TestGlobalInstance(t *testing.T) {
cfgStr := `
appname = beeapi
httpport = 8080
mysqlport = 3600
PI = 3.1415926
runmode = "dev"
autorender = false
copyrequestbody = true
session= on
cookieon= off
newreg = OFF
needlogin = ON
enableSession = Y
enableCookie = N
developer="tom;jerry"
flag = 1
path1 = ${GOPATH}
path2 = ${GOPATH||/home/go}
[demo]
key1="asta"
key2 = "xie"
CaseInsensitive = true
peers = one;two;three
password = ${GOPATH}
`
path := os.TempDir() + string(os.PathSeparator) + "test_global_instance.ini"
f, err := os.Create(path)
if err != nil {
t.Fatal(err)
}
_, err = f.WriteString(cfgStr)
if err != nil {
f.Close()
t.Fatal(err)
}
f.Close()
defer os.Remove(path)
err = InitGlobalInstance("ini", path)
assert.Nil(t, err)
val, err := String("appname")
assert.Nil(t, err)
assert.Equal(t, "beeapi", val)
val = DefaultString("appname__", "404")
assert.Equal(t, "404", val)
vi, err := Int("httpport")
assert.Nil(t, err)
assert.Equal(t, 8080, vi)
vi = DefaultInt("httpport__", 404)
assert.Equal(t, 404, vi)
vi64, err := Int64("mysqlport")
assert.Nil(t, err)
assert.Equal(t, int64(3600), vi64)
vi64 = DefaultInt64("mysqlport__", 404)
assert.Equal(t, int64(404), vi64)
vf, err := Float("PI")
assert.Nil(t, err)
assert.Equal(t, 3.1415926, vf)
vf = DefaultFloat("PI__", 4.04)
assert.Equal(t, 4.04, vf)
vb, err := Bool("copyrequestbody")
assert.Nil(t, err)
assert.True(t, vb)
vb = DefaultBool("copyrequestbody__", false)
assert.False(t, vb)
vss := DefaultStrings("developer__", []string{"tom", ""})
assert.Equal(t, []string{"tom", ""}, vss)
vss, err = Strings("developer")
assert.Nil(t, err)
assert.Equal(t, []string{"tom", "jerry"}, vss)
}