在线问题反馈模块实战(十七):实现excel模板在线下载功能

Posted 2022-08-06 bug菌¹

👨‍🎓作者：bug菌

✏️博客：CSDN、掘金等

💌公众号：猿圈奇妙屋

🚫特别声明：原创不易，转载请附上原文出处链接和本文声明，谢谢配合。

🙏版权声明：文章里可能部分文字或者图片来源于互联网或者百度百科，如有侵权请联系bug菌处理。

​

【开发云】年年都是折扣价，不用四处薅羊毛

一、概述🔥

       接下来的这几期，bug菌想跟大家分享一下自己昨天刚接到一个临时的需求，热乎着呢，想分享一下自己是如何面对临时需求并制定整个开发周期，其中包括从梳理业务到创建业务表再到实现业务逻辑形成闭环再到与前端对接，其中会穿插一些业务拓展及功能性拓展，这一条龙流程在线与大家一起见证，分享给刚入门的小伙伴，希望对你们有所帮助。

环境说明：idea2019.3 + springboot2.3.1.REALSE + mybati-plus3.2.0 + mysql5.6 + jdk1.8

       若小伙伴们在批阅文章的过程中觉得文章对您有一丝丝帮助，还请别吝啬您手里的赞呀，大胆的把文章点亮👍吧，您的点赞三连(收藏⭐️+关注👨‍🎓+留言📃)就是对bug菌我创作道路上最好的鼓励与支持😘。时光不弃🏃🏻‍♀️，创作不停💕，加油☘️ 

二、正文🔥

        时光荏苒，本模块开发任务也即将接近尾声。带着大家做了将近快20期的模块全业务开发，不知道你们收获大不大，反正对于自己，我是察觉到了自己还有很多知识点掌握的不够熟练，需要好好恶补呀，路还很长，咱们一起努力。

        对于这期，我要带着大家手把手教学，如何实现excel模板文件如何从服务器中下载到本地？就对于这么个业务场景，想必大家并不陌生，那么来吧，八仙过海各显神通。看看大家都对此有何不同的实现方法。

        那么，请大家都放马过来吧。

三、如何代码实现excel模板下载🔥

1️⃣定义Controller请求

        既然确定了业务场景为下载excel模板，也就是从服务器下载资源，那好吧，还是老样子，先确定请求格式。比如请求入参，返回参类型，请求路径等。

具体请求定义如下：

    /**
     * 问题反馈excel模板下载
     */
    @GetMapping("/download-model")
    @ApiOperation(value = "问题反馈excel模板下载", notes = "问题反馈excel模板下载")
    public void download() 
        userQuestionsService.download();
    

2️⃣定义接口方法downLoad()

        由于没有返回值，所以直接void即可。

    /**
     * excel模板下载
     */
    void download();

3️⃣实现downLoad()方法

        我是将该template路径配置于yaml配置文件中了，也方便日后测试环境、正式环境修改其保存路径即可。

    //获取template绝对路径
    @Value("$review.file.template")
    private String templatePath;


    /**
     * excel模板下载
     */
    @Override
    public void download() 

        //绝对目录地址
        String target = templatePath + "问题反馈导入模板.xlsx";
        uploader.downloadExcel(target);
    

由于我是直接放在了当前本地项目的template文件夹下，你们也可以随意指定路径。我为了给大家演示，我就指定了本地excel的存放路径了。

给大家看一眼我演示项目excel模板存放位置：仅供参考。

具体excel下载核心代码实现如下：

    /**
     * excel下载
     */
    public void downloadExcel(String targetPath) 
        FileInputStream inputStream = null;
        HttpServletResponse response = SpringServletContextUtils.getResponse();
        try 
            //设置文件头,最后一个参数是设置下载文件名
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(FilenameUtils.getName(targetPath), StandardCharsets.UTF_8.name()));
            File file = new File(targetPath);
            inputStream = new FileInputStream(file);
            OutputStream outputStream = response.getOutputStream();
            IOUtils.copyLarge(inputStream, outputStream);

            outputStream.flush();
         catch (IOException e) 
            log.error(e.getMessage(), e);
         finally 
            //关流
            IOUtils.closeQuietly(inputStream);
        
    

        而且我注意到如果用浏览器请求，肯定是无法设置请求头的，所以我将该接口加到了我的common模块中，该模块有做白名单免token鉴权处理，在其模块下的所有接口都不会被token登录鉴权器所拦截，所以对于我接口模板导出测试就非常方便了。因为我注意到如果通过postman测试导出，下载到本地会是一个.zip的文件，所以暂时放弃了用postman做测试工具。

如下我是直接选择用浏览器进行接口请求测试。直接访问浏览器输入请求地址即可。

        接着我们来debug一下，看看我们所传入的target目标路径是否正确且存在？

如下截图我确定是真实存在且确定是excel模板存放位置。你们也要检查一下，路径有问题也肯定不会实现文件下载成功的。

        去掉断点，直接运行结束，可以看下，浏览器直接弹出下载，我检查了下，虽文件内容格式等都是对的，但是其文件名乱码，这肯定不行。到底是啥原因导致？那又该如何解决呢？

        分析问题得出，对于中文读取的时候不给编码，它可能就用别的编码（不一定适合中文），就会导致中文乱码。所以想读取中文，你就得写明编码格式。

        所以给出的解决方案就是在对设置写入excel文件名时，明确编码格式。如何指定呢？这就用到了这个函数：URLEncoder.encode(String s, String enc)，该方法能将使用指定的编码机制将字符串转换为 application/x-www-form-urlencoded 格式，其格式也是浏览器默认的编码格式。那在上述代码中，你只需要这么改就行。

具体修改代码如下：

//            response.setHeader("Content-Disposition", "attachment;fileName=" + FilenameUtils.getName(targetPath));
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(FilenameUtils.getName(targetPath), StandardCharsets.UTF_8.name()));
  

4️⃣接口测试

        指定编码后我们重启项目，我们再来试一下。经测试，导出的文件名是中文展示了。我们再来检查一下导出的excel文件内容是否也存在乱码问题？经检查一切正常。

        说明上述代码已ok！可供业务使用。也供小伙伴们一键copy。

附上，postman测试导出功能，却文件名依旧乱码！

大家请看： 

        我是选择该【Send and Download】选项，一般是用于对接口有文件下载导出功能所用。

        我选择保存到本地桌面后，打开文件，内容格式都没问题，但是就是文件名乱码了。 

         至于这个问题，我暂时没有想到好的解决方案，这儿先放着，等我想到了解决方案再来修复这一块的bug。你们就暂时按浏览器的方式进行文件下载测试导出就好了。

5️⃣总结

        对于越简单的逻辑接口而言，我们都要百分百用心写。

 ... ...

        好啦，以上就是这期的所有内容啦，你们学废了么？如果对你有所帮助，还请不要忘记给bug菌[三连支持]哟。如果想获得更多的学习资源或者想和更多的技术爱好者一起交流，可以关注我的公众号『猿圈奇妙屋』，后台回复关键词领取学习资料、大厂面经、面试模板等海量资源，就等你来拿。

四、往期热文推荐🔥

        对于问题反馈模块实战开发，我完整的梳理了每一期的教学及链接地址，仅供参考：希望能对你们有所帮助。

• 在线问题反馈模块实战(一):梳理业务需求并创建数据库表
• 在线问题反馈模块实战(二):封装代码自动生成类文件器
• 在线问题反馈模块实战(三):自动生成所有Controller、Service、Mapper等文件
• 在线问题反馈模块实战(四):封装通用字段类
• 在线问题反馈模块实战(五):实现对通用字段内容自动填充功能
• 在线问题反馈模块实战(六):接口文档定义
• 在线问题反馈模块实战(七):安装部署swagger2
• ​在线问题反馈模块实战(八)​:实现图片上传功能(上)
• ​在线问题反馈模块实战(九)​:实现图片上传功能(下)
• ​在线问题反馈模块实战(十)​:实现图片预览功能
• ​在线问题反馈模块实战(十一)​:实现图片下载功能
• ​在线问题反馈模块实战(十二)​:实现图片删除功能
• ​在线问题反馈模块实战(十三)​:实现多参数分页查询列表
• 在线问题反馈模块实战(十四):实现在线答疑功能
• 在线问题反馈模块实战(十五)​:实现在线更新反馈状态功能
• 在线问题反馈模块实战(十六)​:实现查详情功能
• 在线问题反馈模块实战(十七):实现excel模板在线下载功能
• 在线问题反馈模块实战(十八):实现excel台账文件记录批量导入功能
• 在线问题反馈模块实战(十九):实现数据批量导出到excel文件中功能
• 在线问题反馈模块实战(二十):完结篇

        如上是整整二十期内容，每一期都是干货，对于一个模块的开发，如何一点一滴打造并测试部署上线，我再说一遍，这不是演习，是实战！是实战！是实战！

        若你们觉得只是需要了解其中某个知识点或者业务的话，也不反对，你就选择其中的几期进行学习就好，反正都已经完结啦；我只希望你们能有所收获，有所成长，也就不枉我苦心每天下班后给大家总结更新。

五、文末🔥

        如果你还想要学习更多，小伙伴们大可关注bug菌专门为你们创建的专栏《springboot零基础入门教学》，都是我一手打下的江山，持续更新中，希望能帮助到更多小伙伴们。

​

【开发云】年年都是折扣价，不用四处薅羊毛

       我是bug菌，一名想走👣出大山改变命运的程序猿。接下来的路还很长，都等待着我们去突破、去挑战。来吧，小伙伴们，我们一起加油！未来皆可期，fighting！

        最后送大家两句我很喜欢的话，与诸君共勉！

---

☘️做你想做的人，没有时间限制，只要愿意，什么时候都可以开始。

🍀你能从现在开始改变，也可以一成不变；这件事，没有规矩可言，你可以活出最精彩的自己。

---

💌如果文章对您有所帮助，就请留下您的赞吧！(#^.^#)；

💝如果喜欢bug菌分享的文章，就请给bug菌点个关注吧！(๑′ᴗ‵๑)づ╭❤～；

💗如果对文章有任何疑问，还请文末留言或者加群吧【QQ交流群:708072830】；

💞鉴于个人经验有限，所有观点及技术研点，如有异议，请直接回复参与讨论(请勿发表攻击言论，谢谢）；

💕版权声明：原创不易，转载请附上原文出处链接和本文声明，版权所有，盗版必究！！！谢谢。