SpringBoot响应处理之以Json数据返回的实现方法

更新时间：2022年09月29日 16:55:30 作者：刘婉晴

这篇文章主要介绍了SpringBoot整合Web开发其中Json数据返回的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

一、示例代码

访问 localhost:8080/jsonTest —— 返回 json 格式的数据

@Controller
public class ResponseTestController {
    @ResponseBody // 标注 —— 自动返回json数据
    @GetMapping("/jsonTest")
    public Person testPerson(){
        Person person = new Person();
        person.setAge(20);
        person.setUserName("Liuwanqing");
        Pet pet = new Pet();
        pet.setName("huahua");
        pet.setAge("五个月");
        person.setPet(pet);
        return person;
    }
}

二、返回值解析原理

SpringBoot 支持的返回值类型是由返回值解析器决定的，SpringBoot 返回值类型如下：

ModelAndView

Model

View

…

SpringBoot共含15种返回值解析器决定了其支持15种返回值：

三、源代码分析（debug）

设置以下几处断点：

step into —— 返回值处理器逻辑

this.returnValueHandlers.handleReturnValue(returnValue, this.getReturnValueType(returnValue), mavContainer, webRequest);

1. 先找返回值处理器

HandlerMethodReturnValueHandler handler = this.selectHandler(returnValue, returnType);

2. 执行下列代码，找到符合要求的返回值处理器

在众多返回值处理器中找到符合要求的 —RequestResponseBodyMethodRrocessor

即 RequestResponseBodyMethodRrocessor 可处理标注了 @ResponseBody 注解的返回值

   private HandlerMethodReturnValueHandler selectHandler(@Nullable Object value, MethodParameter returnType) {
        boolean isAsyncValue = this.isAsyncReturnValue(value, returnType);
        Iterator var4 = this.returnValueHandlers.iterator();
        HandlerMethodReturnValueHandler handler;
        do {
            do {
                if (!var4.hasNext()) {
                    return null;
                }
                handler = (HandlerMethodReturnValueHandler)var4.next();
            } while(isAsyncValue && !(handler instanceof AsyncHandlerMethodReturnValueHandler));
        } while(!handler.supportsReturnType(returnType));
        return handler;
    }

3. 调用返回值处理器（interface HandlerMethodReturnValueHandler）处理：

判断是否支持这种类型的返回值，支持调用返回值处理器，调用 handleReturnValue 进行处理

public interface HandlerMethodReturnValueHandler {
    boolean supportsReturnType(MethodParameter var1);
    void handleReturnValue(@Nullable Object var1, MethodParameter var2, ModelAndViewContainer var3, NativeWebRequest var4) throws Exception;
}

4. RequestResponseBodyMethodRrocessor工作原理

关键代码：

    public void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws IOException, HttpMediaTypeNotAcceptableException, HttpMessageNotWritableException {
        mavContainer.setRequestHandled(true);
        ServletServerHttpRequest inputMessage = this.createInputMessage(webRequest);
        ServletServerHttpResponse outputMessage = this.createOutputMessage(webRequest);
        this.writeWithMessageConverters(returnValue, returnType, inputMessage, outputMessage);
    }

处理返回值的方法

使用消息转换器（涉及内容协商机制，请移步下文内容协商机制）进行写出操作，消息转换器工作过程如下：

浏览器告知服务器其处理能力
服务器根据其自身能力，判断服务器能生产什么样的内容
SpringMVC 遍历所有容器的底层 HttpMessageConverter, 看谁能处理

四、内容协商机制

1. 内容协商

浏览器告知服务器其需要什么类型的服务类型

浏览器可接受的类型：

服务器得到浏览器的处理能力：

服务器将返回内容转为浏览器能处理的形式

2. 内容协商原理重点源代码

   protected List<MediaType> getProducibleMediaTypes(HttpServletRequest request, Class<?> valueClass, @Nullable Type targetType) {
        Set<MediaType> mediaTypes = (Set)request.getAttribute(HandlerMapping.PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE);
        if (!CollectionUtils.isEmpty(mediaTypes)) {
            return new ArrayList(mediaTypes);
        } else if (this.allSupportedMediaTypes.isEmpty()) {
            return Collections.singletonList(MediaType.ALL);
        } else {
            List<MediaType> result = new ArrayList();
            Iterator var6 = this.messageConverters.iterator();
            while(true) {
                while(var6.hasNext()) {
                    HttpMessageConverter<?> converter = (HttpMessageConverter)var6.next();
                    if (converter instanceof GenericHttpMessageConverter && targetType != null) {
                        if (((GenericHttpMessageConverter)converter).canWrite(targetType, valueClass, (MediaType)null)) {
                            result.addAll(converter.getSupportedMediaTypes());
                        }
                    } else if (converter.canWrite(valueClass, (MediaType)null)) {
                        result.addAll(converter.getSupportedMediaTypes());
                    }
                }
                return result;
            }
        }
    }

3. HttpMessageConverters消息转换器原理

MessageConverter 规范

默认的MessageConverter

最终 MappingJackson2HttpMessageConverter 把对象转为JSON（利用底层的jackson的objectMapper转换的）

总结：

返回值处理器判断是否支持这种类型的返回值（ supportsReturnType）
返回值处理器调用handleReturnValue 进行处理
以 @ResponseBody 注解为例，RequestResponseBodyMethodProcessor 可以处理返回值标
最后，利用 MessageConverters 进行处理将数据写为json

到此这篇关于SpringBoot响应处理之以Json数据返回的实现方法的文章就介绍到这了,更多相关SpringBoot Json数据返回内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

spring boot学习笔记之操作ActiveMQ指南
ActiveMQ是一种开源的基于JMS规范的一种消息中间件的实现,ActiveMQ的设计目标是提供标准的,面向消息的,能够跨越多语言和多系统的应用集成消息通信中间件,这篇文章主要给大家介绍了关于spring boot学习笔记之操作ActiveMQ指南的相关资料,需要的朋友可以参考下
2021-11-11
详解java动态代理的2种实现方式
目前Java开发包中包含了对动态代理的支持,但是其实现只支持对接口的的实现。这篇文章主要介绍了详解java动态代理的2种实现方式，有兴趣的可以了解一下。
2016-11-11
Java如何通过File类方法删除指定文件夹中的全部文件
这篇文章主要给大家介绍了关于Java如何通过File类方法删除指定文件夹中的全部文件的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-01-01
struts2框架入门
本文主要介绍了struts2框架的基础入门知识。具有很好的参考价值。下面跟着小编一起来看下吧
2017-03-03
SpringBoot整合ELK做日志超完整详细教程
本文详细介绍了如何在springboot中快速接入ELK的过程,ELK可以说在实际项目中具有很好的适用价值,不管是小项目,还是中大型项目,都具备普适参考性,值得深入了解和学习,感兴趣的朋友一起看看吧
2024-01-01
Java值传递和引用传递详解
这篇文章主要为大家详细介绍了Java值传递和引用传递，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2016-12-12
SpringBoot SpringSecurity 详细介绍(基于内存的验证)
这篇文章主要介绍了SpringBoot SpringSecurity 介绍（基于内存的验证）,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-04-04
java8 Stream API之reduce使用说明
这篇文章主要介绍了java8 Stream API之reduce使用说明，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-11-11
java使用JSCH实现SFTP文件管理
这篇文章主要为大家详细介绍了java使用JSCH实现SFTP文件管理，实现上传、下载等功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-08-08
java实现简单汽车租赁系统
这篇文章主要为大家详细介绍了java实现简单汽车租赁系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-01-01