Gin是一个用Go语言编写的web框架。它是一个类似于martini但拥有更好性能的API框架, 由于使用了httprouter,速度提高了近40倍。 如果你是性能和高效的追求者, 你会爱上Gin

Gin框架介绍

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

Gin框架安装与使用

安装

下载并安装Gin:

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

第一个Gin示例:


package main

import (
"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()
}
```

将上面的代码保存并编译执行,然后使用浏览器打开127.0.0.1:8080/hello就能看到一串JSON字符串。

RESTful API

REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”或“表现层状态转化”。 推荐阅读阮一峰 理解RESTful架构 简单来说,REST的含义就是客户端与Web服务器之间进行交互的时候,使用HTTP协议中的4个请求方法代表不同的动作。
  • GET用来获取资源
  • POST用来新建资源
  • PUT用来更新资源
  • DELETE用来删除资源。
只要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渲染

HTML渲染

我们首先定义一个存放模板文件的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}}


<p><code>users/index.html</code>文件的内容如下:</p>

<pre><code class="language-template">{{define &quot;users/index.html&quot;}}
&lt;!DOCTYPE html&gt;
&lt;html lang=&quot;en&quot;&gt;

&lt;head&gt;
    &lt;meta charset=&quot;UTF-8&quot;&gt;
    &lt;meta name=&quot;viewport&quot; content=&quot;width=device-width, initial-scale=1.0&quot;&gt;
    &lt;meta http-equiv=&quot;X-UA-Compatible&quot; content=&quot;ie=edge&quot;&gt;
    &lt;title&gt;users/index&lt;/title&gt;
&lt;/head&gt;

&lt;body&gt;
    {{.title}}
&lt;/body&gt;
&lt;/html&gt;
{{end}}

Gin框架中使用LoadHTMLGlob()或者LoadHTMLFiles()方法进行HTML模板渲染。

func main() {
    r := gin.Default()
    r.LoadHTMLGlob(&quot;templates/**/*&quot;)
    //r.LoadHTMLFiles(&quot;templates/posts/index.html&quot;, &quot;templates/users/index.html&quot;)
    r.GET(&quot;/posts/index&quot;, func(c *gin.Context) {
        c.HTML(http.StatusOK, &quot;posts/index.html&quot;, gin.H{
            &quot;title&quot;: &quot;posts/index&quot;,
        })
    })

    r.GET(&quot;users/index&quot;, func(c *gin.Context) {
        c.HTML(http.StatusOK, &quot;users/index.html&quot;, gin.H{
            &quot;title&quot;: &quot;users/index&quot;,
        })
    })

    r.Run(&quot;:8080&quot;)
}

静态文件处理

当我们渲染的HTML文件中引用了静态文件时,我们只需要按照以下方式在渲染页面前调用gin.Static方法即可。

func main() {
    r := gin.Default()
    r.Static(&quot;/static&quot;, &quot;./static&quot;)
    r.LoadHTMLGlob(&quot;templates/**/*&quot;)
   ...
    r.Run(&quot;:8080&quot;)
}

补充文件路径处理

关于模板文件和静态文件的路径,我们需要根据公司/项目的要求进行设置。可以使用下面的函数获取当前执行程序的路径。

func getCurrentPath() string {
    if ex, err := os.Executable(); err == nil {
        return filepath.Dir(ex)
    }
    return &quot;./&quot;
}

JSON渲染

func main() {
    r := gin.Default()

    // gin.H 是map[string]interface{}的缩写
    r.GET(&quot;/someJSON&quot;, func(c *gin.Context) {
        // 方式一:自己拼接JSON
        c.JSON(http.StatusOK, gin.H{&quot;message&quot;: &quot;Hello world!&quot;})
    })
    r.GET(&quot;/moreJSON&quot;, func(c *gin.Context) {
        // 方法二:使用结构体
        var msg struct {
            Name    string `json:&quot;user&quot;`
            Message string
            Age     int
        }
        msg.Name = &quot;小王子&quot;
        msg.Message = &quot;Hello world!&quot;
        msg.Age = 18
        c.JSON(http.StatusOK, msg)
    })
    r.Run(&quot;:8080&quot;)
}

XML渲染

注意需要使用具名的结构体类型。

func main() {
    r := gin.Default()
    // gin.H 是map[string]interface{}的缩写
    r.GET(&quot;/someXML&quot;, func(c *gin.Context) {
        // 方式一:自己拼接JSON
        c.XML(http.StatusOK, gin.H{&quot;message&quot;: &quot;Hello world!&quot;})
    })
    r.GET(&quot;/moreXML&quot;, func(c *gin.Context) {
        // 方法二:使用结构体
        type MessageRecord struct {
            Name    string
            Message string
            Age     int
        }
        var msg MessageRecord
        msg.Name = &quot;小王子&quot;
        msg.Message = &quot;Hello world!&quot;
        msg.Age = 18
        c.XML(http.StatusOK, msg)
    })
    r.Run(&quot;:8080&quot;)
}

YMAL渲染

r.GET(&quot;/someYAML&quot;, func(c *gin.Context) {
    c.YAML(http.StatusOK, gin.H{&quot;message&quot;: &quot;ok&quot;, &quot;status&quot;: http.StatusOK})
})

protobuf渲染

r.GET(&quot;/someProtoBuf&quot;, func(c *gin.Context) {
    reps := []int64{int64(1), int64(2)}
    label := &quot;test&quot;
    // protobuf 的具体定义写在 testdata/protoexample 文件中。
    data := &amp;protoexample.Test{
        Label: &amp;label,
        Reps:  reps,
    }
    // 请注意,数据在响应中变为二进制数据
    // 将输出被 protoexample.Test protobuf 序列化了的数据
    c.ProtoBuf(http.StatusOK, data)
})

获取参数

获取querystring参数

querystring指的是URL中?后面携带的参数,例如:/user/search?username=小王子&address=沙河
获取请求的querystring参数的方法如下:

func main() {
    //Default返回一个默认的路由引擎
    r := gin.Default()
    r.GET(&quot;/user/search&quot;, func(c *gin.Context) {
        username := c.DefaultQuery(&quot;username&quot;, &quot;小王子&quot;)
        //username := c.Query(&quot;username&quot;)
        address := c.Query(&quot;address&quot;)
        //输出json结果给调用方
        c.JSON(http.StatusOK, gin.H{
            &quot;message&quot;:  &quot;ok&quot;,
            &quot;username&quot;: username,
            &quot;address&quot;:  address,
        })
    })

    r.Run()
}

获取form参数

请求的数据通过form表单来提交,例如向/user/search发送一个POST请求,获取请求数据的方式如下:

func main() {
    //Default返回一个默认的路由引擎
    r := gin.Default()
    r.POST(&quot;/user/search&quot;, func(c *gin.Context) {
        // DefaultPostForm取不到值时会返回指定的默认值
        //username := c.DefaultPostForm(&quot;username&quot;, &quot;小王子&quot;)
        username := c.PostForm(&quot;username&quot;)
        address := c.PostForm(&quot;address&quot;)
        //输出json结果给调用方
        c.JSON(http.StatusOK, gin.H{
            &quot;message&quot;:  &quot;ok&quot;,
            &quot;username&quot;: username,
            &quot;address&quot;:  address,
        })
    })
    r.Run(&quot;:8080&quot;)
}

获取path参数

请求的参数通过URL路径传递,例如:/user/search/小王子/沙河
获取请求URL路径中的参数的方式如下。

func main() {
    //Default返回一个默认的路由引擎
    r := gin.Default()
    r.GET(&quot;/user/search/:username/:address&quot;, func(c *gin.Context) {
        username := c.Param(&quot;username&quot;)
        address := c.Param(&quot;address&quot;)
        //输出json结果给调用方
        c.JSON(http.StatusOK, gin.H{
            &quot;message&quot;:  &quot;ok&quot;,
            &quot;username&quot;: username,
            &quot;address&quot;:  address,
        })
    })

    r.Run(&quot;:8080&quot;)
}

参数绑定

为了能够更方便的获取请求相关参数,提高开发效率,我们可以基于请求的content-type识别请求数据类型并利用反射机制自动提取请求中querystring、form表单、JSON、XML等参数到结构体中。

// Binding from JSON
type Login struct {
    User     string `form:&quot;user&quot; json:&quot;user&quot; binding:&quot;required&quot;`
    Password string `form:&quot;password&quot; json:&quot;password&quot; binding:&quot;required&quot;`
}

func main() {
    router := gin.Default()

    // 绑定JSON的示例 ({&quot;user&quot;: &quot;q1mi&quot;, &quot;password&quot;: &quot;123456&quot;})
    router.POST(&quot;/loginJSON&quot;, func(c *gin.Context) {
        var login Login

        if err := c.ShouldBindJSON(&amp;login); err == nil {
            fmt.Printf(&quot;login info:%#v\n&quot;, login)
            c.JSON(http.StatusOK, gin.H{
                &quot;user&quot;:     login.User,
                &quot;password&quot;: login.Password,
            })
        } else {
            c.JSON(http.StatusBadRequest, gin.H{&quot;error&quot;: err.Error()})
        }
    })

    // 绑定form表单示例 (user=q1mi&amp;password=123456)
    router.POST(&quot;/loginForm&quot;, func(c *gin.Context) {
        var login Login
        // ShouldBind()会根据请求的Content-Type自行选择绑定器
        if err := c.ShouldBind(&amp;login); err == nil {
            c.JSON(http.StatusOK, gin.H{
                &quot;user&quot;:     login.User,
                &quot;password&quot;: login.Password,
            })
        } else {
            c.JSON(http.StatusBadRequest, gin.H{&quot;error&quot;: err.Error()})
        }
    })

    // 绑定querystring示例 (user=q1mi&amp;password=123456)
    router.GET(&quot;/loginForm&quot;, func(c *gin.Context) {
        var login Login
        // ShouldBind()会根据请求的Content-Type自行选择绑定器
        if err := c.ShouldBind(&amp;login); err == nil {
            c.JSON(http.StatusOK, gin.H{
                &quot;user&quot;:     login.User,
                &quot;password&quot;: login.Password,
            })
        } else {
            c.JSON(http.StatusBadRequest, gin.H{&quot;error&quot;: err.Error()})
        }
    })

    // Listen and serve on 0.0.0.0:8080
    router.Run(&quot;:8080&quot;)
}

文件上传

单个文件上传

func main() {
    router := gin.Default()
    // 处理multipart forms提交文件时默认的内存限制是32 MiB
    // 可以通过下面的方式修改
    // router.MaxMultipartMemory = 8 &lt;&lt; 20  // 8 MiB
    router.POST(&quot;/upload&quot;, func(c *gin.Context) {
        // 单个文件
        file, err := c.FormFile(&quot;file&quot;)
        if err != nil {
            c.JSON(http.StatusInternalServerError, gin.H{
                &quot;message&quot;: err.Error(),
            })
            return
        }

        log.Println(file.Filename)
        dst := fmt.Sprintf(&quot;C:/tmp/%s&quot;, file.Filename)
        // 上传文件到指定的目录
        c.SaveUploadedFile(file, dst)
        c.JSON(http.StatusOK, gin.H{
            &quot;message&quot;: fmt.Sprintf(&quot;'%s' uploaded!&quot;, file.Filename),
        })
    })
    router.Run()
}

多个文件上传

func main() {
    router := gin.Default()
    // 处理multipart forms提交文件时默认的内存限制是32 MiB
    // 可以通过下面的方式修改
    // router.MaxMultipartMemory = 8 &lt;&lt; 20  // 8 MiB
    router.POST(&quot;/upload&quot;, func(c *gin.Context) {
        // Multipart form
        form, _ := c.MultipartForm()
        files := form.File[&quot;file&quot;]

        for index, file := range files {
            log.Println(file.Filename)
            dst := fmt.Sprintf(&quot;C:/tmp/%s_%d&quot;, file.Filename, index)
            // 上传文件到指定的目录
            c.SaveUploadedFile(file, dst)
        }
        c.JSON(http.StatusOK, gin.H{
            &quot;message&quot;: fmt.Sprintf(&quot;%d files uploaded!&quot;, len(files)),
        })
    })
    router.Run()
}

Gin中间件

Gin框架允许开发者在处理请求的过程中,加入用户自己的钩子(Hook)函数。这个钩子函数就叫中间件,中间件适合处理一些公共的业务逻辑,比如登录校验、日志打印、耗时统计等。

Gin中的中间件必须是一个gin.HandlerFunc类型。例如我们像下面的代码一样定义一个中间件。

// StatCost 是一个统计耗时请求耗时的中间件
func StatCost() gin.HandlerFunc {
    return func(c *gin.Context) {
        start := time.Now()
        c.Set(&quot;name&quot;, &quot;小王子&quot;)
        // 执行其他中间件
        c.Next()
        // 计算耗时
        cost := time.Since(start)
        log.Println(cost)
    }
}

然后注册中间件的时候,可以在全局注册。

func main() {
    // 新建一个没有任何默认中间件的路由
    r := gin.New()
    // 注册一个全局中间件
    r.Use(StatCost())

    r.GET(&quot;/test&quot;, func(c *gin.Context) {
        name := c.MustGet(&quot;name&quot;).(string)
        log.Println(name)
        c.JSON(http.StatusOK, gin.H{
            &quot;message&quot;: &quot;Hello world!&quot;,
        })
    })
    r.Run()
}

也可以给某个路由单独注册中间件。

// 给/test2路由单独注册中间件(可注册多个)
    r.GET(&quot;/test2&quot;, StatCost(), func(c *gin.Context) {
        name := c.MustGet(&quot;name&quot;).(string)
        log.Println(name)
        c.JSON(http.StatusOK, gin.H{
            &quot;message&quot;: &quot;Hello world!&quot;,
        })
    })

重定向

HTTP重定向

HTTP 重定向很容易。 内部、外部重定向均支持。

r.GET(&quot;/test&quot;, func(c *gin.Context) {
    c.Redirect(http.StatusMovedPermanently, &quot;http://www.google.com/&quot;)
})

路由重定向

路由重定向,使用HandleContext

r.GET(&quot;/test&quot;, func(c *gin.Context) {
    // 指定重定向的URL
    c.Request.URL.Path = &quot;/test2&quot;
    r.HandleContext(c)
})
r.GET(&quot;/test2&quot;, func(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{&quot;hello&quot;: &quot;world&quot;})
})

Gin路由

普通路由

r.GET(&quot;/index&quot;, func(c *gin.Context) {...})
r.GET(&quot;/login&quot;, func(c *gin.Context) {...})
r.POST(&quot;/login&quot;, func(c *gin.Context) {...})

此外,还有一个可以匹配所有请求方法的Any方法如下:

r.Any(&quot;/test&quot;, func(c *gin.Context) {...})

为没有配置处理函数的路由添加处理程序。默认情况下它返回404代码。

r.NoRoute(func(c *gin.Context) {
        c.HTML(http.StatusNotFound, &quot;views/404.html&quot;, nil)
    })

路由组

我们可以将拥有共同URL前缀的路由划分为一个路由组。

func main() {
    r := gin.Default()
    userGroup := r.Group(&quot;/user&quot;)
    {
        userGroup.GET(&quot;/index&quot;, func(c *gin.Context) {...})
        userGroup.GET(&quot;/login&quot;, func(c *gin.Context) {...})
        userGroup.POST(&quot;/login&quot;, func(c *gin.Context) {...})

    }
    shopGroup := r.Group(&quot;/shop&quot;)
    {
        shopGroup.GET(&quot;/index&quot;, func(c *gin.Context) {...})
        shopGroup.GET(&quot;/cart&quot;, func(c *gin.Context) {...})
        shopGroup.POST(&quot;/checkout&quot;, func(c *gin.Context) {...})
    }
    r.Run()
}

通常我们将路由分组用在划分业务逻辑或划分API版本时。

路由原理

Gin框架中的路由使用的是httprouter这个库。

其基本原理就是构造一个路由地址的前缀树。

Web框架之Gin的更多相关文章

  1. 01 . Go之从零实现Web框架(类似Gin)

    设计一个框架 大部分时候,我们需要实现一个 Web 应用,第一反应是应该使用哪个框架.不同的框架设计理念和提供的功能有很大的差别.比如 Python 语言的 django和flask,前者大而全,后者 ...

  2. Web框架之Gin介绍及使用

    Gin是一个用Go语言编写的web框架.它是一个类似于martini但拥有更好性能的API框架, 由于使用了httprouter,速度提高了近40倍. 如果你是性能和高效的追求者, 你会爱上Gin. ...

  3. GO语言web框架Gin之完全指南(一)

    作为一款企业级生产力的web框架,gin的优势是显而易见的,高性能,轻量级,易用的api,以及众多的使用者,都为这个框架注入了可靠的因素.截止目前为止,github上面已经有了 35,994 star ...

  4. GO语言web框架Gin之完全指南

    GO语言web框架Gin之完全指南 作为一款企业级生产力的web框架,gin的优势是显而易见的,高性能,轻量级,易用的api,以及众多的使用者,都为这个框架注入了可靠的因素.截止目前为止,github ...

  5. 7天用Go动手写/从零实现Web框架Gee

    设计一个框架 大部分时候,我们需要实现一个 Web 应用,第一反应是应该使用哪个框架.不同的框架设计理念和提供的功能有很大的差别.比如 Python 语言的 django和flask,前者大而全,后者 ...

  6. 01 . Go之从零实现Web框架(框架雏形, 上下文Context,路由)

    设计一个框架 大部分时候,我们需要实现一个 Web 应用,第一反应是应该使用哪个框架.不同的框架设计理念和提供的功能有很大的差别.比如 Python 语言的 django和flask,前者大而全,后者 ...

  7. Gin Web框架简单介绍

    翻译自: https://github.com/gin-gonic/gin/blob/develop/README.md Gin Web框架 branch=master"> Gin是用 ...

  8. Go语言web框架 gin

    Go语言web框架 GIN gin是go语言环境下的一个web框架, 它类似于Martini, 官方声称它比Martini有更好的性能, 比Martini快40倍, Ohhhh….看着不错的样子, 所 ...

  9. Go组件学习——Web框架Gin

    以前学Java的时候,和Spring全家桶打好关系就行了,从Spring.Spring MVC到SpringBoot,一脉相承. 对于一个Web项目,使用Spring MVC,就可以基于MVC的思想开 ...

随机推荐

  1. ccf 201903-3 损坏的RAID5

    9月份考ccf,暑假打算做一些往年的真题... 这个题,一开始真是把我给看晕了 传说中的大模拟,果然不简单QAQ 首先读懂题目就是一个大难点,特别是对于我这种题目一长就看不进去的人来说 读懂题目之后, ...

  2. 【0809 | Day 12】可变长参数/函数的对象/函数的嵌套/名称空间与作用域

    可变长参数 一.形参 位置形参 默认形参 二.实参 位置实参 关键字实参 三.可变长参数之* def func(name,pwd,*args): print('name:',name,'pwd:',p ...

  3. 解读 PHP 的 P++提案

    解读 PHP 的 P++提案 周末看到一篇文章说 PHP 创始人提议将 PHP 拉出新分支,创建 P++ 语言.随后阅读了一下 Zeev Suraski 发起的这个邮件列表,大致了解了一下,这里做个解 ...

  4. 30213Java_接口

    1.简介 接口作用 为什么需要接口?接口和抽象类的区别? 接口就是比“抽象类”还“抽象”的“抽象类”,可以更加规范的对子类进行约束.全面地专业地实现了:规范和具体实现的分离. 抽象类还提供某些具体实现 ...

  5. 深入理解ES6之——代理和反射(proxy)

    通过调用new proxy()你可以创建一个代理来替代另一个对象(被称为目标),这个代理对目标对象进行了虚拟,因此该代理与该目标对象表面上可以被当做同一个对象来对待. 创建一个简单的代理 当你使用Pr ...

  6. javaScript基础-01 javascript语法结构

    一.基础 字符集 JavaScript程序是用Unicode字符集编写的. .区分大小写 .空格.换行符和格式控制符 .Unicode转义序列 .标准化 二.类型.值和变量 JavaScript的数据 ...

  7. 详解InheritableThreadLocal类的使用与原理

    在Java并发编程中,InheritableThreadLocal 与 ThreadLocal 都可以用于线程间通信,不同的是 InheritableThreadLocal 继承了 ThreadLoc ...

  8. 面试java后端面经_4

    作者:早该变坏链接:https://www.nowcoder.com/discuss/157627来源:牛客网 情话部分: 当有自己心仪的小姐姐,又没确定关系,有时候分享彼此爱情观的时候,你就可以开始 ...

  9. 理解Go协程与并发

    协程 Go语言里创建一个协程很简单,使用go关键字就可以让一个普通方法协程化: package main import ( "fmt" "time" ) fun ...

  10. 阿里云部署 Flask + WSGI + Nginx 转载详解

    我采用的部署方案是: Web 服务器采用 uwsgi host Flask 用 Supervisor 引用 uwsgi 作常规启动服务 基于 Nginx 作反向代理 首先, 阿里云服务器可以通过 SS ...