Gin 学习条记

八卦阵  金牌会员 | 2025-1-26 11:10:19 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 962|帖子 962|积分 2886

教程地址：https://www.bilibili.com/video/BV1FV4y1C72M?spm_id_from=333.788.videopod.sections&vd_source=707ec8983cc32e6e065d5496a7f79ee6
  
01-项目搭建



  • 各常用目录的说明：
    https://github.com/golang-standards/project-layout/blob/master/README_zh.md
02-优雅启停



  • 用gin启动web服务器
  1. package main
  3. import (
  4.         "context"
  5.         "github.com/gin-gonic/gin"
  6.         "log"
  7.         "net/http"
  8.         "os"
  9.         "os/signal"
  10.         "syscall"
  11.         "time"
  12. )
  14. func main() {
  15.         r := gin.Default()
  16.         srv := &http.Server{
  17.                 Addr:    ":5000",
  18.                 Handler: r,
  19.         }
  21.         // 通过协程启动服务
  22.         go func() {
  23.                 log.Printf("server listen at %s", srv.Addr)
  24.                 if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
  25.                         log.Fatalf("listen: %s\n", err)
  26.                 }
  27.         }()
  29.         // 制作按Ctrl+C退出功能，此处阻塞
  30.         quit := make(chan os.Signal)
  31.         signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
  32.         <-quit
  34.         // 系统停止开始
  35.         log.Println("Shutdown Server ...")
  36.        
  37.         // 等待2秒
  38.         ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
  39.         defer cancel()
  40.         // 停止服务
  41.         if err := srv.Shutdown(ctx); err != nil {
  42.                 log.Fatal("Server Shutdown:", err)
  43.         }
  44.         // 2秒后打印
  45.         select {
  46.         case <-ctx.Done():
  47.                 log.Println("timeout of 2 seconds.")
  48.         }
  49.         log.Println("Server exiting")
  50. }
复制代码
03-路由




  • 路由通过InitRouter初始化；路由与api操纵分离开来；api的路由设置与路由执行函数分开
  • router/router.go ：路由启动，并挂载user模块的路由
  1. package router
  3. import (
  4.         "Gin_gPRC/api/user"
  5.         "github.com/gin-gonic/gin"
  6. )
  8. // Router 接口，规定里面有一个Route函数
  9. type Router interface {
  10.         Route(r *gin.Engine)
  11. }
  13. // 定义一个RegisterRouter 注册类，这个类有一个Route方法
  14. // Route方法接收一个符合Router接口规范的对象
  15. // Route方法里运行了接收对象里的Route方法，用以绑定路由
  16. type RegisterRouter struct{}
  17. func New() *RegisterRouter {
  18.         return &RegisterRouter{}
  19. }
  20. func (*RegisterRouter) Route(router Router, r *gin.Engine) {
  21.         router.Route(r)
  22. }
  24. // 初始化路由
  25. func InitRouter(r *gin.Engine) {
  26.         router := New()
  27.         // 把user.RouterUser对象给到注册类，委托运行了user里的Route方法，传递r参数
  28.         router.Route(&user.RouterUser{}, r)
  29. }
复制代码


  • api/user/route.go；注册了/login/getCaptcha的POST接口，执行函数写再user.go中
  1. package user
  3. import "github.com/gin-gonic/gin"
  5. type RouterUser struct{}
  7. func (*RouterUser) Route(r *gin.Engine) {
  8.         handler := &HandlerUser{}
  9.         r.POST("/login/getCaptcha", handler.getCaptcha)
  10. }
复制代码


  • api/user/user.go；执行POST
  1. package user
  3. import "github.com/gin-gonic/gin"
  5. type HandlerUser struct{}
  7. func (*HandlerUser) getCaptcha(ctx *gin.Context) {
  8.         ctx.JSON(200, "getCaptcha test")
  9. }
复制代码
04-发送验证码




  • 创建消息模子
  1. package model
  3. type BusinessCode int
  4. type Result struct {
  5.         Code BusinessCode `json:"code"`
  6.         Msg  string       `json:"msg"`
  7.         Data any          `json:"data"`
  8. }
  10. func (r *Result) Success(data any) *Result {
  11.         r.Code = 200
  12.         r.Msg = "success"
  13.         r.Data = data
  14.         return r
  15. }
  17. func (r *Result) Fail(code BusinessCode, msg string) *Result {
  18.         r.Code = code
  19.         r.Msg = msg
  20.         return r
  21. }
复制代码


  • 手机验证
  1. package lib
  3. import "regexp"
  5. func CheckMobile(mobile string) bool {
  6.         if mobile == "" {
  7.                 return false
  8.         }
  9.         regular := "^1[3-9]\\d{9}$"
  10.         reg := regexp.MustCompile(regular)
  11.         return reg.MatchString(mobile)
  12. }
复制代码


  • 运行状态代码
  1. package model
  3. const (
  4.         NoLegalMobile BusinessCode = 2001
  5. )
复制代码


  • 修改getCaptcha，返回123456为验证码
  1. package user
  3. import (
  4.         "Gin_gPRC/lib"
  5.         "Gin_gPRC/model"
  6.         "github.com/gin-gonic/gin"
  7.         "log"
  8.         "time"
  9. )
  11. type HandlerUser struct{}
  13. func (*HandlerUser) getCaptcha(ctx *gin.Context) {
  14.         //ctx.JSON(200, "getCaptcha test")
  15.         rsp := &model.Result{}
  16.         //1. 获取参数
  17.         mobile := ctx.PostForm("mobile")
  18.         //2. 校验参数
  19.         if !lib.CheckMobile(mobile) {
  20.                 ctx.JSON(200, rsp.Fail(model.NoLegalMobile, "手机号码错误"))
  21.                 return
  22.         }
  23.         //3. 生成验证码
  24.         code := "123456"
  25.         //4. 调用短信平台接口
  26.         go func() {
  27.                 time.Sleep(2 * time.Second)
  28.                 log.Println("短信平台调用成功")
  29.         }()
  30.         ctx.JSON(200, rsp.Success(code))
  31. }
复制代码
05-redis操纵




  • redis.go，安装：go get github.com/go-redis/redis/v8
  1. package dao
  3. import (
  4.         "context"
  5.         "github.com/go-redis/redis/v8"
  6.         "time"
  7. )
  9. var Rc *RedisCache
  10. type RedisCache struct {
  11.         rdb *redis.Client
  12. }
  14. func init() {
  15.         rdb := redis.NewClient(&redis.Options{
  16.                 Addr:     "localhost:6379",
  17.                 Password: "",
  18.                 DB:       0,
  19.         })
  21.         Rc = &RedisCache{rdb: rdb}
  22. }
  24. func (rc *RedisCache) Put(ctx context.Context, key string, value string, expire time.Duration) error {
  25.         err := rc.rdb.Set(ctx, key, value, expire).Err()
  26.         return err
  27. }
  29. func (rc *RedisCache) Get(ctx context.Context, key string) (string, error) {
  30.         result, err := rc.rdb.Get(ctx, key).Result()
  31.         return result, err
  32. }
复制代码


  • repo/cache.go，定义Cache的接口，再由dao里的redis.go去实现
  1. package repo
  3. import (
  4.         "context"
  5.         "time"
  6. )
  8. type Cache interface {
  9.         Put(ctx context.Context, key string, value string, expire time.Duration) error
  10.         Get(ctx context.Context, key string) (string, error)
  11. }
复制代码


  • user.go，加入redis生存
  1. package user
  3. import (
  4.         "Gin_gPRC/dao"
  5.         "Gin_gPRC/lib"
  6.         "Gin_gPRC/model"
  7.         "Gin_gPRC/repo"
  8.         "context"
  9.         "github.com/gin-gonic/gin"
  10.         "log"
  11.         "time"
  12. )
  14. type HandlerUser struct {
  15.         cache repo.Cache
  16. }
  18. func New() *HandlerUser {
  19.         return &HandlerUser{
  20.                 cache: dao.Rc,
  21.         }
  22. }
  24. func (h *HandlerUser) getCaptcha(ctx *gin.Context) {
  25.         //ctx.JSON(200, "getCaptcha test")
  26.         rsp := &model.Result{}
  27.         //1. 获取参数
  28.         mobile := ctx.PostForm("mobile")
  29.         //2. 校验参数
  30.         if !lib.CheckMobile(mobile) {
  31.                 ctx.JSON(200, rsp.Fail(model.NoLegalMobile, "手机号码错误"))
  32.                 return
  33.         }
  34.         //3. 生成验证码
  35.         code := "123456"
  36.         //4. 调用短信平台接口
  37.         go func() {
  38.                 time.Sleep(2 * time.Second)
  39.                 log.Println("短信平台调用成功")
  41.                 // 制作一个超时的上下文
  42.                 c, cancel := context.WithTimeout(context.Background(), 2*time.Second)
  43.                 defer cancel()
  45.                 // redis加入
  46.                 err := h.cache.Put(c, "REGISTER"+mobile, code, 15*time.Minute)
  47.                 if err != nil {
  48.                         log.Printf("验证码存入redis出错，%v \n", err)
  49.                 }
  50.         }()
  51.         ctx.JSON(200, rsp.Success(code))
  52. }
复制代码
06-日记

安装：go get -u go.uber.org/zap
安装：go get -u github.com/natefinch/lumberjack



  • logs.go
  1. package lib
  3. import (
  4.         "github.com/gin-gonic/gin"
  5.         "github.com/natefinch/lumberjack"
  6.         "go.uber.org/zap"
  7.         "go.uber.org/zap/zapcore"
  8.         "net"
  9.         "net/http"
  10.         "net/http/httputil"
  11.         "os"
  12.         "runtime/debug"
  13.         "strings"
  14.         "time"
  15. )
  17. var lg *zap.Logger
  19. type LogConfig struct {
  20.         DebugFileName string `json:"debugFileName"`
  21.         InfoFileName  string `json:"infoFileName"`
  22.         WarnFileName  string `json:"warnFileName"`
  23.         MaxSize       int    `json:"maxSize"`
  24.         MaxAge        int    `json:"maxAge"`
  25.         MaxBackups    int    `json:"maxBackups"`
  26. }
  28. func InitLogger(cfg *LogConfig) (err error) {
  29.         writeSyncerDebug := getLogWriter(cfg.DebugFileName, cfg.MaxSize, cfg.MaxBackups, cfg.MaxAge)
  30.         writeSyncerInfo := getLogWriter(cfg.InfoFileName, cfg.MaxSize, cfg.MaxBackups, cfg.MaxAge)
  31.         writeSyncerWarn := getLogWriter(cfg.WarnFileName, cfg.MaxSize, cfg.MaxBackups, cfg.MaxAge)
  32.         encoder := getEncoder()
  34.         debugCore := zapcore.NewCore(encoder, writeSyncerDebug, zapcore.DebugLevel)
  35.         infoCore := zapcore.NewCore(encoder, writeSyncerInfo, zapcore.InfoLevel)
  36.         warnCore := zapcore.NewCore(encoder, writeSyncerWarn, zapcore.WarnLevel)
  38.         consoleEncoder := zapcore.NewConsoleEncoder(zap.NewDevelopmentEncoderConfig())
  39.         std := zapcore.NewCore(consoleEncoder, zapcore.Lock(os.Stdout), zapcore.DebugLevel)
  40.         core := zapcore.NewTee(debugCore, infoCore, warnCore, std)
  41.         lg = zap.New(core, zap.AddCaller())
  42.         zap.ReplaceGlobals(lg)
  43.         return
  45. }
  47. func getEncoder() zapcore.Encoder {
  48.         encoderConfig := zap.NewProductionEncoderConfig()
  49.         encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
  50.         encoderConfig.TimeKey = "time"
  51.         encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
  52.         encoderConfig.EncodeDuration = zapcore.SecondsDurationEncoder
  53.         encoderConfig.EncodeCaller = zapcore.ShortCallerEncoder
  54.         return zapcore.NewJSONEncoder(encoderConfig)
  55. }
  57. func getLogWriter(filename string, maxSize, maxBackup, maxAge int) zapcore.WriteSyncer {
  58.         lumberJackLogger := &lumberjack.Logger{
  59.                 Filename:   filename,
  60.                 MaxSize:    maxSize,
  61.                 MaxBackups: maxBackup,
  62.                 MaxAge:     maxAge,
  63.         }
  64.         return zapcore.AddSync(lumberJackLogger)
  65. }
  67. func GinLogger() gin.HandlerFunc {
  68.         return func(c *gin.Context) {
  69.                 start := time.Now()
  70.                 path := c.Request.URL.Path
  71.                 query := c.Request.URL.RawQuery
  72.                 c.Next()
  74.                 cost := time.Since(start)
  75.                 lg.Info(path,
  76.                         zap.Int("status", c.Writer.Status()),
  77.                         zap.String("method", c.Request.Method),
  78.                         zap.String("path", path),
  79.                         zap.String("query", query),
  80.                         zap.String("ip", c.ClientIP()),
  81.                         zap.String("user-agent", c.Request.UserAgent()),
  82.                         zap.String("errors", c.Errors.ByType(gin.ErrorTypePrivate).String()),
  83.                         zap.Duration("cost", cost),
  84.                 )
  85.         }
  86. }
  88. func GinRecovery(stack bool) gin.HandlerFunc {
  89.         return func(c *gin.Context) {
  90.                 defer func() {
  91.                         if err := recover(); err != nil {
  92.                                 var brokenPipe bool
  93.                                 if ne, ok := err.(*net.OpError); ok {
  94.                                         if se, ok := ne.Err.(*os.SyscallError); ok {
  95.                                                 if strings.Contains(strings.ToLower(se.Error()), "broken pipe") || strings.Contains(strings.ToLower(se.Error()), "connection reset by peer") {
  96.                                                         brokenPipe = true
  97.                                                 }
  98.                                         }
  99.                                 }
  101.                                 httpRequest, _ := httputil.DumpRequest(c.Request, false)
  102.                                 if brokenPipe {
  103.                                         lg.Error(c.Request.URL.Path,
  104.                                                 zap.Any("error", err),
  105.                                                 zap.String("request", string(httpRequest)))
  106.                                         c.Error(err.(error))
  107.                                         c.Abort()
  108.                                         return
  109.                                 }
  111.                                 if stack {
  112.                                         lg.Error("[Recovery from panic]",
  113.                                                 zap.Any("error", err),
  114.                                                 zap.String("request", string(httpRequest)),
  115.                                                 zap.String("stack", string(debug.Stack())))
  116.                                 } else {
  117.                                         lg.Error("[Recovery from panic]",
  118.                                                 zap.Any("error", err),
  119.                                                 zap.String("request", string(httpRequest)))
  120.                                 }
  121.                                 c.AbortWithStatus(http.StatusInternalServerError)
  122.                         }
  123.                 }()
  124.                 c.Next()
  125.         }
  126. }
复制代码


  • main.go里加入log
  1. package main
  3. import (
  4.         "Gin_gPRC/lib"
  5.         "Gin_gPRC/router"
  6.         "context"
  7.         "github.com/gin-gonic/gin"
  8.         "log"
  9.         "net/http"
  10.         "os"
  11.         "os/signal"
  12.         "syscall"
  13.         "time"
  14. )
  16. func main() {
  17.         r := gin.Default()
  19.         //log
  20.         lc := &lib.LogConfig{
  21.                 DebugFileName: "./logs/debug.log",
  22.                 InfoFileName:  "./logs/info.log",
  23.                 WarnFileName:  "./logs/warn.log",
  24.                 MaxSize:       500,
  25.                 MaxAge:        28,
  26.                 MaxBackups:    3,
  27.         }
  28.         err := lib.InitLogger(lc)
  29.         if err != nil {
  30.                 log.Fatal(err)
  31.         }
  33.         router.InitRouter(r)
  35.         srv := &http.Server{
  36.                 Addr:    ":5000",
  37.                 Handler: r,
  38.         }
  40.         go func() {
  41.                 log.Printf("server listen at %s", srv.Addr)
  42.                 if err := srv.ListenAndServe(); err != nil && err != http.ErrServerClosed {
  43.                         log.Fatalf("listen: %s\n", err)
  44.                 }
  45.         }()
  47.         quit := make(chan os.Signal)
  48.         signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
  49.         <-quit
  51.         log.Println("Shutdown Server ...")
  53.         ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
  54.         defer cancel()
  55.         if err := srv.Shutdown(ctx); err != nil {
  56.                 log.Fatal("Server Shutdown:", err)
  57.         }
  58.         select {
  59.         case <-ctx.Done():
  60.                 log.Println("timeout of 2 seconds.")
  61.         }
  62.         log.Println("Server exiting")
  63. }
复制代码


  • 在user.go里应用
  1. package user
  3. import (
  4.         "Gin_gPRC/dao"
  5.         "Gin_gPRC/lib"
  6.         "Gin_gPRC/model"
  7.         "Gin_gPRC/repo"
  8.         "context"
  9.         "github.com/gin-gonic/gin"
  10.         "go.uber.org/zap"
  11.         "time"
  12. )
  14. type HandlerUser struct {
  15.         cache repo.Cache
  16. }
  18. func New() *HandlerUser {
  19.         return &HandlerUser{
  20.                 cache: dao.Rc,
  21.         }
  22. }
  24. func (h *HandlerUser) getCaptcha(ctx *gin.Context) {
  25.         //ctx.JSON(200, "getCaptcha test")
  26.         rsp := &model.Result{}
  27.         //1. 获取参数
  28.         mobile := ctx.PostForm("mobile")
  29.         //2. 校验参数
  30.         if !lib.CheckMobile(mobile) {
  31.                 ctx.JSON(200, rsp.Fail(model.NoLegalMobile, "手机号码错误"))
  32.                 return
  33.         }
  34.         //3. 生成验证码
  35.         code := "123456"
  36.         //4. 调用短信平台接口
  37.         go func() {
  38.                 time.Sleep(2 * time.Second)
  39.                 zap.L().Info("短信平台调用成功")
  41.                 // 制作一个超时的上下文
  42.                 c, cancel := context.WithTimeout(context.Background(), 2*time.Second)
  43.                 defer cancel()
  45.                 // redis加入
  46.                 err := h.cache.Put(c, "REGISTER"+mobile, code, 15*time.Minute)
  47.                 if err != nil {
  48.                         zap.L().Error("验证码存入redis出错" + err.Error())
  49.                 }
  50.         }()
  51.         ctx.JSON(200, rsp.Success(code))
  52. }
复制代码
07-配置

安装：go get github.com/spf13/viper



  • config.yaml
  1. server:
  2.   name: "Gin_gRPC"
  3.   addr: "127.0.0.1:5000"
  4. zap:
  5.   debugFileName: "./logs/debug.log"
  6.   infoFileName: "./logs/info.log"
  7.   warnFileName: "./logs/warn.log"
  8.   maxSize: 500,
  9.   maxAge: 28,
  10.   maxBackups: 3
  11. redis:
  12.   host: "localhost"
  13.   port: 6379
  14.   password: ""
  15.   db: 0
复制代码


  • config/config.go
  1. package config
  3. import (
  4.         "Gin_gPRC/lib"
  5.         "github.com/go-redis/redis/v8"
  6.         "github.com/spf13/viper"
  7.         "log"
  8. )
  10. var Conf = InitConfig()
  12. type Config struct {
  13.         viper *viper.Viper
  14.         SC    *ServerConfig
  15. }
  17. type ServerConfig struct {
  18.         Name string
  19.         Addr string
  20. }
  22. func InitConfig() *Config {
  23.         conf := &Config{viper: viper.New()}
  24.         //workDir, _ := os.Getwd()
  25.         // 确定配置文件的名称、类型与位置
  26.         conf.viper.SetConfigName("config")
  27.         conf.viper.SetConfigType("yaml")
  28.         conf.viper.AddConfigPath("./")
  30.         err := conf.viper.ReadInConfig()
  31.         if err != nil {
  32.                 log.Fatalf("Fatal error config file: %s \n", err)
  33.         }
  35.         // 读取Server的配置
  36.         conf.ReadServerConfig()
  37.         // 初始化zapLog
  38.         conf.InitZapLog()
  39.         return conf
  40. }
  42. func (c *Config) InitZapLog() {
  43.         lc := &lib.LogConfig{
  44.                 DebugFileName: c.viper.GetString("zap.debugFileName"),
  45.                 InfoFileName:  c.viper.GetString("zap.infoFileName"),
  46.                 WarnFileName:  c.viper.GetString("zap.warnFileName"),
  47.                 MaxSize:       c.viper.GetInt("zap.maxSize"),
  48.                 MaxAge:        c.viper.GetInt("zap.maxAge"),
  49.                 MaxBackups:    c.viper.GetInt("zap.maxBackups"),
  50.         }
  51.         err := lib.InitLogger(lc)
  52.         if err != nil {
  53.                 log.Fatal(err)
  54.         }
  55. }
  57. func (c *Config) ReadServerConfig() {
  58.         sc := &ServerConfig{}
  59.         sc.Name = c.viper.GetString("server.name")
  60.         sc.Addr = c.viper.GetString("server.addr")
  61.         c.SC = sc
  62. }
  64. func (c *Config) ReadRedisConfig() *redis.Options {
  65.         return &redis.Options{
  66.                 Addr:     c.viper.GetString("redis.host") + ":" + c.viper.GetString("redis.port"),
  67.                 Password: c.viper.GetString("redis.password"),
  68.                 DB:       c.viper.GetInt("redis.db"),
  69.         }
  70. }
复制代码


  • 在main.go中应用
  1. func main() {
  2.         r := gin.Default()
  3.        
  4.         config.InitConfig()
  6.         router.InitRouter(r)
  8.         srv := &http.Server{
  9.                 Addr:    config.Conf.SC.Addr,
  10.                 Handler: r,
  11.         }
  12.         ...
  13. }
复制代码


  • 在redis.go中应用
  1. func init() {
  2.         rdb := redis.NewClient(config.Conf.ReadRedisConfig())
  3.         Rc = &RedisCache{rdb: rdb}
  4. }
复制代码
结束：

   对于微服务，思量实验下利用Go-micro + Gin的方式，后续继续记录

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

八卦阵

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

AI 运维 CIO 存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表