实习日记：后端应该如何返回文件流

        今天写一个接口的时候出了问题，还是个比较常见的需求，我觉得值得记录一下。

1、背景

        有这样一个需求：根据某些条件从数据库中查询一些记录，然后根据这些记录生成Excel表格并传给前端进行下载。

2、原始思路

        查询数据库表记录放入List集合中然后生成Excel表格，这里生成Excel表格的方式有很多，我使用的是Apache的Workbook类，具体的使用方法不是重点，这里不再赘述。在Service中最终返回的是该文件的字节数组byte[]。

        然后在controller层中，通过统一返回参数ResponseResult来返回结果，这个字节数组放在data字段中，具体代码如下：

    @ApiOperation("推送结果下载")
    @PostMapping(value = "/notifyResultDownload")
    public ResponseResult<byte[]> notifyResultDownload(@RequestBody NotifyResultDownloadRequest request) {
        // 前置的一些其他操作....

        // goodsService.notifyResultDownload(request)最终返回的是byte[]
        return ResponseResult.success(goodsService.notifyResultDownload(request));
    }

        此时前端下载的文件打开后提示：

 3、解决方案

        咨询了公司里的一些老前辈，个人稍加思索后，最终解决了这个问题。先贴出修改完成后的controller层代码：

    @ApiOperation("推送结果下载")
    @PostMapping(value = "/notifyResultDownload")
    public void notifyResultDownload(@RequestBody NotifyResultDownloadRequest request, HttpServletResponse response) {
        // 前置的一些其他操作....
       
        // 设置返回格式为xlsx文件
        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;charset=utf-8");
        // 设置文件名
        String pattern = "yyyyMMdd";
        SimpleDateFormat sdf = new SimpleDateFormat(pattern);
        String start = sdf.format(request.getStartTime());
        String end = sdf.format(request.getEndTime());
        String fileName = "推送结果" + start + "-" + end;  // 文件名
        try {
            response.setHeader("Content-Disposition", String.format("attachment;filename=%s.xlsx", URLEncoder.encode(fileName, "utf-8")));
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }
        // 获取excel文件的字节数组
        byte[] bytes = goodsService.notifyResultDownload(request);
        // 将字节数组写入响应输出流
        try (OutputStream outputStream = response.getOutputStream()) {
            outputStream.write(bytes);
            outputStream.flush();
        } catch (IOException e) {
            throw new RuntimeException("将excel文件写入响应输出流失败：", e);
        }
    }

        这里的关键有以下三点：

1. 不通过ResponseResult进行返回，而是用HttpServletResponse的getOutputStream获取响应输出流，通过响应输出流直接输出文件的字节流byte[]。
2. 通过response.setContentType来指定返回格式为xlsx文件（注意，如果是xls文件，那么写法不一样）。
3. 通过response.setHeader("Content-Disposition",...)来指定文件的名称，这里需要前端增加一些代码来配合。

        至于为什么一开始的方式不行，我认为可能和Spring框架本身有关，比如Spring框架是否对返回值做了一些格式化处理导致原始字节流被改变，也有可能是前后端之间的处理上有一些问题。