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>
274 lines
6.6 KiB
Go
274 lines
6.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_test
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/gogf/gf/v2/container/gmap"
|
|
"github.com/gogf/gf/v2/container/gtype"
|
|
"github.com/gogf/gf/v2/os/gcfg"
|
|
"github.com/gogf/gf/v2/os/gfile"
|
|
"github.com/gogf/gf/v2/test/gtest"
|
|
"github.com/gogf/gf/v2/util/guid"
|
|
)
|
|
|
|
func TestWatcher_File_Ctx(t *testing.T) {
|
|
gtest.C(t, func(t *gtest.T) {
|
|
var (
|
|
key1 = "test-ctx"
|
|
configFile = guid.S() + ".toml"
|
|
content1 = `key = "value1"`
|
|
content2 = `key = "value2"`
|
|
)
|
|
// Create config file.
|
|
err := gfile.PutContents(configFile, content1)
|
|
t.AssertNil(err)
|
|
defer gfile.RemoveFile(configFile)
|
|
|
|
// Create config instance.
|
|
c, err := gcfg.NewAdapterFile(configFile)
|
|
t.AssertNil(err)
|
|
c.Data(context.Background())
|
|
c.AddWatcher(key1, func(ctx context.Context) {
|
|
fileCtx := gcfg.GetAdapterFileCtx(ctx)
|
|
t.Assert(fileCtx.GetOperation(), gcfg.OperationWrite)
|
|
t.Assert(fileCtx.GetFileName(), configFile)
|
|
t.Assert(fileCtx.GetFilePath(), gfile.Abs(configFile))
|
|
})
|
|
gfile.PutContents(configFile, content2)
|
|
time.Sleep(1 * time.Second)
|
|
c.AddWatcher(key1, func(ctx context.Context) {
|
|
fileCtx := gcfg.GetAdapterFileCtx(ctx)
|
|
t.Assert(fileCtx.GetOperation(), gcfg.OperationSet)
|
|
t.Assert(fileCtx.GetKey(), "key")
|
|
t.Assert(fileCtx.GetValue().String(), "value2")
|
|
})
|
|
c.Set("key", "value2")
|
|
time.Sleep(1 * time.Second)
|
|
c.RemoveWatcher(key1)
|
|
})
|
|
}
|
|
|
|
func TestWatcher_AddWatcherAndNotify(t *testing.T) {
|
|
gtest.C(t, func(t *gtest.T) {
|
|
var (
|
|
m = gmap.NewStrAnyMap(true)
|
|
key1 = "test-watcher1"
|
|
key2 = "test-watcher2"
|
|
configFile = guid.S() + ".toml"
|
|
content1 = `key = "value1"`
|
|
content2 = `key = "value2"`
|
|
)
|
|
|
|
// Create config file.
|
|
err := gfile.PutContents(configFile, content1)
|
|
t.AssertNil(err)
|
|
defer gfile.RemoveFile(configFile)
|
|
|
|
// Create config instance.
|
|
c, err := gcfg.NewAdapterFile(configFile)
|
|
t.AssertNil(err)
|
|
m.Set(key1, true)
|
|
m.Set(key2, true)
|
|
|
|
// Add watchers.
|
|
c.AddWatcher(key1, func(ctx context.Context) {
|
|
m.Set(key1, false)
|
|
})
|
|
c.AddWatcher(key2, func(ctx context.Context) {
|
|
m.Set(key2, false)
|
|
})
|
|
|
|
// Check initial values.
|
|
t.Assert(c.MustGet(ctx, "key").String(), "value1")
|
|
t.Assert(m.Get(key1), true)
|
|
t.Assert(m.Get(key2), true)
|
|
|
|
// Update config file content.
|
|
err = gfile.PutContents(configFile, content2)
|
|
t.AssertNil(err)
|
|
|
|
// Wait for watching notification.
|
|
time.Sleep(1 * time.Second)
|
|
|
|
// Check updated values.
|
|
t.Assert(c.MustGet(ctx, "key").String(), "value2")
|
|
t.AssertEQ(m.Get(key1), false)
|
|
t.AssertEQ(m.Get(key2), false)
|
|
})
|
|
}
|
|
|
|
func TestWatcher_RemoveWatcher(t *testing.T) {
|
|
gtest.C(t, func(t *gtest.T) {
|
|
var (
|
|
m = gmap.NewStrAnyMap(true)
|
|
key1 = "test-watcher1"
|
|
key2 = "test-watcher2"
|
|
configFile = guid.S() + ".toml"
|
|
content1 = `key = "value1"`
|
|
content2 = `key = "value2"`
|
|
)
|
|
err := gfile.PutContents(configFile, content1)
|
|
t.AssertNil(err)
|
|
defer gfile.RemoveFile(configFile)
|
|
|
|
// Create config instance.
|
|
c, err := gcfg.NewAdapterFile(configFile)
|
|
t.AssertNil(err)
|
|
m.Set(key1, true)
|
|
m.Set(key2, true)
|
|
|
|
// Add watchers.
|
|
c.AddWatcher(key1, func(ctx context.Context) {
|
|
m.Set(key1, false)
|
|
})
|
|
c.AddWatcher(key2, func(ctx context.Context) {
|
|
m.Set(key2, false)
|
|
})
|
|
|
|
// Check initial values.
|
|
t.Assert(c.MustGet(ctx, "key").String(), "value1")
|
|
t.Assert(m.Get(key1), true)
|
|
t.Assert(m.Get(key2), true)
|
|
|
|
// Remove one watcher.
|
|
c.RemoveWatcher(key2)
|
|
|
|
// Update config file content.
|
|
err = gfile.PutContents(configFile, content2)
|
|
t.AssertNil(err)
|
|
|
|
// Wait for watching notification.
|
|
time.Sleep(1 * time.Second)
|
|
|
|
// Check updated values.
|
|
t.Assert(c.MustGet(ctx, "key").String(), "value2")
|
|
t.AssertEQ(m.Get(key1), false)
|
|
// watcherName2 should not be notified as it was removed
|
|
t.AssertEQ(m.Get(key2), true)
|
|
})
|
|
}
|
|
|
|
func TestWatcher_SetContentNotify(t *testing.T) {
|
|
gtest.C(t, func(t *gtest.T) {
|
|
var (
|
|
count = gtype.NewInt(0)
|
|
key = "test-watcher"
|
|
content1 = `key = "value1"`
|
|
content2 = `key = "value2"`
|
|
)
|
|
|
|
// Create config instance.
|
|
c, err := gcfg.NewAdapterContent(content1)
|
|
t.AssertNil(err)
|
|
|
|
// Add watcher.
|
|
c.AddWatcher(key, func(ctx context.Context) {
|
|
count.Add(1)
|
|
})
|
|
|
|
// Check initial values.
|
|
value, err := c.Get(ctx, "key")
|
|
t.AssertNil(err)
|
|
t.Assert(value, "value1")
|
|
t.Assert(count.Val(), 0)
|
|
|
|
// Set custom content.
|
|
c.SetContent(content2)
|
|
|
|
// Wait for watching notification.
|
|
time.Sleep(2 * time.Second)
|
|
|
|
// Check that watcher was notified
|
|
t.Assert(count.Val(), 1)
|
|
value2, err := c.Get(ctx, "key")
|
|
t.AssertNil(err)
|
|
t.Assert(value2, "value2")
|
|
})
|
|
}
|
|
|
|
func TestWatcher_RemoveContentNotify(t *testing.T) {
|
|
gtest.C(t, func(t *gtest.T) {
|
|
var (
|
|
count = gtype.NewInt(0)
|
|
key = "test-watcher"
|
|
configFile = guid.S() + ".toml"
|
|
content = `key = "value1"`
|
|
)
|
|
|
|
// Create config file.
|
|
err := gfile.PutContents(configFile, content)
|
|
t.AssertNil(err)
|
|
defer gfile.RemoveFile(configFile)
|
|
|
|
// Create config instance.
|
|
c, err := gcfg.NewAdapterFile(configFile)
|
|
t.AssertNil(err)
|
|
|
|
// Add watcher.
|
|
c.AddWatcher(key, func(ctx context.Context) {
|
|
count.Add(1)
|
|
})
|
|
|
|
// Check initial values.
|
|
t.Assert(c.MustGet(ctx, "key").String(), "value1")
|
|
t.Assert(count.Val(), 0)
|
|
|
|
// Remove custom content.
|
|
c.RemoveContent(configFile)
|
|
|
|
// Wait for watching notification.
|
|
time.Sleep(1 * time.Second)
|
|
|
|
// Check that watcher was notified again
|
|
t.Assert(count.Val(), 1)
|
|
t.Assert(c.MustGet(ctx, "key").String(), "value1") // Back to file content
|
|
})
|
|
}
|
|
|
|
func TestWatcher_ClearContentNotify(t *testing.T) {
|
|
gtest.C(t, func(t *gtest.T) {
|
|
var (
|
|
count = gtype.NewInt(0)
|
|
key = "test-watcher"
|
|
configFile = guid.S() + ".toml"
|
|
content = `key = "value1"`
|
|
)
|
|
|
|
// Create config file.
|
|
err := gfile.PutContents(configFile, content)
|
|
t.AssertNil(err)
|
|
defer gfile.RemoveFile(configFile)
|
|
|
|
// Create config instance.
|
|
c, err := gcfg.NewAdapterFile(configFile)
|
|
t.AssertNil(err)
|
|
|
|
// Add watcher.
|
|
c.AddWatcher(key, func(ctx context.Context) {
|
|
count.Add(1)
|
|
})
|
|
|
|
// Check initial values.
|
|
t.Assert(c.MustGet(ctx, "key").String(), "value1")
|
|
t.Assert(count.Val(), 0)
|
|
|
|
// Clear all custom content.
|
|
c.ClearContent()
|
|
|
|
// Wait for watching notification.
|
|
time.Sleep(1 * time.Second)
|
|
|
|
// Check that watcher was notified again
|
|
t.Assert(count.Val(), 1)
|
|
t.Assert(c.MustGet(ctx, "key").String(), "value1") // Back to file content
|
|
})
|
|
}
|