使用HttpMessageConverter处理JSON

╰半橙微兮° 2022-07-15 10:27 194阅读 0赞

## HttpMessageConverter<T>工作原理： ##

HttpMessageConverter<T> 是 Spring3.0 新添加的一个接口，负责将请求信息转换为一个对象（类型为 T）并绑定到处理方法的入参中，或将对象（类型为T）输出为响应信息。对此SpringMVC提供了两种实现途径：

1.  使用@RequestBody/@ResponseBody注解对处理方法进行标注。
2.  使用HttpEntity<T>/ResponseEntity<T>作为处理方法的入参或返回值。
    
    　　当控制器处理方法使用到@RequestBody/@ResponseBody 或者 HttpEntity<T>/ResponseEntity<T>时，Spring首先根据请求头或响应头的Accept属性选择匹配的HttpMessageConverter，进而根据参数类型或泛型类型的过滤得到匹配的HttpMessageConverter，若找不到可用的HttpMessageConverter将会报错。  
    　　  
    　　下图展示了HttpMessageConverter<T>的工作原理：  
    ![image\_1b1e5tcdhui21hgpn6eqo3ba01t.png-204.3kB][image_1b1e5tcdhui21hgpn6eqo3ba01t.png-204.3kB]
    
    　　DispatcherServlet默认装配了RequestMappingHandlerAdapter，我们查看Spring源码发现RequestMappingHandlerAdapter默认装配了如下的HttpMessageConverter：  
    　　![image\_1b1eccehf393hvg135teo0105o3u.png-210.6kB][image_1b1eccehf393hvg135teo0105o3u.png-210.6kB]

## HttpMessageConverter<T>使用示例 ##

在开始介绍HttpMessageConverter<T>的用法之前，需要先导入jar包：  
　　  
![image\_1b1e4vo451r1j1pc1qmm1sc5127n9.png-3.9kB][image_1b1e4vo451r1j1pc1qmm1sc5127n9.png-3.9kB]

在导入以上jar包后，RequestMappingHandlerAdapter会自动额外装配一个HttpMessageConverter对象，用于在Java对象和JSON对象之间进行转换：  
　　![image\_1b1ecs9khgn721bln28qrao04b.png-248.1kB][image_1b1ecs9khgn721bln28qrao04b.png-248.1kB]  
　　  
　　下面的三个示例分别展示了@ResponseBody、@RequestBody和ResponseEntity<T>的使用方法，HttpEntity<T>用法类似。  
　　  
**示例一：**通过@RequestBody注解将目标方法返回的Java对象转为HttpOutputMessage，并在页面中通过AJAX获取：

jsp：

<%@ page language="java" contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    <html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>index jsp</title>
    <script type="text/javascript"
        src="${pageContext.request.contextPath }/scripts/jquery-1.9.1.min.js"></script>
    <script type="text/javascript">
        $(function() {
            $("#testJson").click(function() {
                var url = $(this).attr("href");
                var arg = {
                    "time" : new Date()
                };
                $.get(url, arg, function(data) {
                    for (var i = 0; i < data.length; i++)
                        alert(data[i].id + ":" + data[i].lastName); }); return false; }); }) </script> </head> <body> <a href="testJson" id="testJson">Test Json</a> </body> </html>

controller:

@ResponseBody
        @RequestMapping("/testJson")
        public Collection<Employee> testJson(){
            return employeeDao.getAll();
        }

运行后浏览器会依次弹出“data\[i\].id + “:” + data\[i\].lastName”的提示信息：  
![image\_1b1e5htql1qbvqkm45h1br01pi4m.png-8.8kB][image_1b1e5htql1qbvqkm45h1br01pi4m.png-8.8kB]  
![image\_1b1e5iuc215auou3m7164dubo13.png-9.8kB][image_1b1e5iuc215auou3m7164dubo13.png-9.8kB]  
![image\_1b1e5j6681i2i1jtk1t71fi010mv1g.png-10.2kB][image_1b1e5j6681i2i1jtk1t71fi010mv1g.png-10.2kB]

…  
　　　　　　　　　　  
**示例二：**通过@RequestBody注解实现实现文件上传的功能：

jsp：

<form action="testRequestBody" method="post" enctype="multipart/form-data">
        File：<input type="file" name="file" />
        Description：<input type="text" name="des" />
        <input type="submit" value="Submit" />
        </form>

controller:

@ResponseBody
        @RequestMapping("/testRequestBody")
        public String testRequestBody(@RequestBody String body){
            System.out.println(body);
    
            //return "helloworld!"+new Date()保证了方法执行完后不会匹配任何一个页面
            return "helloworld!"+new Date();
        }

运行程序，我们上传一个test.txt文件，其中存储了某一jsp页面的信息，并在Description中输入文本值“MY TEXT”：

![image\_1b1eatgr614ev90sl1a1bvqlo134.png-4.4kB][image_1b1eatgr614ev90sl1a1bvqlo134.png-4.4kB]

提交之后，HttpMessageConverter会把上传的文件和文本值转换为一个String类型的对象，并在控制台输出：

![image\_1b1ea9rkce0gv63gt42mbdum2a.png-51.8kB][image_1b1ea9rkce0gv63gt42mbdum2a.png-51.8kB]

而且浏览器上也显示了helloworld！+时间：

![image\_1b1eab44h162210eaalel771c802n.png-11.8kB][image_1b1eab44h162210eaalel771c802n.png-11.8kB]

注意，如果在spring的配置文件中注册了CommonsMultipartResolver类型的bean实例，如下：

那么@RequestBody就不能正常将上传的文件类型转换为String类型在控制台输出了，原因暂时我还不太清楚。

**示例三：通过@ResponseEntity<T>实现文件下载的功能：**

jsp：

<a href="testResponseEntity">Test ResponseEntity</a>

在根目录下的file目录下保存了示例二中的test.txt：

![image\_1b1ec0e011pq61o0v1nipd41j6f3h.png-3.2kB][image_1b1ec0e011pq61o0v1nipd41j6f3h.png-3.2kB]

controller:

@ResponseBody
        @RequestMapping("/testResponseEntity")
        public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException{
            byte[] body = null;
            ServletContext context = session.getServletContext();
            InputStream in = context.getResourceAsStream("/file/test.txt");
            body = new byte[in.available()];
            in.read(body);
    
            HttpHeaders headers = new HttpHeaders();
            headers.add("Content-Disposition", "attachment;filename=test.txt");
    
            HttpStatus statusCode = HttpStatus.OK;
    
            ResponseEntity<byte[]> entity = new ResponseEntity<byte[]>(body, headers, statusCode);
    
            return entity;
        }

运行程序，点击超链接Test ResponseEntity后发现可以正确下载test.txt文件。

[image_1b1e5tcdhui21hgpn6eqo3ba01t.png-204.3kB]: /images/20220715/91c4b0367dfb4c6687c28025069fb6ce.png
[image_1b1eccehf393hvg135teo0105o3u.png-210.6kB]: /images/20220715/a6ce12d92e53461d8989e60940c32ff3.png
[image_1b1e4vo451r1j1pc1qmm1sc5127n9.png-3.9kB]: /images/20220715/ec2051db77514022b39c2a5418fbf833.png
[image_1b1ecs9khgn721bln28qrao04b.png-248.1kB]: /images/20220715/8386f388d3864a5f8bef703141d2dde1.png
[image_1b1e5htql1qbvqkm45h1br01pi4m.png-8.8kB]: /images/20220715/9c7df1f8feff4054b622ca5e4afa3fbc.png
[image_1b1e5iuc215auou3m7164dubo13.png-9.8kB]: /images/20220715/0774729b51d2478f931e8b9ce9b3dc81.png
[image_1b1e5j6681i2i1jtk1t71fi010mv1g.png-10.2kB]: /images/20220715/2d7cd2d19424408da8d5aca66a6b4a31.png
[image_1b1eatgr614ev90sl1a1bvqlo134.png-4.4kB]: /images/20220715/a6c1bb326803481aa0110310b305b203.png
[image_1b1ea9rkce0gv63gt42mbdum2a.png-51.8kB]: /images/20220715/047b3e8df2d644329880b987fc3521f7.png
[image_1b1eab44h162210eaalel771c802n.png-11.8kB]: /images/20220715/1273f33dd8c5445d82ffdb833e8718cf.png
[image_1b1ec0e011pq61o0v1nipd41j6f3h.png-3.2kB]: /images/20220715/397c049717a84a3babb6d51016fd669f.png