Gin框架介绍及使用

type

status

date

slug

summary

Gin框架安装与使用

安装

下载并安装gin：

第一个gin示例：

RESTful API

REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”或“表现层状态转化”。

简单来说，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渲染

HTML渲染

我们首先定义一个存放模板文件的 templates 文件夹，然后在其内部按照业务分别定义一个 posts 文件夹和一个 users 文件夹。 posts/index.html 文件的内容如下：

users/index.html 文件的内容如下：

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

自定义模板函数

定义一个不转义相应内容的safe模板函数如下：

在index.tmpl中使用定义好的safe模板函数：

在 Go Gin 框架中，可以使用不同的模板文件扩展名，比如 .html 和 .tmpl 等。index.tmpl 或 index.tpl 是一个模板文件，通常用于动态生成页面内容，可以包含一些动态数据和逻辑。在 Gin 框架中，通常会使用模板文件来渲染动态页面。

静态文件处理

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

使用 r.Static("/static", "./static") 配置了静态文件服务。这会将 URL 路径 "/static" 映射到项目中的 "./static" 目录，客户端可以通过该路径访问静态资源，例如图片、CSS、JavaScript 等文件。

使用模板继承

Gin框架默认都是使用单模板，如果需要使用block template功能，可以通过"github.com/gin-contrib/multitemplate"库实现，具体示例如下：

首先，假设我们项目目录下的templates文件夹下有以下模板文件，其中home.tmpl和index.tmpl继承了base.tmpl：

然后我们定义一个loadTemplates函数如下：

补充文件路径处理

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

JSON渲染

获取参数

获取querystring参数

querystring指的是URL中?后面携带的参数。获取请求的querystring参数的方法如下：

r.DefaultQuery(key, defaultValue)：

DefaultQuery 方法用于获取指定键的查询参数值，如果该参数不存在，则返回默认值defaultValue。

如果请求中不存在指定的查询参数，则返回提供的默认值defaultValue。

这个方法适用于在获取查询参数时提供一个默认值，以避免因参数不存在而引发的错误。

r.URL.Query( ).Get(key) 或 r.URL.Query( )[key]：

Query 方法用于获取指定键的查询参数值。

如果请求中不存在指定的查询参数，则返回空字符串。

这个方法适用于在获取查询参数时直接获取其值，如果参数不存在则返回空字符串。

获取form参数

当前端请求的数据通过form表单提交时，例如向/user/search发送一个POST请求，获取请求数据的方式如下：

DefaultPostForm(key, defaultValue)和PostForm(key)这两个函数用法与DefaultQuery(key, defaultValue)和Query(key)类似

获取JSON参数

当前端请求的数据通过JSON提交时，例如向/json发送一个JSON格式的POST请求，则获取请求参数的方式如下：

更便利的获取请求参数的方式，参见下面的 参数绑定 小节。

获取path参数

请求的参数通过URL路径传递，例如：/user/search/serendipity/China。获取请求URL路径中的参数的方式如下。

参数绑定

为了能够更方便的获取请求相关参数，提高开发效率，我们可以基于请求的Content-Type识别请求数据类型并利用反射机制自动提取请求中QueryString、form表单、JSON、XML等参数到结构体中。下面的示例代码演示了.ShouldBind()强大的功能，它能够基于请求自动提取JSON、form表单和QueryString类型的数据，并把值绑定到指定的结构体对象。

ShouldBind会按照下面的顺序解析请求中的数据完成绑定：

如果是 GET 请求，只使用 Form 绑定引擎（query）。

如果是 POST 请求，首先检查 content-type 是否为 JSON 或 XML，然后再使用 Form（form-data）。

文件上传

单个文件上传

文件上传前端页面代码：

后端gin框架部分代码：

处理multipart forms提交文件时默认的内存限制是32 MB，我们可以通过下面的方式修改r.MaxMultipartMemory ，例如 r.MaxMultipartMemory = 64 << 20 将内存限制改到64MB，这里的 20 表示移动的位数，即左移 20 位，相当于将 32 乘以 2^20，即 1024 * 1024，即 1MB。

多个文件上传

重定向

HTTP重定向

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

路由重定向

路由重定向，使用HandleContext：

Gin路由

普通路由

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

为没有配置处理函数的路由添加处理程序，默认情况下它返回404代码，下面的代码为没有匹配到路由的请求都返回views/404.html页面。

路由组

我们可以将拥有共同URL前缀的路由划分为一个路由组。习惯性一对{}包裹同组的路由，这只是为了看着清晰，你用不用{}包裹功能上没什么区别。

路由组也是支持嵌套的，例如：

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

路由原理

Gin框架中的路由使用的是httprouter这个库，其基本原理就是构造一个路由地址的前缀树。

Gin中间件

Gin框架允许开发者在处理请求的过程中，加入用户自己的钩子（Hook）函数。这个钩子函数就叫中间件，中间件适合处理一些公共的业务逻辑，比如登录认证、权限校验、数据分页、记录日志、耗时统计等。

定义中间件

Gin中的中间件必须是一个gin.HandlerFunc类型。

记录接口耗时的中间件

例如我们像下面的代码一样定义一个统计请求耗时的中间件。

记录响应体的中间件

我们有时候可能会想要记录下某些情况下返回给客户端的响应数据，这个时候就可以编写一个中间件来搞定。

跨域中间件cors

推荐使用社区的https://github.com/gin-contrib/cors 库，一行代码解决前后端分离架构下的跨域问题。

注意： 该中间件需要注册在业务处理函数前面。

这个库支持各种常用的配置项，具体使用方法如下。

当然你可以简单的像下面的示例代码那样使用默认配置，允许所有的跨域请求。

注册中间件

在gin框架中，我们可以为每个路由添加任意数量的中间件。

为全局路由注册

gin.Default() 和 gin.New() 都用于创建 Gin 框架的实例，但它们之间有一些细微的区别：

gin.Default()：

gin.Default() 方法会返回一个默认配置的 Gin 实例。

默认配置包括 Logger 和 Recovery 中间件。Logger 中间件用于记录请求日志，Recovery 中间件用于处理恢复从处理程序中出现的 panic。

这个方法在创建 Gin 实例时会自动使用默认的中间件，因此你无需手动添加 Logger 和 Recovery 中间件。

gin.New()：

gin.New() 方法会返回一个空白的 Gin 实例。

这个方法创建的 Gin 实例不会包含任何默认的中间件。你需要手动添加所需的中间件。

这个方法适用于需要完全自定义 Gin 实例的情况，你可以根据需要选择性地添加中间件。

一般来说，如果你想要快速搭建一个使用了默认 Logger 和 Recovery 中间件的 Gin 实例，可以使用 gin.Default()；如果你想要完全控制 Gin 实例中的中间件，可以使用 gin.New()。

为某个路由单独注册

为路由组注册中间件

为路由组注册中间件有以下两种写法。

写法1：

写法2：

中间件注意事项

gin中间件中使用goroutine

当在中间件或handler中启动新的goroutine时，不能使用原始的上下文（c *gin.Context），必须使用其只读副本，即c.Copy()。

运行多个服务

我们可以在多个端口启动服务，例如：