Golang Gin框架HTTP上传文件

Golang Gin框架HTTP上传文件解析

HTTP上传的文件的原理

HTTP协议的文件上传是通过HTTP POST请求实现的，使用multipart/form-data格式将待上传的文件放入请求体中。

服务器根据请求头中的boundary参数来解析请求体，并根据Content-Disposition字段获取文件名等信息，根据Content-Type字段判断文件类型并保存到相应位置。

Gin框架文件上传Demo

代码逻辑：

1. 通过Gin框架封装的Form表单获取数据，获取上传文件
2. 获取文件名，并创建新的文件存储
3. 将上传的文件内容写入新的文件
4. 返回上传成功信息

package main

import (
	"fmt"
	"github.com/gin-gonic/gin"
	"io"
	"net/http"
	"os"
)

func uploadFile(c *gin.Context) {
	//form表单
	file, header, err := c.Request.FormFile("upload")
	if err != nil {
		c.String(http.StatusBadRequest, fmt.Sprintf("上传文件失败: %s", err.Error()))
		return
	}
	// 获取文件名，并创建新的文件存储
	filename := header.Filename
	out, err := os.Create(filename)
	if err != nil {
		c.String(http.StatusBadRequest, fmt.Sprintf("创建文件: %s", err.Error()))
		return
	}

	defer out.Close()
	//将读取的文件流写到文件中
	_, err = io.Copy(out, file)
	if err != nil {
		c.String(http.StatusBadRequest, fmt.Sprintf("读取文件失败: %s", err.Error()))
		return
	}

	c.String(http.StatusCreated, "上传成功 \n")
}

func main() {
	router := gin.Default()
	//路由:http://localhost:8080/upload
	router.POST("/upload", uploadFile)
	router.Run(":8080")
}

限制文件上传的大小

使用 http.MaxBytesReader() 函数来限制 HTTP 请求中读取的最大字节数。这个函数会返回一个新的 Reader 对象，该对象会在读取请求的正文时自动检查字节数，如果超过指定的最大字节数，则会自动停止读取，返回错误。

//限制大小为2M
c.Request.Body = http.MaxBytesReader(c.Writer, c.Request.Body, int64(2<<20))
	file, header, err := c.Request.FormFile("upload")
	if err != nil {
		c.String(http.StatusBadRequest, fmt.Sprintf("上传文件失败: %s", err.Error()))
		return
	}

该代码不能限制文件上传大小，只是设置内存大小，即使文件大小比这个大，也会写入临时文件

router := gin.Default()
router.MaxMultipartMemory = 2 * 1024 //2M Byte，默认32M

运行结果截图

文件类型验证

验证上传的文件类型，以确保上传的文件是我们期望的类型，借助“github.com/h2non/filetype”实现对文件类型的判断

import (
	"fmt"
	"github.com/gin-gonic/gin"
	"github.com/h2non/filetype"
	"io"
	"net/http"
)
func uploadFile(c *gin.Context) {
	//form表单
	c.Request.Body = http.MaxBytesReader(c.Writer, c.Request.Body, int64(2<<20))
	file, _, err := c.Request.FormFile("upload")
	if err != nil {
		c.String(http.StatusBadRequest, fmt.Sprintf("上传文件失败: %s", err.Error()))
		return
	}
	content, err := io.ReadAll(file)
	if err != nil {
		c.String(http.StatusBadRequest, fmt.Sprintf("读取失败: %s", err.Error()))
		return
	}
	// 解析文件类型
	kind, err := filetype.Match(content)
	if err != nil {
		c.String(http.StatusBadRequest, fmt.Sprintf("文件类型判断失败: %s", err.Error()))
		return
	}
	fmt.Println(kind)
	// 验证文件类型
	if kind == filetype.Unknown {
		c.String(http.StatusCreated, "未知类型 \n")
        return
	}
	if filetype.IsImage(content) {
		c.String(http.StatusCreated, "图片 上传成功 \n")
		return
	}
	c.String(http.StatusCreated, "上传成功 \n")
}

文件上传进度-后台计算文件上传进度

实现原理：

要实现 Gin 框架中的文件上传进度，在文件上传中，计算已上传的字节数，并将其与文件的总大小进行比较，以确定上传的进度。

package main

import (
	"fmt"
	"github.com/gin-gonic/gin"
	"net/http"
	"os"
)


func uploadFile(c *gin.Context) {
	//form表单
	//c.Request.Body = http.MaxBytesReader(c.Writer, c.Request.Body, int64(2<<20))
	file, fileHeader, err := c.Request.FormFile("upload")
	if err != nil {
		c.String(http.StatusBadRequest, fmt.Sprintf("上传文件失败: %s", err.Error()))
		return
	}

	filename := fileHeader.Filename
	out, err := os.Create(filename)
	if err != nil {
		c.String(http.StatusBadRequest, fmt.Sprintf("创建文件: %s", err.Error()))
		return
	}

	defer out.Close()
	count := 0
	for {
		buf := make([]byte, 10000)
		n, err := file.Read(buf)
		if err != nil {
			c.String(http.StatusBadRequest, fmt.Sprintf("读取失败: %s", err.Error()))
			return
		}
		if n == 0 {
			break
		}
		count = count + n
		out.Write(buf)
		fmt.Println(count, float64(fileHeader.Size))
		progress := float64(count) / float64(fileHeader.Size) * 100
		fmt.Println(fmt.Sprintf("%.2f%%", progress))
	}

	c.String(http.StatusCreated, "上传成功 \n")
}

func main() {
	router := gin.Default()
	router.MaxMultipartMemory = 2 * 1024 //2M Byte，默认32M

	//路由:http://localhost:8080/upload
	router.POST("/upload", uploadFile)
	fmt.Println(router.MaxMultipartMemory)
	router.Run(":8080")
}