【web框架】go的web框架——gin（详细）

---

前言

Gin是一个用Go语言编写的web框架。它是一个类似于martini但拥有更好性能的API框架, 由于使用了httprouter，速度提高了近40倍

Go世界里最流行的Web框架，Github上有32K+star。 基于httprouter开发的Web框架。 中文文档齐全，简单易用的轻量级框架。

---

提示：以下是本篇文章正文内容，下面案例可供参考

一、gin的helloworld体验

1. 安装

go get -u github.com/gin-gonic/gin

2. 代码

package main

import "github.com/gin-gonic/gin"

func main() {
	//实例化一个gin的server对象
    r := gin.Default()
    //接受get请求
    r.GET("/ping", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "pong",
        })
    })
    r.Run() // listen and serve on 0.0.0.0:8080
}

3.使用New和Default初始化路由器的区别

gin.Default() 默认使用了logger and recovery (crash-free) 中间件
recovery 会把异常捕获到 做一个处理 比如返回一个状态码

gin.New() 没有使用任何中间件 有异常就会崩溃 无法返回任何信息

//Default逻辑
func Default() *Engine {
	debugPrintWARNINGDefault()
	engine := New()
	engine.Use(Logger(), Recovery())
	return engine
}

4. 使用get、post、put等http方法

func main() {
    // 使用默认中间件创建一个gin路由器
    // logger and recovery (crash-free) 中间件
    router := gin.Default()

    router.GET("/someGet", getting)
    router.POST("/somePost", posting)
    router.PUT("/somePut", putting)
    router.DELETE("/someDelete", deleting)
    router.PATCH("/somePatch", patching)
    router.HEAD("/someHead", head)
    router.OPTIONS("/someOptions", options)

    // 默认启动的是 8080端口，也可以自己定义启动端口
    router.Run()
    // router.Run(":3000") for a hard coded port
}

二、url和路由分组

1. 路由分组

func main() {
    router := gin.Default()
    // Simple group: v1
    v1 := router.Group("/v1")
    {
        v1.POST("/login", loginEndpoint)
        v1.POST("/submit", submitEndpoint)
        v1.POST("/read", readEndpoint)
    }
    // Simple group: v2
    v2 := router.Group("/v2")
    {
        v2.POST("/login", loginEndpoint)
        v2.POST("/submit", submitEndpoint)
        v2.POST("/read", readEndpoint)
    }
    router.Run(":8082")
}

2.带参数的url

package main

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

func main() {
    r := gin.Default()
    r.GET("/ping", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "pong",
        })
    })
    r.GET("/user/:name/:action/", func(c *gin.Context) {
        name := c.Param("name")
        action := c.Param("action")
        c.String(http.StatusOK, "%s is %s", name, action)
    })
    
    r.GET("/user/:name/*action", func(c *gin.Context) {
        name := c.Param("name")
        action := c.Param("action")
        c.String(http.StatusOK, "%s is %s", name, action)
    })


    r.Run(":8082") 
}

3. 获取路由分组的参数

package main

import "github.com/gin-gonic/gin"
//携带tag的结构体
type Person struct {
	//required 必须存在
	//uuid     必须是uuid
	ID string `uri:"id" binding:"required,uuid"`
	Name string `uri:"name" binding:"required"`
}

func main() {
	route := gin.Default()
	route.GET("/:name/:id", func(c *gin.Context) {
		//声明结构体
		var person Person
		//标识符约束于person
		if err := c.ShouldBindUri(&person); err != nil {
			c.JSON(400, gin.H{"msg": err})
			return
		}
		c.JSON(200, gin.H{"name": person.Name, "uuid": person.ID})
	})
	route.Run(":8088")
}

三、获取参数

1.获取get参数

func main() {
    router := gin.Default()
    // 匹配的url格式:  /welcome?firstname=Jane&lastname=Doe
    router.GET("/welcome", func(c *gin.Context) {
    	//带有默认值和不带的
        firstname := c.DefaultQuery("firstname", "Guest")
        lastname := c.Query("lastname") // 是 c.Request.URL.Query().Get("lastname") 的简写
        c.String(http.StatusOK, "Hello %s %s", firstname, lastname)
    })
    router.Run(":8080")
}

2. 获取post参数

func main() {
    router := gin.Default()
    // 匹配的url格式:  nick=Jane&message=Doe
    router.POST("/form_post", func(c *gin.Context) {
    	//带有默认值和不带的
    	nick := c.DefaultPostForm("nick", "anonymous")
        message := c.PostForm("message")
        
        c.JSON(200, gin.H{
            "status":  "posted",
            "message": message,
            "nick":    nick,
        })
    })
    router.Run(":8080")
}

3. get、post混合

POST /post?id=1234&page=1 HTTP/1.1
Content-Type: application/x-www-form-urlencoded

name=manu&message=this_is_great

func main() {
	router := gin.Default()
	router.GET("/welcome", getPost)
	router.POST("/form_post", getPost)
	router.Run(":8083")
}

func getPost(c *gin.Context) {
	id := c.Query("id")
	page := c.DefaultQuery("page", "0")
	name := c.PostForm("name")
	message := c.DefaultPostForm("message", "信息")
	c.JSON(http.StatusOK, gin.H{
		"id":      id,
		"page":    page,
		"name":    name,
		"message": message,
	})
}

四、JSON、ProtoBuf 渲染（输出格式）

1.输出json和protobuf

输出json

package main
import (
	"net/http"
	"github.com/gin-gonic/gin"
)
func main() {
	router := gin.Default()
	router.GET("/moreJSON", moreJSON)
	_=router.Run(":8083")
}
func moreJSON(c *gin.Context) {
	var msg struct {
		//tag定义json是修改默认的key   Name变为user
		Name    string `json:"user"`
		Message string
		Number  int
	}
	msg.Name = "bobby"
	msg.Message = "这是一个测试json"
	msg.Number = 20
	c.JSON(http.StatusOK,msg)
}

输出protobuf

新建user.proto文件

syntax = "proto3";
option go_package = ".;proto";

message Teacher {
    string name = 1;
    repeated string course = 2;
}

输出

package main
import (
	"net/http"
	"github.com/gin-gonic/gin"
	//自己的protobuf文件
	"awesomeProject3/gin_start/ch06/proto"
)
func main() {
	router := gin.Default()
	router.GET("/someProtoBuf", returnProto)
	_=router.Run(":8083")
}
func returnProto(c *gin.Context) {
	course:=[]string{"python","go","微服务"}
	//赋值
	user:=&proto.Teacher{
		Name:"bobby",
		Course:course,
	}
	c.ProtoBuf(http.StatusOK,user)
}

2. PureJSON

通常情况下，JSON会将特殊的HTML字符替换为对应的unicode字符，比如<替换为\u003c，如果想原样输出html，则使用PureJSON

func main() {
    r := gin.Default()
    
    // Serves unicode entities
    r.GET("/json", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "html": "Hello, world!",
        })
    })
    
    // Serves literal characters
    r.GET("/purejson", func(c *gin.Context) {
        c.PureJSON(200, gin.H{
            "html": "Hello, world!",
        })
    })
    
    // listen and serve on 0.0.0.0:8080
    r.Run(":8080")
}

五、表单验证

validator库参数校验若干实用技巧

1. 表单的基本验证

若要将请求主体绑定到结构体中，请使用模型绑定，目前支持JSON、XML、YAML和标准表单值(foo=bar&boo=baz)的绑定。

• Gin使用 go-playground/validator 验证参数，查看完整文档。

需要在绑定的字段上设置tag，比如，绑定格式为json，需要这样设置 json:“fieldname” 。
此外，Gin还提供了两套绑定方法：

• Must bind
• • Methods - Bind, BindJSON, BindXML, BindQuery, BindYAML
• • Behavior - 这些方法底层使用 MustBindWith，如果存在绑定错误，请求将被以下指令中止 c.AbortWithError(400, err).SetType(ErrorTypeBind)，响应状态代码会被设置为400，请求头Content-Type被设置为text/plain; charset=utf-8。注意，如果你试图在此之后设置响应代码，将会发出一个警告 [GIN-debug] [WARNING] Headers were already written. Wanted to override status code 400 with 422，如果你希望更好地控制行为，请使用ShouldBind相关的方法
• Should bind
• • Methods - ShouldBind, ShouldBindJSON, ShouldBindXML, ShouldBindQuery, ShouldBindYAML
• • Behavior - 这些方法底层使用 ShouldBindWith，如果存在绑定错误，则返回错误，开发人员可以正确处理请求和错误。

当我们使用绑定方法时，Gin会根据Content-Type推断出使用哪种绑定器，如果你确定你绑定的是什么，你可以使用MustBindWith或者BindingWith。

你还可以给字段指定特定规则的修饰符，如果一个字段用binding:"required"修饰，并且在绑定时该字段的值为空，那么将返回一个错误。

这里以登录注册逻辑完成示例

// 绑定为json 登录字段
type Login struct {
    User     string `form:"user" json:"user" xml:"user"  binding:"required"`
    Password string `form:"password" json:"password" xml:"password" binding:"required"`
}
// 绑定为json 注册字段
type SignUpParam struct {
    Age        uint8  `json:"age" binding:"gte=1,lte=130"`
    Name       string `json:"name" binding:"required"`
    Email      string `json:"email" binding:"required,email"`
    Password   string `json:"password" binding:"required"`
    RePassword string `json:"re_password" binding:"required,eqfield=Password"`//跨字段
}

func main() {
    router := gin.Default()
    // Example for binding JSON ({"user": "manu", "password": "123"})
    //登录逻辑 json
    router.POST("/loginJSON", func(c *gin.Context) {
        var json Login
        if err := c.ShouldBindJSON(&json); err != nil {
            c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
            return
        }
        
        if json.User != "manu" || json.Password != "123" {
            c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
            return
        } 
        
        c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
    })
    // Example for binding a HTML form (user=manu&password=123)
    //登录逻辑 form
    router.POST("/loginForm", func(c *gin.Context) {
        var form Login
        // This will infer what binder to use depending on the content-type header.
        if err := c.ShouldBind(&form); err != nil {
            c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
            return
        }
        
        if form.User != "manu" || form.Password != "123" {
            c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
            return
        } 
        
        c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
    })
    //注册逻辑
    r.POST("/signup", func(c *gin.Context) {
        var u SignUpParam
        if err := c.ShouldBind(&u); err != nil {
            c.JSON(http.StatusOK, gin.H{
                "msg": err.Error(),
            })
            return
        }
        // 保存入库等业务逻辑代码...

        c.JSON(http.StatusOK, "success")
    })
    
    // Listen and serve on 0.0.0.0:8080
    router.Run(":8080")
}

2. 错误翻译改进

表单认证的返回信息是英文
修改gin框架中的validator引擎属性，实现定制

package main

import (
	"fmt"
	"github.com/gin-gonic/gin"
	"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"
	en_translations "github.com/go-playground/validator/v10/translations/en"
	zh_translations "github.com/go-playground/validator/v10/translations/zh"
	"net/http"
	"reflect"
	"strings"
)

var trans ut.Translator

type LoginForm struct {
	User     string `json:"user" binding:"required,min=3,max=10"`
	Password string `json:"password" binding:"required"`
}
//这个翻译器可以直接拿去用
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
		})
		zhT := zh.New() //中文翻译器
		enT := en.New() //英文翻译器
		//第一个参数是备用的语言环境,后面的参数是支持的语言环境
		uni := ut.New(enT, zhT, enT)
		trans, ok = uni.GetTranslator(locale)
		if !ok {
			return fmt.Errorf("uni.GetTranslator(%s)", locale)
		}
		switch locale {
		case "en":
			en_translations.RegisterDefaultTranslations(v, trans)
		case "zh":
			zh_translations.RegisterDefaultTranslations(v, trans)
		default:
			en_translations.RegisterDefaultTranslations(v, trans)
		}
		return
	}
	return
}

func main() {
	if err := InitTrans("zh"); err != nil {
		fmt.Println("初始化翻译器错误")
		return
	}
	router := gin.Default()
	router.POST("/loginJSON", func(c *gin.Context) {
		var loginForm LoginForm
		if err := c.ShouldBind(&loginForm); err != nil {
			//返回err都得翻译
			errs, ok := err.(validator.ValidationErrors)
			if !ok {
				c.JSON(http.StatusOK, gin.H{
					//返回err中文版
					"msg": errs.Translate(trans),
				})
			}
			c.JSON(http.StatusBadRequest, gin.H{
				//返回err中文版
				"error": errs.Translate(trans),
			})
			return
		}
		c.JSON(http.StatusOK, gin.H{
			"msg": "登录成功",
		})
	})
	_ = router.Run(":8083")

}

3. 进一步改进校验方法

上面的错误提示看起来是可以了，但是还是差点意思，首先是错误提示中的字段并不是请求中使用的字段，例如：RePassword是我们后端定义的结构体中的字段名，而请求中使用的是re_password字段。如何是错误提示中的字段使用自定义的名称，例如jsontag指定的值呢？

只需要在初始化翻译器的时候像下面一样添加一个获取json tag的自定义方法即可。
但是还是有点瑕疵，那就是最终的错误提示信息中心还是有我们后端定义的结构体名称——SignUpParam，这个名称其实是不需要随错误提示返回给前端的，前端并不需要这个值。我们需要想办法把它去掉。

定义一个去掉结构体名称前缀的自定义方法
上述2里的InitTrans已实现

六、中间件和next函数

1.无中间件启动

#使用
r := gin.New()
#替代
// 默认启动方式，包含 Logger、Recovery 中间件
r := gin.Default()

2.使用中间件

func main() {
    // 创建一个不包含中间件的路由器
    r := gin.New()

    // 全局中间件
    // 使用 Logger 中间件
    r.Use(gin.Logger())

    // 使用 Recovery 中间件
    r.Use(gin.Recovery())

    // 路由添加中间件，可以添加任意多个
    r.GET("/benchmark", MyBenchLogger(), benchEndpoint)

    // 路由组中添加中间件
    // authorized := r.Group("/", AuthRequired())
    // exactly the same as:
    authorized := r.Group("/")
    // per group middleware! in this case we use the custom created
    // AuthRequired() middleware just in the "authorized" group.
    authorized.Use(AuthRequired())
    {
        authorized.POST("/login", loginEndpoint)
        authorized.POST("/submit", submitEndpoint)
        authorized.POST("/read", readEndpoint)

        // nested group
        testing := authorized.Group("testing")
        testing.GET("/analytics", analyticsEndpoint)
    }

    // Listen and serve on 0.0.0.0:8080
    r.Run(":8080")
}

3. 自定义组件

gin中间件执行原理

func Logger() gin.HandlerFunc {
    return func(c *gin.Context) {
        t := time.Now()

        // Set example variable
        c.Set("example", "12345")

        // before request

        c.Next()

        // after request
        latency := time.Since(t)
        log.Print(latency)

        // access the status we are sending
        status := c.Writer.Status()
        log.Println(status)
    }
}

func main() {
    r := gin.New()
    r.Use(Logger())

    r.GET("/test", func(c *gin.Context) {
        example := c.MustGet("example").(string)

        // it would print: "12345"
        log.Println(example)
    })

    // Listen and serve on 0.0.0.0:8080
    r.Run(":8080")
}

登录认证逻辑

func TokenRequired() gin.HandlerFunc {
	return func(c *gin.Context) {
		var token string
		for k, v := range c.Request.Header {
			if k == "X-Token" {
				token = v[0]
			} else {
				fmt.Println(k, v)
			}
		}
		if token != "bobby" {
			c.JSON(http.StatusUnauthorized, gin.H{
				"msg": "未登录",
			})
			//为什么连return都阻止不了后续的运行？看上图逻辑
			c.Abort()
		}
		c.Next()
	}
}

七、设置静态文件路径和html文件

官方地址：https://golang.org/pkg/html/template/
翻译： https://colobu.com/2019/11/05/Golang-Templates-Cheatsheet/#if/else_%E8%AF%AD%E5%8F%A5

tmpl是go语言下特有的模板

index.html内容

<html>
    <h1>
        {{ .title }}
    h1>
html>

templates/posts/index.tmpl

{{ define "posts/index.tmpl" }}
<html><h1>
    {{ .title }}
h1>
<p>Using posts/index.tmplp>
html>
{{ end }}

templates/users/index.tmpl

{{ define "users/index.tmpl" }}
<html><h1>
    {{ .title }}
h1>
<p>Using users/index.tmplp>
html>
{{ end }}

逻辑

package main

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

func main() {
    // 创建一个默认的路由引擎
    r := gin.Default()
    //LoadHTMLFiles这个方法会将指定的目录下的文件加载好   这个目录是相对目录
	//为什么我们通过goland运行main.go的时候并没有生成main.exe文件
	//Run启动需要exe文件启动  而goland自动生成了一个临时的exe文件
	//测试的时候要么用绝对路径直接运行  要么生成exe文件用相对路径运行
    // 配置模板 - templates下的所有目录下的所有模板
    r.LoadHTMLGlob("templates/**/*")
    //templates下的指定模板
    //router.LoadHTMLFiles("templates/template1.html", "templates/template2.html")
    // 配置静态文件夹路径 第一个参数是api，第二个是文件夹路径
    //第一个 在tmpl里以/static开头  会从后面找
    r.StaticFS("/static", http.Dir("./static"))
    // GET：请求方式；/hello：请求的路径
    // 当客户端以GET方法请求/hello路径时，会执行后面的匿名函数
    r.GET("/posts/index", func(c *gin.Context) {
        // c.JSON：返回JSON格式的数据
        c.HTML(http.StatusOK, "posts/index.tmpl", gin.H{
            "title": "你好",
        })
    })

    r.GET("gets/login", func(c *gin.Context) {
        c.HTML(http.StatusOK, "posts/login.tmpl", gin.H{
            "title": "登录",
        })
    })

    // 启动HTTP服务，默认在0.0.0.0:8080启动服务
    r.Run()
}

八、优雅重启或停止

package main

import (
	"fmt"
	"net/http"
	"os"
	"os/signal"
	"syscall"

	"github.com/gin-gonic/gin"
)

func main() {
	//	优雅推出,当我们关闭程序的时候应该做的后续处理
	//微服务启动之前或者启动之后会做一件事:将当前的服务的ip地址和端口号注册到注册中必
	//我们当前的服务停止了以后并没有告知注册中心
	router := gin.Default()
	router.GET("/", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{
			"msg": "pong",
		})
	})
	//防止后续阻塞
	go func() {
		_ = router.Run(":8083")
	}()
	//如果想要接收到信号
	quit := make(chan os.Signal)
	// SIGINT：ctrl+c     SIGTERM：kill进程          kill -9不会捕捉到
	signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
	<-quit
	//处理后续的逻辑   先是主协程挂掉  再是子协程
	fmt.Println("关闭server中。。。")
	fmt.Println("注销服务。。。")
}