11. 搭建较通用的GoWeb开发脚手架

2024-03-10 06:12
文章标签 通用 开发 搭建 脚手架 goweb

本文主要是介绍11. 搭建较通用的GoWeb开发脚手架，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文章目录

  • 导言
  • 一、加载配置
  • 二、初始化日志
  • 三、初始化MySQL连接
  • 四、初始化Redis连接
  • 五、初始化gin框架内置的校验器使用的翻译器
  • 六、注册路由
  • 七、 启动服务
  • 八、测试运行
  • 九：注意事项

代码地址：https://gitee.com/lymgoforIT/bluebell

导言

有了前述知识的基础后，我们便可以开始搭建基本脚手架了。

脚手架应该包含如下信息：

  1. 较好的代码管理、即清晰的目录结构，层次分明。
  2. 配置文件管理和加载。
  3. 日志组件初始化和加载。
  4. Redis初始化和加载。
  5. MySQL初始化和加载。
  6. 路由拆分管理。
  7. 中间件使用。
  8. 服务启动。

有了脚手架之后，后续的CRUD就比较简单啦。

本文完成后总体目录结构如下
在这里插入图片描述
注意：我们主要关注的是后端逻辑，所以涉及前端的static和templates两个目录没有过多介绍，可以直接从代码仓库获取即可。

最关键的是main文件，毕竟它是整个程序的入口，我们的main文件应该足够清晰，让人一眼就能看出做了哪些事情，大致结构如下：

package mainfunc main() {// 1. 加载配置// 2. 初始化日志// 3. 初始化MySQL连接// 4. 初始化Redis连接// 5. 初始化gin框架内置的校验器使用的翻译器// 6. 注册路由// 7. 启动服务（优雅关机和重启）
}

一、加载配置

首先我们应该定义一个config.yaml配置文件，将相关配置写到里面

config/config.yaml

name: "bluebell"
mode: "release"
port: 8084
version: "v0.0.1"log:level: "info"filename: "web_app.log"max_size: 200max_age: 30max_backups: 7mysql:host: "127.0.0.1"port: 3306user: "root"password: "root"dbname: "bluebell"max_open_conns: 200max_idle_conns: 50redis:host: "127.0.0.1"port: 6379password: ""db: 0pool_size: 100

由于我们后续是要将配置加载到一个全局结构体对象中，然后各个地方使用这个全局变量读取配置的，所以很自然的想到，我们应该定义对应的配置结构体，并提供一个全局变量以及相应的初始化函数。

setting/setting.go

package settingimport ("fmt""github.com/fsnotify/fsnotify""github.com/spf13/viper"
)var Conf = new(AppConfig)type AppConfig struct {Name    string `mapstructure:"name"`Mode    string `mapstructure:"mode"`Version string `mapstructure:"version"`Port    int    `mapstructure:"port"`*LogConfig   `mapstructure:"log"`*MySQLConfig `mapstructure:"mysql"`*RedisConfig `mapstructure:"redis"`
}type LogConfig struct {Level      string `mapstructure:"level"`Filename   string `mapstructure:"filename"`MaxSize    int    `mapstructure:"max_size"`MaxAge     int    `mapstructure:"max_age"`MaxBackups int    `mapstructure:"max_backups"`
}type MySQLConfig struct {Host         string `mapstructure:"host"`Port         int    `mapstructure:"port"`User         string `mapstructure:"user"`Password     string `mapstructure:"password"`DB           string `mapstructure:"dbname"`MaxOpenConns int    `mapstructure:"max_open_conns"`MaxIdleConns int    `mapstructure:"max_idle_conns"`
}type RedisConfig struct {Host         string `mapstructure:"host"`Port         int    `mapstructure:"port"`Password     string `mapstructure:"password"`DB           int    `mapstructure:"db"`PoolSize     int    `mapstructure:"pool_size"`MinIdleConns int    `mapstructure:"min_idle_conns"`
}func Init(filePath string) (err error) {// 方式1：直接指定配置文件路径（相对路径或者绝对路径）// 相对路径：相对执行的可执行文件的相对路径//viper.SetConfigFile("./conf/config.yaml")// 绝对路径：系统中实际的文件路径//viper.SetConfigFile("/Users/liwenzhou/Desktop/bluebell/conf/config.yaml")// 方式2：指定配置文件名和配置文件的位置，viper自行查找可用的配置文件// 配置文件名不需要带后缀// 配置文件位置可配置多个//viper.SetConfigName("config") // 指定配置文件名（不带后缀）//viper.AddConfigPath(".") // 指定查找配置文件的路径（这里使用相对路径）//viper.AddConfigPath("./conf")      // 指定查找配置文件的路径（这里使用相对路径）// 基本上是配合远程配置中心使用的，告诉viper当前的数据使用什么格式去解析//viper.SetConfigType("json")viper.SetConfigFile(filePath)err = viper.ReadInConfig() // 读取配置信息到viper中if err != nil {fmt.Printf("viper.ReadInconfig failed,err:%v\n", err)return}// 把读取到的配置信息反序列化到 Conf 全局变量中if err := viper.Unmarshal(Conf); err != nil {fmt.Printf("viper.Unmarshal failed,err:%v\n", err)}viper.WatchConfig()viper.OnConfigChange(func(in fsnotify.Event) {fmt.Println("配置文件修改了")if err := viper.Unmarshal(Conf); err != nil {fmt.Printf("viper.Unmarshal failed,err:%v\n", err)}})return
}

二、初始化日志

我们该项目使用之前介绍的Zap作为日志组件，并会仿照Gin中的Logger和Recovery中间件，写自己的中间件替换掉Gin自带的。如下

logger/logger.go

package loggerimport ("bluebell/setting""net""net/http""net/http/httputil""os""runtime/debug""strings""time""github.com/gin-gonic/gin""github.com/natefinch/lumberjack""go.uber.org/zap""go.uber.org/zap/zapcore"
)var lg *zap.Logger// Init 初始化lg
func Init(cfg *setting.LogConfig, mode string) (err error) {writeSyncer := getLogWriter(cfg.Filename, cfg.MaxSize, cfg.MaxBackups, cfg.MaxAge)encoder := getEncoder()var l = new(zapcore.Level)err = l.UnmarshalText([]byte(cfg.Level))if err != nil {return}var core zapcore.Coreif mode == "dev" {// 进入开发模式，日志输出到终端consoleEncoder := zapcore.NewConsoleEncoder(zap.NewDevelopmentEncoderConfig())core = zapcore.NewTee(zapcore.NewCore(encoder, writeSyncer, l),zapcore.NewCore(consoleEncoder, zapcore.Lock(os.Stdout), zapcore.DebugLevel),)} else {core = zapcore.NewCore(encoder, writeSyncer, l)}lg = zap.New(core, zap.AddCaller())// 使用 lg 替换zap中的全局L，从而外部可以直接使用zap.L().Info记录日志，而不是logger.lg.Infozap.ReplaceGlobals(lg)zap.L().Info("init logger success")return
}func getEncoder() zapcore.Encoder {encoderConfig := zap.NewProductionEncoderConfig()encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoderencoderConfig.TimeKey = "time"encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoderencoderConfig.EncodeDuration = zapcore.SecondsDurationEncoderencoderConfig.EncodeCaller = zapcore.ShortCallerEncoderreturn zapcore.NewJSONEncoder(encoderConfig)
}func getLogWriter(filename string, maxSize, maxBackup, maxAge int) zapcore.WriteSyncer {lumberJackLogger := &lumberjack.Logger{Filename:   filename,MaxSize:    maxSize,MaxBackups: maxBackup,MaxAge:     maxAge,}return zapcore.AddSync(lumberJackLogger)
}// GinLogger 接收gin框架默认的日志
func GinLogger() gin.HandlerFunc {return func(c *gin.Context) {start := time.Now()path := c.Request.URL.Pathquery := c.Request.URL.RawQueryc.Next()cost := time.Since(start)lg.Info(path,zap.Int("status", c.Writer.Status()),zap.String("method", c.Request.Method),zap.String("path", path),zap.String("query", query),zap.String("ip", c.ClientIP()),zap.String("user-agent", c.Request.UserAgent()),zap.String("errors", c.Errors.ByType(gin.ErrorTypePrivate).String()),zap.Duration("cost", cost),)}
}// GinRecovery recover掉项目可能出现的panic，并使用zap记录相关日志
func GinRecovery(stack bool) gin.HandlerFunc {return func(c *gin.Context) {defer func() {if err := recover(); err != any(nil) {// Check for a broken connection, as it is not really a// condition that warrants a panic stack trace.var brokenPipe boolif ne, ok := any(err).(*net.OpError); ok {if se, ok := ne.Err.(*os.SyscallError); ok {if strings.Contains(strings.ToLower(se.Error()), "broken pipe") || strings.Contains(strings.ToLower(se.Error()), "connection reset by peer") {brokenPipe = true}}}httpRequest, _ := httputil.DumpRequest(c.Request, false)if brokenPipe {lg.Error(c.Request.URL.Path,zap.Any("error", err),zap.String("request", string(httpRequest)),)// If the connection is dead, we can't write a status to it.c.Error(any(err).(error)) // nolint: errcheckc.Abort()return}if stack {lg.Error("[Recovery from panic]",zap.Any("error", err),zap.String("request", string(httpRequest)),zap.String("stack", string(debug.Stack())),)} else {lg.Error("[Recovery from panic]",zap.Any("error", err),zap.String("request", string(httpRequest)),)}c.AbortWithStatus(http.StatusInternalServerError)}}()c.Next()}
}

三、初始化MySQL连接

使用Gorm，初始化代码如下

dao/mysql/mysql.go

package mysqlimport ("bluebell/setting""fmt""gorm.io/driver/mysql""gorm.io/gorm"
)var db *gorm.DBfunc Init(cfg *setting.MySQLConfig) (err error) {dsn := fmt.Sprintf("%s:%s@(%s:%d)/%s?charset=utf8mb4&parseTime=true&loc=Local", cfg.User, cfg.Password, cfg.Host, cfg.Port, cfg.DB)db, err = gorm.Open(mysql.Open(dsn), &gorm.Config{})if err != nil {panic(any("failed to connect to db"))}sqlDB, err := db.DB()if err != nil {panic(any("create table err"))}// SetMaxIdleConns sets the maximum number of connections in the idle connection pool.sqlDB.SetMaxIdleConns(cfg.MaxIdleConns)// SetMaxOpenConns sets the maximum number of open connections to the database.sqlDB.SetMaxOpenConns(cfg.MaxOpenConns)return nil
}

四、初始化Redis连接

与初始化MySQL非常类似

dao/redis/redis.go

package redisimport ("bluebell/setting""fmt""github.com/go-redis/redis"
)
var (client * redis.ClientNil = redis.Nil
)func Init(cfg *setting.RedisConfig) (err error) {client = redis.NewClient(&redis.Options{Addr:         fmt.Sprintf("%s:%d", cfg.Host, cfg.Port),Password:     cfg.Password, // no password setDB:           cfg.DB,       // use default DBPoolSize:     cfg.PoolSize,MinIdleConns: cfg.MinIdleConns,})// 注：使用Val()不会返回错误，出错时返回零值，使用Result则可以根据返回的error判断是否出错了_, err = client.Ping().Result()if err != nil {fmt.Println("init redis failed")return err}return nil 
}

五、初始化gin框架内置的校验器使用的翻译器

由于我们会使用validator组件进行gin的参数校验，所以为了错误提示信息更为友好，需要初始化翻译器。
controller/validator.go

package controllerimport ("bluebell/models""fmt""reflect""strings""github.com/gin-gonic/gin/binding""github.com/go-playground/locales/en""github.com/go-playground/locales/zh"ut "github.com/go-playground/universal-translator""github.com/go-playground/validator/v10"enTranslations "github.com/go-playground/validator/v10/translations/en"zhTranslations "github.com/go-playground/validator/v10/translations/zh"
)// 定义一个全局翻译器T
var trans ut.Translator// InitTrans 初始化翻译器
func InitTrans(locale string) (err error) {// 修改gin框架中的Validator引擎属性，实现自定制if v, ok := binding.Validator.Engine().(*validator.Validate); ok {// 注册一个获取json tag的自定义方法v.RegisterTagNameFunc(func(fld reflect.StructField) string {name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]if name == "-" {return ""}return name})// 为SignUpParam注册自定义校验方法v.RegisterStructValidation(SignUpParamStructLevelValidation, models.ParamSignUp{})zhT := zh.New() // 中文翻译器enT := en.New() // 英文翻译器// 第一个参数是备用（fallback）的语言环境// 后面的参数是应该支持的语言环境（支持多个）// uni := ut.New(zhT, zhT) 也是可以的uni := ut.New(enT, zhT, enT)// locale 通常取决于 http 请求头的 'Accept-Language'var ok bool// 也可以使用 uni.FindTranslator(...) 传入多个locale进行查找trans, ok = uni.GetTranslator(locale)if !ok {return fmt.Errorf("uni.GetTranslator(%s) failed", locale)}// 注册翻译器switch locale {case "en":err = enTranslations.RegisterDefaultTranslations(v, trans)case "zh":err = zhTranslations.RegisterDefaultTranslations(v, trans)default:err = enTranslations.RegisterDefaultTranslations(v, trans)}return}return
}// removeTopStruct 去除提示信息中的结构体名称
func removeTopStruct(fields map[string]string) map[string]string {res := map[string]string{}for field, err := range fields {res[field[strings.Index(field, ".")+1:]] = err}return res
}// SignUpParamStructLevelValidation 自定义SignUpParam结构体校验函数
func SignUpParamStructLevelValidation(sl validator.StructLevel) {su := sl.Current().Interface().(models.ParamSignUp)if su.Password != su.RePassword {// 输出错误提示信息，最后一个参数就是传递的paramsl.ReportError(su.RePassword, "re_password", "RePassword", "eqfield", "password")}
}

其中我们为注册参数ParamSignUp校验做了自定义校验，用到了注册参数，所以这里也把model定义一下。

models/params.go

package models// ParamSignUp 注册请求参数
type ParamSignUp struct {Username   string `json:"username" binding:"required"`Password   string `json:"password" binding:"required"`RePassword string `json:"re_password" binding:"required,eqfield=Password"`
}

六、注册路由

注册路由用到了我们之前介绍的路由拆分和管理技巧。

package routerimport ("bluebell/logger""net/http""github.com/gin-gonic/gin"
)func SetupRouter(mode string) *gin.Engine {if mode == gin.ReleaseMode {gin.SetMode(gin.ReleaseMode) // gin 设置成发布模式}r := gin.New()// 使用我们自定义的两个中间件r.Use(logger.GinLogger(), logger.GinRecovery(true))// 加载首页html文件r.LoadHTMLFiles("./templates/index.html")// 加载静态文件r.Static("/static", "./static")r.GET("/ping", func(c *gin.Context) {c.String(http.StatusOK, "pong")})r.GET("/", func(c *gin.Context) {c.HTML(http.StatusOK, "index.html", nil)})r.NoRoute(func(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"msg": "404",})})return r
}

七、 启动服务

main.go

package mainimport ("bluebell/controller""bluebell/dao/mysql""bluebell/dao/redis""bluebell/logger""bluebell/router""bluebell/setting""fmt""os"
)func main() {if len(os.Args) < 2 {fmt.Println("need config file. eg:bluebell config.yaml")return}// 1. 加载配置if err := setting.Init(os.Args[1]); err != nil {fmt.Printf("load config failed,err:%v\n", err)return}// 2. 初始化日志if err := logger.Init(setting.Conf.LogConfig, setting.Conf.Mode); err != nil {fmt.Printf("init logger failed,err:%v\n", err)return}// 3. 初始化MySQL连接if err := mysql.Init(setting.Conf.MySQLConfig); err != nil {fmt.Printf("init mysql failed,err:%v\n", err)}// 4. 初始化Redis连接if err := redis.Init(setting.Conf.RedisConfig); err != nil {fmt.Printf("init redis failed,err:%v\n", err)}// 5. 初始化gin框架内置的校验器使用的翻译器if err := controller.InitTrans("zh"); err != nil {fmt.Printf("init validator trans failed, err:%v\n", err)return}// 6. 注册路由r := router.SetupRouter(setting.Conf.Mode)// 7. 启动服务（优雅关机和重启）err := r.Run(fmt.Sprintf(":%d", setting.Conf.Port))if err != nil {fmt.Printf("run server failed, err:%v\n", err)return}
}

八、测试运行

运行前需要先保证MySQL中已经建立了对应的bluebell库，然后Redis服务端时开启的。

首先我们需要使用go build编译项目，在项目路径下执行go build即可，编译成功会出现一个可执行文件，如下
在这里插入图片描述

随后我们传入配置文件路径执行，可以看到启动后，没有报错且光标一直在闪烁，便是项目启动成功且在8084端口监听了（可通过Ctrl+C退出程序）。此外，我们也能看到产生了日志文件web_app.log
在这里插入图片描述
通过浏览器访问也成功了

在这里插入图片描述
还可以访问一下首页看看，访问成功！只是目前还没有业务数据，所以是一个非常简单的空页面而已。
在这里插入图片描述

九：注意事项

项目中我们使用了os.Args接收参数，实际也可以使用flag。那么为什么要运行时传配置文件路径，而不是直接在代码中用相对路径写死呢？

原因是项目运行时的基准目录，是以执行运行程序所在目录为准的，也就是说，编译后产生了.exe文件，我们如何放到了其他目录下去执行，代码中写死配置文件读取目录的话可能就读不到了，因为路径不对了。但是让用户自己指定目录，在执行时保证指定路径下配置文件存在，就可以正常执行。

这篇关于11. 搭建较通用的GoWeb开发脚手架的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/793309。

相关文章

Python通过模块化开发优化代码的技巧分享

Python通过模块化开发优化代码的技巧分享

《Python通过模块化开发优化代码的技巧分享》模块化开发就是把代码拆成一个个“零件”,该封装封装,该拆分拆分,下面小编就来和大家简单聊聊python如何用模块化开发进行代码优化吧... 目录什么是模块化开发如何拆分代码改进版：拆分成模块让模块更强大：使用 __init__.py你一定会遇到的问题模www.
阅读更多...
Spring Security基于数据库的ABAC属性权限模型实战开发教程

Spring Security基于数据库的ABAC属性权限模型实战开发教程

《SpringSecurity基于数据库的ABAC属性权限模型实战开发教程》：本文主要介绍SpringSecurity基于数据库的ABAC属性权限模型实战开发教程,本文给大家介绍的非常详细,对大... 目录1. 前言2. 权限决策依据RBACABAC综合对比3. 数据库表结构说明4. 实战开始5. MyBA
阅读更多...
使用Python开发一个简单的本地图片服务器

使用Python开发一个简单的本地图片服务器

《使用Python开发一个简单的本地图片服务器》本文介绍了如何结合wxPython构建的图形用户界面GUI和Python内建的Web服务器功能,在本地网络中搭建一个私人的,即开即用的网页相册,文中的示... 目录项目目标核心技术栈代码深度解析完整代码工作流程主要功能与优势潜在改进与思考运行结果总结你是否曾经
阅读更多...
使用Python实现快速搭建本地HTTP服务器

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》：本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.
阅读更多...
MySQL双主搭建+keepalived高可用的实现

MySQL双主搭建+keepalived高可用的实现

《MySQL双主搭建+keepalived高可用的实现》本文主要介绍了MySQL双主搭建+keepalived高可用的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,... 目录一、测试环境准备二、主从搭建1.创建复制用户2.创建复制关系3.开启复制，确认复制是否成功4.同
阅读更多...
Spring Boot + MyBatis Plus 高效开发实战从入门到进阶优化(推荐)

Spring Boot + MyBatis Plus 高效开发实战从入门到进阶优化(推荐)

《SpringBoot+MyBatisPlus高效开发实战从入门到进阶优化(推荐)》本文将详细介绍SpringBoot+MyBatisPlus的完整开发流程,并深入剖析分页查询、批量操作、动... 目录Spring Boot + MyBATis Plus 高效开发实战：从入门到进阶优化1. MyBatis
阅读更多...
Python基于wxPython和FFmpeg开发一个视频标签工具

Python基于wxPython和FFmpeg开发一个视频标签工具

《Python基于wxPython和FFmpeg开发一个视频标签工具》在当今数字媒体时代,视频内容的管理和标记变得越来越重要,无论是研究人员需要对实验视频进行时间点标记,还是个人用户希望对家庭视频进行... 目录引言1. 应用概述2. 技术栈分析2.1 核心库和模块2.2 wxpython作为GUI选择的优
阅读更多...
使用Java实现通用树形结构构建工具类

使用Java实现通用树形结构构建工具类

《使用Java实现通用树形结构构建工具类》这篇文章主要为大家详细介绍了如何使用Java实现通用树形结构构建工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录完整代码一、设计思想与核心功能二、核心实现原理1. 数据结构准备阶段2. 循环依赖检测算法3. 树形结构构建4. 搜索子
阅读更多...
利用Python开发Markdown表格结构转换为Excel工具

利用Python开发Markdown表格结构转换为Excel工具

《利用Python开发Markdown表格结构转换为Excel工具》在数据管理和文档编写过程中,我们经常使用Markdown来记录表格数据,但它没有Excel使用方便,所以本文将使用Python编写一... 目录1.完整代码2. 项目概述3. 代码解析3.1 依赖库3.2 GUI 设计3.3 解析 Mark
阅读更多...
利用Go语言开发文件操作工具轻松处理所有文件

利用Go语言开发文件操作工具轻松处理所有文件

《利用Go语言开发文件操作工具轻松处理所有文件》在后端开发中,文件操作是一个非常常见但又容易出错的场景,本文小编要向大家介绍一个强大的Go语言文件操作工具库,它能帮你轻松处理各种文件操作场景... 目录为什么需要这个工具？核心功能详解1. 文件/目录存javascript在性检查2. 批量创建目录3. 文件
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2