springboot 文件下载 解决中文文件名故障问题

 

原文链接: springboot 文件下载 解决中文文件名乱码问题

上一篇: springboot 上传文件

下一篇: springboot thymeleaf 热部署

参考

https://blog.****.net/qq415200973/article/details/51149234# 

 

 Springboot对资源的描述提供了相应的接口，其主要实现类有ClassPathResource、FileSystemResource、UrlResource、ByteArrayResource、ServletContextResource和InputStreamResource。

1. ClassPathResource可用来获取类路径下的资源文件。假设我们有一个资源文件test.txt在类路径下，我们就可以通过给定对应资源文件在类路径下的路径path来获取它，new ClassPathResource(“test.txt”)。
2. FileSystemResource可用来获取文件系统里面的资源。我们可以通过对应资源文件的文件路径来构建一个FileSystemResource。FileSystemResource还可以往对应的资源文件里面写内容，当然前提是当前资源文件是可写的，这可以通过其isWritable()方法来判断。FileSystemResource对外开放了对应资源文件的输出流，可以通过getOutputStream()方法获取到。
3. UrlResource可用来代表URL对应的资源，它对URL做了一个简单的封装。通过给定一个URL地址，我们就能构建一个UrlResource。
4. ByteArrayResource是针对于字节数组封装的资源，它的构建需要一个字节数组。
5. ServletContextResource是针对于ServletContext封装的资源，用于访问ServletContext环境下的资源。ServletContextResource持有一个ServletContext的引用，其底层是通过ServletContext的getResource()方法和getResourceAsStream()方法来获取资源的。
6. InputStreamResource是针对于输入流封装的资源，它的构建需要一个输入流。

 

Resource接口中主要定义有以下方法：

 

1. exists()：用于判断对应的资源是否真的存在。
2. isReadable()：用于判断对应资源的内容是否可读。需要注意的是当其结果为true的时候，其内容未必真的可读，但如果返回false，则其内容必定不可读。
3. isOpen()：用于判断当前资源是否代表一个已打开的输入流，如果结果为true，则表示当前资源的输入流不可多次读取，而且在读取以后需要对它进行关闭，以防止内存泄露。该方法主要针对于InputStreamResource，实现类中只有它的返回结果为true，其他都为false。
4. getURL()：返回当前资源对应的URL。如果当前资源不能解析为一个URL则会抛出异常。如ByteArrayResource就不能解析为一个URL。
5. getFile()：返回当前资源对应的File。如果当前资源不能以绝对路径解析为一个File则会抛出异常。如ByteArrayResource就不能解析为一个File。
6. getInputStream()：获取当前资源代表的输入流。除了InputStreamResource以外，其它Resource实现类每次调用getInputStream()方法都将返回一个全新的InputStream。
7. 以及一些类似于Java中的File的接口，比如getName,getContenLength等等。

 

如果需要获取本地文件系统中的指定路径下的文件，有一下几种方式

 

1. 通过ResponseEntity<InputStreamResource>实现
2. 通过写HttpServletResponse的OutputStream实现

 

     第一种方式通过封装ResponseEntity，将文件流写入body中。这里注意一点，就是文件的格式需要根据具体文件的类型来设置，一般默认为application/octet-stream。文件头中设置缓存，以及文件的名字。文件的名字写入了，都可以避免出现文件随机产生名字，而不能识别的问题。

 

 

遇到中文文件名需要进行转码处理

        // 设置下载时的文件名，中文文件名需要进行转码，否则是乱码
        headers.add("Content-Disposition",
                "attachment; filename=" +
                        new String(file.getFilename().getBytes("UTF-8"), "iso-8859-1"));

 

java

    @RequestMapping(value = "/down", method = RequestMethod.GET)
    public ResponseEntity<FileSystemResource> downloadFile()
            throws IOException {
        String filePath = "d:/Spring实战（第4版）.pdf";
        FileSystemResource file = new FileSystemResource(filePath);
        HttpHeaders headers = new HttpHeaders();
        headers.add("Cache-Control", "no-cache, no-store, must-revalidate");

        // 设置下载时的文件名，中文文件名需要进行转码，否则是乱码
        headers.add("Content-Disposition",
                "attachment; filename=" +
                        new String(file.getFilename().getBytes("UTF-8"), "iso-8859-1"));
        headers.add("Pragma", "no-cache");
        headers.add("Expires", "0");

        return ResponseEntity
                .ok()
                .headers(headers)
                .contentLength(file.contentLength())
                .contentType(MediaType.parseMediaType("application/octet-stream"))
                .body(file);
    }