Go语言(Golang)的Web框架：gin的使用

gin是Go语言写的一个web框架，API性能超强，运行速度号称较httprouter要快40倍。封装比较优雅，API友好，源码注释比较明确，具有快速灵活，容错方便等特点。

Github地址：https://github.com/gin-gonic/gin
gin的安装：go get github.com/gin-gonic/gin

API
gin.Default()   //创建路由
gin.DisableConsoleColor() //禁用控制台颜色
gin.SetMode() //设置gin模式。参数可以传递：gin.DebugMode、gin.ReleaseMode、gin.TestMode。
路由的方法为：假定我们先创建一个路由
router := gin.Default()
获取的方式可以为

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

router.Group(s string) //分组，s为组名

一、第一个gin程序

官方给的一个示例程序

package main
import "github.com/gin-gonic/gin"
func main() {
    r := gin.Default()
    r.GET("/ping", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "pong",
        })
    })
    r.Run(":8080") // listen and serve on 0.0.0.0:8080
}

运行程序，在浏览器上访问：http://127.0.0.1:8080/ping

c.String用来返回字符串。
c.JSON用来返回Json。

gin的功能不只是简单输出Json数据。它是一个轻量级的WEB框架，支持RestFull风格API，支持GET，POST，PUT，PATCH，DELETE，OPTIONS 等http方法，支持文件上传，分组路由，Multipart/Urlencoded FORM，以及支持JsonP，参数处理等等功能，这些都和WEB紧密相关，通过提供这些功能，使开发人员更方便地处理WEB业务。不同于 net/http库的路由函数，gin进行了封装，把request和response都封装到 gin.Context的上下文环境。

二、快速匹配参数

Gin框架可以快速的匹配参数

func main() {
    router := gin.Default()
    router.GET("/user/:name/:password", HinHandler)
    router.Run(":8081")
}
//HinHandler 解构传过来的name和password
func HinHandler(c *gin.Context) {
    name := c.Param("name")
    pwd := c.Param("password")
    //内部提供方法用来返回字符串
    c.String(http.StatusOK, "你好 %s,你的密码为%s", name, pwd)
}

运行程序在浏览器上访问：http://127.0.0.1:8081/user/huangzhe/123

三、Gin获取普通get参数

func main() {
    //修改模式
    gin.SetMode(gin.ReleaseMode)
    //Default方法创建一个路由handler。
    router := gin.Default()
    router.GET("/user", GetHandler)
    router.Run(":8081")
}
//GetHandler 使用get方式获取对应键的值
func GetHandler(c *gin.Context) {
    name := c.DefaultQuery("name", "Guest") //找不到name给它一个默认值Guest
    password := c.Query("password")         //找不到直接赋空
    //GetQuery返回两个参数，第一个是找到的对应键的值，第二个是是否找到error类型
    id, exist := c.GetQuery("id")
    if !exist {
        name = "the key is not exist"
    }
    c.Data(http.StatusOK, "text/plain",
        []byte(fmt.Sprintf("get success! %s %s %s", name, password, id)))
}

运行程序在浏览器上访问：
http://127.0.0.1:8081/user?name=huangzhe&password=123&id=456

四、分组

    //分组
    //组内成员访问为http://127.0.0.1:8080/admin/...
    v1 := router.Group("admin")
    
    {
        //访问为http://127.0.0.1:8080/admin/ping
        v1.GET("/ping", api.HelloPage)
        v1.GET("/welcome", api.LoginHandler)
        v1.GET("/getquery",api.GetHandler)
    }

五、Gin默认路由

我们可以自定义404错误

func main() {
    //修改模式
    gin.SetMode(gin.ReleaseMode)

    //Default方法创建一个路由handler。
    router := gin.Default()

    //设定请求url不存在的返回值
    router.NoRoute(NoResponse)

    router.GET("/user", GetHandler)
    router.Run(":8081")
}
//NoResponse 请求的url不存在，返回404
func NoResponse(c *gin.Context) {
    //返回404状态码
    c.JSON(http.StatusNotFound, gin.H{
        "status": 404,
        "error":  "404, page not exists!",
    })
}
//GetHandler 使用get方式获取对应键的值
func GetHandler(c *gin.Context) {
    name := c.DefaultQuery("name", "Guest") //找不到name给它一个默认值Guest
    password := c.Query("password")         //找不到直接赋空
    //GetQuery返回两个参数，第一个是找到的对应键的值，第二个是是否找到error类型
    id, exist := c.GetQuery("id")
    if !exist {
        name = "the key is not exist"
    }
    c.Data(http.StatusOK, "text/plain",
        []byte(fmt.Sprintf("get success! %s %s %s", name, password, id)))
}

我们去请求一个并不存在的url：http://127.0.0.1:8081/us

六、Gin获取普通post参数

我这里是使用RESTClient来模拟的，在Firefox上附加组件(https://addons.mozilla.org/zh-CN/firefox/addon/restclient/)

func main() {
    //修改模式
    gin.SetMode(gin.ReleaseMode)

    //Default方法创建一个路由handler。
    router := gin.Default()

    //设定请求url不存在的返回值
    router.NoRoute(NoResponse)

    router.POST("/user", PostLoginHandler)
    router.Run(":8081")
}

//NoResponse 请求的url不存在，返回404
func NoResponse(c *gin.Context) {
    //返回404状态码
    c.JSON(http.StatusNotFound, gin.H{
        "status": 404,
        "error":  "404, page not exists!",
    })
}

//PostLoginHandler 获取参数
func PostLoginHandler(c *gin.Context) {
    name := c.PostForm("name")                       //找不到name直接返回0值
    password := c.DefaultPostForm("password", "888") //找不到password赋默认值
    sec, ok := c.GetPostForm("second")               //判断是否能找到，找不到返回false
    c.String(http.StatusOK, "hello %s %s %s", name, password, sec)
    log.Panicln(ok)
}

使用post需要添加头字段

如下：

七、中间件MiddleWare

注意，gin.Default() 默认是加载了一些框架内置的中间件的，而 gin.New() 则没有，根据需要自己手动加载中间件。

func MiddleWare(c *gin.Context) {
    fmt.Println("before request")
    c.Next()
}
func main() {
    //修改模式
    gin.SetMode(gin.ReleaseMode)

    //Default方法创建一个路由handler。
    router := gin.Default()

    //设定请求url不存在的返回值
    router.NoRoute(NoResponse)

    router.Use(MiddleWare)

    router.GET("/user", GetHandler)
    router.Run(":8081")
}

//NoResponse 请求的url不存在，返回404
func NoResponse(c *gin.Context) {
    //返回404状态码
    c.JSON(http.StatusNotFound, gin.H{
        "status": 404,
        "error":  "404, page not exists!",
    })
}

//GetHandler 使用get方式获取对应键的值
func GetHandler(c *gin.Context) {
    name := c.DefaultQuery("name", "Guest") //找不到name给它一个默认值Guest
    password := c.Query("password")         //找不到直接赋空
    //GetQuery返回两个参数，第一个是找到的对应键的值，第二个是是否找到error类型
    id, exist := c.GetQuery("id")
    if !exist {
        name = "the key is not exist"
    }
    c.Data(http.StatusOK, "text/plain",
        []byte(fmt.Sprintf("get success! %s %s %s", name, password, id)))
}

我们访问上面的url

在终端上你会发现中间件已执行，我们可以在中间件里做验证或者⽇志记录

c.Next()继续执行下面的函数
c.Abort()截断执行

八、文件服务

上传单个文件

func main() {
    router := gin.Default()
    // Set a lower memory limit for multipart forms (default is 32 MiB)
    // router.MaxMultipartMemory = 8 << 20  // 8 MiB
    router.POST("/upload", func(c *gin.Context) {
        // single file
        file, _ := c.FormFile("file")
        log.Println(file.Filename)

        // Upload the file to specific dst.
        // c.SaveUploadedFile(file, dst)

        c.String(http.StatusOK, fmt.Sprintf("'%s' uploaded!", file.Filename))
    })
    router.Run(":8080")
}

上传多个文件

func main() {
    router := gin.Default()
    // Set a lower memory limit for multipart forms (default is 32 MiB)
    // router.MaxMultipartMemory = 8 << 20  // 8 MiB
    router.POST("/upload", func(c *gin.Context) {
        // Multipart form
        form, _ := c.MultipartForm()
        files := form.File["upload[]"]
        for _, file := range files {
            log.Println(file.Filename)

            // Upload the file to specific dst.
            // c.SaveUploadedFile(file, dst)
        }
        c.String(http.StatusOK, fmt.Sprintf("%d files uploaded!", len(files)))
    })
    router.Run(":8080")
}

九、异步协程

golang的高并发一大利器就是协程。gin里可以借助协程实现异步任务。因为涉及异步过程，请求的上下文需要copy到异步的上下文，并且这个上下文是只读的。

func main()  {
	router := gin.Default()
	router.GET("/async", func(c *gin.Context) {
		//This has to be used when the context has to be passed to a goroutine.
		cCp1:=c.Copy()
		go func() {
			time.Sleep(5*time.Second)
			fmt.Println("Done01! in path"+cCp1.Request.URL.Path)
			//c.String(http.StatusOK,"请求0：%s",cCp.Request.URL.Port())
		}()
		go func() {
			time.Sleep(3*time.Second)
			//c.String(http.StatusOK,"请求1：%s",cCp2.Request.URL.Path)
			fmt.Println("Done02! in path"+cCp1.Request.URL.Path)
		}()
		fmt.Println("main goroutine is done")
	})
	router.Run(":8080")

}

浏览器输入：http://localhost:8080/async

运行效果：

可以看出两个goroutine已经在运行了。

十、多格式渲染

既然请求可以使用不同的content-type，响应也如此。通常响应会有html，text，plain，json和xml等。
gin提供了很优雅的渲染方法。到目前为止，我们已经见识了c.String， c.JSON，c.HTML，下面介绍一下c.XML。

func main()  {
	router := gin.Default()
	router.GET("/render", func(c *gin.Context) {
		contentType:=c.DefaultQuery("content_type","xml")
		if contentType =="json" {
			c.JSON(http.StatusOK,gin.H{
				"user":"jiangzhou",
				"password":"666",
			})
		}else if contentType =="xml" {
			c.XML(http.StatusOK,gin.H{
				"user":"jz",
				"passowrd":"123",
			})

		}

	})
	router.Run(":8080")
}

浏览器输入：http://localhost:8080/render?content_type=json

浏览器输入：http://localhost:8080/render?content_type=xml

十一、表单上传

上面我们使用的都是curl上传，实际上，用户上传图片更多是通过表单，或者ajax和一些requests的请求完成。下面展示一下web的form表单如何上传。

我们先要写一个表单页面，因此需要引入gin如何render模板。前面我们见识了c.String和c.JSON。下面就来看看c.HTML方法。

首先需要定义一个模板的文件夹。然后调用c.HTML渲染模板，可以通过gin.H给模板传值。至此，无论是String，JSON还是HTML，以及后面的XML和YAML，都可以看到Gin封装的接口简明易用。

创建一个文件夹templates，然后再里面创建html文件upload.html:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>upload</title>
</head>
<body>
<h3>Single Upload</h3>
<form action="/upload", method="post" enctype="multipart/form-data">
    <input type="text" value="hello gin" />
    <input type="file" name="upload" />
    <input type="submit" value="upload" />
</form>
 
 
<h3>Multi Upload</h3>
<form action="/multi/upload", method="post" enctype="multipart/form-data">
    <input type="text" value="hello gin" />
    <input type="file" name="upload" />
    <input type="file" name="upload" />
    <input type="submit" value="upload" />
</form>
 
</body>
</html>

func main()  {
	//gin.SetMode(gin.ReleaseMode)
	router := gin.Default()
	// LoadHTMLGlob loads HTML files identified by glob pattern
	// and associates the result with HTML renderer.
	router.LoadHTMLGlob("templates/*")
	router.GET("/upload", func(c *gin.Context) {
		c.HTML(http.StatusOK, "upload.html", gin.H{
			"titel":"数据加载",
		})
	})
	router.Run(":8080")
}

特别注意：如果出现以下错误：

文件路径是绝对正确的，但是就是报错，后来才发现，是使用了goland的run功能，它的实际运行环境是：

func main()  {
	fmt.Println(os.Args)
}

因此，要在终端自己go build 工程名，生成 xx.exe ，然后双击该文件运行即可。

文章参考链接：https://www.jianshu.com/p/ebd73ffe31e8     https://blog.csdn.net/heiyeshuwu/article/details/79165162

更多gin的使用可以去Github去查：https://github.com/gin-gonic/gin