mirror of
https://gitee.com/johng/gf
synced 2026-06-06 16:21:40 +08:00
ac3efe5a00
为`gcfg`添加配置文件变更自定义回调，实现了`WatcherAdapter`接口，以下是`AdapterFile`的用法
test.yaml
```
b: "b"
```
```
package main
import (
"fmt"
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/os/gcfg"
"github.com/gogf/gf/v2/os/gctx"
)
func main() {
ctx := gctx.New()
file, _ := gcfg.NewAdapterFile("test.yaml")
file.Data(ctx)
file.AddWatcher("test", func() {
value := file.MustGet(ctx, "b")
fmt.Println(value.String())
})
server := g.Server()
server.Run()
}
```
使用`g`和默认配置文件
```
file := g.Cfg().GetAdapter().(*gcfg.AdapterFile)
file.AddWatcher("test", func() {
})
file := g.Cfg().GetAdapter().(*gcfg.AdapterFile)
file.RemoveWatcher("test")
```
注意：由于`gf`的`AdapterFile`使用的监听到文件变化删除缓存下一次重新初始化的懒加载方案，所有除了默认加载的`config.xxx`文件外，自定义的配置文件像`test.yaml`之类的都需要在`AddWatcher`前主动读取一次数据进行初始化监听(
`g.Cfg("test").Data(ctx)`)
---------
Co-authored-by: hailaz <739476267@qq.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Hunk Zhu <hunk@joy999.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
41 lines
1.6 KiB
Go
41 lines
1.6 KiB
Go
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
package gcfg
|
|
|
|
import "context"
|
|
|
|
// Adapter is the interface for configuration retrieving.
|
|
type Adapter interface {
|
|
// Available checks and returns the backend configuration service is available.
|
|
// The optional parameter `resource` specifies certain configuration resource.
|
|
//
|
|
// Note that this function does not return error as it just does simply check for
|
|
// backend configuration service.
|
|
Available(ctx context.Context, resource ...string) (ok bool)
|
|
|
|
// Get retrieves and returns value by specified `pattern` in current resource.
|
|
// Pattern like:
|
|
// "x.y.z" for map item.
|
|
// "x.0.y" for slice item.
|
|
Get(ctx context.Context, pattern string) (value any, err error)
|
|
|
|
// Data retrieves and returns all configuration data in current resource as map.
|
|
// Note that this function may lead lots of memory usage if configuration data is too large,
|
|
// you can implement this function if necessary.
|
|
Data(ctx context.Context) (data map[string]any, err error)
|
|
}
|
|
|
|
// WatcherAdapter is the interface for configuration watcher.
|
|
type WatcherAdapter interface {
|
|
// AddWatcher adds a watcher function for specified `pattern` and `resource`.
|
|
AddWatcher(name string, fn func(ctx context.Context))
|
|
// RemoveWatcher removes the watcher function for specified `pattern` and `resource`.
|
|
RemoveWatcher(name string)
|
|
// GetWatcherNames returns all watcher names.
|
|
GetWatcherNames() []string
|
|
}
|