SpringMVC实现文件下载2种实现方法

在Web应用程序中，文件下载是非常常见的需求。SpringMVC提供了很多方便的方式来实现文件下载。本文将详细讲解SpringMVC实现文件下载的2种实现方法。

方法1：使用ResponseEntity对象

在SpringMVC中，我们可以使用ResponseEntity对象来处理文件下载。ResponseEntity对象是SpringMVC提供的一个类，用于表示HTTP响应。下面是一个示例代码，演示如何实现文件下载：

@GetMapping("/download")
public ResponseEntity<byte[]> handleFileDownload() {
  try {
    byte[] bytes = // 从文件中读取字节数组
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
    headers.setContentDispositionFormData("attachment", "filename.txt");
    headers.setContentLength(bytes.length);
    return new ResponseEntity<>(bytes, headers, HttpStatus.OK);
  } catch (IOException e) {
    e.printStackTrace();
  }
  return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
}

在上面的代码中，我们使用@GetMapping注解来标记handleFileDownload方法为处理GET请求的方法。在try块中，我们使用字节数组来表示要下载的文件内容，并使用HttpHeaders对象来设置响应头信息。在HttpHeaders对象中，我们setContentType方法来设置响应内容的MIME类型，使用setContentDispositionFormData方法来设置响应头中的Content-Disposition字段，以便浏览器能够正确地处理文件下载。最后，我们使用ResponseEntity对象来封装响应内容，并返回给客户端。

方法2：使用OutputStream对象

在SpringMVC中，我们也可以使用OutputStream对象来处理文件下载。OutputStream对象是Java IO提供的一个类，用于表示输出流。下面是一个示例代码，演示如何实现文件下载：

@GetMapping("/download")
public void handleFileDownload(HttpServletResponse response) {
  try {
    byte[] bytes = // 从文件中读取字节数组
    response.setContentType(MediaType.APPLICATION_OCTET_STREAM_VALUE);
    response.setHeader("Content-Disposition", "attachment; filename=filename.txt");
    response.setContentLength(bytes.length);
    OutputStream outputStream = response.getOutputStream();
    outputStream.write(bytes);
    outputStream.flush();
    outputStream.close();
  } catch (IOException e) {
    e.printStackTrace();
  }
}

在上面的代码中，我们使用@GetMapping注解来标记handleFileDownload方法为处理GET请求的方法。在try块中，我们使用字节数组来表示要下载的文件内容，并使用HttpServletResponse对象来设置响应头信息。在HttpServletResponse对象中，我们setContentType方法来设置响应内容的MIME类型，使用setHeader方法来设置响应头中的Content-Disposition字段，以便浏览器能够正确地处理文件下载。最后，我们使用OutputStream对象来将文件内容写入响应输出流中，并关闭输出流。

示例说明

示例1：使用ResponseEntity对象实现文件下载

在SpringMVC的配置文件中添加以下代码：

<mvc:resources mapping="/files/**" location="file:/path/to/files/"/>

在上面的代码中，我们使用标签来配置静态资源的映射关系。我们将/files/**映射到本地文件系统中的/path/to/files/目录下。

在Controller中添加以下代码：

@GetMapping("/download")
public ResponseEntity<byte[]> handleFileDownload() {
  try {
    byte[] bytes = Files.readAllBytes(Paths.get("/path/to/files/filename.txt"));
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
    headers.setContentDispositionFormData("attachment", "filename.txt");
    headers.setContentLength(bytes.length);
    return new ResponseEntity<>(bytes, headers, HttpStatus.OK);
  } catch (IOException e) {
    e.printStackTrace();
  }
  return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
}

在上面的代码中，我们使用Files类来读取本地文件系统中的文件内容，并使用ResponseEntity对象来封装响应内容。

示例2：使用OutputStream对象实现文件下载

在SpringMVC的配置文件中添加以下代码：

<mvc:resources mapping="/files/**" location="file:/path/to/files/"/>

在上面的代码中，我们使用标签来配置静态资源的映射关系。我们将/files/**映射到本地文件系统中的/path/to/files/目录下。

在Controller中添加以下代码：

@GetMapping("/download")
public void handleFileDownload(HttpServletResponse response) {
  try {
    byte[] bytes = Files.readAllBytes(Paths.get("/path/to/files/filename.txt"));
    response.setContentType(MediaType.APPLICATION_OCTET_STREAM_VALUE);
    response.setHeader("Content-Disposition", "attachment; filename=filename.txt");
    response.setContentLength(bytes.length);
    OutputStream outputStream = response.getOutputStream();
    outputStream.write(bytes);
    outputStream.flush();
    outputStream.close();
  } catch (IOException e) {
    e.printStackTrace();
  }
}

在上面的代码中，我们使用Files类来读取本地文件系统中的文件内容，并使用OutputStream对象将文件内容写入响应输出流中。

结论

在本文中，我们详细讲解了SpringMVC实现文件下载的2种实现方法。无论是使用ResponseEntity对象还是使用OutputStream对象，SpringMVC都提供了很多方便的方式来处理文件下载需求。

阅读剩余 62%