springboot中Excel文件下载踩坑大全

项目场景：spring boot文件下载

调用接口下载spring boot工程的resources目录下的excel模板文件，非常常见的一个文件下载功能，但是却容易遇到很多坑，下面总结记录下。

问题一：下载的文件名称出现中文乱码的问题

解决方案：

response.setheader("content-disposition",
                "attachment;filename=" + new string("下载模板".getbytes("utf-8"), "iso8859-1"));

说明：
这是网上最常见的解决方案，经过这样的修改后，在浏览器上调用get请求下载的文件确实没有出现文件名中文乱码了。
但是在swagger里面测试接口，下载的问题还是会出现中文乱码。

问题二：在swagger中测试下载接口，点击下载的文件，发现文件名是乱码的问题

这里我项目中使用的是springdoc-openapi-ui 1.5.9，基于的是openapi3.0的协议。
整体使用方式和界面和swagger类似。

swagger中下载的文件，点击开发后，文件名乱码问题：

解决方案：

response.setheader("content-disposition", "attachment;filename=" + 
urlencoder.encode("线索导入模板.xlsx","utf8"));

说明：
通过urlencoder.encode函数对文件名称处理后，无论是在浏览器调用get请求下载文件，还是swagger中调用下载接口，都不会出现文件名乱码问题。

问题三：下载的excel文件打开时总是提示部分内容有问题，尝试恢复。

解决办法：
给response的header设置大小：

/加上设置大小 下载下来的excel文件才不会在打开前提示修复
response.addheader("content-length",string.valueof(file.length()));

问题四：开发环境下载成功，打成jar包发布到服务器上部署就出现下载失败问题

原因：
resource下的文件是存在于jar这个文件里面，在磁盘上是没有真实路径存在的，它其实是位于jar内部的一个路径。所以通过resourceutils.getfile或者this.getclass().getresource(“”)方法无法正确获取文件。

解决：
通过classpathresource读取文件流

 classpathresource classpathresource = new classpathresource("template/template.xlsx");

完整代码

1、控制层代码

@operation(summary = "下载模版",description = "下载模版")
@getmapping("/download")
public void download(httpservletresponse response){
    templateservice.download(response);
}

2、下载方法实现

/**
 * 下载线索模板
 * @param response
 */
public void download(httpservletresponse response) {
    inputstream inputstream = null;
    bufferedinputstream bis = null;
    outputstream outputstream = null;
    try {
        classpathresource classpathresource = new classpathresource("template/template.xlsx");
        inputstream = classpathresource.getinputstream();

        response.setcontenttype("application/octet-stream");
        response.setheader("content-type", "application/octet-stream");
        //待下载文件名
        string filename = urlencoder.encode("模板.xlsx","utf8");
        response.setheader("content-disposition", "attachment;filename=" + filename);
        //加上设置大小 下载下来的excel文件才不会在打开前提示修复
        response.addheader("content-length",string.valueof(classpathresource.getfile().length()));

        byte[] buff = new byte[1024];
        outputstream = response.getoutputstream();
        bis = new bufferedinputstream(inputstream);
        int read = bis.read(buff);
        while (read != -1) {
            outputstream.write(buff, 0, buff.length);
            outputstream.flush();
            read = bis.read(buff);
        }
    } catch ( ioexception e ) {
        log.error("文件下载失败,e");
    } finally {
        ioutils.closequietly(outputstream);
        ioutils.closequietly(inputstream);
        ioutils.closequietly(bis);
    }
}

参考：https://blog.csdn.net/hi_boy_/article/details/107198371

到此这篇关于springboot中excel文件下载踩坑大全的文章就介绍到这了,更多相关springboot excel文件下载内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com！

黄山市民网：https://www.huangshanshimin.com/