26-gin框架参数处理以及文件上传

获取参数

获取querystring参数

querystring指的是是URL中?后面携带的参数，例如：user/search?username=小男孩&address=天通苑。获取请求的querystring参数的方法如下：

// 获取querystring参数
func QueryDemo() {
	// 声明一个默认的路由引擎
	r := gin.Default()
	r.GET("/user/search", func(ctx *gin.Context) {
		username := ctx.DefaultQuery("username", "小男孩") // 如果username获取不到，就用默认值
		address := ctx.Query("address")
		// 输出json给调用房
		ctx.JSON(http.StatusOK, gin.H{
			"message":  "ok",
			"username": username,
			"address":  address,
		})
	})

	r.Run(":8080")
}

结果：

获取form参数

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

// 获取form参数
func FormDemo() {
	// 注册一个默认的路由
	r := gin.Default()
	r.POST("/user/search", func(ctx *gin.Context) {
		// DefaultPOstForm取不到值会返回指定的默认值
		// username := ctx.DefaultPOstForm("username","小王子")
		username := ctx.PostForm("username")
		address := ctx.PostForm("address")

		// 输出json结果
		ctx.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/serach/小王子/沙河。获取请求URL路径参数的方式如下。

// 获取path参数
func PathDemo() {
	// 注册一个默认的路由
	r := gin.Default()
	r.GET("/user/serach/:user/:address", func(ctx *gin.Context) {
		username := ctx.Param("user")
		address := ctx.Param("address")

		//输出json结果给调用房
		ctx.JSON(http.StatusOK, gin.H{
			"message":  "ok",
			"username": username,
			"address":  address,
		})
	})

	r.Run(":8080")
}

参数绑定

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

注意：

1. 字段首字母大写，并且tag要对应上
2. 要传指针类型

绑定JSON示例

// 参数绑定
type Login struct {
	User     string `form:"user" json:"user" binding:"required"`
	Password string `form:"password" json:"password" binding:"required"`
}

func ShouldBindDemo1() {
	// 注册默认路由
	r := gin.Default()

	//绑定JSON示例({"user": "王磊", "password": "123456"})
	r.POST("/loginJSON", func(ctx *gin.Context) {
		var login Login

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

	//启动
	r.Run(":8080")

}

结果：

绑定form示例

// 参数绑定
type Login struct {
	User     string `form:"user" json:"user" binding:"required"`
	Password string `form:"password" json:"password" binding:"required"`
}


// 绑定表单form示例(user=王磊&password=123456)
func ShouldBindDemo2() {
	// 注册路由
	r := gin.Default()

	//绑定form示例(user=王磊&password=123456)
	r.POST("/loginFORM", func(ctx *gin.Context) {
		var login Login

		if err := ctx.ShouldBind(&login); err == nil {
			fmt.Printf("login info :%#v\n", login)
			ctx.JSON(http.StatusOK, gin.H{
				"result":   "ok",
				"user":     login.User,
				"password": login.Password,
			})
		} else {
			ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		}
	})

	// 启动
	r.Run(":8080")
}

结果：

绑定QueryString示例

// 参数绑定
type Login struct {
	User     string `form:"user" json:"user" binding:"required"`
	Password string `form:"password" json:"password" binding:"required"`
}

func ShouldBindDemo3() {
	// 注册默认路由
	r := gin.Default()

	//绑定QueryString示例 (/loginQuery?user=q1mi&password=123456)
	r.GET("/loginQuery", func(ctx *gin.Context) {
		var login Login

		if err := ctx.ShouldBind(&login); err == nil {
			fmt.Printf("login info:%#v\n", login)
			ctx.JSON(http.StatusOK, gin.H{
				"result":   "ok",
				"user":     login.User,
				"password": login.Password,
			})
		} else {
			ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		}
	})

	//启动
	r.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 UploadSingleFile() {

	r := gin.Default()

	// 1、访问浏览器时，可以获取一个上传文件页面
	r.LoadHTMLFiles("/Users/alblue/Documents/路飞go/day11/作业/gin/templates/uploadfile/upload.html")
	r.GET("upload", func(ctx *gin.Context) {
		ctx.HTML(http.StatusOK, "upload.html", nil)
	})

	// 2、post上传文件
	// 处理multipart forms提交文件时默认的内存限制是32MiB
	// 可以通过下面的方式修改
	// router.MaxMultipartMemory = 8 << 20  // 8 MiB
	r.POST("/upload", func(ctx *gin.Context) {
		// 单个文件
		file, err := ctx.FormFile("f1")
		if err != nil {
			ctx.JSON(http.StatusBadRequest, gin.H{
				"error": err.Error(),
			})
			return
		}

		log.Println(file.Filename)                                                        // 拿到上传文件的名字
		dst := fmt.Sprintf("/Users/alblue/Documents/路飞go/day11/作业/gin/%s", file.Filename) // 定义上传文件的位置
		// 上传文件到指定目录
		ctx.SaveUploadedFile(file, dst)
		ctx.JSON(http.StatusOK, gin.H{
			"message": fmt.Sprintf("%s uploaded syccess", file.Filename),
		})
	})

	// 启动
	r.Run(":8080")
}

结果：

1、浏览器访问http://127.0.0.1:8080/upload， 进入上传文件的html页面.

2、选择文件上传

多文件上传

前端代码：

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

后端go代码

// 多个文件上传

func UploadMultiFile() {

	// 注册默认路由
	r := gin.Default()

	// 1、 获取上传文件html页面
	r.LoadHTMLFiles("/Users/alblue/Documents/路飞go/day11/作业/gin/templates/uploadfile/upload.html")
	r.GET("/upload", func(ctx *gin.Context) {
		ctx.HTML(http.StatusOK, "upload.html", nil)
	})

	// 2、 上传文件
	// 处理multipart forms提交文件时默认的内存限制是32 MiB
	// 可以通过下面的方式修改
	// router.MaxMultipartMemory = 8 << 20  // 8 MiB
	r.POST("/upload", func(ctx *gin.Context) {
		form, err := ctx.MultipartForm()
		if err != nil {
			panic(err)
		}
		files := form.File["f1"] // form.File["f1"] 获取的事前端中name=f1

		log.Println(files)
		// 遍历
		for _, file := range files {
			log.Println(file.Filename)
			dst := fmt.Sprintf("/Users/alblue/Documents/路飞go/day11/作业/gin/%s", file.Filename)
			// 上传文件到指定目录
			ctx.SaveUploadedFile(file, dst)
		}
		ctx.JSON(http.StatusOK, gin.H{
			"message": fmt.Sprintf("%v file upload sucess", len(files)),
		})

	})

	// 运行
	r.Run(":8888")
}

结果：

1、浏览器访问http://127.0.0.1:8888/upload， 进入上传文件的html页面

2、上传多个文件