Gin是一个用Go语言编写的web框架。它是一个类似于martini但拥有更好性能的API框架, 由于使用了httprouter,速度提高了近40倍。 如果你是性能和高效的追求者, 你会爱上Gin。
一、Gin框架介绍
Go世界里最流行的Web框架,Github上有32K+star。 基于httprouter开发的Web框架。 中文文档齐全,简单易用的轻量级框架。
二、Gin框架安装与使用
2.1 安装
下载并安装Gin:
go get -u github.com/gin-gonic/gin
若遇到protobuf缺失(Google相关的包):— 未开启go mod的情况下
- 在Go的root目录,src下创建两个文件夹“%GOROOT%\src\google.golang.org\protobuf”
 - 使用git clone命令,执行如下代码“https://github.com/protocolbuffers/protobuf-go.git”,将下载内容拷贝至放入protobuf文件夹中
或 https://robinqiwei.coding.net/p/googleprotobuf/git (项目代码托管在coding上)2.2 分类处理(按类型进行直接解析): 调用r.GET/POST/DELETE等
 
Logger是负责进行打印并输出日志的中间件,方便开发者进行程序调试;Recovery中间件的作用是如果程序执行过程中遇到panic中断了服务,则Recovery会恢复程序执行,并返回服务器500内部错误。通常情况下,我们使用默认的gin.Default创建Engine实例。 注意:Run方法的参数是冒号+port的字符串!!!
package mainimport ("github.com/gin-gonic/gin")func main() {// 创建一个默认的路由引擎r := gin.Default()// GET:请求方式;/hello:请求的路径// 当客户端以GET方法请求/hello路径时,会执行后面的匿名函数r.GET("/hello", func(c *gin.Context) {// c.JSON:返回JSON格式的数据c.JSON(200, gin.H{"message": "Hello world!",})})// 启动HTTP服务,默认在0.0.0.0:8080启动服务r.Run(":8000")}
将上面的代码保存并编译执行,然后使用浏览器打开127.0.0.1:8080/hello就能看到一串JSON字符串。
2.3 通用的处理方法: r.Handle()方法处理请求
engine中可以直接进行HTTP请求的处理,在engine中使用Handle方法进行http请求的处理。Handle方法包含三个参数,具体如下所示:
func (group *RouterGroup) Handle(httpMethod, relativePath string, handlers ...HandlerFunc) IRoutes// 例子engine.Handle("GET", "/hello", func(context *gin.Context) {//获取请求接口fmt.Println(context.FullPath())//获取字符串参数name := context.DefaultQuery("name", "")fmt.Println(name)//输出context.Writer.Write([]byte("Hello ," + name))})// Context是gin框架中封装的一个结构体,这是gin框架中最重要,最基础的一个结构体对象。该结构体可以提供我们操作请求,处理请求,获取数据等相关的操作,通常称之为上下文对象,简单说为我们提供操作环境。
- httpMethod:第一个参数表示要处理的HTTP的请求类型,是GET、POST、DELETE等8种请求类型中的一种。
 
注意: httpMethod不支持小写,仅全部大写
- relativePath:第二个参数表示要解析的接口,由开发者进行定义。
 - 
三、规范之RESTful API
REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”或“表现层状态转化”。
推荐阅读阮一峰 理解RESTful架构
简单来说,REST的含义就是客户端与Web服务器之间进行交互的时候,使用HTTP协议中的4个请求方法代表不同的动作。 GET用来获取资源POST用来新建资源PUT用来更新资源DELETE用来删除资源。- OPTIONS、HEAD、TRACE、CONNECT 这几种不常用
 
只要API程序遵循了REST风格,那就可以称其为RESTful API。目前在前后端分离的架构中,前后端基本都是通过RESTful API来进行交互。
例如,我们现在要编写一个管理书籍的系统,我们可以查询对一本书进行查询、创建、更新和删除等操作,我们在编写程序的时候就要设计客户端浏览器与我们Web服务端交互的方式和路径。按照经验我们通常会设计成如下模式:
| 请求方法 | URL | 含义 | 
|---|---|---|
| GET | /book | 查询书籍信息 | 
| POST | /create_book | 创建书籍记录 | 
| POST | /update_book | 更新书籍信息 | 
| POST | /delete_book | 删除书籍信息 | 
同样的需求我们按照RESTful API设计如下:
| 请求方法 | URL | 含义 | 
|---|---|---|
| GET | /book | 查询书籍信息 | 
| POST | /book | 创建书籍记录 | 
| PUT | /book | 更新书籍信息 | 
| DELETE | /book | 删除书籍信息 | 
Gin框架支持开发RESTful API的开发。
func main() {r := gin.Default()r.GET("/book", func(c *gin.Context) {c.JSON(200, gin.H{"message": "GET",})})r.POST("/book", func(c *gin.Context) {c.JSON(200, gin.H{"message": "POST",})})r.PUT("/book", func(c *gin.Context) {c.JSON(200, gin.H{"message": "PUT",})})r.DELETE("/book", func(c *gin.Context) {c.JSON(200, gin.H{"message": "DELETE",})})}
开发RESTful API的时候我们通常使用Postman来作为客户端的测试工具。
四、Gin渲染
4.1 HTML渲染 - LoadHTMLGlob()或者LoadHTMLFiles()
我们首先定义一个存放模板文件的templates文件夹,然后在其内部按照业务分别定义一个posts文件夹和一个users文件夹。 posts/index.html文件的内容如下:
{{define "posts/index.html"}}<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>posts/index</title></head><body>{{.title}}</body></html>{{end}}
users/index.html文件的内容如下:
{{define "users/index.html"}}<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>users/index</title></head><body>{{.title}}</body></html>{{end}}
Gin框架中使用LoadHTMLGlob()或者LoadHTMLFiles()方法进行HTML模板渲染。
func main() {r := gin.Default()r.LoadHTMLGlob("templates/**/*");// 多个//r.LoadHTMLFiles("templates/posts/index.html","templates/users/index.html")// 单个文件r.GET("/posts/index", func(c *gin.Context) {c.HTML(http.StatusOK, "posts/index.html", gin.H{"title": "posts/index",})})r.GET("users/index", func(c *gin.Context) {c.HTML(http.StatusOK, "users/index.html", gin.H{"title": "users/index",})})r.Run(":8080")}
4.2 自定义模板函数 - SetFuncMap
定义一个不转义相应内容的safe模板函数如下:
func main() {router := gin.Default()router.SetFuncMap(template.FuncMap{"safe": func(str string) template.HTML{return template.HTML(str)},})router.LoadHTMLFiles("./index.tmpl")router.GET("/index", func(c *gin.Context) {c.HTML(http.StatusOK, "index.tmpl", "<a href='https://liwenzhou.com'>李文周的博客</a>")})router.Run(":8080")}
在index.tmpl中使用定义好的safe模板函数:
<!DOCTYPE html><html lang="zh-CN"><head><title>修改模板引擎的标识符</title></head><body><div>{{ . | safe }}</div></body></html>
4.3 静态文件处理 - Static
当我们渲染的HTML文件中引用了静态文件时,我们只需要按照以下方式在渲染页面前调用gin.Static方法即可。
func main() {r := gin.Default()r.Static("/static", "./static")r.LoadHTMLGlob("templates/**/*")// ...r.Run(":8080")}
4.4 使用模板继承
Gin框架默认都是使用单模板,如果需要使用block template功能,可以通过"github.com/gin-contrib/multitemplate"库实现,具体示例如下:
首先,假设我们项目目录下的templates文件夹下有以下模板文件,其中home.tmpl和index.tmpl继承了base.tmpl:
templates├── includes│ ├── home.tmpl│ └── index.tmpl├── layouts│ └── base.tmpl└── scripts.tmpl
然后我们定义一个loadTemplates函数如下:
func loadTemplates(templatesDir string) multitemplate.Renderer {r := multitemplate.NewRenderer()layouts, err := filepath.Glob(templatesDir + "/layouts/*.tmpl")if err != nil {panic(err.Error())}includes, err := filepath.Glob(templatesDir + "/includes/*.tmpl")if err != nil {panic(err.Error())}// 为layouts/和includes/目录生成 templates mapfor _, include := range includes {layoutCopy := make([]string, len(layouts))copy(layoutCopy, layouts)files := append(layoutCopy, include)r.AddFromFiles(filepath.Base(include), files...)}return r}
我们在main函数中
func indexFunc(c *gin.Context){c.HTML(http.StatusOK, "index.tmpl", nil)}func homeFunc(c *gin.Context){c.HTML(http.StatusOK, "home.tmpl", nil)}func main(){r := gin.Default()r.HTMLRender = loadTemplates("./templates")r.GET("/index", indexFunc)r.GET("/home", homeFunc)r.Run()}
4.5 补充文件路径处理
关于模板文件和静态文件的路径,我们需要根据公司/项目的要求进行设置。可以使用下面的函数获取当前执行程序的路径。
func getCurrentPath() string {if ex, err := os.Executable(); err == nil {return filepath.Dir(ex)}return "./"}
4.6 JSON渲染
func main() {r := gin.Default()// gin.H 是map[string]interface{}的缩写r.GET("/someJSON", func(c *gin.Context) {// 方式一:自己拼接JSONc.JSON(http.StatusOK, gin.H{"message": "Hello world!"})})r.GET("/moreJSON", func(c *gin.Context) {// 方法二:使用结构体var msg struct {Name string `json:"user"` // json中key值使用`user`Message stringAge int}msg.Name = "小王子"msg.Message = "Hello world!"msg.Age = 18c.JSON(http.StatusOK, msg)})r.Run(":8080")}
4.7 XML渲染
注意需要使用具名的结构体类型。
func main() {r := gin.Default()// gin.H 是map[string]interface{}的缩写r.GET("/someXML", func(c *gin.Context) {// 方式一:自己拼接JSONc.XML(http.StatusOK, gin.H{"message": "Hello world!"})})r.GET("/moreXML", func(c *gin.Context) {// 方法二:使用结构体type MessageRecord struct {Name stringMessage stringAge int}var msg MessageRecordmsg.Name = "小王子"msg.Message = "Hello world!"msg.Age = 18c.XML(http.StatusOK, msg)})r.Run(":8080")}
4.8 YMAL渲染
r.GET("/someYAML", func(c *gin.Context) {c.YAML(http.StatusOK, gin.H{"message": "ok", "status": http.StatusOK})})
4.9 protobuf渲染
r.GET("/someProtoBuf", func(c *gin.Context) {reps := []int64{int64(1), int64(2)}label := "test"// protobuf 的具体定义写在 testdata/protoexample 文件中。data := &protoexample.Test{Label: &label,Reps: reps,}// 请注意,数据在响应中变为二进制数据// 将输出被 protoexample.Test protobuf 序列化了的数据c.ProtoBuf(http.StatusOK, data)})
五、获取参数
5.1 获取querystring参数 - Query 或 DefaultQuery
querystring指的是URL中?后面携带的参数,例如:/user/search?username=小王子&address=沙河。 获取请求的querystring参数的方法如下:
func main() {//Default返回一个默认的路由引擎r := gin.Default()r.GET("/user/search", func(c *gin.Context) {username := c.DefaultQuery("username", "小王子"); // 设置默认值//username := c.Query("username")address := c.Query("address")//输出json结果给调用方c.JSON(http.StatusOK, gin.H{"message": "ok","username": username,"address": address,})})r.Run()}
5.2 获取form参数 - PostForm 或 DefaultPostForm
请求的数据通过form表单来提交,例如向/user/search发送一个POST请求,获取请求数据的方式如下:
func main() {//Default返回一个默认的路由引擎r := gin.Default()r.POST("/user/search", func(c *gin.Context) {// DefaultPostForm取不到值时会返回指定的默认值// 1.默认值id := c.DefaultPostForm("id", "10086")// 2.仅获取username := c.PostForm("username")username := c.PostForm("username")fmt.Println(username)// 3.返回的第二个参数表示是否获取到password, exist := c.GetPostForm("password")if exist {fmt.Println(password)}//输出json结果给调用方c.JSON(http.StatusOK, gin.H{"message": "ok","id": id,"username": username,"password": password,"address": address,})})r.Run(":8080")}
5.3 路由参数-获取path参数 - Param
express路由
请求的参数通过URL路径传递,例如:/user/search/小王子/沙河。 获取请求URL路径中的参数的方式如下。
func main() {//Default返回一个默认的路由引擎r := gin.Default()r.GET("/user/search/:username/:address", func(c *gin.Context) {username := c.Param("username") // 都是必传,不然url路径不全address := c.Param("address")//输出json结果给调用方c.JSON(http.StatusOK, gin.H{"message": "ok","username": username,"address": address,})})r.Run(":8080")}
5.4 ** 参数绑定 - .ShouldBind() 反射
为了能够更方便的获取请求相关参数,提高开发效率,我们可以基于请求的Content-Type识别请求数据类型并利用反射机制自动提取请求中QueryString、form表单、JSON、XML等参数到结构体中。 下面的示例代码演示了.ShouldBind()强大的功能,它能够基于请求自动提取JSON、form表单和QueryString类型的数据,并把值绑定到指定的结构体对象。
相对于ShouldBind根据Content-type自动解析;但是ShouldBindQuery、BindJSON、ShouldBindJSON等以ShouldXxx或者BindXxx解析特定格式的参数
// Binding from JSONtype Login struct {User string `form:"user" json:"user" binding:"required"`Password string `form:"password" json:"password" binding:"required"`}func main() {router := gin.Default()// 绑定JSON的示例 ({"user": "q1mi", "password": "123456"})router.POST("/loginJSON", func(c *gin.Context) {var login Loginif err := c.ShouldBind(&login); err == nil {fmt.Printf("login info:%#v\n", login)c.JSON(http.StatusOK, gin.H{"user": login.User,"password": login.Password,})} else {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})}})// 绑定form表单示例 (user=q1mi&password=123456)router.POST("/loginForm", func(c *gin.Context) {var login Login// ShouldBind()会根据请求的Content-Type自行选择绑定器if err := c.ShouldBind(&login); err == nil {c.JSON(http.StatusOK, gin.H{"user": login.User,"password": login.Password,})} else {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})}})// 绑定QueryString示例 (/loginQuery?user=q1mi&password=123456)router.GET("/loginForm", func(c *gin.Context) {var login Login// ShouldBind()会根据请求的Content-Type自行选择绑定器if err := c.ShouldBind(&login); err == nil {c.JSON(http.StatusOK, gin.H{"user": login.User,"password": login.Password,})} else {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})}})// Listen and serve on 0.0.0.0:8080router.Run(":8080")}
ShouldBind会按照下面的顺序解析请求中的数据完成绑定:
- 如果是 
GET请求,只使用Form绑定引擎(query)。 - 如果是 
POST请求,首先检查content-type是否为JSON或XML,然后再使用Form(form-data)。六、文件上传
6.1 单个文件上传
文件上传前端页面代码:
后端gin框架部分代码:<!DOCTYPE html><html lang="zh-CN"><head><title>上传文件示例</title></head><body><form action="/upload" method="post" enctype="multipart/form-data"><input type="file" name="f1" /><input type="submit" value="上传" /></form></body></html>
func main() {router := gin.Default()// 处理multipart forms提交文件时默认的内存限制是32 MiB// 可以通过下面的方式修改// router.MaxMultipartMemory = 8 << 20 // 8 MiBrouter.POST("/upload", func(c *gin.Context) {// 单个文件file, err := c.FormFile("f1"); // 参数'f1'是前端input的name属性值if err != nil {c.JSON(http.StatusInternalServerError, gin.H{"message": err.Error(),})return}log.Println(file.Filename)dst := fmt.Sprintf("C:/tmp/%s", file.Filename); //写入保存路径// 上传文件到指定的目录c.SaveUploadedFile(file, dst)c.JSON(http.StatusOK, gin.H{"message": fmt.Sprintf("'%s' uploaded!", file.Filename),})})router.Run()}
6.2 多个文件上传
func main() {router := gin.Default()// 处理multipart forms提交文件时默认的内存限制是32 MiB// 可以通过下面的方式修改// router.MaxMultipartMemory = 8 << 20 // 8 MiBrouter.POST("/upload", func(c *gin.Context) {// Multipart form 多个文件!!!form, _ := c.MultipartForm()files := form.File["file"]for index, file := range files {log.Println(file.Filename)dst := fmt.Sprintf("C:/tmp/%s_%d", file.Filename, index)// 上传文件到指定的目录c.SaveUploadedFile(file, dst)}c.JSON(http.StatusOK, gin.H{"message": fmt.Sprintf("%d files uploaded!", len(files)),})})router.Run()}
七、重定向
HTTP重定向
HTTP 重定向很容易。 内部、外部重定向均支持。r.GET("/test", func(c *gin.Context) {c.Redirect(http.StatusMovedPermanently, "http://www.sogo.com/")})
路由重定向
路由重定向,使用HandleContext:r.GET("/test", func(c *gin.Context) {// 指定重定向的URLc.Request.URL.Path = "/test2"r.HandleContext(c)})r.GET("/test2", func(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"hello": "world"})})
八、Gin路由
8.1 普通路由
此外,还有一个可以匹配所有请求方法的r.GET("/index", func(c *gin.Context) {...})r.GET("/login", func(c *gin.Context) {...})r.POST("/login", func(c *gin.Context) {...})
Any方法如下:
为没有配置处理函数的路由添加处理程序,默认情况下它返回404代码,下面的代码为没有匹配到路由的请求都返回r.Any("/test", func(c *gin.Context) {...})
views/404.html页面。r.NoRoute(func(c *gin.Context) {c.HTML(http.StatusNotFound, "views/404.html", nil)})
8.2 路由组-Group
我们可以将拥有共同URL前缀的路由划分为一个路由组。习惯性一对{}包裹同组的路由,这只是为了看着清晰,你用不用{}包裹功能上没什么区别。不要理解成函数的{}。
路由组也是支持嵌套的,例如:func main() {r := gin.Default()userGroup := r.Group("/user"){userGroup.GET("/index", func(c *gin.Context) {...})userGroup.GET("/login", func(c *gin.Context) {...})userGroup.POST("/login", func(c *gin.Context) {...})}shopGroup := r.Group("/shop"){shopGroup.GET("/index", func(c *gin.Context) {...})shopGroup.GET("/cart", func(c *gin.Context) {...})shopGroup.POST("/checkout", func(c *gin.Context) {...})}r.Run()}
通常我们将路由分组用在划分业务逻辑或划分API版本时。shopGroup := r.Group("/shop"){shopGroup.GET("/index", func(c *gin.Context) {...})shopGroup.GET("/cart", func(c *gin.Context) {...})shopGroup.POST("/checkout", func(c *gin.Context) {...})// 嵌套路由组xx := shopGroup.Group("xx")xx.GET("/oo", func(c *gin.Context) {...})}
8.3 路由原理 - 树
Gin框架中的路由使用的是httprouter这个库。
其基本原理就是构造一个路由地址的前缀树。九、Gin中间件
Gin框架允许开发者在处理请求的过程中,加入用户自己的钩子(Hook)函数。这个钩子函数就叫中间件,中间件适合处理一些公共的业务逻辑,比如登录认证、权限校验、数据分页、记录日志、耗时统计等。 
在gin中,中间件称之为middleware,中间件的类型定义如下所示:
// HandlerFunc defines the handler used by gin middleware as return value.type HandlerFunc func(*Context)
HandlerFunc是一个函数类型,接收一个Context参数。用于编写程序处理函数并返回HandleFunc类型,作为中间件的定义。
9.0 中间件Use用法
在之前学习的课程中,均使用gin.Default创建了gin引擎engins变量,其中,就使用了中间件。如下图所示:
func Default() *Engine {debugPrintWARNINGDefault()engine := New()engine.Use(Logger(), Recovery())return engine}//Log中间件func Logger() HandlerFunc {return LoggerWithConfig(LoggerConfig{})}//Recovery中间件func Recovery() HandlerFunc {return RecoveryWithWriter(DefaultErrorWriter)}
在Default函数中,engine调用Use方法设置了Logger中间件和Recovery中间件。Use函数接收一个可变参数(三个…),类型为HandlerFunc,恰为中间件的类型。Use方法定义如下:
func (engine *Engine) Use(middleware ...HandlerFunc) IRoutes {engine.RouterGroup.Use(middleware...)engine.rebuild404Handlers()engine.rebuild405Handlers()return engine}
9.1 定义中间件[必须为 gin.HandlerFunc类型]
Gin中的中间件必须是一个gin.HandlerFunc类型。例如我们像下面的代码一样定义一个统计请求耗时的中间件。
// StatCost 是一个统计耗时请求耗时的中间件func StatCost() gin.HandlerFunc {return func(c *gin.Context) {start := time.Now()c.Set("name", "小王子") // 可以通过c.Set在请求上下文中设置值,后续的处理函数能够取到该值// 调用该请求的剩余处理程序c.Next()// 不调用该请求的剩余处理程序// c.Abort()// 计算耗时cost := time.Since(start)log.Println(cost)}}
9.2 注册中间件
为全局路由注册 - Use
func main() {// 新建一个没有任何默认中间件的路由r := gin.New()// 注册一个全局中间件r.Use(StatCost())r.GET("/test", func(c *gin.Context) {name := c.MustGet("name").(string) // 从上下文取值log.Println(name)c.JSON(http.StatusOK, gin.H{"message": "Hello world!",})})r.Run()}
为某个路由单独注册 - 参数
// 给/test2路由单独注册中间件(可注册多个)r.GET("/test2", StatCost(), func(c *gin.Context) {name := c.MustGet("name").(string) // 从上下文取值log.Println(name)c.JSON(http.StatusOK, gin.H{"message": "Hello world!",})})
为路由组注册中间件 - 参数
为路由组注册中间件有以下两种写法。
写法1:
shopGroup := r.Group("/shop", StatCost()){shopGroup.GET("/index", func(c *gin.Context) {...})...}
写法2:
shopGroup := r.Group("/shop")shopGroup.Use(StatCost()){shopGroup.GET("/index", func(c *gin.Context) {...})...}
9.3 中间件注意事项
gin默认中间件
gin.Default()默认使用了Logger和Recovery中间件,其中:
Logger中间件将日志写入gin.DefaultWriter,即使配置了GIN_MODE=release。 — 日志Recovery中间件会recover任何panic。如果有panic的话,会写入500响应码。— 覆盖错误,写入500
如果不想使用上面两个默认的中间件,可以使用gin.New()新建一个没有任何默认中间件的路由。
gin中间件中使用goroutine,启用新线程时:
当在中间件或handler中启动新的goroutine时,不能使用原始的上下文(c *gin.Context),必须使用其只读副本(c.Copy())。
十、运行多个服务
我们可以在多个端口启动服务,例如:
package mainimport ("log""net/http""time""github.com/gin-gonic/gin""golang.org/x/sync/errgroup")var (g errgroup.Group)func router01() http.Handler {// 服务1!!!e := gin.New()e.Use(gin.Recovery())e.GET("/", func(c *gin.Context) {c.JSON(http.StatusOK,gin.H{"code": http.StatusOK,"error": "Welcome server 01",},)})return e}func router02() http.Handler {// 服务2!!!e := gin.New()e.Use(gin.Recovery())e.GET("/", func(c *gin.Context) {c.JSON(http.StatusOK,gin.H{"code": http.StatusOK,"error": "Welcome server 02",},)})return e}func main() {server01 := &http.Server{Addr: ":8080",Handler: router01(),ReadTimeout: 5 * time.Second,WriteTimeout: 10 * time.Second,}server02 := &http.Server{Addr: ":8081",Handler: router02(),ReadTimeout: 5 * time.Second,WriteTimeout: 10 * time.Second,}// 借助errgroup.Group或者自行开启两个goroutine分别启动两个服务g.Go(func() error {return server01.ListenAndServe()})g.Go(func() error {return server02.ListenAndServe()})if err := g.Wait(); err != nil {log.Fatal(err)}}
