手把手，带你从零封装Gin框架（五）：静态资源处理 & 优雅重启服务器

用户10002156

发布于 2024-01-17 13:30:07

1.3K1

发布于 2024-01-17 13:30:07

文章被收录于专栏：生活处处有BUG

前言

这一篇将对路由进行分组调整，把定义路由的文件集中到同一个目录下，并处理前端项目打包后的静态文件。在 Go 1.8 及以上版本中，内置的 http.Server 提供了 Shutdown() 方法，支持平滑重启服务器，本次将使用它调整项目启动代码，若 Go 版本低于 1.8 可以使用 fvbock/endless[1] 来替代

路由分组调整

新建 routes/api.go 文件，用来存放 api 分组路由

package routes

import (
    "github.com/gin-gonic/gin"
    "net/http"
)

// SetApiGroupRoutes 定义 api 分组路由
func SetApiGroupRoutes(router *gin.RouterGroup) {
    router.GET("/ping", func(c *gin.Context) {
        c.String(http.StatusOK, "pong")
    })
}

新建 bootstrap/router.go 文件，编写

ackage bootstrap

import (
    "github.com/gin-gonic/gin"
    "jassue-gin/global"
    "jassue-gin/routes"
)

func setupRouter() *gin.Engine {
    router := gin.Default()

    // 注册 api 分组路由
    apiGroup := router.Group("/api")
    routes.SetApiGroupRoutes(apiGroup)

    return router
}

// RunServer 启动服务器
func RunServer() {
    r := setupRouter()
    r.Run(":" + global.App.Config.App.Port)
}

若之后还有其它的分组路由，可以先在 routes 目录下新建一个文件，编写定义路由的方法，然后再到 bootstrap/router.go 调用注册

在 main.go 文件中调用 RunServer() 方法

package main

import (
    "jassue-gin/bootstrap"
    "jassue-gin/global"
)

func main() {
    // 初始化配置
    bootstrap.InitializeConfig()

    // 初始化日志
    global.App.Log = bootstrap.InitializeLog()
    global.App.Log.Info("log init success!")

    // 初始化数据库
    global.App.DB = bootstrap.InitializeDB()
    // 程序关闭前，释放数据库连接
    defer func() {
        if global.App.DB != nil {
            db, _ := global.App.DB.DB()
            db.Close()
        }
    }()

    // 启动服务器
    bootstrap.RunServer()
}

静态资源处理

在 bootstrap/router.go 文件，setupRouter() 方法中编写：

func setupRouter() *gin.Engine {
    router := gin.Default()

    // 前端项目静态资源
    router.StaticFile("/", "./static/dist/index.html")
    router.Static("/assets", "./static/dist/assets")
    router.StaticFile("/favicon.ico", "./static/dist/favicon.ico")
    // 其他静态资源
    router.Static("/public", "./static")
    router.Static("/storage", "./storage/app/public")

    // 注册 api 分组路由
    apiGroup := router.Group("/api")
    routes.SetApiGroupRoutes(apiGroup)

    return router
}

使用 docker 快速打包一份前端项目文件：

# 创建 node环境 容器
docker run -idt --name vue-app node:18.18.0-alpine
# 进入容器
docker exec -it vue-app sh
# 初始化 vue 模板
mkdir /app && cd /app
npm init vue@latest -y
# 安装项目依赖
cd vue-project
npm install
# 打包
npm run build
# 退出容器
exit
# 拷贝前端文件到 go 项目静态资源文件夹
docker cp vue-app:/app/vue-project/dist ~/go/src/jassue-gin/static

启动 main.go ，访问 http://localhost:8888/[2] ，前端资源处理成功

优雅重启/停止服务器

在 bootstrap/router.go 文件中，调整 RunServer() 方法

package bootstrap

import (
    "context"
    "github.com/gin-gonic/gin"
    "jassue-gin/global"
    "jassue-gin/routes"
    "log"
    "net/http"
    "os"
    "os/signal"
    "syscall"
    "time"
)

//...

func RunServer() {
   r := setupRouter()

   srv := &http.Server{
       Addr:    ":" + global.App.Config.App.Port,
       Handler: r,
   }

   go func() {
       if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
           log.Fatalf("listen: %s\n", err)
       }
   }()

   // 等待中断信号以优雅地关闭服务器（设置 5 秒的超时时间）
   quit := make(chan os.Signal)
   signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
   <-quit
   log.Println("Shutdown Server ...")

   ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
   defer cancel()
   if err := srv.Shutdown(ctx); err != nil {
       log.Fatal("Server Shutdown:", err)
   }
   log.Println("Server exiting")
}

在 routes/api.go 中，添加一条测试路由：

router.GET("/test", func(c *gin.Context) {
    time.Sleep(5*time.Second)
    c.String(http.StatusOK, "success")
})

启动 main.go，访问 http://localhost:8888/api/test[3] ，使用 CTRL + C 停止服务器，如下图所示：

服务器接收到中止命令后，依旧等待 /api/test 接口完成响应后才停止服务器

本文参与腾讯云自媒体同步曝光计划，分享自微信公众号。

原始发表：2024-01-13，如有侵权请联系 cloudcommunity@tencent.com 删除

框架

本文分享自生活处处有BUG 微信公众号，前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体同步曝光计划，欢迎热爱写作的你一起参与！

登录后参与评论

0 条评论

热度