Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
gcfg集成到了gf框架的单例管理器中,可以方便地通过 我们推荐使用单例模式获取配置管理对象。我们可以方便地通过g.Cfg()获取默认的全局配置管理对象。同时,我们也可以通过gcfg.Instance包方法获取配置管理对象单例。

使用g.

Config

Cfg

我们来看一个示例,演示如何读取全局配置的信息。需要注意的是,全局配置是与框架相关的,因此统一使用g.Cfg()进行获取。以下是一个默认的全局配置文件,包含了模板引擎的目录配置以及MySQL数据库集群(两台进行获取。以下是一个默认的全局配置文件,包含了模板引擎的目录配置以及MySQL数据库集群(两台master)的配置。

package main import ( "fmt" "

示例配置:

Code Block
languageyml
viewpath: "/home/www/templates/"
database:
  default:
  - link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
    role: "master"
  - link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
    role: "slave"

示例代码:

Code Block
languagego
package main

import (
	"fmt"

	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/os/gctx"
)

func main() {
	var ctx 
= gctx.New()
	fmt.Println(g.Cfg().
GetString
Get(ctx, "viewpath"))
	fmt.Println(g.Cfg().
GetString
Get(ctx, "database.default.0.
host
role"))
}

以上示例为读取数据库的第一个配置的role信息。运行后输出:

Code Block
languagehtml
以上示例为读取数据库的第一个配置的host信息。运行后输出:
/home/www/templates/
127.0.0.1
master

可以看到,我们可以通过g.Cfg()方法获取一个全局的配置管理器单例对象。配置文件内容可以通过英文“.”号进行层级访问(数组默认从0开始),”号进行层级访问(数组默认从0开始),pattern参数database.default.0.hostrole表示读取database配置项中default数据库集群中的第0项数据库服务器的hostrole数据。

使用gcfg.Instance

当然也可以独立使用gcfg包,通过Instance方法获取单例对象。

Code Block
languagego
package main

import (
	"fmt"

	"github.com/gogf/gf/v2/os/gcfg"
	"github.com/gogf/gf/v2/os/gctx"
)

func main() {
	var ctx = gctx.New()
	fmt.Println(gcfg.Instance().
GetString
Get(ctx, "viewpath"))
	fmt.Println(gcfg.Instance().
GetString
Get(ctx, "database.default.0.
host
role"))
}

注意事项

GF v1.12版本开始,为方便多文件场景下的配置文件调用,简便使用并提高开发效率,因此当给定的单例名称对应的toml配置文件在配置目录中存在时,将自动设置该单例对象的默认配置文件为该文件。

自动检索特性

单例对象在创建时会按照文件后缀toml/yaml/yml/json/ini/xml/properties自动检索配置文件。默认情况下会自动检索配置文件config.toml/yaml/yml/json/ini/xml/properties并缓存,配置文件在外部被修改时将会自动刷新缓存。

为方便多文件场景下的配置文件调用,简便使用并提高开发效率,单例对象在创建时将会自动使用单例名称进行文件检索。例如:例如:g.Cfg("redis")获取到的单例对象将会默认去检索会自动检索获取到的单例对象将默认会自动检索redis.tomlredis.yamlredis.jsonredis.iniredis.xml/yaml/yml/json/ini/xml/properties,如果检索成功那么将该文件加载到内存缓存中,下一次将会直接从内存中读取;当该文件不存在时,则使用默认的配置文件(config.toml)。



Panel
titleContent Menu

Table of Contents