Spring——HttpMessageConverter

HttpMessageConverter简介

Http:http协议；Message：消息；Converter:转换器，合起来就是报文消息转换器，它可以将请求报文转化为java对象，也可以将java对象转换为响应报文信息。HttpMessageConverter有两个类型：RequestEntity，ResponseEntity，分别代表请求实体，响应实体；还要两个注解@RequestBody，@ResponseBody，这两个注解就是用在请求参数里面，标注成对应类型的请求参数。

1、@RequestBody

这个注解用来获取请求体，注解在请求参数里面，在注解后面加上形式参数。这个注解就将请求体赋值到请求参数里面。
控制器方法：

    @RequestMapping(value = "/requestBody")
    public String requestBody(@RequestBody String requestBody){
        System.out.println(requestBody);
        return "success";
    }

2、RequestEntity

RequestEntity是能所有请求报文做一个封装，可以用这个属性下面对应的方法获取请求头、请求体、请求行的内容，又可以根据获取的请求头通过对应的方法获取里面的属性。

    @RequestMapping(value = "/requestEntity")
    public String requestEntity(RequestEntity<String> requestEntity){
        System.out.println("获取全部请求报文："+requestEntity);
        System.out.println("获取请求体："+requestEntity.getBody());
        System.out.println("获取请求头里面的HOST属性："+requestEntity.getHeaders().get("host"));
        return "success";
    }

运行的结果：

3、@ResponseBody

@ResponseBody注解用来将java实体封装到响应体里面，然后响应到前端。注解方式和@RequestBody不同，@ResponseBody注解是注解在方法上面，不是注解到参数列表里面，还有就是@ResponseBody返回值是响应到页面上面的内容，不是返回视图名称。@ResponseBody可以封装普通的javaBean，也可以封装json对象。

（1）响应普通类型

    @RequestMapping("/responseBody")
    @ResponseBody
    public String  responseBody(){
        return "hello responseBody!!!";
    }

（2）响应json对象

普通类型的只能是文本内容，也就是只能响应String类型。响应json对象需要实现以下步骤：

1. 导入json依赖

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.13.1</version>
        </dependency>

2. 在spring的核心配置文件里面开启MVC注解驱动，开启之后才能将java对象转换为json格式的字符串。

<!--    开启mvc注解驱动-->
    <mvc:annotation-driven></mvc:annotation-driven>

3. 在方法上面注解@ResponseBody
4. 方法返回值修改为对应的java实体类型

    @RequestMapping("/responseBodyJson")
    @ResponseBody
    public Fruit  responseBodyJson(){
        Fruit fruit = new Fruit("001", 100, "西瓜", 3.20F, 100);
        return fruit;
    }

运行结果：

4、ResponseEntity

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

（1）文件的下载

使用ResponseEntity属性实现文件的下载
下面文件的下载代码直接复制来用，下载都模板差不多。然后一一介绍一下每个方法的作用吧。

（1）返回类型ResponseEntity<byte[]>：作用于控制器方法的返回值，表示将要响应到浏览器的响应报文封装起来。
（2）参数列表：HttpSession session，用于获取ServletContext，获取ServletContext对象的方法有很多，request，response等都就可以获取，也就是参数列表可以换成其它可以获取ServletContext的对象。
（3）session.getServletContext()：获取ServletContext对象。
（4）getRealPath()：获取将要下载文件在服务器里面的真实路径。
（5）fileInputStream.available()：用来获取输入流的字节长度，就不再用循环一个字节一个字节的读。
（6）MultiValueMap<String,String> headers = new HttpHeaders()：创建一个响应头的对象，ResponseEntity里面需要响应头里面的某些属性，然后前面的MultiValueMap实质上就是Map集合，它继承了Map，由于请求头都是键值对，所以泛型设置成<String,String>
（7）headers.add(“Content-Disposition”,“attachment;filename=springmvc.jpg”)：往响应头里面添加信息，它也是一个键值对。attachment表示用附件的方式下载，filename表示下载后的默认文件名。这是下载必须要设置的，里面除了下载文件名能修改，其它信息一律不能动。
（8）HttpStatus.OK：设置响应状态码，只有当响应码为200才能下载，OK对应的就是200
（9）ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes,headers,httpStatus)：将响应信息封装ResponseEntity里面，通过响应报文响应到浏览器。

    @RequestMapping("/fileDown")
    public ResponseEntity<byte[]> fileDown(HttpSession session) throws Exception {
//        1.获取ServletContext对象
        ServletContext context = session.getServletContext();
//        2.获取服务器中文件的真实路径
        String realPath = context.getRealPath("/static/img/springmvc.jpg");
//        3.创建输入流
        InputStream fileInputStream = new FileInputStream(realPath);
//        4.创建字节数组
        byte[] bytes = new byte[fileInputStream.available()];
//        5.将流读到字节数组中
        fileInputStream.read(bytes);
//        6.创建HttpHeaders对象设置响应头信息
        MultiValueMap<String,String> headers = new HttpHeaders();
//        7.设置下载方式以及下载文件名字
        headers.add("Content-Disposition","attachment;filename=springmvc.jpg");
//        8.设置响应状态码
        HttpStatus httpStatus = HttpStatus.OK;
//        9.创建ResponseEntity对象
        ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes,headers,httpStatus);
//        10.关闭输入流
        fileInputStream.close();
//        11.返回ResponseEntity对象
        return responseEntity;
    }

下载效果：

（3）文件上传

1. 文件上传表单
   表单提交方式必须是post，然后enctype属性必须改成multipart/form-data，这个属性代表以二进制的方式上传。

<form th:action="@{/fileUp}" method="post" enctype="multipart/form-data">
    选择图片：<input type="file" name="photo">
    <input type="submit" value="上传图片">
</form>

2. 导入依赖

<!--        文件上传依赖-->
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.4</version>
        </dependency>

3. 配置文件上传解析器
   文件上传解析器 用来将上传的文件封装成MultipartFile

<!--    配置文件上传解析器，将上传的文件封装成MultipartFile-->
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"></bean>

4. 编写控制器方法
   控制器里面的一些方法：
   （1）参数列表的MultipartFile属性：将表单提交的文件封装成为流的形式
   （2）参数列表session属性：用来获取ServletContext对象，进而获取文件部署在Tomcat服务器的对应文件夹的路径。
   （3）filename.substring(filename.lastIndexOf(“.”))：获取上传文件的后缀名，lastIndexOf（“.”）表示从最后一个"."开始算起。
   （4）UUID.randomUUID().toString()：用UUID生成随机的文件名，处理文件名相同的问题。
   （5）context.getRealPath(“img”)：获取Tomcat里面部署的名叫“img”文件夹的真实路径。
   （6）file.exists()：判断该文件是否存在。
   （7）file.mkdir()：新建一个文件夹。
   （8）realPath + File.separator + filename：文件夹的真实路径+文件分隔符+文件名。
   （9）photo.transferTo(new File(finalName))：把文件路径所指向的文件放在对应的文件夹下面。

    @RequestMapping("/fileUp")
    public String fileUp(MultipartFile photo,HttpSession session) throws IOException {
//        1.获取上传文件的文件名
        String filename = photo.getOriginalFilename();
//        2.获取上传文件的后缀名
        String suffixName = filename.substring(filename.lastIndexOf("."));
//        3.将UUID作为文件名
        String uuid = UUID.randomUUID().toString();
//        4.将UUID和文件后缀连接起来成为最后的文件名
        filename = uuid + suffixName;
//        5.通过servletContext回去服务器里面存放文件的文件夹路径
        ServletContext context = session.getServletContext();
        String realPath = context.getRealPath("img");
        File file = new File(realPath);
//        6.判断文件夹是否存在
        if (!file.exists()){
//            不存在则创建目录
            file.mkdir();
        }
        String finalName = realPath + File.separator + filename;
        photo.transferTo(new File(finalName));
        return "success";
    }

上传结果：