Documentation
¶
Index ¶
- Constants
- Variables
- func PanicIfError(err interface{})
- type AttachmentStruct
- type COSStruct
- type ConfigReplaceRule
- type DbStruct
- type DefaultConfigStruct
- type FTPStruct
- type ListData
- type MailerStruct
- type OSSStruct
- type Option
- type ProjectStruct
- type PushPlusStruct
- type RedisStruct
- type RepositoryStruct
- type Result
- type SFTPStruct
- type SSLStruct
- type SqlLiteStruct
- type WebServer
Constants ¶
const ( ConfigTypeJSON = "json" // 配置类型:json文件 ConfigTypeINI = "ini" // 配置类型:ini文件 ConfigTypeYAML = "yaml" // 配置类型:yaml文件 ConfigTypeCommand = "command" // 配置类型:通过命令行传递的字符串json // ConfigTypeFile 文件类型,根据文件后缀自动识别是json、ini还是yaml文件 // Deprecated: 推荐使用ConfigTypeJSON、ConfigTypeINI或ConfigTypeYAML,保留仅为了兼容旧版 ConfigTypeFile = "file" )
Variables ¶
var Config interface{}
Config 实例化后配置信息将储存在此全局变量中
Functions ¶
func PanicIfError ¶ added in v0.6.1
func PanicIfError(err interface{})
PanicIfError 异常处理 如果err不为nil,则直接panic,用于省略if判断 redis.Nil(键不存在)视为正常,不触发 panic
行为变更(自 v0.17.0 起): 旧版本的类型分支中 case error 先于 case redis.Error 匹配, redis.Nil 也会触发 panic;现版本 redis.Nil 视为正常,其余 redis 错误仍 panic。
Types ¶
type AttachmentStruct ¶ added in v0.6.1
type AttachmentStruct struct {
StorageType string `json:"storage_type" ini:"storage_type" default:"local"` // 存储类型 local/ftp/sftp/cos/oss
LocalDir string `json:"local_dir" ini:"local_dir" default:"attachment"` // 本地附件目录,默认为 attachment
// 附件访问域名
// 配置后以配置为准,不配置则初始化中自动赋值,一定以"/"结尾
// 如果配置了远程附件,则此处为远程附件访问域名,否则为本地附件访问域名
VisitDomain string `json:"visit_domain" ini:"visit_domain" default:"/"`
// 本地附件访问域名,不管是否配置远程附件
// 配置后以配置为准,不配置则初始化中自动赋值,一定以"/"结尾
LocalVisitDomain string `json:"local_visit_domain" ini:"local_visit_domain" default:"/"`
}
AttachmentStruct 附件配置
type COSStruct ¶ added in v0.8.0
type COSStruct struct {
SecretId string `json:"secretId" ini:"secretId" default:""` // 腾讯云Cos SecretId
SecretKey string `json:"secretKey" ini:"secretKey" default:""` // 腾讯云Cos SecretKey
Token string `json:"token,omitempty" ini:"token,omitempty" default:""` // 腾讯云Cos临时密钥Token(可选,使用STS临时凭证时填写)
Bucket string `json:"bucket" ini:"bucket" default:""` // 腾讯云Cos Bucket
Region string `json:"region" ini:"region" default:""` // 腾讯云Cos Region
Url string `json:"url" ini:"url" default:""` // 腾讯云Cos Url
// 自定义附件访问域名(非平台配置,供程序调用,非必填,一定以"/"结尾)
CustomizeVisitDomain string `json:"customize_visit_domain,omitempty" ini:"customize_visit_domain,omitempty" default:""`
}
COSStruct cos配置
type ConfigReplaceRule ¶ added in v0.13.13
type ConfigReplaceRule struct {
NodePath string `json:"node_path"` // 节点路径,如 "title" 或 "db.host"
NewValue interface{} `json:"new_value"` // 新的配置值
Condition interface{} `json:"condition,omitempty"` // 条件值,如果提供则只有当原节点值等于条件值时才替换
}
ConfigReplaceRule 配置替换规则
type DbStruct ¶ added in v0.2.1
type DbStruct struct {
DriverName string `json:"driverName" ini:"driverName" yaml:"driverName" default:"mysql"` // 驱动类型(yaml tag 补齐:驼峰键此前不匹配 yaml.v3 默认全小写规则,导致该键静默失效)
Protocol string `json:"protocol" ini:"protocol" default:"tcp"` // 协议
Host string `json:"host" ini:"host" default:"localhost"` // 数据库地址
Port string `json:"port" ini:"port" default:"3306"` // 数据库端口号
Dbname string `json:"dbname" ini:"dbname" default:"dbname"` // 表名称
Username string `json:"username" ini:"username" default:"root"` // 用户名
Password string `json:"password" ini:"password" default:""` // 密码
Charset string `json:"charset" ini:"charset" default:"utf8mb4"` // 编码
TablePrefix string `json:"tablePrefix,omitempty" ini:"tablePrefix,omitempty" yaml:"tablePrefix" default:""` // 表前缀
ParseTime string `json:"parseTime" ini:"parseTime" yaml:"parseTime" default:"False"` // 是否开启时间解析(yaml tag 补齐:驼峰键此前不匹配 yaml.v3 默认全小写规则,导致该键静默失效)
Loc string `json:"loc" ini:"loc" default:"Local"` // 时区:Local=服务器本地时区(默认)、UTC,或 IANA 时区名(如 Asia/Shanghai);约定“库里存 UTC”的项目须显式配置为 UTC
SingularTable bool `json:"singularTable" ini:"singularTable" yaml:"singularTable" default:"true"` // 使用单数表名
DisableForeignKeyConstraintWhenMigrating bool `` // 是否禁用外键约束
/* 158-byte string literal not displayed */
// 连接池配置(可选)。不加 default tag:0 值即「使用库内默认」,未配置时行为与历史版本完全一致
MaxOpenConns int `json:"maxOpenConns" ini:"maxOpenConns" yaml:"maxOpenConns"` // 最大打开连接数,0=默认100
MaxIdleConns int `json:"maxIdleConns" ini:"maxIdleConns" yaml:"maxIdleConns"` // 最大空闲连接数,0=默认10
ConnMaxLifetimeSeconds int `json:"connMaxLifetimeSeconds" ini:"connMaxLifetimeSeconds" yaml:"connMaxLifetimeSeconds"` // 连接最大生存时间(秒),0=默认300(5分钟)
ConnMaxIdleTimeSeconds int `json:"connMaxIdleTimeSeconds" ini:"connMaxIdleTimeSeconds" yaml:"connMaxIdleTimeSeconds"` // 空闲连接最大生存时间(秒),0=默认180(3分钟)
}
DbStruct 数据库配置
type DefaultConfigStruct ¶ added in v0.6.1
type DefaultConfigStruct struct {
Db DbStruct `json:"db" ini:"db"` // 数据库配置信息
Redis RedisStruct `json:"redis" ini:"redis"` // redis配置信息
Attachment AttachmentStruct `json:"attachment" ini:"attachment"` // 附件配置信息
Oss OSSStruct `json:"oss" ini:"oss"` // oss配置信息
Cos COSStruct `json:"cos" ini:"cos"` // cos配置信息
Project ProjectStruct `json:"project" ini:"project"` // 项目配置信息
Repository RepositoryStruct `json:"repository" ini:"repository"` // 仓库配置信息
PushPlus PushPlusStruct `json:"pushplus" ini:"pushplus"` // PushPlus 推送配置
}
DefaultConfigStruct 默认配置信息结构 一般情况下推荐自定义,不想自定义的情况下可以采用默认结构
type FTPStruct ¶ added in v0.8.0
type FTPStruct struct {
Address string `json:"address" ini:"address" default:""` // FTP服务器地址
Username string `json:"username" ini:"username" default:""` // FTP登录用户名
Password string `json:"password" ini:"password" default:""` // FTP登录密码
Timeout time.Duration `json:"timeout,omitempty" ini:"timeout,omitempty" default:""` // 连接超时时间,可选
// 自定义附件访问域名(非平台配置,供程序调用,非必填,一定以"/"结尾)
CustomizeVisitDomain string `json:"customize_visit_domain,omitempty" ini:"customize_visit_domain,omitempty" default:""`
}
type ListData ¶ added in v0.7.1
type ListData struct {
List interface{} `json:"list"`
Total int `json:"total"`
Page int `json:"page"`
PageSize int `json:"page_size"`
}
ListData 分页查询数据输出
type MailerStruct ¶ added in v0.6.1
type MailerStruct struct {
Host string `json:"host" ini:"host" default:"smtp.qq.com"` // 邮箱地址
Port string `json:"port" ini:"port" default:"465"` // 邮箱端口号
Username string `json:"username" ini:"username" default:"example@qq.com"` // 邮箱用户名
Password string `json:"password" ini:"password" default:"123456"` // 邮箱密码
From string `json:"from" ini:"from" default:"example@qq.com"` // 发件邮箱
UseTLS bool `json:"useTls" ini:"useTls" default:"true"` // 是否使用TLS
CertPath string `json:"cert_path" ini:"cert_path" default:""` // 证书文件路径
KeyPath string `json:"key_path" ini:"key_path" default:""` // 私钥文件路径
CAPath string `json:"ca_path" ini:"ca_path" default:""` // CA证书文件路径
}
MailerStruct 发送邮箱配置
type OSSStruct ¶ added in v0.8.0
type OSSStruct struct {
AccessKeyId string `json:"AccessKeyId" ini:"AccessKeyId" default:""` // 阿里云访问密钥ID
AccessKeySecret string `json:"AccessKeySecret" ini:"AccessKeySecret" default:""` // 阿里云访问密钥Secret
Endpoint string `json:"endpoint" ini:"endpoint" default:""` // 阿里云OSS的Endpoint
BucketName string `json:"bucketName" ini:"bucketName" default:""` // 阿里云OSS存储桶名称
// 自定义附件访问域名(非平台配置,供程序调用,非必填,一定以"/"结尾)
CustomizeVisitDomain string `json:"customize_visit_domain,omitempty" ini:"customize_visit_domain,omitempty" default:""`
}
OSSStruct oss配置
type Option ¶ added in v0.6.1
type Option struct {
ConfigType string `json:"config_type" ini:"config_type" default:"file"` // 配置类型,支持:json、ini、yaml、command、file
ConfigSource string `json:"config_source" ini:"config_source" default:"./data/conf.ini"` // 配置源(json文件/ini文件/命令行)
ConfigData interface{} `json:"config_data" ini:"config_data"` // 配置信息
RuntimePath string `json:"runtime_path" ini:"runtime_path" default:"./data/runtime/"` // 运行缓存目录,默认在data目录下
ConfigReplaceRules []ConfigReplaceRule `json:"config_replace_rules,omitempty" ini:"config_replace_rules,omitempty"` // 配置替换规则
}
Option jcbaseGo配置选项
func (*Option) ConfigToStruct ¶ added in v0.6.1
ConfigToStruct 将 Option.ConfigData 赋值到自定义结构体中 返回转换过程中发生的错误,成功时返回 nil
func (*Option) GetConfig ¶ added in v0.6.1
func (opt *Option) GetConfig() *interface{}
GetConfig 获取配置信息 返回配置数据的指针,调用者需要确保配置数据不为空
func (*Option) GetConfigOption ¶ added in v0.6.1
GetConfigOption 获取配置选项
func (*Option) ReloadConfig ¶ added in v0.13.23
ReloadConfig 重新加载配置 当配置文件在外部被更新后,调用此方法可重新读取最新配置并同步更新全局 Config 变量 参数:
- 无
返回:
- error: 重载失败时返回错误,成功返回 nil
使用示例:
opt := jcbaseGo.New(jcbaseGo.Option{ConfigSource: "./config.json", ConfigData: &cfg})
if err := opt.ReloadConfig(); err != nil {
log.Printf("重载配置失败: %v", err)
}
func (*Option) ReplaceConfigNode ¶ added in v0.13.13
func (opt *Option) ReplaceConfigNode(nodePath string, newValue interface{}, condition interface{}) bool
ReplaceConfigNode 替换指定节点的配置信息 参数:
- nodePath: 节点路径,如 "title" 或 "db.host"
- newValue: 新的配置值,类型必须与原节点类型匹配
- condition: 条件值,如果提供则只有当原节点值等于条件值时才替换
返回:
- bool: 是否成功替换
使用示例:
// 替换所有title节点为ok
opt.ReplaceConfigNode("title", "ok", nil)
// 仅当title=test时替换为ok
opt.ReplaceConfigNode("title", "ok", "test")
type ProjectStruct ¶ added in v0.6.1
type ProjectStruct struct {
Name string `json:"name" ini:"name" default:"jcbaseGo"` // 项目名称
}
ProjectStruct 项目配置
type PushPlusStruct ¶ added in v0.17.0
type PushPlusStruct struct {
Token string `json:"token" ini:"token" default:""` // 用户令牌,必填
Topic string `json:"topic,omitempty" ini:"topic,omitempty" default:""` // 默认群组编码,可选
Channel string `json:"channel,omitempty" ini:"channel,omitempty" default:"wechat"` // 默认发送渠道:wechat/webhook/cp/mail/sms/voice
Template string `json:"template,omitempty" ini:"template,omitempty" default:"html"` // 默认消息模板:html/json/markdown/txt
Timeout time.Duration `json:"timeout,omitempty" ini:"timeout,omitempty" default:""` // 请求超时时间,默认 10s
BaseURL string `json:"base_url,omitempty" ini:"base_url,omitempty" default:"https://www.pushplus.plus/send"` // 发送接口地址
}
PushPlusStruct PushPlus 推送配置
type RedisStruct ¶ added in v0.2.1
type RedisStruct struct {
Host string `json:"host" ini:"host" default:"localhost"` // redis地址
Port string `json:"port" ini:"port" default:"6379"` // redis端口号
Password string `json:"password,omitempty" ini:"password,omitempty" default:""` // redis密码
Db string `json:"db,omitempty" ini:"db,omitempty" default:"0"` // redis数据库
}
RedisStruct redis配置
type RepositoryStruct ¶ added in v0.2.1
type RepositoryStruct struct {
Dir string `json:"dir" ini:"dir" default:"./project/app/"` // 本地仓库目录
Branch string `json:"branch" ini:"branch" default:"master"` // 远程仓库分支
RemoteName string `json:"remoteName" ini:"remoteName" default:"origin"` // 远程仓库名称
RemoteURL string `json:"remoteURL" ini:"remoteURL" default:"git@github.com:jcbowen/jcbaseGo.git"` // 远程仓库地址
}
RepositoryStruct 仓库配置
type Result ¶ added in v0.7.1
type Result struct {
Code int `json:"code" default:"200"`
Message string `json:"message" default:"success"`
Data interface{} `json:"data,omitempty"`
Total *int `json:"total,omitempty"`
}
Result 响应结构
type SFTPStruct ¶ added in v0.8.0
type SFTPStruct struct {
Address string `json:"address" ini:"address" default:""` // SFTP服务器地址
Username string `json:"username" ini:"username" default:""` // SFTP登录用户名
Password string `json:"password" ini:"password" default:""` // SFTP登录密码
PrivateKey []byte `json:"private_key" ini:"private_key" default:""` // SFTP登录私钥
Timeout time.Duration `json:"timeout,omitempty" ini:"timeout,omitempty" default:""` // 连接超时时间,可选
// 自定义附件访问域名(非平台配置,供程序调用,非必填,一定以"/"结尾)
CustomizeVisitDomain string `json:"customize_visit_domain,omitempty" ini:"customize_visit_domain,omitempty" default:""`
}
SFTPStruct sftp配置
type SqlLiteStruct ¶ added in v0.6.1
type SqlLiteStruct struct {
DbFile string `json:"dbFile" ini:"dbFile" default:"./data/db/jcbaseGo.db"` // 数据库文件,默认在data目录下
TablePrefix string `json:"tablePrefix" ini:"tablePrefix" default:""` // 表前缀(默认无前缀;需要前缀的项目显式配置)
SingularTable bool `json:"singularTable" ini:"singularTable" default:"true"` // 使用单数表名
DisableForeignKeyConstraintWhenMigrating bool `json:"disableForeignKeyConstraintWhenMigrating" ini:"disableForeignKeyConstraintWhenMigrating" default:"false"` // 是否禁用外键约束
}
SqlLiteStruct sqlite配置
func (*SqlLiteStruct) UnmarshalYAML ¶ added in v0.17.9
func (c *SqlLiteStruct) UnmarshalYAML(value *yaml.Node) error
UnmarshalYAML 实现 yaml.v3 的自定义解析:解析前先做键名别名归一化(与 DbStruct 同规则)。 参数:
- value: 待解析的 yaml 节点
返回值:
- error: 键名冲突或节点解析失败时返回对应错误
type WebServer ¶ added in v0.9.1
type WebServer struct {
Port int `json:"port" ini:"port" default:"8080"` // web服务端口号
EnableSSL bool `json:"enable_ssl" ini:"enable_ssl" default:"false"` // 是否启用ssl
CertPath string `json:"cert_path" ini:"cert_path" default:""` // ssl证书路径
KeyPath string `json:"key_path" ini:"key_path" default:""` // ssl密钥路径
}
WebServer web服务配置
Directories
¶
| Path | Synopsis |
|---|---|
|
component
|
|
|
attachment/remote
Package remote 提供多种远程存储方式的统一接口。
|
Package remote 提供多种远程存储方式的统一接口。 |
|
orm/mysql
Package mysql 提供 MySQL 数据库的 ORM 封装,基于 GORM,包含连接创建、连接池配置、表名处理与分页查询等辅助方法。
|
Package mysql 提供 MySQL 数据库的 ORM 封装,基于 GORM,包含连接创建、连接池配置、表名处理与分页查询等辅助方法。 |
|
orm/sqlite
Package sqlite 提供 SQLite 数据库的 ORM 封装,基于 GORM,包含连接管理、表名处理与分页查询等辅助方法。
|
Package sqlite 提供 SQLite 数据库的 ORM 封装,基于 GORM,包含连接管理、表名处理与分页查询等辅助方法。 |
|
ratelimit
Package ratelimit 提供基于 Redis 有序集合的滑动窗口限流,并内置本地内存降级。
|
Package ratelimit 提供基于 Redis 有序集合的滑动窗口限流,并内置本地内存降级。 |
|
serializer
Package serializer 提供响应数据的递归序列化能力。
|
Package serializer 提供响应数据的递归序列化能力。 |
|
snowflake
Package snowflake 提供基于雪花算法(Snowflake)的分布式唯一 ID 生成能力。
|
Package snowflake 提供基于雪花算法(Snowflake)的分布式唯一 ID 生成能力。 |
|
timezone
Package timezone 提供"数据库存 UTC、前端展示北京时间"约定的通用时区工具。
|
Package timezone 提供"数据库存 UTC、前端展示北京时间"约定的通用时区工具。 |
|
example
|
|
|
attachment/cos
command
|
|
|
attachment/ftp
command
|
|
|
attachment/oss
command
|
|
|
attachment/upload
command
|
|
|
debugger/basic_usage
command
|
|
|
debugger/config_examples
command
|
|
|
debugger/controller_usage
command
|
|
|
debugger/custom_path_example
command
|
|
|
debugger/database_usage
command
|
|
|
debugger/file_storage
command
|
|
|
debugger/logger_usage
command
|
|
|
debugger/process_usage
command
|
|
|
helper/convert
command
|
|
|
helper/string
command
|
|
|
mailer
command
|
|
|
message
command
|
|
|
orm
command
|
|
|
orm/debugger_integration
command
|
|
|
orm/mysql
command
|
|
|
orm/sqlite
command
|
|
|
php
command
|
|
|
php/basic
command
|
|
|
php/custom
command
|
|
|
php/json
command
|
|
|
php/math
command
|
|
|
php/serialize
command
|
|
|
php/string
command
|
|
|
php/utils_example
command
|
|
|
security/aes
command
|
|
|
security/sm4
command
|
|
|
time_field_migration/migration
command
|
|
|
time_field_migration/mixed_type
command
|
|
|
time_field_migration/string_type
command
|
|
|
time_field_migration/time_type
command
|
|
|
validator
command
|
|