Gin框架

标签：gt 框架 quot gin lt amp Gin td

<article class="post-article"> <section class="markdown-content"><code>Gin</code>是一个用Go语言编写的web框架。它是一个类似于<code>martini</code>但拥有更好性能的API框架, 由于使用了<code>httprouter</code>，速度提高了近40倍。如果你是性能和高效的追求者, 你会爱上<code>Gin</code>。 <h1 id="Gin框架介绍"><a href="#Gin框架介绍" class="headerlink" title="Gin框架介绍"></a>Gin框架介绍</h1>Go世界里最流行的Web框架，<a href="https://github.com/gin-gonic/gin" target="_blank" rel="noopener">Github</a>上有<code>24K+</code>star。基于<a href="https://github.com/julienschmidt/httprouter" target="_blank" rel="noopener">httprouter</a>开发的Web框架。 <a href="https://gin-gonic.com/zh-cn/docs/" target="_blank" rel="noopener">中文文档</a>齐全，简单易用的轻量级框架。 <h1 id="Gin框架安装与使用"><a href="#Gin框架安装与使用" class="headerlink" title="Gin框架安装与使用"></a>Gin框架安装与使用</h1><h1 id="安装"><a href="#安装" class="headerlink" title="安装"></a>安装</h1>下载并安装<code>Gin</code>: <figure class="highlight bash" data-lang="BASH"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="bash">1 </code></pre></td><td class="code"><pre class="hljs cs"><code class="bash">go get -u github.com/gin-gonic/gin </code></pre></td></tr></tbody></table></figure> <h1 id="第一个Gin示例："><a href="#第一个Gin示例：" class="headerlink" title="第一个Gin示例："></a>第一个Gin示例：</h1><pre><code class="language-golang">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() } <figure class="highlight plain" data-lang="PLAIN"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="plain">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 </code></pre></td><td class="code"><pre class="hljs xml"><code class="plain"> <p>将上面的代码保存并编译执行，然后使用浏览器打开<code>127.0.0.1:8080/hello</code>就能看到一串JSON字符串。</p> # RESTful API <p>REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”或“表现层状态转化”。</p> <p>推荐阅读<a href="http://www.ruanyifeng.com/blog/2011/09/restful.html">阮一峰理解RESTful架构</a></p> <p>简单来说，REST的含义就是客户端与Web服务器之间进行交互的时候，使用HTTP协议中的4个请求方法代表不同的动作。</p> <ul> <li><code>GET</code>用来获取资源</li> <li><code>POST</code>用来新建资源</li> <li><code>PUT</code>用来更新资源</li> <li><code>DELETE</code>用来删除资源。</li> </ul> <p>只要API程序遵循了REST风格，那就可以称其为RESTful API。目前在前后端分离的架构中，前后端基本都是通过RESTful API来进行交互。</p> <p>例如，我们现在要编写一个管理书籍的系统，我们可以查询对一本书进行查询、创建、更新和删除等操作，我们在编写程序的时候就要设计客户端浏览器与我们Web服务端交互的方式和路径。按照经验我们通常会设计成如下模式：</p> <table> <thead> <tr> <th>请求方法</th> <th>URL</th> <th>含义</th> </tr> </thead> <tbody> <tr> <td>GET</td> <td>/book</td> <td>查询书籍信息</td> </tr> <tr> <td>POST</td> <td>/create_book</td> <td>创建书籍记录</td> </tr> <tr> <td>POST</td> <td>/update_book</td> <td>更新书籍信息</td> </tr> <tr> <td>POST</td> <td>/delete_book</td> <td>删除书籍信息</td> </tr> </tbody> </table> <p>同样的需求我们按照RESTful API设计如下：</p> <table> <thead> <tr> <th>请求方法</th> <th>URL</th> <th>含义</th> </tr> </thead> <tbody> <tr> <td>GET</td> <td>/book</td> <td>查询书籍信息</td> </tr> <tr> <td>POST</td> <td>/book</td> <td>创建书籍记录</td> </tr> <tr> <td>PUT</td> <td>/book</td> <td>更新书籍信息</td> </tr> <tr> <td>DELETE</td> <td>/book</td> <td>删除书籍信息</td> </tr> </tbody> </table> <p>Gin框架支持开发RESTful API的开发。</p> ```go 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", }) }) } </code></pre></td></tr></tbody></table></figure> 开发RESTful API的时候我们通常使用<a href="https://www.getpostman.com/" target="_blank" rel="noopener">Postman</a>来作为客户端的测试工具。 # Gin渲染 # HTML渲染 我们首先定义一个存放模板文件的<code>templates</code>文件夹，然后在其内部按照业务分别定义一个<code>posts</code>文件夹和一个<code>users</code>文件夹。 <code>posts/index.html</code>文件的内容如下： <figure class="highlight html" data-lang="HTML"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="html">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </code></pre></td><td class="code"><pre class="hljs perl"><code class="html"><pre><code class="language-template">{{define &quot;posts/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;posts/index&lt;/title&gt; &lt;/head&gt; &lt;body&gt; {{.title}} &lt;/body&gt; &lt;/html&gt; {{end}} </code></pre></td></tr></tbody></table></figure> <code>users/index.html</code>文件的内容如下： <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </code></pre></td><td class="code"><pre class="hljs perl"><code class="go"><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}} </code></pre></td></tr></tbody></table></figure> Gin框架中使用<code>LoadHTMLGlob()</code>或者<code>LoadHTMLFiles()</code>方法进行HTML模板渲染。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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;) } </code></pre></td></tr></tbody></table></figure> # 静态文件处理 当我们渲染的HTML文件中引用了静态文件时，我们只需要按照以下方式在渲染页面前调用<code>gin.Static</code>方法即可。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 </code></pre></td><td class="code"><pre class="hljs css"><code class="go">func main() { r := gin.Default() r.Static(&quot;/static&quot;, &quot;./static&quot;) r.LoadHTMLGlob(&quot;templates/**/*&quot;) ... r.Run(&quot;:8080&quot;) } </code></pre></td></tr></tbody></table></figure> # 补充文件路径处理 关于模板文件和静态文件的路径，我们需要根据公司/项目的要求进行设置。可以使用下面的函数获取当前执行程序的路径。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 </code></pre></td><td class="code"><pre class="hljs cpp"><code class="go">func getCurrentPath() string { if ex, err := os.Executable(); err == nil { return filepath.Dir(ex) } return &quot;./&quot; } </code></pre></td></tr></tbody></table></figure> # JSON渲染 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 </code></pre></td><td class="code"><pre class="hljs coffeescript"><code class="go">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;) } </code></pre></td></tr></tbody></table></figure> # XML渲染 注意需要使用具名的结构体类型。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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;) } </code></pre></td></tr></tbody></table></figure> # YMAL渲染 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 </code></pre></td><td class="code"><pre class="hljs"><code class="go">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}) }) </code></pre></td></tr></tbody></table></figure> # protobuf渲染 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 </code></pre></td><td class="code"><pre class="hljs javascript"><code class="go">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) }) </code></pre></td></tr></tbody></table></figure> # 获取参数 # 获取querystring参数 <code>querystring</code>指的是URL中<code>?</code>后面携带的参数，例如：<code>/user/search?username=小王子&address=沙河</code>。获取请求的querystring参数的方法如下： <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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() } </code></pre></td></tr></tbody></table></figure> # 获取form参数 请求的数据通过form表单来提交，例如向<code>/user/search</code>发送一个POST请求，获取请求数据的方式如下： <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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;) } </code></pre></td></tr></tbody></table></figure> # 获取path参数 请求的参数通过URL路径传递，例如：<code>/user/search/小王子/沙河</code>。获取请求URL路径中的参数的方式如下。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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;) } </code></pre></td></tr></tbody></table></figure> # 参数绑定 为了能够更方便的获取请求相关参数，提高开发效率，我们可以基于请求的<code>content-type</code>识别请求数据类型并利用反射机制自动提取请求中<code>querystring</code>、form表单、JSON、XML等参数到结构体中。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 </code></pre></td><td class="code"><pre class="hljs coffeescript"><code class="go">// 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;) } </code></pre></td></tr></tbody></table></figure> # 文件上传 # 单个文件上传 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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() } </code></pre></td></tr></tbody></table></figure> # 多个文件上传 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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() } </code></pre></td></tr></tbody></table></figure> # Gin中间件 Gin框架允许开发者在处理请求的过程中，加入用户自己的钩子（Hook）函数。这个钩子函数就叫中间件，中间件适合处理一些公共的业务逻辑，比如登录校验、日志打印、耗时统计等。 Gin中的中间件必须是一个<code>gin.HandlerFunc</code>类型。例如我们像下面的代码一样定义一个中间件。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">// 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) } } </code></pre></td></tr></tbody></table></figure> 然后注册中间件的时候，可以在全局注册。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </code></pre></td><td class="code"><pre class="hljs cpp"><code class="go">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() } </code></pre></td></tr></tbody></table></figure> 也可以给某个路由单独注册中间件。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 </code></pre></td><td class="code"><pre class="hljs cpp"><code class="go">// 给/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;, }) }) </code></pre></td></tr></tbody></table></figure> # 重定向 # HTTP重定向 HTTP 重定向很容易。内部、外部重定向均支持。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 </code></pre></td><td class="code"><pre class="hljs coffeescript"><code class="go">r.GET(&quot;/test&quot;, func(c *gin.Context) { c.Redirect(http.StatusMovedPermanently, &quot;http://www.google.com/&quot;) }) </code></pre></td></tr></tbody></table></figure> # 路由重定向 路由重定向，使用<code>HandleContext</code>： <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 </code></pre></td><td class="code"><pre class="hljs javascript"><code class="go">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;}) }) </code></pre></td></tr></tbody></table></figure> # Gin路由 # 普通路由 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 </code></pre></td><td class="code"><pre class="hljs javascript"><code class="go">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) {...}) </code></pre></td></tr></tbody></table></figure> 此外，还有一个可以匹配所有请求方法的<code>Any</code>方法如下： <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 </code></pre></td><td class="code"><pre class="hljs bash"><code class="go">r.Any(&quot;/test&quot;, func(c *gin.Context) {...}) </code></pre></td></tr></tbody></table></figure> 为没有配置处理函数的路由添加处理程序。默认情况下它返回404代码。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 </code></pre></td><td class="code"><pre class="hljs objectivec"><code class="go">r.NoRoute(func(c *gin.Context) { c.HTML(http.StatusNotFound, &quot;views/404.html&quot;, nil) }) </code></pre></td></tr></tbody></table></figure> # 路由组 我们可以将拥有共同URL前缀的路由划分为一个路由组。 <figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </code></pre></td><td class="code"><pre class="hljs javascript"><code class="go">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() } </code></pre></td></tr></tbody></table></figure> 通常我们将路由分组用在划分业务逻辑或划分API版本时。 # 路由原理 Gin框架中的路由使用的是<a href="https://github.com/julienschmidt/httprouter" target="_blank" rel="noopener">httprouter</a>这个库。 其基本原理就是构造一个路由地址的前缀树。</code></pre></section><code class="language-golang">  <div class="tags"> Tags: <a href="/tags#Go"> Go </a> </div>   <div class="nav-container">  <a class="nav-left" href="/others/%E6%9D%82%E4%B8%83%E6%9D%82%E5%85%AB%E7%B3%BB%E5%88%97/"> ← [置顶]杂七杂八系列 </a> <a class="nav-right" href="/Elasticsearch/Elasticsearch%E7%B3%BB%E5%88%97%E6%95%99%E7%A8%8B/"> [置顶]Elasticsearch系列教程 → </a> </div>   <div class="money-like"> <div class="reward-btn"> 赏 <div class="code-image"></div> 使用支付宝打赏 <div class="code-image"></div> 使用微信打赏 </div> 点击上方按钮,请我喝杯咖啡！ </div>   <div class="qrcode"> <canvas id="share-qrcode" height="100" width="100"></canvas> 扫描二维码，分享此文章 </div>   <div id="comments"><div lang="en-US" class="gitment-container gitment-root-container"><div><div lang="en-US" class="gitment-container gitment-header-container"> <svg class="gitment-heart-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50"><path d="M25 39.7l-.6-.5C11.5 28.7 8 25 8 19c0-5 4-9 9-9 4.1 0 6.4 2.3 8 4.1 1.6-1.8 3.9-4.1 8-4.1 5 0 9 4 9 9 0 6-3.5 9.7-16.4 20.2l-.6.5zM17 12c-3.9 0-7 3.1-7 7 0 5.1 3.2 8.5 15 18.1 11.8-9.6 15-13 15-18.1 0-3.9-3.1-7-7-7-3.5 0-5.4 2.1-6.9 3.8L25 17.1l-1.1-1.3C22.4 14.1 20.5 12 17 12z"></path></svg> Like <a class="gitment-header-issue-link" href="undefined" target="_blank">Issue Page</a></div></div><div><div lang="en-US" class="gitment-container gitment-editor-container"> <a class="gitment-editor-avatar" href="https://github.com/login/oauth/authorize?scope=public_repo&redirect_uri=https%3A%2F%2Fwww.liuqingzheng.top%2Fgo%2F4-Go%25E8%25AF%25AD%25E8%25A8%2580%25E6%25A1%2586%25E6%259E%25B6%2F01-Web%25E6%25A1%2586%25E6%259E%25B6%25E4%25B9%258BGin%2F&client_id=32a4076431cf39d0ecea&client_secret=94484bd79b3346a949acb2fda3c8a76ce16990c6" title="login with GitHub"> <svg class="gitment-github-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50"><path d="M25 10c-8.3 0-15 6.7-15 15 0 6.6 4.3 12.2 10.3 14.2.8.1 1-.3 1-.7v-2.6c-4.2.9-5.1-2-5.1-2-.7-1.7-1.7-2.2-1.7-2.2-1.4-.9.1-.9.1-.9 1.5.1 2.3 1.5 2.3 1.5 1.3 2.3 3.5 1.6 4.4 1.2.1-1 .5-1.6 1-2-3.3-.4-6.8-1.7-6.8-7.4 0-1.6.6-3 1.5-4-.2-.4-.7-1.9.1-4 0 0 1.3-.4 4.1 1.5 1.2-.3 2.5-.5 3.8-.5 1.3 0 2.6.2 3.8.5 2.9-1.9 4.1-1.5 4.1-1.5.8 2.1.3 3.6.1 4 1 1 1.5 2.4 1.5 4 0 5.8-3.5 7-6.8 7.4.5.5 1 1.4 1 2.8v4.1c0 .4.3.9 1 .7 6-2 10.2-7.6 10.2-14.2C40 16.7 33.3 10 25 10z"></path></svg> </a> <div class="gitment-editor-main"> <div class="gitment-editor-header"> <nav class="gitment-editor-tabs"> <button class="gitment-editor-tab gitment-selected">Write</button> <button class="gitment-editor-tab">Preview</button> </nav> <div class="gitment-editor-login"> <a class="gitment-editor-login-link" href="https://github.com/login/oauth/authorize?scope=public_repo&redirect_uri=https%3A%2F%2Fwww.liuqingzheng.top%2Fgo%2F4-Go%25E8%25AF%25AD%25E8%25A8%2580%25E6%25A1%2586%25E6%259E%25B6%2F01-Web%25E6%25A1%2586%25E6%259E%25B6%25E4%25B9%258BGin%2F&client_id=32a4076431cf39d0ecea&client_secret=94484bd79b3346a949acb2fda3c8a76ce16990c6">Login</a> with GitHub </div> </div> <div class="gitment-editor-body"> <div class="gitment-editor-write-field"> <textarea placeholder="Leave a comment" title="Login to Comment" disabled=""></textarea> </div> <div class="gitment-editor-preview-field gitment-hidden"> <div class="gitment-editor-preview gitment-markdown"></div> </div> </div> </div> <div class="gitment-editor-footer"> <a class="gitment-editor-footer-tip" href="https://guides.github.com/features/mastering-markdown/" target="_blank"> Styling with Markdown is supported </a> <button class="gitment-editor-submit" title="Login to Comment" disabled="">Comment</button> </div> </div></div><div><div lang="en-US" class="gitment-container gitment-comments-container"><div class="gitment-comments-error">Error: Comments Not Initialized</div></div></div><div><div lang="en-US" class="gitment-container gitment-footer-container"> Powered by <a class="gitment-footer-project-link" href="https://github.com/imsun/gitment" target="_blank"> Gitment </a> </div></div></div></div>  </code></article> <article class="post-article"> <section class="markdown-content"><code>Gin</code>是一个用Go语言编写的web框架。它是一个类似于<code>martini</code>但拥有更好性能的API框架, 由于使用了<code>httprouter</code>，速度提高了近40倍。如果你是性能和高效的追求者, 你会爱上<code>Gin</code>。
<h1 id="Gin框架介绍"><a href="#Gin框架介绍" class="headerlink" title="Gin框架介绍"></a>Gin框架介绍</h1>Go世界里最流行的Web框架，<a href="https://github.com/gin-gonic/gin" target="_blank" rel="noopener">Github</a>上有<code>24K+</code>star。基于<a href="https://github.com/julienschmidt/httprouter" target="_blank" rel="noopener">httprouter</a>开发的Web框架。<a href="https://gin-gonic.com/zh-cn/docs/" target="_blank" rel="noopener">中文文档</a>齐全，简单易用的轻量级框架。
<h1 id="Gin框架安装与使用"><a href="#Gin框架安装与使用" class="headerlink" title="Gin框架安装与使用"></a>Gin框架安装与使用</h1><h1 id="安装"><a href="#安装" class="headerlink" title="安装"></a>安装</h1>下载并安装<code>Gin</code>:
<figure class="highlight bash" data-lang="BASH"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="bash">1 </code></pre></td><td class="code"><pre class="hljs cs"><code class="bash">go get -u github.com/gin-gonic/gin </code></pre></td></tr></tbody></table></figure>
<h1 id="第一个Gin示例："><a href="#第一个Gin示例：" class="headerlink" title="第一个Gin示例："></a>第一个Gin示例：</h1><pre><code class="language-golang">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()}
<figure class="highlight plain" data-lang="PLAIN"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="plain">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 </code></pre></td><td class="code"><pre class="hljs xml"><code class="plain"> <p>将上面的代码保存并编译执行，然后使用浏览器打开<code>127.0.0.1:8080/hello</code>就能看到一串JSON字符串。</p> # RESTful API <p>REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”或“表现层状态转化”。</p> <p>推荐阅读<a href="http://www.ruanyifeng.com/blog/2011/09/restful.html">阮一峰理解RESTful架构</a></p> <p>简单来说，REST的含义就是客户端与Web服务器之间进行交互的时候，使用HTTP协议中的4个请求方法代表不同的动作。</p> <ul> <li><code>GET</code>用来获取资源</li> <li><code>POST</code>用来新建资源</li> <li><code>PUT</code>用来更新资源</li> <li><code>DELETE</code>用来删除资源。</li> </ul> <p>只要API程序遵循了REST风格，那就可以称其为RESTful API。目前在前后端分离的架构中，前后端基本都是通过RESTful API来进行交互。</p> <p>例如，我们现在要编写一个管理书籍的系统，我们可以查询对一本书进行查询、创建、更新和删除等操作，我们在编写程序的时候就要设计客户端浏览器与我们Web服务端交互的方式和路径。按照经验我们通常会设计成如下模式：</p> <table> <thead> <tr> <th>请求方法</th> <th>URL</th> <th>含义</th> </tr> </thead> <tbody> <tr> <td>GET</td> <td>/book</td> <td>查询书籍信息</td> </tr> <tr> <td>POST</td> <td>/create_book</td> <td>创建书籍记录</td> </tr> <tr> <td>POST</td> <td>/update_book</td> <td>更新书籍信息</td> </tr> <tr> <td>POST</td> <td>/delete_book</td> <td>删除书籍信息</td> </tr> </tbody> </table> <p>同样的需求我们按照RESTful API设计如下：</p> <table> <thead> <tr> <th>请求方法</th> <th>URL</th> <th>含义</th> </tr> </thead> <tbody> <tr> <td>GET</td> <td>/book</td> <td>查询书籍信息</td> </tr> <tr> <td>POST</td> <td>/book</td> <td>创建书籍记录</td> </tr> <tr> <td>PUT</td> <td>/book</td> <td>更新书籍信息</td> </tr> <tr> <td>DELETE</td> <td>/book</td> <td>删除书籍信息</td> </tr> </tbody> </table> <p>Gin框架支持开发RESTful API的开发。</p> ```go 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", }) }) } </code></pre></td></tr></tbody></table></figure>
开发RESTful API的时候我们通常使用<a href="https://www.getpostman.com/" target="_blank" rel="noopener">Postman</a>来作为客户端的测试工具。
# Gin渲染
# HTML渲染
我们首先定义一个存放模板文件的<code>templates</code>文件夹，然后在其内部按照业务分别定义一个<code>posts</code>文件夹和一个<code>users</code>文件夹。<code>posts/index.html</code>文件的内容如下：<figure class="highlight html" data-lang="HTML"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="html">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </code></pre></td><td class="code"><pre class="hljs perl"><code class="html"><pre><code class="language-template">{{define &quot;posts/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;posts/index&lt;/title&gt; &lt;/head&gt; &lt;body&gt; {{.title}} &lt;/body&gt; &lt;/html&gt; {{end}} </code></pre></td></tr></tbody></table></figure>

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

<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </code></pre></td><td class="code"><pre class="hljs perl"><code class="go"><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}} </code></pre></td></tr></tbody></table></figure>
Gin框架中使用<code>LoadHTMLGlob()</code>或者<code>LoadHTMLFiles()</code>方法进行HTML模板渲染。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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;) } </code></pre></td></tr></tbody></table></figure>
# 静态文件处理
当我们渲染的HTML文件中引用了静态文件时，我们只需要按照以下方式在渲染页面前调用<code>gin.Static</code>方法即可。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 </code></pre></td><td class="code"><pre class="hljs css"><code class="go">func main() { r := gin.Default() r.Static(&quot;/static&quot;, &quot;./static&quot;) r.LoadHTMLGlob(&quot;templates/**/*&quot;) ... r.Run(&quot;:8080&quot;) } </code></pre></td></tr></tbody></table></figure>
# 补充文件路径处理
关于模板文件和静态文件的路径，我们需要根据公司/项目的要求进行设置。可以使用下面的函数获取当前执行程序的路径。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 </code></pre></td><td class="code"><pre class="hljs cpp"><code class="go">func getCurrentPath() string { if ex, err := os.Executable(); err == nil { return filepath.Dir(ex) } return &quot;./&quot; } </code></pre></td></tr></tbody></table></figure>
# JSON渲染
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 </code></pre></td><td class="code"><pre class="hljs coffeescript"><code class="go">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;) } </code></pre></td></tr></tbody></table></figure>
# XML渲染
注意需要使用具名的结构体类型。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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;) } </code></pre></td></tr></tbody></table></figure>
# YMAL渲染
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 </code></pre></td><td class="code"><pre class="hljs"><code class="go">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}) }) </code></pre></td></tr></tbody></table></figure>
# protobuf渲染
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 </code></pre></td><td class="code"><pre class="hljs javascript"><code class="go">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) }) </code></pre></td></tr></tbody></table></figure>
# 获取参数
# 获取querystring参数
<code>querystring</code>指的是URL中<code>?</code>后面携带的参数，例如：<code>/user/search?username=小王子&address=沙河</code>。获取请求的querystring参数的方法如下：
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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() } </code></pre></td></tr></tbody></table></figure>
# 获取form参数
请求的数据通过form表单来提交，例如向<code>/user/search</code>发送一个POST请求，获取请求数据的方式如下：
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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;) } </code></pre></td></tr></tbody></table></figure>
# 获取path参数
请求的参数通过URL路径传递，例如：<code>/user/search/小王子/沙河</code>。获取请求URL路径中的参数的方式如下。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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;) } </code></pre></td></tr></tbody></table></figure>
# 参数绑定
为了能够更方便的获取请求相关参数，提高开发效率，我们可以基于请求的<code>content-type</code>识别请求数据类型并利用反射机制自动提取请求中<code>querystring</code>、form表单、JSON、XML等参数到结构体中。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 </code></pre></td><td class="code"><pre class="hljs coffeescript"><code class="go">// 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;) } </code></pre></td></tr></tbody></table></figure>
# 文件上传
# 单个文件上传
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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() } </code></pre></td></tr></tbody></table></figure>
# 多个文件上传
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">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() } </code></pre></td></tr></tbody></table></figure>
# Gin中间件
Gin框架允许开发者在处理请求的过程中，加入用户自己的钩子（Hook）函数。这个钩子函数就叫中间件，中间件适合处理一些公共的业务逻辑，比如登录校验、日志打印、耗时统计等。
Gin中的中间件必须是一个<code>gin.HandlerFunc</code>类型。例如我们像下面的代码一样定义一个中间件。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 </code></pre></td><td class="code"><pre class="hljs ruby"><code class="go">// 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) } } </code></pre></td></tr></tbody></table></figure>
然后注册中间件的时候，可以在全局注册。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </code></pre></td><td class="code"><pre class="hljs cpp"><code class="go">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() } </code></pre></td></tr></tbody></table></figure>
也可以给某个路由单独注册中间件。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 </code></pre></td><td class="code"><pre class="hljs cpp"><code class="go">// 给/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;, }) }) </code></pre></td></tr></tbody></table></figure>
# 重定向
# HTTP重定向
HTTP 重定向很容易。内部、外部重定向均支持。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 </code></pre></td><td class="code"><pre class="hljs coffeescript"><code class="go">r.GET(&quot;/test&quot;, func(c *gin.Context) { c.Redirect(http.StatusMovedPermanently, &quot;http://www.google.com/&quot;) }) </code></pre></td></tr></tbody></table></figure>
# 路由重定向
路由重定向，使用<code>HandleContext</code>：
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 </code></pre></td><td class="code"><pre class="hljs javascript"><code class="go">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;}) }) </code></pre></td></tr></tbody></table></figure>
# Gin路由
# 普通路由
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 </code></pre></td><td class="code"><pre class="hljs javascript"><code class="go">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) {...}) </code></pre></td></tr></tbody></table></figure>
此外，还有一个可以匹配所有请求方法的<code>Any</code>方法如下：
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 </code></pre></td><td class="code"><pre class="hljs bash"><code class="go">r.Any(&quot;/test&quot;, func(c *gin.Context) {...}) </code></pre></td></tr></tbody></table></figure>
为没有配置处理函数的路由添加处理程序。默认情况下它返回404代码。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 </code></pre></td><td class="code"><pre class="hljs objectivec"><code class="go">r.NoRoute(func(c *gin.Context) { c.HTML(http.StatusNotFound, &quot;views/404.html&quot;, nil) }) </code></pre></td></tr></tbody></table></figure>
# 路由组
我们可以将拥有共同URL前缀的路由划分为一个路由组。
<figure class="highlight go" data-lang="GO"><table><tbody><tr><td class="gutter"><pre class="hljs"><code class="go">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </code></pre></td><td class="code"><pre class="hljs javascript"><code class="go">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() } </code></pre></td></tr></tbody></table></figure>
通常我们将路由分组用在划分业务逻辑或划分API版本时。
# 路由原理
Gin框架中的路由使用的是<a href="https://github.com/julienschmidt/httprouter" target="_blank" rel="noopener">httprouter</a>这个库。
其基本原理就是构造一个路由地址的前缀树。</code></pre></section><code class="language-golang">  <div class="tags"> Tags: <a href="/tags#Go"> Go </a>
</div>   <div class="nav-container">  <a class="nav-left" href="/others/%E6%9D%82%E4%B8%83%E6%9D%82%E5%85%AB%E7%B3%BB%E5%88%97/"> ← [置顶]杂七杂八系列 </a> <a class="nav-right" href="/Elasticsearch/Elasticsearch%E7%B3%BB%E5%88%97%E6%95%99%E7%A8%8B/"> [置顶]Elasticsearch系列教程 → </a> </div>
  <div class="money-like"> <div class="reward-btn"> 赏 <div class="code-image"></div> 使用支付宝打赏 <div class="code-image"></div> 使用微信打赏 </div> 点击上方按钮,请我喝杯咖啡！ </div>   <div class="qrcode"> <canvas id="share-qrcode" height="100" width="100"></canvas> 扫描二维码，分享此文章 </div>   <div id="comments"><div lang="en-US" class="gitment-container gitment-root-container"><div><div lang="en-US" class="gitment-container gitment-header-container"> <svg class="gitment-heart-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50"><path d="M25 39.7l-.6-.5C11.5 28.7 8 25 8 19c0-5 4-9 9-9 4.1 0 6.4 2.3 8 4.1 1.6-1.8 3.9-4.1 8-4.1 5 0 9 4 9 9 0 6-3.5 9.7-16.4 20.2l-.6.5zM17 12c-3.9 0-7 3.1-7 7 0 5.1 3.2 8.5 15 18.1 11.8-9.6 15-13 15-18.1 0-3.9-3.1-7-7-7-3.5 0-5.4 2.1-6.9 3.8L25 17.1l-1.1-1.3C22.4 14.1 20.5 12 17 12z"></path></svg> Like <a class="gitment-header-issue-link" href="undefined" target="_blank">Issue Page</a></div></div><div><div lang="en-US" class="gitment-container gitment-editor-container"> <a class="gitment-editor-avatar" href="https://github.com/login/oauth/authorize?scope=public_repo&redirect_uri=https%3A%2F%2Fwww.liuqingzheng.top%2Fgo%2F4-Go%25E8%25AF%25AD%25E8%25A8%2580%25E6%25A1%2586%25E6%259E%25B6%2F01-Web%25E6%25A1%2586%25E6%259E%25B6%25E4%25B9%258BGin%2F&client_id=32a4076431cf39d0ecea&client_secret=94484bd79b3346a949acb2fda3c8a76ce16990c6" title="login with GitHub"> <svg class="gitment-github-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50"><path d="M25 10c-8.3 0-15 6.7-15 15 0 6.6 4.3 12.2 10.3 14.2.8.1 1-.3 1-.7v-2.6c-4.2.9-5.1-2-5.1-2-.7-1.7-1.7-2.2-1.7-2.2-1.4-.9.1-.9.1-.9 1.5.1 2.3 1.5 2.3 1.5 1.3 2.3 3.5 1.6 4.4 1.2.1-1 .5-1.6 1-2-3.3-.4-6.8-1.7-6.8-7.4 0-1.6.6-3 1.5-4-.2-.4-.7-1.9.1-4 0 0 1.3-.4 4.1 1.5 1.2-.3 2.5-.5 3.8-.5 1.3 0 2.6.2 3.8.5 2.9-1.9 4.1-1.5 4.1-1.5.8 2.1.3 3.6.1 4 1 1 1.5 2.4 1.5 4 0 5.8-3.5 7-6.8 7.4.5.5 1 1.4 1 2.8v4.1c0 .4.3.9 1 .7 6-2 10.2-7.6 10.2-14.2C40 16.7 33.3 10 25 10z"></path></svg> </a> <div class="gitment-editor-main"> <div class="gitment-editor-header"> <nav class="gitment-editor-tabs"> <button class="gitment-editor-tab gitment-selected">Write</button> <button class="gitment-editor-tab">Preview</button> </nav> <div class="gitment-editor-login"> <a class="gitment-editor-login-link" href="https://github.com/login/oauth/authorize?scope=public_repo&redirect_uri=https%3A%2F%2Fwww.liuqingzheng.top%2Fgo%2F4-Go%25E8%25AF%25AD%25E8%25A8%2580%25E6%25A1%2586%25E6%259E%25B6%2F01-Web%25E6%25A1%2586%25E6%259E%25B6%25E4%25B9%258BGin%2F&client_id=32a4076431cf39d0ecea&client_secret=94484bd79b3346a949acb2fda3c8a76ce16990c6">Login</a> with GitHub </div> </div> <div class="gitment-editor-body"> <div class="gitment-editor-write-field"> <textarea placeholder="Leave a comment" title="Login to Comment" disabled=""></textarea> </div> <div class="gitment-editor-preview-field gitment-hidden"> <div class="gitment-editor-preview gitment-markdown"></div> </div> </div> </div> <div class="gitment-editor-footer"> <a class="gitment-editor-footer-tip" href="https://guides.github.com/features/mastering-markdown/" target="_blank"> Styling with Markdown is supported </a> <button class="gitment-editor-submit" title="Login to Comment" disabled="">Comment</button> </div> </div></div><div><div lang="en-US" class="gitment-container gitment-comments-container"><div class="gitment-comments-error">Error: Comments Not Initialized</div></div></div><div><div lang="en-US" class="gitment-container gitment-footer-container"> Powered by <a class="gitment-footer-project-link" href="https://github.com/imsun/gitment" target="_blank"> Gitment </a> </div></div></div></div>  </code></article>

标签：gt,框架,quot,gin,lt,amp,Gin,td
From： https://www.cnblogs.com/Asura2Ares/p/17012359.html

相关文章

赞助商

阅读排行