Golang实现http server提供压缩文件下载功能

2023-07-07 01:56:03 69

最近遇到了一个下载静态html报表的需求，需要以提供压缩包的形式完成下载功能，实现的过程中发现相关文档非常杂，故总结一下自己的实现。

开发环境：

系统环境：MacOS+Chrome
框架：beego
压缩功能：tar+gzip
目标压缩文件：自带数据和全部包的静态html文件

首先先提一下httpserver文件下载的实现，其实就是在后端返回前端的数据包中，将数据头设置为下载文件的格式，这样前端收到返回的响应时，会直接触发下载功能(就像时平时我们在chrome中点击下载那样)
数据头设置格式如下：

func(c*Controller)Download(){
//...文件信息的产生逻辑
//
//rw为responseWriter
rw:=c.Ctx.ResponseWriter
//规定下载后的文件名
rw.Header().Set("Content-Disposition","attachment;filename="+"(文件名字)")
rw.Header().Set("Content-Description","FileTransfer")
//标明传输文件类型
//如果是其他类型，请参照：https://www.runoob.com/http/http-content-type.html
rw.Header().Set("Content-Type","application/octet-stream")
rw.Header().Set("Content-Transfer-Encoding","binary")
rw.Header().Set("Expires","0")
rw.Header().Set("Cache-Control","must-revalidate")
rw.Header().Set("Pragma","public")
rw.WriteHeader(http.StatusOK)
//文件的传输是用byteslice类型，本例子中：b是一个bytes.Buffer，则需调用b.Bytes()
http.ServeContent(rw,c.Ctx.Request,"(文件名字)",time.Now(),bytes.NewReader(b.Bytes()))
}

这样，beego后端就会将在头部标记为下载文件的数据包发送给前端，前端收到后会自动启动下载功能。

然而这只是最后一步的情况，如何将我们的文件先进行压缩再发送给前端提供下载呢？

如果需要下载的不只一个文件，需要用tar打包，再用gzip进行压缩，实现如下：

//最内层用bytes.Buffer来进行文件的存储
varbbytes.Buffer
//嵌套tar包的writter和gzip包的writer
gw:=gzip.NewWriter(&b)
tw:=tar.NewWriter(gw)


dataFile:=//...文件的产生逻辑，dataFile为File类型
info,_:=dataFile.Stat()
header,_:=tar.FileInfoHeader(info,"")
//下载后当前文件的路径设置
header.Name="report"+"/"+header.Name
err:=tw.WriteHeader(header)
iferr!=nil{
utils.LogErrorln(err.Error())
return
}
_,err=io.Copy(tw,dataFile)
iferr!=nil{
utils.LogErrorln(err.Error())
}
//...可以继续添加文件
//tarwriter和gzipwriter的关闭顺序一定不能反
tw.Close()
gw.Close()

最后和中间步骤完成了，我们只剩File文件的产生逻辑了，由于是静态html文件，我们需要把所有html引用的依赖包全部完整的写入到生成的文件中的")) //剩下的所有静态文件 staticFiles,_:=ioutil.ReadDir("static/report/") for_,tempfile:=rangestaticFiles{ iftempfile.Name()=="jquery.min.js"{ continue } tempfilename:="static/report/"+tempfile.Name() tempfileP,_:=os.Open(tempfilename) info,_:=os.Stat(tempfilename) curFileByte:=make([]byte,info.Size()) _,err:=tempfileP.Read(curFileByte) iferr!=nil{ utils.LogErrorln(err.Error()) } ifisJs,_:=regexp.MatchString(`\.js$`,tempfilename);isJs{ allStaticFiles=append(allStaticFiles,[]byte("")) }elseifisCss,_:=regexp.MatchString(`\.css$`,tempfilename);isCss{ allStaticFiles=append(allStaticFiles,[]byte("")) } tempfileP.Close() } //转成http.File格式进行返回 mf:=&MyFile{ Reader:bytes.NewReader(html), mif:myFileInfo{ name:"report.html", data:html, }, } varfhttp.File=mf returnf }

OK！目前为止，后端的文件生成->打包->压缩都已经做好啦，我们把他们串起来：

func(c*Controller)Download(){
varbbytes.Buffer
gw:=gzip.NewWriter(&b)

tw:=tar.NewWriter(gw)

//生成动态report,并添加进压缩包
//调用上文中的testWrite方法
dataFile:=testWrite(responseByRules,strTaskId)
info,_:=dataFile.Stat()
header,_:=tar.FileInfoHeader(info,"")
header.Name="report_"+strTaskId+"/"+header.Name
err:=tw.WriteHeader(header)
iferr!=nil{
utils.LogErrorln(err.Error())
return
}
_,err=io.Copy(tw,dataFile)
iferr!=nil{
utils.LogErrorln(err.Error())
}

tw.Close()
gw.Close()
rw:=c.Ctx.ResponseWriter
rw.Header().Set("Content-Disposition","attachment;filename="+"report_"+strTaskId+".tar.gz")
rw.Header().Set("Content-Description","FileTransfer")
rw.Header().Set("Content-Type","application/octet-stream")
rw.Header().Set("Content-Transfer-Encoding","binary")
rw.Header().Set("Expires","0")
rw.Header().Set("Cache-Control","must-revalidate")
rw.Header().Set("Pragma","public")
rw.WriteHeader(http.StatusOK)
http.ServeContent(rw,c.Ctx.Request,"report_"+strTaskId+".tar.gz",time.Now(),bytes.NewReader(b.Bytes()))
}

后端部分已经全部实现了，前端部分如何接收呢，本例中我做了一个按钮嵌套标签来进行请求:


下载报表

这样，当前端页面中点击下载报表按钮之后，会自动启动下载，下载我们后端传回的report.tar.gz文件。

到此这篇关于Golang实现httpserver提供压缩文件下载功能的文章就介绍到这了,更多相关Golanghttpserver压缩下载内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！

Golang实现http server提供压缩文件下载功能

开发环境：

热门推荐

随机推荐