从零封装Gin框架配置初始化全局变量

 更新时间:2024年01月31日 10:41:13   作者:生活处处有BUG  
这篇文章主要为大家介绍了从零封装Gin框架配置初始化全局变量,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

引言

配置文件是每个项目必不可少的部分,用来保存应用基本数据、数据库配置等信息,避免要修改一个配置项需要到处找的尴尬。这里我使用 viper 作为配置管理方案,它支持 JSON、TOML、YAML、HCL、envfile、Java properties 等多种格式的配置文件,并且能够监听配置文件的修改,进行热重载,详细介绍大家可以去官方文档查看

安装

go get -u github.com/spf13/viper 

编写配置文件

在项目根目录下新建一个文件 config.yaml ,初期先将项目的基本配置放入,后续我们会添加更多配置信息

app: # 应用基本配置
  env: local # 环境名称
  port: 8888 # 服务监听端口号
  app_name: gin-app # 应用名称
  app_url: http://localhost # 应用域名

编写配置结构体

在项目根目录下新建文件夹 config,用于存放所有配置对应的结构体

新建 config.go 文件,定义 Configuration 结构体,其 App 属性对应 config.yaml 中的 app

package config

type Configuration struct {
    App App `mapstructure:"app" json:"app" yaml:"app"`
}

新建 app.go 文件,定义 App 结构体,其所有属性分别对应 config.yaml 中 app 下的所有配置

package config

type App struct {
    Env string `mapstructure:"env" json:"env" yaml:"env"`
    Port string `mapstructure:"port" json:"port" yaml:"port"`
    AppName string `mapstructure:"app_name" json:"app_name" yaml:"app_name"`
    AppUrl string `mapstructure:"app_url" json:"app_url" yaml:"app_url"`
}

注意:配置结构体中 mapstructure 标签需对应 config.ymal 中的配置名称, viper 会根据标签 value 值把 config.yaml 的数据赋予给结构体

全局变量

新建 global/app.go 文件,定义 Application 结构体,用来存放一些项目启动时的变量,便于调用,目前先将 viper 结构体和 Configuration 结构体放入,后续会添加其他成员属性

package global

import (
    "github.com/spf13/viper"
    "jassue-gin/config"
)

type Application struct {
    ConfigViper *viper.Viper
    Config config.Configuration
}

var App = new(Application)

使用 viper 载入配置

新建 bootstrap/config.go 文件,编写代码:

package bootstrap
import (
    "fmt"
    "github.com/fsnotify/fsnotify"
    "github.com/spf13/viper"
    "jassue-gin/global"
    "os"
)
func InitializeConfig() *viper.Viper {
    // 设置配置文件路径
    config := "config.yaml"
    // 生产环境可以通过设置环境变量来改变配置文件路径
    if configEnv := os.Getenv("VIPER_CONFIG"); configEnv != "" {
        config = configEnv
    }
    // 初始化 viper
    v := viper.New()
    v.SetConfigFile(config)
    v.SetConfigType("yaml")
    if err := v.ReadInConfig(); err != nil {
        panic(fmt.Errorf("read config failed: %s \n", err))
    }
    // 监听配置文件
    v.WatchConfig()
    v.OnConfigChange(func(in fsnotify.Event) {
        fmt.Println("config file changed:", in.Name)
        // 重载配置
        if err := v.Unmarshal(&global.App.Config); err != nil {
            fmt.Println(err)
        }
    })
    // 将配置赋值给全局变量
    if err := v.Unmarshal(&global.App.Config); err != nil {
       fmt.Println(err)
    }
    return v
}

初始化配置

修改 main.go 文件

package main
import (
    "github.com/gin-gonic/gin"
    "jassue-gin/bootstrap"
    "jassue-gin/global"
    "net/http"
)
func main() {
    // 初始化配置
    bootstrap.InitializeConfig()
    r := gin.Default()
    // 测试路由
    r.GET("/ping", func(c *gin.Context) {
        c.String(http.StatusOK, "pong")
    })
    // 启动服务器
    r.Run(":" + global.App.Config.App.Port)
}

执行 go run main.go ,启动应用,服务器监听的端口是已经是配置文件里的端口号了,http://127.0.0.1:8888/ping

以上就是从零封装Gin框架配置初始化全局变量的详细内容,更多关于封装Gin初始化全局变量的资料请关注脚本之家其它相关文章!

相关文章

  • golang中随机数rand的使用

    golang中随机数rand的使用

    本文主要介绍了golang中随机数rand的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08
  • GO语言协程创建使用并通过channel解决资源竞争

    GO语言协程创建使用并通过channel解决资源竞争

    这篇文章主要为大家介绍了GO语言协程创建使用并通过channel解决资源竞争,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步早日升职加薪
    2022-04-04
  • Golang科学计数法转换string数字输出的实现

    Golang科学计数法转换string数字输出的实现

    最近接手一个商城运单号模块,接手后发现有部分运单号返回给前端是按照科学计数法的方式返回,本文就介绍一下Golang科学计数法转换string数字输出,感兴趣的可以了解一下
    2021-07-07
  • 基于GORM实现CreateOrUpdate方法详解

    基于GORM实现CreateOrUpdate方法详解

    这篇文章主要为大家介绍了基于GORM实现CreateOrUpdate方法详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-10-10
  • Golang实现Md5校验的示例代码

    Golang实现Md5校验的示例代码

    本文主要介绍了Golang实现Md5校验的示例代码,要求接收方需要文件的md5值,和接收到的文件做比对,以免文件不完整,但引起bug,下面就一起来解决一下
    2024-08-08
  • Go语言rune与字符串转换的密切关系解析

    Go语言rune与字符串转换的密切关系解析

    这篇文章主要为大家介绍了Go语言rune与字符串转换的密切关系示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-12-12
  • 深入理解golang chan的使用

    深入理解golang chan的使用

    本文主要介绍了golang chan的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-06-06
  • 关于Go语言中的IO操作详解

    关于Go语言中的IO操作详解

    在现代软件开发中,高效的输入输出(I/O)操作是提高程序性能的关键之一,Go语言提供了丰富的I/O操作接口,使得文件读写、网络通信等任务变得简单而高效,本文介绍了关于Go语言中的IO操作,需要的朋友可以参考下
    2024-10-10
  • 基于Go语言实现插入排序算法及优化

    基于Go语言实现插入排序算法及优化

    插入排序是一种简单的排序算法。这篇文章将利用Go语言实现冒泡排序算法,文中的示例代码讲解详细,对学习Go语言有一定的帮助,需要的可以参考一下
    2022-12-12
  • golang zap日志库的具体使用

    golang zap日志库的具体使用

    本文主要介绍了golang zap日志库的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-11-11

最新评论