SpringBoot源码——媒体类型的解析和运行流程

Love The Way You Lie 2021-11-26 11:08 379阅读 0赞

说到媒体类型，也差不多就相当于是一些前后台的协商，使用媒体类型来制定规则，比如请求中Accept里的内容。  
下面就来一起分析一下媒体类型解析的源码  
`User类`

package com.wrial.art6_rest.domain;
    /*
     * @Author  Wrial
     * @Date Created in 14:01 2019/7/23
     * @Description
     */
        private Integer id;
        private String name;
        //getter,setter
    
    }

`UserRestController类`

package com.wrial.art6_rest.controller;
    /*
     * @Author  Wrial
     * @Date Created in 14:01 2019/7/23
     * @Description
     */
    
    import com.wrial.art6_rest.domain.User;
    import org.springframework.web.bind.annotation.*;
    
    @RestController
    public class UserRestController {
    
        @PostMapping(value = "/echo/user")
        public User user(@RequestBody User user){
            return user;
        }
    }

`SpringBoot启动类`

package com.wrial.art6_rest.bootstrap;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    /*
     * @Author  Wrial
     * @Date Created in 22:11 2019/7/22
     * @Description
     */
    @SpringBootApplication(scanBasePackages= "com.wrial.art6_rest.controller")
    public class SpringBootRestBootStrap {
        public static void main(String[] args) {
            SpringApplication.run(SpringBootRestBootStrap.class, args);
        }
    
    }

使用PostMan发送Post请求  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70]  
编写请求内容  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 1]  
进行第一次的媒体匹配调试  
先简单的说一下请求流程，先是通过DispatcherServlet接受并处理请求，通过getHandler选择了RequestMappingHandlerMapping，然后就是适配并且返回一个ModelAndView，然后去检查这个请求是否被支持`checkRequest(request)`,然后通过之后就到了我们写的PostMapping方法了，然后通过invoke获取方法参数，并且对返回值进行处理，详细的可以去看[Rest运行流程][Rest]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 2]  
然后就到了媒体类型解析，是通过`getProducibleMediaTypes`方法进行判断和解析，可以看到mediaType是一个空值，这能说明什么，这就是说明我们没有在定义中说明一个确定的mediaType  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 3]  
因此它没有找到自定义的mediaType，就会根据请求中的Accept属性的值进行适配，可以看到如果不能根据`RequestMapping中的products`来适配就去一个个的和这10个媒体类型进行适配并选择最优的那一个。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 4]  
在执行结束后我们可以看到它适配找到了四个可以支持的mediaType，但是很明显0和2是一样的，1和3是一样的，并且很明显1和3是不符合的，因此我们必须继续往下来寻找答案，因为这些中只能选择一个mediaType  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 5]  
接下来就到了选择阶段，可以看出是通过发送请求的Accept中application/json和目前这些可用的mediaType进行最佳匹配，如果是一致的就加入mediaTypesToUse中，可以上一张图中的看到0号元素适配成功  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 6]  
循环完之后可以看到最终只选择了完全匹配的两个  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 7]  
然后通过sortBySpecificityAndQuality进行排序，也就是说要选择最佳的排序在前面，并在后边使用它  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 8]  
然后根据契合度进行排序，下面就是比较器的代码

public static final Comparator<MediaType> QUALITY_VALUE_COMPARATOR = (mediaType1, mediaType2) -> {
    		double quality1 = mediaType1.getQualityValue();
    		double quality2 = mediaType2.getQualityValue();
    		int qualityComparison = Double.compare(quality2, quality1);
    		if (qualityComparison != 0) {
    			return qualityComparison;  // audio/*;q=0.7 < audio/*;q=0.3
    		}
    		else if (mediaType1.isWildcardType() && !mediaType2.isWildcardType()) {  // */* < audio/*
    			return 1;
    		}
    		else if (mediaType2.isWildcardType() && !mediaType1.isWildcardType()) {  // audio/* > */*
    			return -1;
    		}
    		else if (!mediaType1.getType().equals(mediaType2.getType())) {  // audio/basic == text/html
    			return 0;
    		}
    		else {  // mediaType1.getType().equals(mediaType2.getType())
    			if (mediaType1.isWildcardSubtype() && !mediaType2.isWildcardSubtype()) {  // audio/* < audio/basic
    				return 1;
    			}
    			else if (mediaType2.isWildcardSubtype() && !mediaType1.isWildcardSubtype()) {  // audio/basic > audio/*
    				return -1;
    			}
    			else if (!mediaType1.getSubtype().equals(mediaType2.getSubtype())) {  // audio/basic == audio/wave
    				return 0;
    			}
    			else {
    				int paramsSize1 = mediaType1.getParameters().size();
    				int paramsSize2 = mediaType2.getParameters().size();
    				return Integer.compare(paramsSize2, paramsSize1);  // audio/basic;level=1 < audio/basic
    			}
    		}
    	};

到了这一块就已经是按照上面的Comparator排序过的集合了，并且可以从源码中看到它遍历到第一个值结束后就break，它就选到了最优的方案  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 9]  
然后它选择出一个最佳的，然后根据最佳mediaType的值在所有序列化器中进行选择  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 10]  
执行结束可以看到和Jackon2匹配成功了,然后返回ModelAndView，因为采用的序列化格式不一样了，View当然要重新适配了  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 11]  
下面就可以看到输出的JSON格式了  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 12]  
有没有留意在前文中说的一个细节就是`GetMapping`中的produces属性，我们给他加上Accept的值再来调试

package com.wrial.art6_rest.controller;
    /*
     * @Author  Wrial
     * @Date Created in 14:01 2019/7/23
     * @Description
     */
    
    import com.wrial.art6_rest.domain.User;
    import org.springframework.web.bind.annotation.*;
    
    @RestController
    public class UserRestController {
    
        @PostMapping(value = "/echo/user",produces = "application/json;charset=UTF-8")
        public User user(@RequestBody User user){
            return user;
        }
    }

可以惊异的看到我们添加的`meidaType`已经加入到`mediaTypes`这个Set中了（Set也就暗示这可以加多个），因此它到这一步就直接返回一个`List< MediaType >`，所以下面这些都不会再执行了  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 13]  
然后就直接跳到了使用Accept中的值和Produces中的值进行适配  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 14]  
适配成功就加到了`mediaTypeToUse`集合中去，然后和前面流程一样去和那10个序列化器进行唯一匹配，然后更改`body`等等

> 可以发现的是，这样其实就是省了使用Accept和那10个序列化器的序列化属性进行比较了（比较出来的是可用的序列化器，不一定是最佳的），而是直接就有结果，然后就从根据类型从序列化器中找

那么我们要是不会的`Accept`这个属性为JSON，只在`PostMapping`中的`produce`属性中加，那会怎么样呢？  
不如再来看看，按理来说是采用JSON格式，因为如果不规定，它就默认匹配为\* / \*,也就是全都适配，那么和`mediaTypeToUse`也可以匹配的上

那么就来试试看看理论会不会成功？  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 15]  
可以看到的是，请求类型变为了\* / \* ，并且发现匹配成功并给`mediaTypesToUse`中添加了所有的`producibleTypes`（目前我们只制定了一个，Charset算是一个附加条件）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 16]  
因此后边就不多说啦，发现猜想是正确的！

> 这些就是我要说的关于媒体类型解析的内容！细节很多，更多的细节就没有太展示，还是需要自己下去多多研究。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70]: /images/20211126/2c66c49064c7494291f02c66ceedbbc1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 1]: /images/20211126/dd82c1e9bd9a4ff29736b4def2667aff.png
[Rest]: https://blog.csdn.net/qq_42605968/article/details/96978764
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 2]: /images/20211126/cff4cd4212d245c78ce434ce3aa19e7a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 3]: /images/20211126/35a9080f4297438f80ed10e8de2dd8bf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 4]: /images/20211126/c673b4008d484dacb3ab3832442a3d09.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 5]: /images/20211126/ede1ff021c3246c9ad39248d74ca8428.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 6]: /images/20211126/cfb8a1bd49034faba30dd94db01d048c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 7]: /images/20211126/6aedfd86ffab459c8e6ad3ce368bc2b9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 8]: /images/20211126/27dbf99c562a41bf8f3ae13c18d14c57.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 9]: /images/20211126/e51286ae7d2f4870a9e578054ab516d4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 10]: /images/20211126/7fd7ad5f3fb84eae8ef6a2220d716133.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 11]: /images/20211126/4db06ae18e8f406aade199ed159365b1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 12]: /images/20211126/fee8c8be5dd443caaa0636f14539b7ca.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 13]: /images/20211126/355dd0878c35479a84321163a904f0d2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 14]: /images/20211126/6f2fc699d4334df49c9e23affd55ee3e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 15]: /images/20211126/dce9466a3ce24e6babd3035967fdbab2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNjA1OTY4_size_16_color_FFFFFF_t_70 16]: /images/20211126/c9ef492796d74706964737115fbb983a.png