(11)在SpringMVC中文件上传解析器的配置,使用MultipartFile实现文件的上传,ResponseEntity对象实现文件下载

HttpMessageConverter

HttpMessageConverter是报文信息转换器,可以将请求报文转换为Java对象(RequestEntity), 或将Java对象(ResponseEntity)转换为响应报文

RequestEntity类型

RequestEntity类型的对象封装了请求报文中的所有数据,通过它我们可以获取请求头信息和请求体信息等其他信息

• 如果控制器方法形参的类型是RequestEntity类型,那么前端控制器会自动给该类型的形参赋值

方法名	功能
public HttpHeaders getHeaders()	获取所有的请求头信息,也可以通过HttpHeaders对象获取具体的一个请求头信息
public String getBody()	获取请求体信息

<form th:action="@{/testRequestEntity}" method="post">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    <input type="submit" value="测试RequestEntity">
</form>

@RequestMapping("/testRequestEntity")
public String testRequestEntity(RequestEntity<String> requestEntity){// 以字符串的方式获取请求报文
    //requestHeader:[host:"localhost:8080", connection:"keep-alive", content-length:"27", cache-control:"max-age=0"....
    System.out.println("requestHeader:"+requestEntity.getHeaders());
    //requestBody:username=admin&password=123
    System.out.println("requestBody:"+requestEntity.getBody());
    return "success";
}

ResponseEntity

ResponseEntity类型的对象封装了响应报文中的所有数据,主要用于控制器方法的返回值类型

<a th:href="@{/testDown}">下载1.jpg</a><br>

@RequestMapping("/testDown")
public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException {
    // 创建HttpHeaders对象设置响应头信息
    MultiValueMap<String, String> headers = new HttpHeaders();
    // 设置要下载方式以及默认下载文件的名字,attachment表示以附件的下载方式
    headers.add("Content-Disposition", "attachment;filename=1.jpg");
    // 设置响应状态码,HttpStatus.OK就是200
    HttpStatus statusCode = HttpStatus.OK;
    // 创建ResponseEntity对象,指定响应体,响应头,响应状态码
    ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes, headers, statusCode);
}

文件的上传和下载

文件下载

ResponseEntity类型的对象封装了响应报文中的所有数据,主要用于控制器方法的返回值类型

<a th:href="@{/testDown}">下载1.jpg</a><br>

@RequestMapping("/testDown")
public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException {
    // 获取ServletContext对象
    ServletContext servletContext = session.getServletContext();
    // 获取服务器中文件的真实路径,""表示获取当前工程的war包在服务器中的路径
    //String realPath = servletContext.getRealPath("/static/img/1.jpg");
    // File.separator()方法可以获取当前系统适应的文件分隔符
    String realPath = servletContext.getRealPath("static");// 直接在当前工程的war包在服务器中的路径后面拼接地址字符串
    realPath = realPath + File.separator() + "img" + File.separator() + "1.jpg";
    // 创建输入流
    InputStream is = new FileInputStream(realPath);
    // 创建字节数组,available方法可以返回流当中剩余的没有读到的字节数量,可以实现一次读取但不太适合读取太大的文件
    byte[] bytes = new byte[is.available()];
    // 将流(文件对应的字节)全部读到字节数组中,这样最终的字节数组就是我们的响应体
    is.read(bytes);
    // 创建HttpHeaders对象设置响应头信息
    MultiValueMap<String, String> headers = new HttpHeaders();
    // 设置要下载方式以及默认下载文件的名字,attachment表示以附件的下载方式
    headers.add("Content-Disposition", "attachment;filename=1.jpg");
    // 设置响应状态码,HttpStatus.OK就是200
    HttpStatus statusCode = HttpStatus.OK;
    // 创建ResponseEntity对象,指定响应体,响应头,响应状态码
    ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes, headers, statusCode);
    // 关闭输入流
    is.close();
    return responseEntity;
}

文件上传

前端上传文件时需要满足一定的条件,才能将文件上传到服务器

• 第一: 要求form表单的请求方式必须为POST
• 第二: 要求enctype属性的值为multipart/form-data表示以二进制形式传输数据,默认是application/x-www-form-urlencoded表示以键值对的形式传输
• 第三步: 上传文件的表单控件必须指定name属性,用来表示当前上传的文件类似于请求参数的name,这样后端就可以根据name获取value(文件对应的二进制数据)

<form th:action="@{/testUp}" method="post" enctype="multipart/form-data">
    <!--上传文件的控件必须指定name属性,用来标识当前上传的文件-->
    头像：<input type="file" name="photo"><br>
    <input type="submit" value="上传">
</form>

如果想直接在控制器方法中声明MultipartFile类型的形参获取SpringMVC封装的MultipartFile对象(包含上传文件的所有信息)还需要一些配置

第一步: 添加文件上传的依赖commons-fileupload

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

第二步: 在SpringMVC的配置文件中配置文件解析器可以将上传的文件转换为MultipartFile对象,并且也可以设置文件上传时的编码和体积等

<!--bean必须设置id,因为SpringMVC是通过id获取bean对象为属性注入值-->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"></bean>

第三步: 编写处理文件上传请求的控制器方法,在控制器方法的形参中声明MultipartFile类型的形参,形参名与上传文件的name属性值相同

@RequestMapping("/testUp")
public String testUp(MultipartFile photo, HttpSession session) throws IOException {
    // 获取上传的文件的文件名,主要是用来确定文件的后缀
    String fileName = photo.getOriginalFilename();
    // 处理文件重名问题,从最后一个"."开始截取直到最后就是上传文件的后缀名,
    String hzName = fileName.substring(fileName.lastIndexOf("."));
    // 使用java.util包下的UUID生成随机值的工具类 
    fileName = (UUID.randomUUID().toString()).replaceAll("-","") + hzName;
    // 设置文件上传的位置比如服务器中的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;
    // 实现上传功能(本质是文件的复制,先读后写),将MultipartFile中封装的文件数据转移到最终的文件位置
    photo.transferTo(new File(finalPath));
    return "success";
}