SpringMVC学习之路——ResponseEntity实现文件下载和上传

这一章我们将主要介绍springMVC如何实现文件下载和文件上传

我们主要使用ResponseEntity实现文件下载

首先我们来介绍一下什么是ResponseEntity

ResponseEntity

ResponseEntity对象是Spring对请求响应的封装。它继承了HttpEntity对象，包含了响应头、响应体、响应码。通过ResponseEntity对象，我们可以自定义响应头、响应体以及响应码。

用于控制器方法的返回值类型，该控制器方法的返回值就是响应到浏览器的响应报文。

结合文件下载的具体案例，我们可以对该对ResponseEntity有一个更深的理解。

实现文件下载

使用构造方法创建ResponseEntity，我们需要传入响应体、响应头以及响应码

 所以文件下载就可以大致分成三个步骤：

1、创建byte[]类型的响应体

2、创建MultiValueMap<String,String>类型的响应头

3、创建HttpStatus类型的响应码

@RequestMapping("/testDown")
public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException {
    //获取ServletContext对象
    ServletContext servletContext = session.getServletContext();
    //获取服务器中文件的真实路径
    String realPath = servletContext.getRealPath("/static/img/1.jpg");
    //创建输入流
    InputStream is = new FileInputStream(realPath);
    //创建字节数组
    byte[] bytes = new byte[is.available()];
    //将流读到字节数组中
    is.read(bytes);
    //创建HttpHeaders对象设置响应头信息
    MultiValueMap<String, String> headers = new HttpHeaders();
    //设置要下载方式以及下载文件的名字
    headers.add("Content-Disposition", "attachment;filename=1.jpg");
    //设置响应状态码
    HttpStatus statusCode = HttpStatus.OK;
    //创建ResponseEntity对象
    ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes, headers, statusCode);
    //关闭输入流
    is.close();
    return responseEntity;
}

注意：

is.available()用于获取输入流所对应文件的字节数

响应头Content-Disposition中的attachment表示以附件的形式进行下载

实现文件上传

SpringMVC中将上传的文件封装到MultipartFile对象中，通过此对象可以获取文件相关信息

将MultipartFile设在控制器方法形参位置，在方法内直接调用

上传步骤：

a>添加依赖：

<!-- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <version>1.3.1</version>
</dependency>

b>在SpringMVC的配置文件中添加配置：

<!--必须通过文件解析器的解析才能将文件转换为MultipartFile对象-->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"></bean>

c>控制器方法：

@RequestMapping("/testUp")
public String testUp(MultipartFile photo, HttpSession session) throws IOException {
    //获取上传的文件的文件名
    String fileName = photo.getOriginalFilename();
    //处理文件重名问题
    String suffixName = fileName.substring(fileName.lastIndexOf("."));
    fileName = UUID.randomUUID().toString() + suffName;
    //获取服务器中photo目录的路径（如果没有目录则创建）
    ServletContext servletContext = session.getServletContext();
    String photoPath = servletContext.getRealPath("photo");
    File file = new File(photoPath);
    if(!file.exists()){
        file.mkdir();
    }
    String finalPath = photoPath + File.separator + fileName;
    //实现上传功能
    photo.transferTo(new File(finalPath));
    return "success";
}

注意：

• 文件上传要求form表单的请求方式必须为post

• 并且表单要添加属性enctype="multipart/form-data"，表示以二进制的方式上传而不是name=value方式

• 控制器方法的形参名要与传递文件的参数名一致，否则出现空指针异常