Files
gf/os/gcfg/gcfg_ctx_keys.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

52 lines
1.9 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 "github.com/gogf/gf/v2/os/gctx"
// Context key constants for configuration operations.
const (
// ContextKeyFileName is the context key for file name
ContextKeyFileName gctx.StrKey = "fileName"
// ContextKeyFilePath is the context key for file path
ContextKeyFilePath gctx.StrKey = "filePath"
// ContextKeyFileType is the context key for file type
ContextKeyFileType gctx.StrKey = "fileType"
// ContextKeyOperation is the context key for operation type
ContextKeyOperation gctx.StrKey = "operation"
// ContextKeyKey is the context key for key
ContextKeyKey gctx.StrKey = "key"
// ContextKeyValue is the context key for value
ContextKeyValue gctx.StrKey = "value"
// ContextKeyContent is the context key for set content
ContextKeyContent gctx.StrKey = "content"
)
// OperationType defines the type for configuration operation.
type OperationType string
// Operation constants for configuration operations.
const (
// OperationSet represents set operation
OperationSet OperationType = "set"
// OperationWrite represents write operation
OperationWrite OperationType = "write"
// OperationRename represents rename operation
OperationRename OperationType = "rename"
// OperationRemove represents remove operation
OperationRemove OperationType = "remove"
// OperationCreate represents create operation
OperationCreate OperationType = "create"
// OperationChmod represents chmod operation
OperationChmod OperationType = "chmod"
// OperationClear represents clear operation
OperationClear OperationType = "clear"
// OperationUpdate represents update operation
OperationUpdate OperationType = "update"
)