spring-mvc-boot-5 自定义参数转换和输出 JSON

忘是亡心i 2022-01-14 13:21 154阅读 0赞

一、原理

HTTP 的请求 = 请求头 （ Header ）+ 请求体 （Body ）+ URL + 参数，服务器还包含其上下文环境和客户端交互会话（ Session ）机制，**而这里的消息转换是指请求体的转换** 。

**当一个请求来到时，会首先从http请求和上下文环境来得到参数。**

注1：如果是简单的参数，会以简单的转换器进行转换，这是SpringMVC自身提供的。如int等。

注2：如果是转换http请求体（BODY），会调用HttpMessageConverter接口。

注3:  调用HttpMessageConverter接口对 请求体（Body ）进行转换，

首先、会判断能否进行转换 canRead。

然后、将(用户JSON)转换 read 为控制器参数(用户User)。

**注4： 参数转换用到的是  canRead + read**

**      注5： 输出为为JSON用到的是  canWrite + write**

**               返回的结果类型和媒体类型作为参数，然后MappingJackson2HttpMessageConverter的canWrite方法确定是否转换**

--------------------

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpZG9uZ2xpYW5nemhpY2Fp_size_16_color_FFFFFF_t_70][]

--------------------

二、HttpMessageConverter接口分析

public interface HttpMessageConverter<T> {
    
         1.是否可读，其中clazz为Java类型，mediaType为HTTP请求类型
         canRead(clazz,mediaType);
    
         2.是否可转换为mediaType类型
         canWrite(Class <?> clazz,MediaType mediaType);
    
         3.可支持的媒体类型列表
         List<MediaType> getSupportedMediaTypes();
    
         4.当canRead验证通过后,读入HTTP请求信息
          T read(clazz,inputMessage)
    
         5.当 canWrite 方法验证通过后,写入响应
          void write(T t,contentType,outputMessage)
    }

三、架构分析

--------------------------------------------------------
           +----------------------------+
           |  HttpMessageConverter      |
           +--------------+---------+---+
                          |        |||   +----------+
                          |         +----|调用控制器|
                          |              +----------+
                          |                |||
    +---------------------|-----------------|------+
    |webDataBinder       |||                |      |
    |  +------------------------------+     |      |
    |  | |---------|     |---------|  |     |      |
    |  | |Converter|     |Formatter|  |     |      |
    |  | +---------|     |---------+  |     |      |
    |  |       |----------------|     |     |      |
    |  |       |GenericConverter|     |     |      |
    |  |       |----------------|     |     |      |
    |  +---------------|--------------+     |      |
    |           |------|----|        -+----------+ |
    |           |   POJO    |---------| 验证机制 | |
    |           |-----------|        -|----------| |
    +----------------------------------------------+

四、说明

1.在SpringMVC是通过WebDataBinder机制来获取参数的，它的主要作用是解析HTTP请求的上下文，在控制器调用之前。

*     WebDataBinder机制【获取参数---验证参数---转换参数】 --- > 控制器
 *     WebDataBinder机制是通过三种接口【Converter\[一般\]+Formatter\[格式转换\]+GenericConverter\[数组\]】来进行各类参数转换
 *     SpringMVC对这三种接口都使用了注册机机制，并且已经在注册机中注册了许多的转换器。

2.＠RequestBody 标注了该注释后处理器会采用请求体（BODY）的内容进行参数转换，当前端的请求体为JSON类型，SpringMVC会调用自定义【转换器】：

前端的JSON类型数据---canRead方法---read方法---转换为控制器的（User）类参数

3. 举例使用

*  应用1一对一转换：Converter一对一自定义转换器：@Component+实现Converter。springMVC会自动扫描注册到转换器中。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpZG9uZ2xpYW5nemhpY2Fp_size_16_color_FFFFFF_t_70 1][]

--------------------

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpZG9uZ2xpYW5nemhpY2Fp_size_16_color_FFFFFF_t_70 2][]

--------------------

![20190614162354987.png][]

注：使用 url中是-隔开的string，控制器中自动转换为user

--------------------

*  应用2数组转换：GenericConverter数组转换器：首先会按照逗号拆分子字符串。然后根于原类型泛型为String，目标泛型为User的Converter<String, User>进行转换。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpZG9uZ2xpYW5nemhpY2Fp_size_16_color_FFFFFF_t_70 3][]

--------------------

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpZG9uZ2xpYW5nemhpY2Fp_size_16_color_FFFFFF_t_70 4][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpZG9uZ2xpYW5nemhpY2Fp_size_16_color_FFFFFF_t_70]: /images/20220114/ebab9e8735324dbb93837088e69ce93b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpZG9uZ2xpYW5nemhpY2Fp_size_16_color_FFFFFF_t_70 1]: /images/20220114/6b38339c52bf4b749b7a3ee93e63b3b1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpZG9uZ2xpYW5nemhpY2Fp_size_16_color_FFFFFF_t_70 2]: /images/20220114/da7e3448e2b54efb8939d285c139024a.png
[20190614162354987.png]: /images/20220114/29635142efdc4d62b05afaaf2efc84c4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpZG9uZ2xpYW5nemhpY2Fp_size_16_color_FFFFFF_t_70 3]: /images/20220114/f085cc1e526d4cb9a2a420879e00e83b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpZG9uZ2xpYW5nemhpY2Fp_size_16_color_FFFFFF_t_70 4]: /images/20220114/33e26be39b3f4713856c36aa0c15e2eb.png