go语言Gin框架快速指南

最新推荐文章于 2024-06-03 10:44:17 发布

我只要一发

最新推荐文章于 2024-06-03 10:44:17 发布

阅读量813

点赞数

文章标签： golang

本文链接：https://blog.csdn.net/weixin_44865158/article/details/115030252

版权

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

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

Gin框架安装与使用
安装
下载并安装Gin:

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

gin实现hello world

package main

import "github.com/gin-gonic/gin"

func main() {
	//创建一个默认的路由引擎
	r := gin.Default()
	//GET请求方式，/hello请求路径
	//当客户端以GET方式请求/hello路径时，就会执行后面的匿名函数
	r.GET("/hello", func(c *gin.Context) {
		//.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的简称，中文翻译为“表征状态转移”或“表现层状态转化”。

简单来说，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
GOT	/book
POST	/book
PUT	/book
DELETE	/book

Gin框架支持开发RESTful API的开发。

package main

import "github.com/gin-gonic/gin"

func main() {
	r := gin.Default()
	r.GET("/hello", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "hello GET",
		})
	})

	r.POST("/hello", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "hello POST",
		})
	})

	r.PUT("/hello", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "hello PUT",
		})
	})

	r.DELETE("/hello", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "hello DELETE",
		})
	})
	r.Run()
}

JSON渲染与XML渲染

package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

func htmlJson(c *gin.Context) {
	c.JSON(http.StatusOK, gin.H{"dlq": "自定义的json"})
}

func httpXml(c *gin.Context) {
	c.XML(http.StatusOK, gin.H{"dlq": "自定义xml"})
}

func uctJson(c *gin.Context) {
	//使用结构体
	type jso struct {
		Name string `json:"name" xml:"name"`
		Age  int    `json:"age" xml:"age"`
	}
	var j jso
	j.Name = "dlq"
	j.Age = 12
	c.JSON(http.StatusOK, j)
}
//JSON方法还可以接受map类型

func uctXml(c *gin.Context) {
	//使用结构体
	type xm struct {
		Name string `json:"name" xml:"name"`
		Age  int    `json:"age" xml:"age"`
	}
	var x xm
	x.Name = "zkj"
	x.Age = 23
	c.XML(http.StatusOK, x)
}
//XML方法不接受map类型

func main() {
	r := gin.Default()
	r.GET("/json", htmlJson)
	r.GET("/xml", httpXml)
	r.GET("/structjson", uctJson)
	r.GET("/structxml", uctXml)
	r.Run()
}

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

package main

import (
	"fmt"
	"net/http"
	"strconv"

	"github.com/gin-gonic/gin"
)

func uctXml(c *gin.Context, name string, age int64) {
	type xm struct {
		Name string `json:"name" xml:"name"`
		Age  int64  `json:"age" xml:"age"`
	}
	var x xm
	x.Name = name
	x.Age = age
	c.XML(http.StatusOK, x)
}

func query(c *gin.Context) {
	name := c.Query("name")
	age := c.Query("age")
	i, err := strconv.ParseInt(age, 10, 64)
	if err != nil {
		fmt.Println(err)
		return
	}
	uctXml(c, name, i)
}

func main() {
	r := gin.Default()
	r.GET("/structxml", query)
	r.Run()
}

Query方法返回的是string类型，如果没有查找到这个key，那么就返回空字符串

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

package main

import (
	"fmt"
	"net/http"
	"strconv"

	"github.com/gin-gonic/gin"
)

func uctXml(c *gin.Context, name string, age int64) {
	type xm struct {
		Name string `json:"name" xml:"name"`
		Age  int64  `json:"age" xml:"age"`
	}
	var x xm
	x.Name = name
	x.Age = age
	c.XML(http.StatusOK, x)
}

func query(c *gin.Context) {
	name := c.PostForm("name")
	age := c.PostForm("age")
	if age == "" {
		age = "23"
	}
	i, err := strconv.ParseInt(age, 10, 64)
	if err != nil {
		fmt.Println(err)
		return
	}
	uctXml(c, name, i)
}

func main() {
	r := gin.Default()
	r.POST("/structxml", query)
	r.Run()
}

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

package main

import (
	"encoding/json"
	"net/http"

	"github.com/gin-gonic/gin"
)

func query(c *gin.Context) {
	//注意：下面为了举例子方便，去掉错误处理
	v, _ := c.GetRawData()
	var mp map[string]interface{}
	//反序列化
	json.Unmarshal(v, &mp)
	c.JSON(http.StatusOK, mp)
}

func main() {
	r := gin.Default()
	r.POST("/structxml", query)
	r.Run()
}

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

package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

func query(c *gin.Context) {
	name := c.Param("name")
	age := c.Param("age")
	c.JSON(http.StatusOK, gin.H{
		"name": name,
		"age":  age,
	})

}

func main() {
	r := gin.Default()
	r.POST("/structxml/:name/:age", query)
	r.Run()
}

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

package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

type User struct {
	Name string `json:"name" form:"name" binding:"required"`
	Age  string `json:"age" form:"age" binding:"required"`
}

// 绑定JSON的示例 ({"user": "q1mi", "password": "123456"})
func queryJSON(c *gin.Context) {
	var user User
	// ShouldBind()会根据请求的Content-Type自行选择绑定器
	//可以自动识别JSON和form提交的数据，两种数据格式，可以用同一种方法
	if err := c.ShouldBind(&user); err == nil {
		c.JSON(http.StatusOK, gin.H{
			"name": user.Name,
			"age":  user.Age,
		})
	} else {
		c.JSON(http.StatusBadRequest, gin.H{"err": err.Error()})
	}
}

func main() {
	r := gin.Default()
	r.POST("/structJSON", queryJSON)
	r.Run()
}

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

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

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

package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

type User struct {
	Name string `json:"name" form:"name" binding:"required"`
	Age  string `json:"age" form:"age" binding:"required"`
}

func queryJSON(c *gin.Context) {
	var user User
	// 因为是GET请求所以只能够使用query方式提交数据
	if err := c.ShouldBind(&user); err == nil {
		c.JSON(http.StatusOK, gin.H{
			"name": user.Name,
			"age":  user.Age,
		})
	} else {
		c.JSON(http.StatusBadRequest, gin.H{"err": err.Error()})
	}
}

func main() {
	r := gin.Default()
	r.GET("/structJSON", queryJSON)
	r.Run()
}

单个文件上传
文件上传前端页面代码：

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

后端gin框架部分代码：

package main

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
)

func queryJSON(c *gin.Context) {
	file, err := c.FormFile("f1")
	if err != nil {
		fmt.Println(err)
		return
	}
	c.SaveUploadedFile(file, fmt.Sprintf("%s%s", "F:/file/", file.Filename))
	c.JSON(http.StatusOK, gin.H{
		"sss": file.Filename,
	})
}

func main() {
	r := gin.Default()
	r.POST("/structJSON", queryJSON)
	r.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：

package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

func aa(c *gin.Context) {
	c.JSON(http.StatusOK, gin.H{
		"name": "dlq",
	})
}

func main() {
	r := gin.Default()
	r.GET("/ss", func(c *gin.Context) {
		c.Request.URL.Path = "/aa"
		r.HandleContext(c)
	})
	r.GET("/aa", aa)
	r.Run()
}

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)
	})

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

package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

func main() {
	r := gin.Default()
	book := r.Group("/book")
	book.GET("a", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{
			"name": "dlq",
		})
	})
	book.GET("b", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{
			"name": "zkj",
		})
	})
	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类型。例如我们像下面的代码一样定义一个统计请求耗时的中间件

func stat() gin.HandlerFunc {
	return func(c *gin.Context) {
		start := time.Now()
		c.Set("name", "dlq") //通过Set方法在请求上下文中添加值
		//调用该请求的其他方法
		c.Next()
		//不掉筒其他方法
		// c.Abort()
		//计算耗时
		cost := time.Since(start)
		log.Panicln(cost)
	}
}

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

为全局路由注册

package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

func stat() gin.HandlerFunc {
	return func(c *gin.Context) {
		c.Set("name", "dlq") //通过Set方法在请求上下文中添加值
		//调用该请求的其他方法
		c.Next()
		//不掉筒其他方法
		// c.Abort()
	}
}

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

	r.GET("/a", func(c *gin.Context) {
		name := c.MustGet("name")
		c.JSON(http.StatusOK, gin.H{
			"name": name,
		})
	})
	r.Run()
}

为某个路由单独注册

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

	r.GET("/a", stat(), func(c *gin.Context) {
		name := c.MustGet("name")
		c.JSON(http.StatusOK, gin.H{
			"name": name,
		})
	})
	r.Run()
}

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

写法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()）。

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

package main

import (
	"log"
	"net/http"
	"time"

	"github.com/gin-gonic/gin"
	"golang.org/x/sync/errgroup"
)

var (
	g errgroup.Group
)

func router01() http.Handler {
	e := gin.New()
	e.Use(gin.Recovery())
	e.GET("/", func(c *gin.Context) {
		c.JSON(
			http.StatusOK,
			gin.H{
				"code":  http.StatusOK,
				"error": "Welcome server 01",
			},
		)
	})

	return e
}

func router02() http.Handler {
	e := gin.New()
	e.Use(gin.Recovery())
	e.GET("/", func(c *gin.Context) {
		c.JSON(
			http.StatusOK,
			gin.H{
				"code":  http.StatusOK,
				"error": "Welcome server 02",
			},
		)
	})

	return e
}

func main() {
	server01 := &http.Server{
		Addr:         ":8080",
		Handler:      router01(),
		ReadTimeout:  5 * time.Second,
		WriteTimeout: 10 * time.Second,
	}

	server02 := &http.Server{
		Addr:         ":8081",
		Handler:      router02(),
		ReadTimeout:  5 * time.Second,
		WriteTimeout: 10 * time.Second,
	}
   // 借助errgroup.Group或者自行开启两个goroutine分别启动两个服务
	g.Go(func() error {
		return server01.ListenAndServe()
	})

	g.Go(func() error {
		return server02.ListenAndServe()
	})

	if err := g.Wait(); err != nil {
		log.Fatal(err)
	}
}

我只要一发

关注

0
点赞
踩
9

收藏

觉得还不错? 一键收藏
1
评论
go语言Gin框架快速指南

Gin框架介绍Gin是一个用Go语言编写的web框架。它是一个类似于martini但拥有更好性能的API框架, 由于使用了httprouter，速度提高了近40倍。如果你是性能和高效的追求者, 你会爱上Gin。Gin框架介绍Go世界里最流行的Web框架，Github上有32K+star。基于httprouter开发的Web框架。中文文档齐全，简单易用的轻量级框架。Gin框架安装与使用安装下载并安装Gin:go get -u github.com/gin-gonic/gingin实现h
复制链接

扫一扫