初始化配置

一、配置yaml文件

Server:Mode: debug # 服务器模式，可选值为 debug 或 releasePort: :8765 # 服务器端口号DbType: "mysql" # 数据库类型，可选值为 mysql 或 sqliteDbAutoMigrate: true # 是否自动迁移数据库表结构，如果表结构没有变化，可以设为 false 提高启动速度DbLogMode: "error" # 数据库日志级别，可选值有 silent, error, warn, info, 默认为 infoJWT: # JWT 鉴权配置Secret: "abc123321" # JWT 密钥Expire: 24 # JWT 过期时间，单位为小时Issuer: "gin-vue-blog" # JWT 签发者Mysql: # MySQL 数据库配置Host: "127.0.0.1" # MySQL 主机地址Port: "3306" # MySQL 端口号Config: "charset=utf8mb4&parseTime=True&loc=Local" # MySQL 配置，例如字符集和时区设置Dbname: "gvb" # MySQL 数据库名称Username: "root" # MySQL 用户名Password: "123456" # MySQL 密码Sqlite: # SQLite 数据库配置Dsn: "gvb.db" # SQLite 数据库文件路径Redis: # Redis 缓存配置DB: 0 # Redis 数据库索引Addr: '' # Redis 服务器地址Password: '' # Redis 访问密码，如果没有设置密码则留空Session: # 会话（Session）配置Name: "mysession" # 会话名称Salt: "salt" # 加密盐MaxAge: 600 # 会话过期时间，单位为秒Log: # 日志配置Level: "debug" # 日志级别，可选值有 debug, info, warn, errorFormat: "text" # 日志格式，可选值有 text, jsonDirectory: "log" # 日志存储目录Email: # 邮件发送配置Host: "smtp.qq.com" # SMTP 服务器地址Port: 465 # SMTP 服务器端口号From: "" # 发件人邮箱IsSSL: true # 是否开启 SSLSecret: "" # SMTP 密钥Nickname: "" # 发件人昵称Captcha: # 验证码配置SendEmail: true # 是否通过邮件发送验证码ExpireTime: 5  # 验证码过期时间，单位为分钟Upload: # 文件上传配置OssType: "qiniu" # 文件上传类型，可选值为 local 或 qiniuPath: "public/uploaded" # 本地文件访问路径，OssType="local" 生效StorePath: "../public/uploaded" # 本地文件上传路径，相对于 main.go，OssType="local" 生效Qiniu: # 七牛云存储配置ImgPath: "" # 外链Zone: "z1" # 存储区域，可选值有 z0, z1, z2, na0, as0Bucket: "" # 存储空间名称AccessKey: "-" # 七牛云 AccessKeySecretKey: "" # 七牛云 SecretKeyUseHttps: false # 是否使用 HTTPS 协议进行图片上传和访问UseCdnDomains: false # 是否使用七牛云 CDN 加速域名

二、Go读取配置文件

1.结构体的定义

type Config struct {Server struct {Mode          string // debug | releasePort          stringDbType        string // mysql | sqliteDbAutoMigrate bool   // 是否自动迁移数据库表结构DbLogMode     string // silent | error | warn | info}Log struct {Level     string // debug | info | warn | errorPrefix    stringFormat    string // text | jsonDirectory string}JWT struct {Secret stringExpire int64 // hourIssuer string}Mysql struct {Host     string // 服务器地址Port     string // 端口Config   string // 高级配置Dbname   string // 数据库名Username string // 数据库用户名Password string // 数据库密码}SQLite struct {Dsn string // Data Source Name}Redis struct {DB       int    // 指定 Redis 数据库Addr     string // 服务器地址:端口Password string // 密码}Session struct {Name   stringSalt   stringMaxAge int}Email struct {To       string // 收件人 多个以英文逗号分隔 例：a@qq.com,b@qq.comFrom     string // 发件人 要发邮件的邮箱Host     string // 服务器地址, 例如 smtp.qq.com 前往要发邮件的邮箱查看其 smtp 协议Secret   string // 密钥, 不是邮箱登录密码, 是开启 smtp 服务后获取的一串验证码Nickname string // 发件人昵称, 通常为自己的邮箱名Port     int    // 前往要发邮件的邮箱查看其 smtp 协议端口, 大多为 465IsSSL    bool   // 是否开启 SSL}Captcha struct {SendEmail  bool // 是否通过邮箱发送验证码ExpireTime int  // 过期时间}Upload struct {// Size      int    // 文件上传的最大值OssType   string // local | qiniuPath      string // 本地文件访问路径StorePath string // 本地文件存储路径}Qiniu struct {ImgPath       string // 外链链接Zone          string // 存储区域Bucket        string // 空间名称AccessKey     string // 秘钥AKSecretKey     string // 秘钥SKUseHTTPS      bool   // 是否使用httpsUseCdnDomains bool   // 上传是否使用 CDN 上传加速}
}

2.从指定路径中读取配置信息到结构体里面

// 定义一个Public的变量
var Conf *Configfunc GetConfig() *Config {if Conf == nil {log.Panic("配置文件未初始化")return nil}return Conf
}// 从指定路径读取配置文件
func ReadConfig(path string) *Config {v := viper.New()v.SetConfigFile(path)v.AutomaticEnv()                                   // 允许使用环境变量v.SetEnvKeyReplacer(strings.NewReplacer(".", "_")) // SERVER_APPMODE => SERVER.APPMODEif err := v.ReadInConfig(); err != nil {panic("配置文件读取失败: " + err.Error())}if err := v.Unmarshal(&Conf); err != nil {panic("配置文件反序列化失败: " + err.Error())}log.Println("配置文件内容加载成功: ", path)return Conf
}// 数据库类型
func (*Config) DbType() string {if Conf.Server.DbType == "" {Conf.Server.DbType = "sqlite"}return Conf.Server.DbType
}// 数据库连接字符串
func (*Config) DbDSN() string {switch Conf.Server.DbType {case "mysql":conf := Conf.Mysqlreturn fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?%s",conf.Username, conf.Password, conf.Host, conf.Port, conf.Dbname, conf.Config,)case "sqlite":return Conf.SQLite.Dsn// 默认使用 sqlite, 并且使用内存数据库default:Conf.Server.DbType = "sqlite"if Conf.SQLite.Dsn == "" {Conf.SQLite.Dsn = "file::memory:"}return Conf.SQLite.Dsn}
}

三、初始化日志Logger

在1.21.0版本后，go添加了slog的结构化日志库。故使用轻量级的日志库。

func InitLogger(conf *g.Config) *slog.Logger {var level slog.Level// 设置日志级别switch conf.Log.Level {case "debug":level = slog.LevelDebugcase "info":level = slog.LevelInfocase "warn":level = slog.LevelWarncase "error":level = slog.LevelErrordefault:level = slog.LevelInfo}option := &slog.HandlerOptions{AddSource: true, // 是否显示代码详细位置Level:     level,ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {if a.Key == slog.TimeKey {if t, ok := a.Value.Any().(time.Time); ok {a.Value = slog.StringValue(t.Format(time.DateTime))}}return a},}var handler slog.Handlerswitch conf.Log.Format {case "json":handler = slog.NewJSONHandler(os.Stdout, option)case "text":fallthroughdefault: //默认texthandler = slog.NewTextHandler(os.Stdout, option)}loggers := slog.New(handler)slog.SetDefault(loggers)return loggers
}

四、初始化数据库（MySQL或SqlLite）

func InitDatabase(conf *g.Config) *gorm.DB {dbtype := conf.DbType() // 数据库类型dsn := conf.DbDSN()     //DSNvar db *gorm.DBvar err errorvar level logger.LogLevelswitch conf.Server.DbLogMode {case "silent":level = logger.Silentcase "info":level = logger.Infocase "warn":level = logger.Warncase "error":fallthroughdefault:level = logger.Error}config := &gorm.Config{Logger:                                   logger.Default.LogMode(level),DisableForeignKeyConstraintWhenMigrating: true, // 禁用外键约束SkipDefaultTransaction:                   true, // 禁用默认事务（提高运行速度）NamingStrategy: schema.NamingStrategy{SingularTable: true, // 单数表名},}switch dbtype {case "mysql":db, err = gorm.Open(mysql.Open(dsn), config)case "sqlite":db, err = gorm.Open(sqlite.Open(dsn), config)default:log.Fatal("不支持的数据库类型: ", dbtype)}if err != nil {log.Fatal("数据库连接失败", err)}log.Println("数据库连接成功", dbtype, dsn)if conf.Server.DbAutoMigrate {if err := model.MakeMigrate(db); err != nil {log.Fatal("数据库迁移失败", err)}log.Println("数据库自动迁移成功")}return db
}

五、初始化缓存（Redis）

func InitRedis(conf *g.Config) *redis.Client {rdb := redis.NewClient(&redis.Options{Addr:     conf.Redis.Addr,Password: conf.Redis.Password,DB:       conf.Redis.DB,})_, err := rdb.Ping(context.Background()).Result()if err != nil {log.Fatal("Redis 连接失败: ", err)}log.Println("Redis 连接成功", conf.Redis.Addr, conf.Redis.DB, conf.Redis.Password)return rdb
}

六、中间件服务（middleware）

1.跨域请求

func CORS() gin.HandlerFunc {return cors.New(cors.Config{AllowOrigins:     []string{"*"},AllowMethods:     []string{"PUT", "POST", "GET", "DELETE", "OPTIONS", "PATCH"},AllowHeaders:     []string{"Origin", "Authorization", "Content-Type", "X-Requested-With"},ExposeHeaders:    []string{"Content-Type"},AllowCredentials: true,AllowOriginFunc: func(origin string) bool {return true},MaxAge: 24 * time.Hour,})
}

2.绑定db，将*gorm.DB绑定到context的g.CTX_DB键上

func WithGormDB(db *gorm.DB) gin.HandlerFunc {return func(ctx *gin.Context) {ctx.Set(g.CTX_DB, db)ctx.Next()}
}

3.绑定Redis

func WithRedisDB(rdb *redis.Client) gin.HandlerFunc {return func(ctx *gin.Context) {ctx.Set(g.CTX_RDB, rdb)ctx.Next()}
}

4.设置cookie，用于在请求和响应之间存储会话信息

func WithCookieStore(name, secret string) gin.HandlerFunc {store := cookie.NewStore([]byte(secret))store.Options(sessions.Options{Path: "/", MaxAge: 600})return sessions.Sessions(name, store)
}