一劳永逸！SpringBoot下载文件中文乱码等问题解决指南

后端

2023-09-07 01:01:53

解决SpringBoot下载中文文件乱码的终极指南

简介

下载文件时中文文件名出现乱码是开发人员常遇到的难题。在SpringBoot中，这个问题尤为突出。本文将深入探讨此问题，并提供针对Spring Boot和Swagger的解决方案，帮助你解决中文文件名乱码问题。

问题一：SpringBoot下载中文文件乱码

在SpringBoot中，下载中文文件时，文件名会出现乱码。这是因为HTTP协议默认使用ASCII编码，而中文属于Unicode编码。当使用ASCII编码传输中文文件名时，会造成乱码现象。

解决方案：使用URLEncoder.encode编码文件名

为了解决这个问题，我们需要将中文文件名进行编码，使其能够在HTTP协议中正确传输。我们可以使用URLEncoder.encode函数对文件名进行编码，将中文转换成十六进制编码。

String encodedFileName = URLEncoder.encode(fileName, "UTF-8");

在编码文件名后，将其添加到HTTP响应头中，指定Content-Disposition头信息，并设置文件名参数。

HttpHeaders headers = new HttpHeaders();
headers.add("Content-Disposition", "attachment; filename=\"" + encodedFileName + "\"");

通过这种方式，中文文件名可以正确传输，避免出现乱码现象。

问题二：Swagger测试下载接口出现文件名乱码

在Swagger中测试下载接口时，你可能会发现点击下载的文件文件名也是乱码。这是因为Swagger默认使用文本/html媒体类型，而浏览器无法正确处理二进制文件。

解决方案：在@RequestMapping注解中指定produces属性

为了解决这个问题，我们需要在@RequestMapping注解中添加produces属性，并将其值设置为application/octet-stream。这样可以告诉Swagger，这个接口的响应媒体类型是二进制流，Swagger会自动将文件名进行编码，以防止出现乱码。

@RequestMapping(value = "/file/download", produces = "application/octet-stream")
public ResponseEntity<byte[]> downloadFile() {
    // ...
}

代码示例

以下是一个完整的SpringBoot下载中文文件示例：

@RestController
@RequestMapping("/file")
public class FileController {

    @GetMapping("/download")
    public ResponseEntity<byte[]> downloadFile() {
        // 从数据库或文件系统中获取文件字节数组
        byte[] bytes = ...;

        // 对中文文件名进行编码
        String encodedFileName = URLEncoder.encode(fileName, "UTF-8");

        // 设置HTTP响应头
        HttpHeaders headers = new HttpHeaders();
        headers.add("Content-Disposition", "attachment; filename=\"" + encodedFileName + "\"");
        headers.add("Content-Type", "application/octet-stream");

        // 将文件字节数组和HTTP头信息封装成ResponseEntity对象
        ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes, headers, HttpStatus.OK);

        // 返回ResponseEntity对象
        return responseEntity;
    }
}