xgodbconfig

Documentation

Overview

数据库配置的读写支持

Index

• func GetBool(name string) bool
• func GetFloat(name string) float64
• func GetInt(name string) int64
• func GetSelect(name string) string
• func GetString(name string) string
• func GetUserConfig(uid uint, conf any) error
• func GroupInserts(g []ConfigureGroup) error
• func InsertsOrContinue(confs []Configure) error
• func Regedit(c *Config)
• func SetBool(name string, val bool) error
• func SetFloat(name string, val float64) error
• func SetInt(name string, val int64) error
• func SetLongText(name, val string) error
• func SetSelect(name, val string) error
• func SetString(name, val string) error
• func SetText(name, val string) error
• func SetUserConfigure(uid uint, conf any) error
• type Config
• type Configure
  • func Getconfigure(name string) Configure
  • func List(group string) ([]Configure, error)
  • func (c *Configure) TableName() string
• type ConfigureGroup
  • func GroupList(fid uint) ([]ConfigureGroup, error)
  • func (c *ConfigureGroup) TableName() string
• type ConfigureUser
  • func (c *ConfigureUser) TableName() string

Functions

func GetBool

func GetBool(name string) bool

获取开关值

name	要获取的配置项的配置下标

func GetFloat

func GetFloat(name string) float64

获取浮点数值

name	要获取的配置项的配置下标

func GetInt

func GetInt(name string) int64

读取配置项的值

name	要获取的配置项的配置下标

func GetSelect

func GetSelect(name string) string

获取select下拉列表

name	要获取的配置项的配置下标

func GetString

func GetString(name string) string

获取string值的配置

name	要获取的配置项的配置下标

func GetUserConfig

func GetUserConfig(uid uint, conf any) error

获取个人配置项

uid		用户ID
conf	配置项（采用json读取的方式进行反向解析，所以此处请使用指针进行获取）

func GroupInserts

func GroupInserts(g []ConfigureGroup) error

插入配置项分组信息[一定要指定ID，此处不进行ID自增和ID返回操作，需要手动指定配置组的ID，以便进行无限分类获取]

g	待插入的分组列表信息

func InsertsOrContinue

func InsertsOrContinue(confs []Configure) error

设置配置项(批量插入)，若存在则跳过该配置项

confs	待插入的配置项列表

func Regedit

func Regedit(c *Config)

注入配置项

func SetBool

func SetBool(name string, val bool) error

设置bool类型配置

name	配置项的名称
val		配置项的值

func SetFloat

func SetFloat(name string, val float64) error

设置float类型配置

name	配置项的名称
val		配置项的值

func SetInt

func SetInt(name string, val int64) error

设置int类型配置

name	配置项的名称
val		配置项的值

func SetLongText

func SetLongText(name, val string) error

设置longtext类型配置 下拉列表，多项使用,分割key和key_cn使用:分割

name	配置项的名称
val		配置项的值

func SetSelect

func SetSelect(name, val string) error

设置select类型配置 下拉列表，多项使用,分割key和key_cn使用:分割

name	配置项的名称
val		配置项的值

func SetString

func SetString(name, val string) error

设置string类型配置

name	配置项的名称
val		配置项的值

func SetText

func SetText(name, val string) error

设置text类型配置 下拉列表，多项使用,分割key和key_cn使用:分割

name	配置项的名称
val		配置项的值

func SetUserConfigure

func SetUserConfigure(uid uint, conf any) error

写入个人配置项

uid		用户ID
conf	配置项（采用json读取的方式进行反向解析，所以此处请使用指针进行获取）

Types

type Config

type Config struct {
	DB                  *gorm.DB
	ConfigTable         string                  // 配置表名称
	ConfigUserTable     string                  // 用户配置存储表
	ConfigureGroupTable string                  // 配置项分组表表明
	Lock                sync.Mutex              // 缓存锁
	Cache               map[string]Configure    // 缓存配置项
	CacheUser           map[uint]string         // 用户配置项
	ConfigEdit          func(name string) error // 配置项修改的回调函数
}

数据库相关配置

type Configure

type Configure struct {
	Id        uint   `gorm:"column:id;primaryKey;type:INT UNSIGNED;not null;autoIncrement" json:"id" form:"id"`
	NameKey   string `gorm:"column:name_key;type:varchar(100);unique;comment:配置项key" json:"name_key" form:"name_key"`    //配置项key
	NameCn    string `gorm:"column:name_cn;type:varchar(200);comment:配置项名称" json:"name_cn" form:"name_cn"`               //配置项名称
	NameGroup string `gorm:"column:name_group;type:varchar(100);index;comment:配置项组" json:"name_group" form:"name_group"` //配置项组
	Types     string `gorm:"column:types;type:varchar(20);index;comment:配置项类型" json:"types" form:"types"`                //配置项类型
	Desc      string `gorm:"column:desc;type:text;comment:配置项介绍信息" json:"desc" form:"desc"`                              //配置项介绍信息
	ValueBool uint8  ``                                                                                                  // bool类型的值存储 uint8
	/* 138-byte string literal not displayed */
	ValueString string  `gorm:"column:value_string;type:text;comment:字符串类型配置" json:"value_string" form:"value_string"`            // 字符串类型配置
	ValueInt    int64   `gorm:"column:value_int;type:bigint;default:0;comment:int类型配置" json:"value_int" form:"value_int"`         // int类型配置
	ValueFloat  float64 `gorm:"column:value_float;type:double;default:0;comment:float类型配置" json:"value_float" form:"value_float"` // float类型配置
	EnumSelect  string  ``                                                                                                        //下拉列表，多项使用,分割key和key_cn使用:分割，下拉选择的值存储在value_string中
	/* 186-byte string literal not displayed */
	CreatedAt string `gorm:"column:created_at;type:datetime;comment:创建时间" json:"created_at" form:"created_at"` //创建时间
	UpdatedAt string `gorm:"column:updated_at;type:datetime;comment:更新时间" json:"updated_at" form:"updated_at"` //更新时间
}

配置项信息存储表

func Getconfigure

func Getconfigure(name string) Configure

获取配置项的详情值

name	要获取的配置项的配置下标

func List

func List(group string) ([]Configure, error)

获取配置项列表信息

group	分组下标KEY

func (*Configure) TableName

func (c *Configure) TableName() string

表名

type ConfigureGroup

type ConfigureGroup struct {
	Id          uint   `gorm:"column:id;primary_key;NOT NULL" json:"id" form:"id"`                                         // 自增ID
	Fid         uint   `gorm:"column:fid;default:0;NOT NULL;comment:'上级分组ID'" json:"fid" form:"fid"`                       // 上级分组ID
	NameGroup   string `gorm:"column:name_group;NOT NULL;comment:'分组名_key值'" json:"name_group" form:"name_group"`          // 分组KEY下标
	NameGroupCn string `gorm:"column:name_group_cn;NOT NULL;comment:'分组值-中文名称'" json:"name_group_cn" form:"name_group_cn"` // 分组名称
}

配置项分组信息

func GroupList

func GroupList(fid uint) ([]ConfigureGroup, error)

获取配置项分组列表[因配置项分组不会经常获取，所以此处不进行分组缓存，仅进行基础的配置项缓存]

fid	父级分类ID

func (*ConfigureGroup) TableName

func (c *ConfigureGroup) TableName() string

type ConfigureUser

type ConfigureUser struct {
	UserId    uint   `gorm:"column:user_id;primaryKey;type:INT UNSIGNED;comment:用户ID" json:"user_id" form:"user_id"` //用户ID
	Configure string `gorm:"column:configure;type:longtext;comment:配置信息JSON串" json:"configure" form:"configure"`     //配置信息JSON串
}

用户个性化配置项存储表

func (*ConfigureUser) TableName

func (c *ConfigureUser) TableName() string