Springboot文件下载

     Springboot对资源的描述提供了相应的接口,其主要实现类有ClassPathResourceFileSystemResourceUrlResourceByteArrayResource

ServletContextResourceInputStreamResource

  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。文件头中设置缓存,以及文件的名字。文件的名字写入了,都可以避免出现文件随机产生名字,而不能识别的问题。

@RequestMapping(value = "/media", method = RequestMethod.GET)
    public ResponseEntity<InputStreamResource> downloadFile( Long id)
            throws IOException {
        String filePath = "E:/" + id + ".rmvb";
        FileSystemResource file = new FileSystemResource(filePath);
        HttpHeaders headers = new HttpHeaders();
        headers.add("Cache-Control", "no-cache, no-store, must-revalidate");
        headers.add("Content-Disposition", String.format("attachment; filename=\"%s\"", file.getFilename()));
        headers.add("Pragma", "no-cache");
        headers.add("Expires", "0");

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

     第二种方式采用了Java中的File文件资源,然后通过写response的输出流,放回文件。

@RequestMapping(value="/media/", method=RequestMethod.GET)
    public void getDownload(Long id, HttpServletRequest request, HttpServletResponse response) {

        // Get your file stream from wherever.
        String fullPath = "E:/" + id +".rmvb";
        File downloadFile = new File(fullPath);

        ServletContext context = request.getServletContext();

        // get MIME type of the file
        String mimeType = context.getMimeType(fullPath);
        if (mimeType == null) {
            // set to binary type if MIME mapping not found
            mimeType = "application/octet-stream";
            System.out.println("context getMimeType is null");
        }
        System.out.println("MIME type: " + mimeType);

        // set content attributes for the response
        response.setContentType(mimeType);
        response.setContentLength((int) downloadFile.length());

        // set headers for the response
        String headerKey = "Content-Disposition";
        String headerValue = String.format("attachment; filename=\"%s\"",
                downloadFile.getName());
        response.setHeader(headerKey, headerValue);

        // Copy the stream to the response's output stream.
        try {
            InputStream myStream = new FileInputStream(fullPath);
            IOUtils.copy(myStream, response.getOutputStream());
            response.flushBuffer();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

SpringBoot是一款流行的框架,用于开发Web应用程序。在使用SpringBoot构建Web应用程序时,可能需要实现文件下载的功能。文件下载是指在Web应用程序中提供用户下载文件的功能。这可以是图片、PDF、音频或文档等格式的文件。通常情况下,文件的下载需要从服务器端向客户端传输文件。SpringBoot为此提供了很多支持。 SpringBoot提供了一种基于Restful的方式进行文件下载。在SpringBoot中,可以使用ResponseEntity<byte[]>类来表示数据,这是一个特殊的ResponseEntity响应类型,它允许向客户端提供二进制数据。要下载文件,需要使用ResponseEntity<byte[]>将文件的字节流封装到响应中。该字节流可以来自于你的本地文件系统、数据库或其他数据源。 为了让用户下载文件,需要根据请求头中的Accept参数来返回正确的文件类型。用Content-Type头来通知浏览器返回的数据类型。可以使用以下代码实现该功能: ``` @GetMapping("/download") public ResponseEntity<byte[]> downloadFile() { // 从文件路径中获取输入流 InputStream input = new FileInputStream(new File("path/to/file")); byte[] bytes = IOUtils.toByteArray(input); HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_PDF); // 设置Content-Type headers.setContentDispositionFormData("attachment", "file.pdf"); // 文件名 ResponseEntity<byte[]> response = new ResponseEntity<>(bytes, headers, HttpStatus.OK); return response; } ``` 在这个例子中,使用了Java IO流。首先将从文件路径中获取的输入流读入到字节数组中,然后设置响应的头信息,包括Content-Type和Content-Disposition。最后将字节数组和响应头一起封装到ResponseEntity<byte[]>响应实体中,并返回。 在SpringBoot中,可以轻松实现文件下载的功能。以上代码仅仅是其中之一的实现方式。具体实现方式会依据实际情况有所不同。使用SpringBoot提供的ResponseEntity类提供二进制数据,可以以Restful的方式来下载文件。这样的方式不仅简单,方便,而且支持多种文件类型。
评论 9
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值