settings

README

配置文件

package main

import (
	`log`

	`github.com/aid297/aid/v2/settings`
	`github.com/aid297/aid/v2/str`
	`github.com/aid297/aid/v2/web-site/backend/aid-web-backend/src/global`
	`github.com/fsnotify/fsnotify`
	`github.com/spf13/viper`
)

func main() {
	var config any

	_, err := settings.APP.New(
		settings.Filename("local.yaml"),   // 文件名
		settings.EnvName("CONFIG"),        // 环境变量
		settings.DefaultName("test.yaml"), // 默认名
		settings.Content(&config),         // 获取配置文件
		settings.OnChange(func(v *viper.Viper, e fsnotify.Event) {
			log.Println("配置文件发生变化")
			if err := v.Unmarshal(&global.CONFIG); err != nil {
				global.LOG.Error(str.APP.Buffer.JoinString("更新配置文件失败：", err.Error()))
			}
		}),
	)
	if err != nil {
		panic(err)
	}
}

Documentation

Index

• Variables
• type AttrConfig
  • func Content(content any) AttrConfig
  • func (my AttrConfig) Register(settings *Setting)
• type AttrDefaultName
  • func DefaultName(name string) AttrDefaultName
  • func (my AttrDefaultName) Register(settings *Setting)
• type AttrEnvName
  • func EnvName(envName string) AttrEnvName
  • func (my AttrEnvName) Register(settings *Setting)
• type AttrFilename
  • func Filename(filename string) AttrFilename
  • func (my AttrFilename) Register(settings *Setting)
• type AttrOnChange
  • func OnChange(onChange func(v *viper.Viper, e fsnotify.Event)) AttrOnChange
  • func (my AttrOnChange) Register(settings *Setting)
• type Setting
  • func (my Setting) SetAttrs(attrs ...SettingAttributes) Setting
• type SettingAttributes

Variables

var (
	ErrConfigNotSet       = errors.New("配置文件路径未设置")
	ErrConfigFileNotFound = errors.New("配置文件未找到")
	ErrConfigReadFailed   = errors.New("读取配置文件失败")
)

var APP app

Types

type AttrConfig

type AttrConfig struct {
	// contains filtered or unexported fields
}

******************** 配置文件属性 ********************

func Content

func Content(content any) AttrConfig

func (AttrConfig) Register

func (my AttrConfig) Register(settings *Setting)

type AttrDefaultName

type AttrDefaultName struct {
	// contains filtered or unexported fields
}

******************** 配置文件属性 ********************

func DefaultName

func DefaultName(name string) AttrDefaultName

func (AttrDefaultName) Register

func (my AttrDefaultName) Register(settings *Setting)

type AttrEnvName

type AttrEnvName struct {
	// contains filtered or unexported fields
}

******************** 配置文件属性 ********************

func EnvName

func EnvName(envName string) AttrEnvName

func (AttrEnvName) Register

func (my AttrEnvName) Register(settings *Setting)

type AttrFilename

type AttrFilename struct {
	// contains filtered or unexported fields
}

******************** 配置文件属性 ********************

func Filename

func Filename(filename string) AttrFilename

func (AttrFilename) Register

func (my AttrFilename) Register(settings *Setting)

type AttrOnChange

type AttrOnChange struct {
	// contains filtered or unexported fields
}

******************** 配置文件属性 ********************

func OnChange

func OnChange(onChange func(v *viper.Viper, e fsnotify.Event)) AttrOnChange

func (AttrOnChange) Register

func (my AttrOnChange) Register(settings *Setting)

type Setting

type Setting struct {
	// contains filtered or unexported fields
}

******************** 配置文件 ******************** Setting

func (Setting) SetAttrs

func (my Setting) SetAttrs(attrs ...SettingAttributes) Setting

type SettingAttributes

type SettingAttributes interface{ Register(settings *Setting) }

******************** 配置文件属性 ********************