AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

Gin快速入门2

2023-11-10 77
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Gin快速入门2

Gin模板渲染

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

package main
import (
  "github.com/gin-gonic/gin"
  "net/http"
)
func main() {
  //创建路由
  r := gin.Default()
  //定义模板
  //解析模板
  r.LoadHTMLGlob("template/**/*")
  //执行模板
  r.GET("posts/index", func(c *gin.Context) {
    //向页面返回一个html
    c.HTML(http.StatusOK, "post/index.html", gin.H{
      "title": "posts/index",
    })
  })
  r.GET("users/index", func(c *gin.Context) {
    //向页面返回一个html
    c.HTML(http.StatusOK, "users/index.html", gin.H{
      "title": "users/index",
    })
  })
  r.Run(":9090")
}

自定义函数模板

package main
import (
  "github.com/gin-gonic/gin"
  "html/template"
  "net/http"
)
func main() {
  //创建路由
  r := gin.Default()
  r.SetFuncMap(template.FuncMap{
    "safe": func(str string) template.HTML {
      return template.HTML(str)
    },
  })
  //定义模板
  //解析模板
  r.LoadHTMLGlob("./index.tmpl")
  r.GET("/index", func(c *gin.Context) {
    c.HTML(http.StatusOK, "index.tmpl", "<a href='https://liwenzhuo.com'>博客</a>")
  })
  r.Run(":9090")
}
<!DOCTYPE html>
<html land="zh-CN">
    <head>
        <title>aaaaa</title>
    </head>
    <body>
        <div>{{. | safe}}</div>
    </body>
</html>

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

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

获取querystring参数

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

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

获取form参数

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

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

获取json参数

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

r.POST("/json", func(c *gin.Context) {
  // 注意：下面为了举例子方便，暂时忽略了错误处理
  b, _ := c.GetRawData()  // 从c.Request.Body读取请求数据
  // 定义map或结构体
  var m map[string]interface{}
  // 反序列化
  _ = json.Unmarshal(b, &m)
  c.JSON(http.StatusOK, m)
})

获取path参数

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

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

参数绑定

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

// Binding from JSON
type Login struct {
  User     string `form:"user" json:"user" binding:"required"`
  Password string `form:"password" json:"password" binding:"required"`
}
func main() {
  router := gin.Default()
  // 绑定JSON的示例 ({"user": "q1mi", "password": "123456"})
  router.POST("/loginJSON", func(c *gin.Context) {
    var login Login
    if err := c.ShouldBind(&login); err == nil {
      fmt.Printf("login info:%#v\n", login)
      c.JSON(http.StatusOK, gin.H{
        "user":     login.User,
        "password": login.Password,
      })
    } else {
      c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
    }
  })
  // 绑定form表单示例 (user=q1mi&password=123456)
  router.POST("/loginForm", func(c *gin.Context) {
    var login Login
    // ShouldBind()会根据请求的Content-Type自行选择绑定器
    if err := c.ShouldBind(&login); err == nil {
      c.JSON(http.StatusOK, gin.H{
        "user":     login.User,
        "password": login.Password,
      })
    } else {
      c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
    }
  })
  // 绑定QueryString示例 (/loginQuery?user=q1mi&password=123456)
  router.GET("/loginForm", func(c *gin.Context) {
    var login Login
    // ShouldBind()会根据请求的Content-Type自行选择绑定器
    if err := c.ShouldBind(&login); err == nil {
      c.JSON(http.StatusOK, gin.H{
        "user":     login.User,
        "password": login.Password,
      })
    } else {
      c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
    }
  })
  // Listen and serve on 0.0.0.0:8080
  router.Run(":8080")
}

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

  1. 如果是 GET 请求，只使用 Form 绑定引擎（query）。
  2. 如果是 POST 请求，首先检查 content-type 是否为 JSON 或 XML，然后再使用 Form（form-data）。

文件上传

单个文件上传

文件上传前端页面代码：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <title>上传文件示例</title>
</head>
<body>
<form action="/upload" method="post" enctype="multipart/form-data">
    <input type="file" name="f1">
    <input type="submit" value="上传">
</form>
</body>
</html>

后端gin框架部分代码：

func main() {
  router := gin.Default()
  // 处理multipart forms提交文件时默认的内存限制是32 MiB
  // 可以通过下面的方式修改
  // router.MaxMultipartMemory = 8 << 20  // 8 MiB
  router.POST("/upload", func(c *gin.Context) {
    // 单个文件
    file, err := c.FormFile("f1")
    if err != nil {
      c.JSON(http.StatusInternalServerError, gin.H{
        "message": err.Error(),
      })
      return
    }
    log.Println(file.Filename)
    dst := fmt.Sprintf("C:/tmp/%s", file.Filename)
    // 上传文件到指定的目录
    c.SaveUploadedFile(file, dst)
    c.JSON(http.StatusOK, gin.H{
      "message": fmt.Sprintf("'%s' uploaded!", file.Filename),
    })
  })
  router.Run()
}

多个文件上传

func main() {
  router := gin.Default()
  // 处理multipart forms提交文件时默认的内存限制是32 MiB
  // 可以通过下面的方式修改
  // router.MaxMultipartMemory = 8 << 20  // 8 MiB
  router.POST("/upload", func(c *gin.Context) {
    // Multipart form
    form, _ := c.MultipartForm()
    files := form.File["file"]
    for index, file := range files {
      log.Println(file.Filename)
      dst := fmt.Sprintf("C:/tmp/%s_%d", file.Filename, index)
      // 上传文件到指定的目录
      c.SaveUploadedFile(file, dst)
    }
    c.JSON(http.StatusOK, gin.H{
      "message": fmt.Sprintf("%d files uploaded!", len(files)),
    })
  })
  router.Run()
}

重定向

HTTP重定向

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

r.GET("/test", func(c *gin.Context) {
  c.Redirect(http.StatusMovedPermanently, "http://www.sogo.com/")
})

路由重定向

路由重定向，使用HandleContext：

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

Gin路由

普通路由

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

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

r.Any("/test", func(c *gin.Context) {...})

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

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

路由组

func main() {
  r := gin.Default()
  userGroup := r.Group("/user")
  {
    userGroup.GET("/index", func(c *gin.Context) {...})
    userGroup.GET("/login", func(c *gin.Context) {...})
    userGroup.POST("/login", func(c *gin.Context) {...})
  }
  shopGroup := r.Group("/shop")
  {
    shopGroup.GET("/index", func(c *gin.Context) {...})
    shopGroup.GET("/cart", func(c *gin.Context) {...})
    shopGroup.POST("/checkout", func(c *gin.Context) {...})
  }
  r.Run()
}

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

shopGroup := r.Group("/shop")
  {
    shopGroup.GET("/index", func(c *gin.Context) {...})
    shopGroup.GET("/cart", func(c *gin.Context) {...})
    shopGroup.POST("/checkout", func(c *gin.Context) {...})
    // 嵌套路由组
    xx := shopGroup.Group("xx")
    xx.GET("/oo", func(c *gin.Context) {...})
  }

路由原理

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

Gin中间件

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

定义中间件

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

// StatCost 是一个统计耗时请求耗时的中间件
func StatCost() gin.HandlerFunc {
  return func(c *gin.Context) {
    start := time.Now()
    c.Set("name", "小王子") // 可以通过c.Set在请求上下文中设置值，后续的处理函数能够取到该值
    // 调用该请求的剩余处理程序
    c.Next()
    // 不调用该请求的剩余处理程序
    // c.Abort()
    // 计算耗时
    cost := time.Since(start)
    log.Println(cost)
  }
}

定义中间件

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

// StatCost 是一个统计耗时请求耗时的中间件
func StatCost() gin.HandlerFunc {
  return func(c *gin.Context) {
    start := time.Now()
    c.Set("name", "小王子") // 可以通过c.Set在请求上下文中设置值，后续的处理函数能够取到该值
    // 调用该请求的剩余处理程序
    c.Next()
    // 不调用该请求的剩余处理程序
    // c.Abort()
    // 计算耗时
    cost := time.Since(start)
    log.Println(cost)
  }
}

注册中间件

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

为全局路由注册

func main() {
  // 新建一个没有任何默认中间件的路由
  r := gin.New()
  // 注册一个全局中间件
  r.Use(StatCost())
  r.GET("/test", func(c *gin.Context) {
    name := c.MustGet("name").(string) // 从上下文取值
    log.Println(name)
    c.JSON(http.StatusOK, gin.H{
      "message": "Hello world!",
    })
  })
  r.Run()
}

为某个路由单独注册

// 给/test2路由单独注册中间件（可注册多个）
  r.GET("/test2", StatCost(), func(c *gin.Context) {
    name := c.MustGet("name").(string) // 从上下文取值
    log.Println(name)
    c.JSON(http.StatusOK, gin.H{
      "message": "Hello world!",
    })
  })

为路由组注册中间件

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

写法1：

shopGroup := r.Group("/shop", StatCost())
{
    shopGroup.GET("/index", func(c *gin.Context) {...})
    ...
}

写法2：

shopGroup := r.Group("/shop")
shopGroup.Use(StatCost())
{
    shopGroup.GET("/index", func(c *gin.Context) {...})
    ...
}

中间件注意事项

gin默认中间件

gin.Default()默认使用了Logger和Recovery中间件，其中：

  • Logger中间件将日志写入gin.DefaultWriter，即使配置了GIN_MODE=release。
  • Recovery中间件会recover任何panic。如果有panic的话，会写入500响应码。

如果不想使用上面两个默认的中间件，可以使用gin.New()新建一个没有任何默认中间件的路由。

gin中间件中使用goroutine

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

文章标签：
中间件
数据格式
JSON
前端开发
XML
干饭小白
目录
相关文章
干饭小白
|
Go API 网络架构
Gin框架快速入门1
Gin框架快速入门1
干饭小白
130 0
林钟一
|
SQL 关系型数据库 MySQL
gin框架学习-Gorm入门指南
Snake Case命名风格，就是各个单词之间用下划线（_）分隔，首字母大写区分一个单词，例如： CreateTime的Snake Case风格命名为create_time
林钟一
482 0
gin框架学习-Gorm入门指南
好奇的菜鸟
|
6月前
|
Go
gin初体验
gin初体验
好奇的菜鸟
37 0
落雨便归尘
|
6月前
|
JSON 中间件 数据格式
Gin框架学习笔记(六)——gin中的日志使用
Gin框架学习笔记(六)——gin中的日志使用
落雨便归尘
285 0
落雨便归尘
|
6月前
|
JSON 中间件 API
Gin框架笔记(一) Gin框架的安装与Hello World
Gin框架笔记(一) Gin框架的安装与Hello World
落雨便归尘
230 0
让线程再跑一会
|
6月前
|
JSON 前端开发 Java
Gin 框架的使用（1）
Gin 框架的使用
让线程再跑一会
108 0
让线程再跑一会
|
6月前
|
前端开发 中间件 关系型数据库
Gin 框架的使用（2）
Gin 框架的使用
让线程再跑一会
59 0
dahezhiquan
|
SQL 开发框架 安全
【Gin】初识Gin框架，模板基本语法
1.Gin介绍 Gin 是一个用 Go (Golang) 编写的 HTTP Web 框架。 它具有类似 Martini 的 API，但性能比 Martini 快 40 倍。如果你需要极好的性能，使用 Gin 吧
dahezhiquan
620 1
【Gin】初识Gin框架，模板基本语法
林钟一
|
Go API
gin框架学习-快速安装gin
Gin 是一个用 Go (Golang) 编写的 Web 框架，由于 httprouter，它具有 martini 的 API，性能提高了 40 倍。具有高性能的优点。
林钟一
168 0
gin框架学习-快速安装gin
北岛末巷
|
中间件
Gin框架学习（三）
来这里学习gin框架，目标明确不迷茫。
北岛末巷
197 0
Gin框架学习（三）

热门文章

最新文章

  • 1
    docker容器里安装ssh
  • 2
    优秀的代码都是如何分层的？
  • 3
    RDS入门——Excel文件转存到RDS数据库实践
  • 4
    3、Python与设计模式--建造者模式
  • 5
    PostgreSQL SQL HINT的使用
  • 6
    跟阿里云技术专家阙寒一起深度了解视频直播CDN技术
  • 7
    AjaxFileUploader上传插件 兼容性好
  • 8
    （转载） 数组a[]={3,5,2,4,1,8}，要求从a中找出所有“和”等于10的子集
  • 9
    SAP WM Movement Type Mail Control for Background processing
  • 10
    Ext 4 概述（七）之面板Panel &amp; 杂项
  • 1
    自学记录HarmonyOS Next DRM API 13：构建安全的数字内容保护系统
    43
  • 2
    《MaxFrame：数据处理的卓越实践与提升》
    58
  • 3
    《DataWorks：数据处理的卓越实践与改进思考》
    51
  • 4
    三维球体空间中光线反射模拟与三维点云提取matlab仿真
    50
  • 5
    《多模态数据信息提取解决方案的体验与部署》
    47
  • 6
    基于PSO优化的PV光伏发电系统simulink建模与仿真
    57
  • 7
    数据链中常见电磁干扰matlab仿真,对比噪声调频,线性调频,噪声,扫频,灵巧五种干扰模型
    51
  • 8
    《破局之路：人工智能产业的健康发展》
    39
  • 9
    《强化学习算法在动态环境中的优化之路》
    44
  • 10
    《大模型训练成本高，如何在不牺牲性能的前提下破局》
    43

    • 相关电子书

    更多
  • 低代码开发师（初级）实战教程
  • 冬季实战营第三期：MySQL数据库进阶实战
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    手把手教你白嫖阿里云服务器(免费领服务器)