位置: IT常识 - 正文
gin框架中如何实现流式下载(gin框架使用案例)
编辑：rootadmin作者:张富春(ahfuzhang)，转载时请注明作者和引用链接，谢谢！ cnblogs博客 zhihu Github 公众号:一本正经的瞎扯 团队中之前的文件下载做得比较复杂，因为担心量太大，是后台做异步的下载，最终生成文件，传送文件到CDN服务器，最后再告诉用户下载链接。 其实在查询接口中就可以实 ... 
本文链接地址:https://www.jiuchutong.com/zhishi/313079.html
转载请保留说明！
推荐整理分享gin框架中如何实现流式下载(gin框架使用案例)，希望有所帮助，仅作参考，欢迎阅读内容。
文章相关热门搜索词:gin框架原理详解,gin框架原理详解,gin框架教程,gin框架context,gin框架中文文档,gin框架原理详解,gin框架中文文档,gin框架原理详解,内容如对您有帮助，希望把文章链接给更多的朋友！
作者:张富春(ahfuzhang)，转载时请注明作者和引用链接，谢谢！
cnblogs博客zhihuGithub公众号:一本正经的瞎扯团队中之前的文件下载做得比较复杂，因为担心量太大，是后台做异步的下载，最终生成文件，传送文件到CDN服务器，最后再告诉用户下载链接。其实在查询接口中就可以实现流式下载，这样查询接口和下载接口可以合二为一，更加简单。
下面是我的demo:
1.建立一个download_file的文件夹作为项目文件夹go mod init download_file2.生成go.mod文件，并准备对应的包：go get github.com/gin-gonic/gin@latestgo get github.com/gin-contrib/gzipgo.mod文件内容如下：
module download_filego 1.17require github.com/gin-gonic/gin v1.8.1require (github.com/gin-contrib/gzip v0.0.6 // indirectgithub.com/gin-contrib/sse v0.1.0 // indirectgithub.com/go-playground/locales v0.14.0 // indirectgithub.com/go-playground/universal-translator v0.18.0 // indirectgithub.com/go-playground/validator/v10 v10.10.0 // indirectgithub.com/goccy/go-json v0.9.7 // indirectgithub.com/json-iterator/go v1.1.12 // indirectgithub.com/leodido/go-urn v1.2.1 // indirectgithub.com/mattn/go-isatty v0.0.14 // indirectgithub.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirectgithub.com/modern-go/reflect2 v1.0.2 // indirectgithub.com/pelletier/go-toml/v2 v2.0.1 // indirectgithub.com/ugorji/go/codec v1.2.7 // indirectgolang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 // indirectgolang.org/x/net v0.0.0-20210226172049-e18ecbb05110 // indirectgolang.org/x/sys v0.0.0-20210806184541-e5e7981a1069 // indirectgolang.org/x/text v0.3.6 // indirectgoogle.golang.org/protobuf v1.28.0 // indirectgopkg.in/yaml.v2 v2.4.0 // indirect)3.main.go文件：3.1 初始化gin框架func main() {log.SetFlags(log.LstdFlags | log.Lshortfile)engine := gin.New()// engine.Use(gzip.Gzip(gzip.DefaultCompression)) //如果需要开启gzip压缩，取消这一行的注释engine.Handle("POST", "/query", downloadFile) // 假定查询和下载接口都是这条接口实现engine.Handle("GET", "/", homepage)engine.Run(":8080")}3.2 下载链接页，模拟post到新窗口的场景func homepage(ctx *gin.Context) {ctx.Header("Content-Type", "text/html")ctx.Writer.WriteString(`<html><body>open window and to download:<a href="javascript:download()">download</a><script>function download(){ var handle = window.open("about:blank", "my_download_window");document.forms[0].target = "my_download_window";document.forms[0].json.value="ahfu test";document.forms[0].submit();}</script><form action="/query" method="POST" enctype="multipart/form-data"><input type="hidden" name="json" value=""/></form></body></html>`)}点击链接后，弹出新窗口，在新窗口中POST json数据
3.3 流式下载功能func downloadFile(ctx *gin.Context) {reqData, has := ctx.GetPostForm("json")if !has {ctx.Data(400, "text/plain","not found json form data")return} // 此处省略查询的业务逻辑 // todo: // 下面开始下载的准备ctx.Writer.WriteHeader(200)ctx.Header("Content-Type", "text/plain; charset=utf-8")ctx.Header("Transfer-Encoding", "chunked") // 告诉浏览器，分段的流式的输出数据// ctx.Header("Content-Encoding", "gzip") // 输出不是gzip内容，又加上这个头，浏览器会拒收。这里是个实验，不要加这行代码now := time.Now()fileName := now.Format("20060102_150405.csv")ctx.Header("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", fileName)) // 设置下载的文件名ctx.Writer.WriteHeaderNow()// 下面模拟一个周期非常长的数据处理和下载过程for i := 0; i < 100; i++ {ctx.Writer.WriteString("\"")ctx.Writer.WriteString(str)ctx.Writer.WriteString("\"\t")ctx.Writer.WriteString("\"")ctx.Writer.WriteString(time.Now().Format("2006-01-02 15:04:05"))ctx.Writer.WriteString("\"\n")ctx.Writer.Flush() // 产生一定的数据后， flush到浏览器端time.Sleep(time.Duration(500) * time.Millisecond)}}打开浏览器，输入：http://127.0.0.1:8080然后点击链接，过一会儿后会出现文件下载框。点击保存后，可以看见陆续下载文件的过程。注意：为什么过了一会儿才出现文件下载框？这是由于浏览器的缓冲机制导致的。如果一开始下载的字节数很多，就会很快出现下载框
3.4 启用gzip压缩大流量的文本下载，可能很占带宽，我们可以开启GZIP压缩：
func main() {log.SetFlags(log.LstdFlags | log.Lshortfile)engine := gin.New()engine.Use(gzip.Gzip(gzip.DefaultCompression)) //如果需要开启gzip压缩，取消这一行的注释engine.Handle("POST", "/query", downloadFile) // 假定查询和下载接口都是这条接口实现engine.Handle("GET", "/", homepage)engine.Run(":8080")}gin框架中已经提供gzip压缩的能力。
3.5 完整代码：// main.gopackage mainimport ("fmt""log""time""github.com/gin-contrib/gzip""github.com/gin-gonic/gin")func useGzip(engine *gin.Engine) {engine.Use(gzip.Gzip(gzip.DefaultCompression))}func main() {log.SetFlags(log.LstdFlags | log.Lshortfile)engine := gin.New()// engine.Use(gzip.Gzip(gzip.DefaultCompression)) //如果需要开启gzip压缩，取消这一行的注释engine.Handle("POST", "/query", downloadFile)engine.Handle("GET", "/", homepage)engine.Run(":8080")}func downloadFile(ctx *gin.Context) {reqData, has := ctx.GetPostForm("json")if !has {ctx.Data(400, "text/plain","not found json form data")return} // 此处省略查询的业务逻辑 // todo: // 下面开始下载的准备ctx.Writer.WriteHeader(200)ctx.Header("Content-Type", "text/plain; charset=utf-8")ctx.Header("Transfer-Encoding", "chunked") // 告诉浏览器，分段的流式的输出数据// ctx.Header("Content-Encoding", "gzip") // 输出不是gzip内容，又加上这个头，浏览器会拒收。这里是个实验，不要加这行代码now := time.Now()fileName := now.Format("20060102_150405.csv")ctx.Header("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", fileName)) // 设置下载的文件名ctx.Writer.WriteHeaderNow()// 下面模拟一个周期非常长的数据处理和下载过程for i := 0; i < 100; i++ {ctx.Writer.WriteString("\"")ctx.Writer.WriteString(str)ctx.Writer.WriteString("\"\t")ctx.Writer.WriteString("\"")ctx.Writer.WriteString(time.Now().Format("2006-01-02 15:04:05"))ctx.Writer.WriteString("\"\n")ctx.Writer.Flush() // 产生一定的数据后， flush到浏览器端time.Sleep(time.Duration(500) * time.Millisecond)}}func homepage(ctx *gin.Context) {ctx.Header("Content-Type", "text/html")ctx.Writer.WriteString(`<html><body>open window and to download:<a href="javascript:download()">download</a><script>function download(){ var handle = window.open("about:blank", "my_download_window");document.forms[0].target = "my_download_window";document.forms[0].json.value="ahfu test";document.forms[0].submit();}</script><form action="/query" method="POST" enctype="multipart/form-data"><input type="hidden" name="json" value=""/></form></body></html>`)}have fun. ?
下一篇：python多线程和多进程之间的联系(python多线程多核)
