[转]Go语言(Golang)的Web框架比较：gin VS echo

骑猪看日落 2022-06-01 09:14 237阅读 0赞

# Go语言(Golang)的web框架比较之：gin vs echo #

由  [butaixianran][] 在 2016-01-23 22:00 发布 35423 次点击

原文发在：[https://771dian.com/cb/topic/41em4\_hug][https_771dian.com_cb_topic_41em4_hug]

## Web框架类型 ##

--------------------

web框架的主流，是采用轻量级的中间件式框架，把网站变成只有api的一个个小服务，其他都扔到cdn之类的地方处理。

这种方式，开发快速、拼装能力强，要什么就加什么，不要的就不加，就像是乐高玩具，大受欢迎。

问题在于，这种框架有一堆，到底该选哪个。

## Gin vs Echo ##

--------------------

在golang中，这种杰出代表，有2个：gin 和 echo。

这两个框架，在同类中，路由性能最高，超出其他框架一大截。google了一大堆英文站，也没有找到这两个框架的比较。于是，在我们实际使用后，提供个比较。

先说结论：

*  如果你代表企业，最好选择gin，无痛开发。
 *  如果是个人，开发个轻量服务，哪怕echo有点小问题，你也觉得没啥，那么，就用echo。

下面是比较：

## 框架成熟度 ##

--------------------

gin完胜。

*  gin拥有详尽的出错信息，极为方便调试。
 *  这非常关键。团队项目，这个更加重要。
 *  echo在这方面，就略微逊色。使用框架的第一天，就遇到了明明路由语法写错了，却不报错、不给结果，也没有任何提示的情况。

## 路由性能 ##

--------------------

gin微弱小胜

*  gin的卖点，是所有web框架中，路由性能最好。
 *  echo的卖点，是它的路由性能，比gin还好10%。

国外实际测试结果是：echo只在空路由时，性能比gin好10%。而常用的各种带参数路由，echo其实要输给gin约5-10%。

echo给出和其他框架的对比  
![687474703a2f2f692e696d6775722e636f6d2f684232716452532e706e67][]

最新详尽对比：[https://github.com/gin-gonic/gin/issues/329][https_github.com_gin-gonic_gin_issues_329]

## 路由便利、灵活性 ##

--------------------

一回事，都有点小不便

*  两个路由采用同一种算法，这种算法性能很高，但有个缺点： 不支持路由排序，会认为是路由冲突。
 *  比如： 路由`Get("/name")`和 `Get("/:id")` ，一般来说，只要把`Get("/name")`放在`Get("/:id")`前面，就是不冲突的。路由模块，会先尝试匹配前面那个，没匹配上，再去匹配后面的。
 *  而 gin和echo用的路由模块，会认为这两个路由是冲突的。gin会给出提醒，不让编译通过；echo完全不提醒，冲突就冲突了。。。

这给路由起名、设计，带来了一些麻烦。

## 框架的可持续发展 ##

--------------------

两个都不够好。

*  gin的主创是2个大学生。每年寒暑假就频繁更新，快到期末考试了，就完全不更新了。两人不在的时候，有网友在帮忙热情的维护，但主要是修bug、整理中间件。框架本身的发展，还是靠主创寒暑假爆发。就是这样的框架，连csico都在用。。。
 *  好在，gin的代码注释量大，易读性高，便于其他人参与。而且包装中间件，也超级容易。
 *  作者本人的态度是，对于一个在github上，start达到5000+的项目，他怎么可能会不去维护。请大家放心使用，到寒暑假了，他自然会去更新。。。

*  echo则是主创当前处于活跃状态，并且乐呵呵的想要开发2.0版。由于主创活跃，它自带了一些流行功能，比如websocket, http2, jwt授权。用gin的话，这些功能要自己包装个中间件，虽然也很容易就是了。
 *  但echo的问题在于，它的代码毫无注释。作者现在是在劲头上，等3-6个月，在路上看到个穿超短的妹子，热情转移了，很快就会忘记当时代码是怎么写的。没有注释，不但别人不方便接手，自己也懒得再去看，于是慢慢就永不再更新。
 *  缺少注释的开源包，大部分都有这个问题。echo最终会不会变成这个结局，我们无从得知。

## 总结 ##

--------------------

综上，

*  echo的状态是当下主创本人活跃，框架还不太成熟，适合最轻量级服务；
 *  gin则是整体成熟、易于调试，但可以预期，框架本身发展不会太快，除非主创大学毕业，从事和golang相关的工作。
 *  echo的使用方式、命名，都参考了gin，两者很接近，切换框架很容易，所以不用担心选错。

更新  
由于echo的路由冲突频繁且没有调试信息，目前不是合理选择。等作者补上了路由冲突检测，那么就还不错。

如果想要回避这种框架的路由冲突，又想享受类似的优秀，[neo框架][neo]目前最接近

文章来源：https://771dian.com/cb/topic/41em4\_hug

# Golang 微框架 Gin 简介 #

所谓框架
    
       
        框架一直是敏捷开发中的利器，能让开发者很快的上手并做出应用，甚至有的时候，脱离了框架，一些开发者都不会写程序了。成长总不会一蹴而就，从写出程序获取成就感，再到精通框架，快速构造应用，当这些方面都得心应手的时候，可以尝试改造一些框架，或是自己创造一个。
    
       
        曾经我以为Python世界里的框架已经够多了，后来发现相比golang简直小巫见大巫。golang提供的net/http库已经很好了，对于http的协议的实现非常好，基于此再造框架，也不会是难事，因此生态中出现了很多框架。既然构造框架的门槛变低了，那么低门槛同样也会带来质量参差不齐的框架。
    
       
        考察了几个框架，通过其github的活跃度，维护的team，以及生产环境中的使用率。发现Gin还是一个可以学习的轻巧框架。
    
       
        Gin
    
       
        Gin是一个golang的微框架，封装比较优雅，API友好，源码注释比较明确，已经发布了1.0版本。具有快速灵活，容错方便等特点。其实对于golang而言，web框架的依赖要远比Python，Java之类的要小。自身的net/http足够简单，性能也非常不错。框架更像是一些常用函数或者工具的集合。借助框架开发，不仅可以省去很多常用的封装带来的时间，也有助于团队的编码风格和形成规范。
    
       
        下面就Gin的用法做一个简单的介绍。
    
       
        首先需要安装，安装比较简单，使用go get即可：
    
       
        go get gopkg.in/gin-gonic/gin.v1 
       
        gin的版本托管再 gopkg的网站上。我在安装的过程中，gokpg卡住了，后来不得不根据gin里的godep的文件，把响应的源码从github上下载，然后copy到对应的目录。
       
        关于golang的包管理和依赖，我们以后再讨论。
       
        Hello World
       
        使用Gin实现Hello world非常简单，创建一个router，然后使用其Run的方法：
       
        import ( "gopkg.in/gin-gonic/gin.v1" "net/http" ) func main(){ router := gin.Default() router.GET("/", func(c *gin.Context) { c.String(http.StatusOK, "Hello World") }) router.Run(":8000") } 
       
        简单几行代码，就能实现一个web服务。使用gin的Default方法创建一个路由handler。然后通过HTTP方法绑定路由规则和路由函数。不同于net/http库的路由函数，gin进行了封装，把request和response都封装到gin.Context的上下文环境。最后是启动路由的Run方法监听端口。麻雀虽小，五脏俱全。当然，除了GET方法，gin也支持POST,PUT,DELETE,OPTION等常用的restful方法。
       
        restful路由
       
        gin的路由来自httprouter库。因此httprouter具有的功能，gin也具有，不过gin不支持路由正则表达式：
       
        func main(){ router := gin.Default() router.GET("/user/:name", func(c *gin.Context) { name := c.Param("name") c.String(http.StatusOK, "Hello %s", name) }) } 
       
        冒号:加上一个参数名组成路由参数。可以使用c.Params的方法读取其值。当然这个值是字串string。诸如/user/rsj217，和/user/hello都可以匹配，而/user/和/user/rsj217/不会被匹配。
       
        ☁ ~ curl http://127.0.0.1:8000/user/rsj217 Hello rsj217% ☁ ~ curl http://127.0.0.1:8000/user/rsj217/ 404 page not found% ☁ ~ curl http://127.0.0.1:8000/user/ 404 page not found% 
       
        除了:，gin还提供了*号处理参数，*号能匹配的规则就更多。
       
        func main(){ router := gin.Default() router.GET("/user/:name/*action", func(c *gin.Context) { name := c.Param("name") action := c.Param("action") message := name + " is " + action c.String(http.StatusOK, message) }) } 
       
        访问效果如下
       
        ☁ ~ curl http://127.0.0.1:8000/user/rsj217/ rsj217 is /% ☁ ~ curl http://127.0.0.1:8000/user/rsj217/中国 rsj217 is /中国% 
       
        query string参数与body参数
       
        web提供的服务通常是client和server的交互。其中客户端向服务器发送请求，除了路由参数，其他的参数无非两种，查询字符串query string和报文体body参数。所谓query string，即路由用，用?以后连接的key1=value2&key2=value2的形式的参数。当然这个key-value是经过urlencode编码。
       
        query string
       
        对于参数的处理，经常会出现参数不存在的情况，对于是否提供默认值，gin也考虑了，并且给出了一个优雅的方案：
       
        func main(){ router := gin.Default() router.GET("/welcome", func(c *gin.Context) { firstname := c.DefaultQuery("firstname", "Guest") lastname := c.Query("lastname") c.String(http.StatusOK, "Hello %s %s", firstname, lastname) }) router.Run() } 
       
        使用c.DefaultQuery方法读取参数，其中当参数不存在的时候，提供一个默认值。使用Query方法读取正常参数，当参数不存在的时候，返回空字串：
       
        ☁ ~ curl http://127.0.0.1:8000/welcome Hello Guest % ☁ ~ curl http://127.0.0.1:8000/welcome\?firstname\=中国 Hello 中国 % ☁ ~ curl http://127.0.0.1:8000/welcome\?firstname\=中国\&lastname\=天朝 Hello 中国 天朝% ☁ ~ curl http://127.0.0.1:8000/welcome\?firstname\=\&lastname\=天朝 Hello 天朝% ☁ ~ curl http://127.0.0.1:8000/welcome\?firstname\=%E4%B8%AD%E5%9B%BD Hello 中国 % 
       
        之所以使用中文，是为了说明urlencode。注意，当firstname为空字串的时候，并不会使用默认的Guest值，空值也是值，DefaultQuery只作用于key不存在的时候，提供默认值。
       
        body
       
        http的报文体传输数据就比query string稍微复杂一点，常见的格式就有四种。例如application/json，application/x-www-form-urlencoded, application/xml和multipart/form-data。后面一个主要用于图片上传。json格式的很好理解，urlencode其实也不难，无非就是把query string的内容，放到了body体里，同样也需要urlencode。默认情况下，c.PostFROM解析的是x-www-form-urlencoded或from-data的参数。
       
        func main(){ router := gin.Default() router.POST("/form_post", func(c *gin.Context) { message := c.PostForm("message") nick := c.DefaultPostForm("nick", "anonymous") c.JSON(http.StatusOK, gin.H{ "status": gin.H{ "status_code": http.StatusOK, "status": "ok", }, "message": message, "nick": nick, }) }) } 
       
        与get处理query参数一样，post方法也提供了处理默认参数的情况。同理，如果参数不存在，将会得到空字串。
       
        ☁  ~  curl -X POST http://127.0.0.1:8000/form_post -H "Content-Type:application/x-www-form-urlencoded" -d "message=hello&nick=rsj217" | python -m json.tool
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100   104  100    79  100    25  48555  15365 --:--:-- --:--:-- --:--:-- 79000
    {
        "message": "hello",
        "nick": "rsj217",
        "status": {
            "status": "ok",
            "status_code": 200
        }
    }
    
       
        前面我们使用c.String返回响应，顾名思义则返回string类型。content-type是plain或者text。调用c.JSON则返回json数据。其中gin.H封装了生成json的方式，是一个强大的工具。使用golang可以像动态语言一样写字面量的json，对于嵌套json的实现，嵌套gin.H即可。 
       
        发送数据给服务端，并不是post方法才行，put方法一样也可以。同时querystring和body也不是分开的，两个同时发送也可以：
       
        func main(){ router := gin.Default() router.PUT("/post", func(c *gin.Context) { id := c.Query("id") page := c.DefaultQuery("page", "0") name := c.PostForm("name") message := c.PostForm("message") fmt.Printf("id: %s; page: %s; name: %s; message: %s \n", id, page, name, message) c.JSON(http.StatusOK, gin.H{ "status_code": http.StatusOK, }) }) } 
       
        上面的例子，展示了同时使用查询字串和body参数发送数据给服务器。
       
        文件上传
       
        上传单个文件
       
        前面介绍了基本的发送数据，其中multipart/form-data转用于文件上传。gin文件上传也很方便，和原生的net/http方法类似，不同在于gin把原生的request封装到c.Request中了。
       
        func main(){
        router := gin.Default()
        
        router.POST("/upload", func(c *gin.Context) {
            name := c.PostForm("name")
            fmt.Println(name)
            file, header, err := c.Request.FormFile("upload")
            if err != nil {
                c.String(http.StatusBadRequest, "Bad request")
                return
            }
            filename := header.Filename
    
            fmt.Println(file, err, filename)
    
            out, err := os.Create(filename)
            if err != nil {
                log.Fatal(err)
            }
            defer out.Close()
            _, err = io.Copy(out, file)
            if err != nil {
                log.Fatal(err)
            }
            c.String(http.StatusCreated, "upload successful")
        })
        router.Run(":8000")
    }
    
       
        使用c.Request.FormFile解析客户端文件name属性。如果不传文件，则会抛错，因此需要处理这个错误。一种方式是直接返回。然后使用os的操作，把文件数据复制到硬盘上。
       
        使用下面的命令可以测试上传，注意upload为c.Request.FormFile指定的参数，其值必须要是绝对路径：
       
        curl -X POST http://127.0.0.1:8000/upload -F "upload=@/Users/ghost/Desktop/pic.jpg" -H "Content-Type: multipart/form-data" 
       
        上传多个文件
       
        单个文件上传很简单，别以为多个文件就会很麻烦。依葫芦画瓢，所谓多个文件，无非就是多一次遍历文件，然后一次copy数据存储即可。下面只写handler，省略main函数的初始化路由和开启服务器监听了：
       
        router.POST("/multi/upload", func(c *gin.Context) {
            err := c.Request.ParseMultipartForm(200000)
            if err != nil {
                log.Fatal(err)
            }
    
            formdata := c.Request.MultipartForm 
    
            files := formdata.File["upload"] 
            for i, _ := range files { /
                file, err := files[i].Open()
                defer file.Close()
                if err != nil {
                    log.Fatal(err)
                }
    
                out, err := os.Create(files[i].Filename)
    
                defer out.Close()
    
                if err != nil {
                    log.Fatal(err)
                }
    
                _, err = io.Copy(out, file)
    
                if err != nil {
                    log.Fatal(err)
                }
    
                c.String(http.StatusCreated, "upload successful")
    
            }
    
        })
    
       
        与单个文件上传类似，只不过使用了c.Request.MultipartForm得到文件句柄，再获取文件数据，然后遍历读写。
       
        使用curl上传
       
        curl -X POST http://127.0.0.1:8000/multi/upload -F "upload=@/Users/ghost/Desktop/pic.jpg" -F "upload=@/Users/ghost/Desktop/journey.png" -H "Content-Type: multipart/form-data" 
       
        表单上传
       
        上面我们使用的都是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>
    
       
        upload 很简单，没有参数。一个用于单个文件上传，一个用于多个文件上传。
       
            router.LoadHTMLGlob("templates/*")
        router.GET("/upload", func(c *gin.Context) {
            c.HTML(http.StatusOK, "upload.html", gin.H{})
        })
    
    
       
        使用LoadHTMLGlob定义模板文件路径。
       
        参数绑定
       
        我们已经见识了x-www-form-urlencoded类型的参数处理，现在越来越多的应用习惯使用JSON来通信，也就是无论返回的response还是提交的request，其content-type类型都是application/json的格式。而对于一些旧的web表单页还是x-www-form-urlencoded的形式，这就需要我们的服务器能改hold住这多种content-type的参数了。
       
        Python的世界里很好解决，毕竟动态语言不需要实现定义数据模型。因此可以写一个装饰器将两个格式的数据封装成一个数据模型。golang中要处理并非易事，好在有gin，他们的model bind功能非常强大。
       
        type User struct { Username string `form:"username" json:"username" binding:"required"` Passwd string `form:"passwd" json:"passwd" bdinding:"required"` Age int `form:"age" json:"age"` } func main(){ router := gin.Default() router.POST("/login", func(c *gin.Context) { var user User var err error contentType := c.Request.Header.Get("Content-Type") switch contentType { case "application/json": err = c.BindJSON(&user) case "application/x-www-form-urlencoded": err = c.BindWith(&user, binding.Form) } if err != nil { fmt.Println(err) log.Fatal(err) } c.JSON(http.StatusOK, gin.H{ "user": user.Username, "passwd": user.Passwd, "age": user.Age, }) }) } 
       
        先定义一个User模型结构体，然后针对客户端的content-type，一次使BindJSON和BindWith方法。
       
        ☁ ~ curl -X POST http://127.0.0.1:8000/login -H "Content-Type:application/x-www-form-urlencoded" -d "username=rsj217&passwd=123&age=21" | python -m json.tool % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 79 100 46 100 33 41181 29543 --:--:-- --:--:-- --:--:-- 46000 { "age": 21, "passwd": "123", "username": "rsj217" } ☁ ~ curl -X POST http://127.0.0.1:8000/login -H "Content-Type:application/x-www-form-urlencoded" -d "username=rsj217&passwd=123&new=21" | python -m json.tool % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 78 100 45 100 33 37751 27684 --:--:-- --:--:-- --:--:-- 45000 { "age": 0, "passwd": "123", "username": "rsj217" } ☁ ~ curl -X POST http://127.0.0.1:8000/login -H "Content-Type:application/x-www-form-urlencoded" -d "username=rsj217&new=21" | python -m json.tool % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0curl: (52) Empty reply from server No JSON object could be decoded 
       
        可以看到，结构体中，设置了binding标签的字段（username和passwd），如果没传会抛错误。非banding的字段（age），对于客户端没有传，User结构会用零值填充。对于User结构没有的参数，会自动被忽略。
       
        改成json的效果类似：
       
        ☁ ~ curl -X POST http://127.0.0.1:8000/login -H "Content-Type:application/json" -d '{"username": "rsj217", "passwd": "123", "age": 21}' | python -m json.tool % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 96 100 46 100 50 32670 35511 --:--:-- --:--:-- --:--:-- 50000 { "age": 21, "passwd": "123", "username": "rsj217" } ☁ ~ curl -X POST http://127.0.0.1:8000/login -H "Content-Type:application/json" -d '{"username": "rsj217", "passwd": "123", "new": 21}' | python -m json.tool % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 95 100 45 100 50 49559 55066 --:--:-- --:--:-- --:--:-- 50000 { "age": 0, "passwd": "123", "username": "rsj217" } ☁ ~ curl -X POST http://127.0.0.1:8000/login -H "Content-Type:application/json" -d '{"username": "rsj217", "new": 21}' | python -m json.tool % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0curl: (52) Empty reply from server No JSON object could be decoded ☁ ~ curl -X POST http://127.0.0.1:8000/login -H "Content-Type:application/json" -d '{"username": "rsj217", "passwd": 123, "new": 21}' | python -m json.tool % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0curl: (52) Empty reply from server No JSON object could be decoded 
       
        使用json还需要注意一点，json是有数据类型的，因此对于 {"passwd": "123"} 和 {"passwd": 123}是不同的数据类型，解析需要符合对应的数据类型,否则会出错。 
       
        当然，gin还提供了更加高级方法，c.Bind，它会更加content-type自动推断是bind表单还是json的参数。
       
        router.POST("/login", func(c *gin.Context) { var user User err := c.Bind(&user) if err != nil { fmt.Println(err) log.Fatal(err) } c.JSON(http.StatusOK, gin.H{ "username": user.Username, "passwd": user.Passwd, "age": user.Age, }) }) 
       
        多格式渲染
       
        既然请求可以使用不同的content-type，响应也如此。通常响应会有html，text，plain，json和xml等。 gin提供了很优雅的渲染方法。到目前为止，我们已经见识了c.String， c.JSON，c.HTML，下面介绍一下c.XML。
       
            router.GET("/render", func(c *gin.Context) {
            contentType := c.DefaultQuery("content_type", "json")
            if contentType == "json" {
                c.JSON(http.StatusOK, gin.H{
                    "user":   "rsj217",
                    "passwd": "123",
                })
            } else if contentType == "xml" {
                c.XML(http.StatusOK, gin.H{
                    "user":   "rsj217",
                    "passwd": "123",
                })
            }
    
        })
    
       
        结果如下：
       
        ☁ ~ curl http://127.0.0.1:8000/render\?content_type\=json { "passwd":"123","user":"rsj217"} ☁ ~ curl http://127.0.0.1:8000/render\?content_type\=xml <map><user>rsj217</user><passwd>123</passwd></map>% 
       
        重定向
       
        gin对于重定向的请求，相当简单。调用上下文的Redirect方法：
       
            router.GET("/redict/google", func(c *gin.Context) {
            c.Redirect(http.StatusMovedPermanently, "https://google.com")
        })
    
       
        分组路由
       
        熟悉Flask的同学应该很了解蓝图分组。Flask提供了蓝图用于管理组织分组api。gin也提供了这样的功能，让你的代码逻辑更加模块化，同时分组也易于定义中间件的使用范围。
       
            v1 := router.Group("/v1")
    
        v1.GET("/login", func(c *gin.Context) {
            c.String(http.StatusOK, "v1 login")
        })
    
        v2 := router.Group("/v2")
    
        v2.GET("/login", func(c *gin.Context) {
            c.String(http.StatusOK, "v2 login")
        })
    
       
        访问效果如下：
       
        ☁ ~ curl http://127.0.0.1:8000/v1/login v1 login% ☁ ~ curl http://127.0.0.1:8000/v2/login v2 login% 
       
        middleware中间件
       
        golang的net/http设计的一大特点就是特别容易构建中间件。gin也提供了类似的中间件。需要注意的是中间件只对注册过的路由函数起作用。对于分组路由，嵌套使用中间件，可以限定中间件的作用范围。中间件分为全局中间件，单个路由中间件和群组中间件。
       
        全局中间件
       
        先定义一个中间件函数：
       
        func MiddleWare() gin.HandlerFunc { return func(c *gin.Context) { fmt.Println("before middleware") c.Set("request", "clinet_request") c.Next() fmt.Println("before middleware") } } 
       
        该函数很简单，只会给c上下文添加一个属性，并赋值。后面的路由处理器，可以根据被中间件装饰后提取其值。需要注意，虽然名为全局中间件，只要注册中间件的过程之前设置的路由，将不会受注册的中间件所影响。只有注册了中间件一下代码的路由函数规则，才会被中间件装饰。
       
        router.Use(MiddleWare()) { router.GET("/middleware", func(c *gin.Context) { request := c.MustGet("request").(string) req, _ := c.Get("request") c.JSON(http.StatusOK, gin.H{ "middile_request": request, "request": req, }) }) } 
       
        使用router装饰中间件，然后在/middlerware即可读取request的值，注意在router.Use(MiddleWare())代码以上的路由函数，将不会有被中间件装饰的效果。
       
        使用花括号包含被装饰的路由函数只是一个代码规范，即使没有被包含在内的路由函数，只要使用router进行路由，都等于被装饰了。想要区分权限范围，可以使用组返回的对象注册中间件。 
       
        ☁ ~ curl http://127.0.0.1:8000/middleware { "middile_request":"clinet_request","request":"clinet_request"} 
       
        如果没有注册就使用MustGet方法读取c的值将会抛错，可以使用Get方法取而代之。
       
        上面的注册装饰方式，会让所有下面所写的代码都默认使用了router的注册过的中间件。
       
        单个路由中间件
       
        当然，gin也提供了针对指定的路由函数进行注册。
       
        router.GET("/before", MiddleWare(), func(c *gin.Context) { request := c.MustGet("request").(string) c.JSON(http.StatusOK, gin.H{ "middile_request": request, }) }) 
       
        把上述代码写在 router.Use(Middleware())之前，同样也能看见/before被装饰了中间件。
       
        群组中间件
       
        群组的中间件也类似，只要在对于的群组路由上注册中间件函数即可：
       
        authorized := router.Group("/", MyMiddelware()) // 或者这样用： authorized := router.Group("/") authorized.Use(MyMiddelware()) { authorized.POST("/login", loginEndpoint) } 
       
        群组可以嵌套，因为中间件也可以根据群组的嵌套规则嵌套。
       
        中间件实践
       
        中间件最大的作用，莫过于用于一些记录log，错误handler，还有就是对部分接口的鉴权。下面就实现一个简易的鉴权中间件。
       
            router.GET("/auth/signin", func(c *gin.Context) {
            cookie := &http.Cookie{
                Name:     "session_id",
                Value:    "123",
                Path:     "/",
                HttpOnly: true,
            }
            http.SetCookie(c.Writer, cookie)
            c.String(http.StatusOK, "Login successful")
        })
    
        router.GET("/home", AuthMiddleWare(), func(c *gin.Context) {
            c.JSON(http.StatusOK, gin.H{
          "data": "home"})
        })
    
       
        登录函数会设置一个session_id的cookie，注意这里需要指定path为/，不然gin会自动设置cookie的path为/auth，一个特别奇怪的问题。/homne的逻辑很简单，使用中间件AuthMiddleWare注册之后，将会先执行AuthMiddleWare的逻辑，然后才到/home的逻辑。
       
        AuthMiddleWare的代码如下：
       
        func AuthMiddleWare() gin.HandlerFunc { return func(c *gin.Context) { if cookie, err := c.Request.Cookie("session_id"); err == nil { value := cookie.Value fmt.Println(value) if value == "123" { c.Next() return } } c.JSON(http.StatusUnauthorized, gin.H{ "error": "Unauthorized", }) c.Abort() return } } 
       
        从上下文的请求中读取cookie，然后校对cookie，如果有问题，则终止请求，直接返回，这里使用了c.Abort()方法。
       
        In [7]: resp = requests.get('http://127.0.0.1:8000/home') In [8]: resp.json() Out[8]: { u'error': u'Unauthorized'} In [9]: login = requests.get('http://127.0.0.1:8000/auth/signin') In [10]: login.cookies Out[10]: <RequestsCookieJar[Cookie(version=0, name='session_id', value='123', port=None, port_specified=False, domain='127.0.0.1', domain_specified=False, domain_initial_dot=False, path='/', path_specified=True, secure=False, expires=None, discard=True, comment=None, comment_url=None, rest={ 'HttpOnly': None}, rfc2109=False)]> In [11]: resp = requests.get('http://127.0.0.1:8000/home', cookies=login.cookies) In [12]: resp.json() Out[12]: { u'data': u'home'} 
       
        异步协程
       
        golang的高并发一大利器就是协程。gin里可以借助协程实现异步任务。因为涉及异步过程，请求的上下文需要copy到异步的上下文，并且这个上下文是只读的。
       
        router.GET("/sync", func(c *gin.Context) { time.Sleep(5 * time.Second) log.Println("Done! in path" + c.Request.URL.Path) }) router.GET("/async", func(c *gin.Context) { cCp := c.Copy() go func() { time.Sleep(5 * time.Second) log.Println("Done! in path" + cCp.Request.URL.Path) }() }) 
       
        在请求的时候，sleep5秒钟，同步的逻辑可以看到，服务的进程睡眠了。异步的逻辑则看到响应返回了，然后程序还在后台的协程处理。
       
        自定义router
       
        gin不仅可以使用框架本身的router进行Run，也可以配合使用net/http本身的功能：
       
        func main() { router := gin.Default() http.ListenAndServe(":8080", router) } 
       
        或者
       
        func main() { router := gin.Default() s := &http.Server{ Addr: ":8000", Handler: router, ReadTimeout: 10 * time.Second, WriteTimeout: 10 * time.Second, MaxHeaderBytes: 1 << 20, } s.ListenAndServe() } 
       
        当然还有一个优雅的重启和结束进程的方案。后面将会探索使用supervisor管理golang的进程。
       
        总结
       
        Gin是一个轻巧而强大的golang web框架。涉及常见开发的功能，我们都做了简单的介绍。关于服务的启动，请求参数的处理和响应格式的渲染，以及针对上传和中间件鉴权做了例子。更好的掌握来自实践，同时gin的源码注释很详细，可以阅读源码了解更多详细的功能和魔法特性。
       
        文中的部分代码
      
       
    
    作者：人世间
    链接：https://www.jianshu.com/p/a31e4ee25305
    來源：简书
    著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

文章来源：https://www.jianshu.com/p/a31e4ee25305

# Golang 微框架 echo 快速入门 #

## 快速开始 ##

### 安装 ###

$ go get github.com/labstack/echo/...

### 编写 Hello, World! ###

创建 `server.go` 文件

package main
    
    import (
    	"net/http"
    	"github.com/labstack/echo"
    )
    
    func main() { 
    	e := echo.New()
    	e.GET("/", func(c echo.Context) error { 
    		return c.String(http.StatusOK, "Hello, World!")
    	})
    	e.Logger.Fatal(e.Start(":1323"))
    }

启动服务

$ go run server.go

用在浏览器访问 [http://localhost:1323][http_localhost_1323] 然后你就能在页面上看到 `Hello, World!`

### 路由 ###

e.POST("/users", saveUser)
    e.GET("/users/:id", getUser)
    e.PUT("/users/:id", updateUser)
    e.DELETE("/users/:id", deleteUser)

### URL路径参数 ###

// e.GET("/users/:id", getUser)
    func getUser(c echo.Context) error { 
    	// User ID 来自于url `users/:id`
    	id := c.Param("id")
    	return c.String(http.StatusOK, id)
    }

### 请求参数 ###

`/show?team=x-men&member=wolverine`

// e.GET("/show", show)
    func show(c echo.Context) error { 
    	// 从请求参数里获取 team 和 member 的值
    	team := c.QueryParam("team")
    	member := c.QueryParam("member")
    	return c.String(http.StatusOK, "team:" + team + ", member:" + member)
    }

从浏览器访问 `http://localhost:1323/show?team=x-men&member=wolverine` 可以看到页面上显示”team:x-men, member:wolverine”

### 表单 `application/x-www-form-urlencoded` ###

`POST` `/save`

<table style="box-sizing: inherit; margin-right: 0px; margin-bottom: 20px; margin-left: 0px; padding: 0px; border: 0px; font-size: 14px; vertical-align: baseline; width: 895px; color: rgb(34, 35, 36); font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif; line-height: 20px; background-image: initial; background-attachment: initial; background-size: initial; background-origin: initial; background-clip: initial; background-position: initial; background-repeat: initial;"> 
 <thead style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
  <tr style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
   <th align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-width: 0px 0px 2px; border-color: rgb(211, 214, 219); vertical-align: top; color: rgb(174, 177, 181); background: transparent;">name</th> 
   <th align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-width: 0px 0px 2px; border-color: rgb(211, 214, 219); vertical-align: top; color: rgb(174, 177, 181); background: transparent;">value</th> 
  </tr> 
 </thead> 
 <tbody style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
  <tr style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
   <td align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-top-width: 0px; border-right-width: 0px; border-left-width: 0px; border-color: rgb(211, 214, 219); vertical-align: top; background: transparent;">name</td> 
   <td align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-top-width: 0px; border-right-width: 0px; border-left-width: 0px; border-color: rgb(211, 214, 219); vertical-align: top; background: transparent;">Joe Smith</td> 
  </tr> 
  <tr style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
   <td align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-width: 0px; border-color: rgb(211, 214, 219); vertical-align: top; background: transparent;">email</td> 
   <td align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-width: 0px; border-color: rgb(211, 214, 219); vertical-align: top; background: transparent;">joe@labstack.com</td> 
  </tr> 
 </tbody> 
</table>

// e.POST("/save", save)
    func save(c echo.Context) error { 
    	// 获取 name 和 email 的值
    	name := c.FormValue("name")
    	email := c.FormValue("email")
    	return c.String(http.StatusOK, "name:" + name + ", email:" + email)
    }

在命令行里执行下面的语句

$ curl -F "name=Joe Smith" -F "email=joe@labstack.com" http://localhost:1323/save

控制台会输出`name:Joe Smith, email:joe@labstack.com`

### 表单 `multipart/form-data` ###

`POST` `/save`

<table style="box-sizing: inherit; margin-right: 0px; margin-bottom: 20px; margin-left: 0px; padding: 0px; border: 0px; font-size: 14px; vertical-align: baseline; width: 895px; color: rgb(34, 35, 36); font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif; line-height: 20px; background-image: initial; background-attachment: initial; background-size: initial; background-origin: initial; background-clip: initial; background-position: initial; background-repeat: initial;"> 
 <thead style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
  <tr style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
   <th align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-width: 0px 0px 2px; border-color: rgb(211, 214, 219); vertical-align: top; color: rgb(174, 177, 181); background: transparent;">name</th> 
   <th align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-width: 0px 0px 2px; border-color: rgb(211, 214, 219); vertical-align: top; color: rgb(174, 177, 181); background: transparent;">value</th> 
  </tr> 
 </thead> 
 <tbody style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
  <tr style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
   <td align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-top-width: 0px; border-right-width: 0px; border-left-width: 0px; border-color: rgb(211, 214, 219); vertical-align: top; background: transparent;">name</td> 
   <td align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-top-width: 0px; border-right-width: 0px; border-left-width: 0px; border-color: rgb(211, 214, 219); vertical-align: top; background: transparent;">Joe Smith</td> 
  </tr> 
  <tr style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
   <td align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-top-width: 0px; border-right-width: 0px; border-left-width: 0px; border-color: rgb(211, 214, 219); vertical-align: top; background: transparent;">email</td> 
   <td align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-top-width: 0px; border-right-width: 0px; border-left-width: 0px; border-color: rgb(211, 214, 219); vertical-align: top; background: transparent;">joe@labstack.com</td> 
  </tr> 
  <tr style="box-sizing: inherit; margin: 0px; padding: 0px; border: 0px; vertical-align: baseline; background: transparent;"> 
   <td align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-width: 0px; border-color: rgb(211, 214, 219); vertical-align: top; background: transparent;">avatar</td> 
   <td align="left" style="box-sizing: inherit; margin: 0px; padding: 5px 10px; border-width: 0px; border-color: rgb(211, 214, 219); vertical-align: top; background: transparent;">avatar</td> 
  </tr> 
 </tbody> 
</table>

func save(c echo.Context) error { 
    	// Get name
    	name := c.FormValue("name")
    	// Get avatar
      	avatar, err := c.FormFile("avatar")
      	if err != nil { 
     		return err
     	}
     
     	// Source
     	src, err := avatar.Open()
     	if err != nil { 
     		return err
     	}
     	defer src.Close()
     
     	// Destination
     	dst, err := os.Create(avatar.Filename)
     	if err != nil { 
     		return err
     	}
     	defer dst.Close()
     
     	// Copy
     	if _, err = io.Copy(dst, src); err != nil { 
      		return err
      	}
    
    	return c.HTML(http.StatusOK, "<b>Thank you! " + name + "</b>")
    }

命令行执行下面语句

$ curl -F "name=Joe Smith" -F "avatar=@/path/to/your/avatar.png" http://localhost:1323/save
    //output => <b>Thank you! Joe Smith</b>

同时在项目目录下可以看到刚刚上传的图片。

### 处理请求 ###

*  在数据结构体里设置 `JSON` 或 `XML` 或 `form` 标签直接匹配请求头的 `Content-Type`。
 *  结合响应状态将响应渲染为 `JSON` 或者 `XML`。

type User struct { 
    	Name  string `json:"name" xml:"name" form:"name" query:"name"`
    	Email string `json:"email" xml:"email" form:"email" query:"email"`
    }
    
    e.POST("/users", func(c echo.Context) error { 
    	u := new(User)
    	if err := c.Bind(u); err != nil { 
    		return err
    	}
    	return c.JSON(http.StatusCreated, u)
    	// 或者
    	// return c.XML(http.StatusCreated, u)
    })

### 静态资源 ###

下面的代码定义`/static/*`目录为静态资源文件目录

e.Static("/static", "static")

##### [了解更多…][Link 1] #####

### [模板渲染][Link 2] ###

### 中间件 ###

// Root level middleware
    e.Use(middleware.Logger())
    e.Use(middleware.Recover())
    
    // Group level middleware
    g := e.Group("/admin")
    g.Use(middleware.BasicAuth(func(username, password string, c echo.Context) (error, bool) { 
      if username == "joe" && password == "secret" { 
        return nil, true
      }
      return nil, false
    }))
    
    // Route level middleware
    track := func(next echo.HandlerFunc) echo.HandlerFunc { 
    	return func(c echo.Context) error { 
    		println("request to /users")
    		return next(c)
    	}
    }
    e.GET("/users", func(c echo.Context) error { 
    	return c.String(http.StatusOK, "/users")
    }, track)

\#\#\#\#\#[了解更多][Link 3]

来源：http://go-echo.org/

[butaixianran]: https://www.golangtc.com/member/butaixianran
[https_771dian.com_cb_topic_41em4_hug]: https://771dian.com/cb/topic/41em4_hug
[687474703a2f2f692e696d6775722e636f6d2f684232716452532e706e67]: /images/20220601/9b0b582299d8492099923e06eebecd09.png
[https_github.com_gin-gonic_gin_issues_329]: https://github.com/gin-gonic/gin/issues/329
[neo]: http://www.golangtc.com/t/56a97b3cb09ecc0831000145
[http_localhost_1323]: http://localhost:1323/
[Link 1]: http://go-echo.org/guide/static-files
[Link 2]: http://go-echo.org/guide/templates
[Link 3]: https://echo.labstack.com/middleware