Files
gf/os/gcfg/gcfg_adapter_content_ctx.go
Lance Add ac3efe5a00 feat(os/gcfg): Add file watcher with custom callback support (#4446)
为`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>
2025-10-15 16:59:52 +08:00

75 lines
2.3 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 provides reading, caching and managing for configuration.
package gcfg
import (
"context"
)
// AdapterContentCtx is the context for AdapterContent.
type AdapterContentCtx struct {
// Ctx is the context with configuration values
Ctx context.Context
}
// NewAdapterContentCtxWithCtx creates and returns a new AdapterContentCtx with the given context.
func NewAdapterContentCtxWithCtx(ctx context.Context) *AdapterContentCtx {
if ctx == nil {
ctx = context.Background()
}
return &AdapterContentCtx{Ctx: ctx}
}
// NewAdapterContentCtx creates and returns a new AdapterContentCtx.
// If ctx is provided, it uses that context, otherwise it creates a background context.
func NewAdapterContentCtx(ctx ...context.Context) *AdapterContentCtx {
if len(ctx) > 0 {
return NewAdapterContentCtxWithCtx(ctx[0])
}
return NewAdapterContentCtxWithCtx(context.Background())
}
// GetAdapterContentCtx creates and returns an AdapterContentCtx with the given context.
func GetAdapterContentCtx(ctx context.Context) *AdapterContentCtx {
return NewAdapterContentCtxWithCtx(ctx)
}
// WithOperation sets the operation in the context and returns the updated AdapterContentCtx.
func (a *AdapterContentCtx) WithOperation(operation OperationType) *AdapterContentCtx {
a.Ctx = context.WithValue(a.Ctx, ContextKeyOperation, operation)
return a
}
// WithContent sets the content in the context and returns the updated AdapterContentCtx.
func (a *AdapterContentCtx) WithContent(content string) *AdapterContentCtx {
a.Ctx = context.WithValue(a.Ctx, ContextKeyContent, content)
return a
}
// GetOperation retrieves the operation from the context.
// Returns empty string if not found.
func (a *AdapterContentCtx) GetOperation() OperationType {
if v := a.Ctx.Value(ContextKeyOperation); v != nil {
if s, ok := v.(OperationType); ok {
return s
}
}
return ""
}
// GetContent retrieves the content from the context.
// Returns empty string if not found.
func (a *AdapterContentCtx) GetContent() string {
if v := a.Ctx.Value(ContextKeyContent); v != nil {
if s, ok := v.(string); ok {
return s
}
}
return ""
}