SpringMVC HttpMessageConverter消息转换器怎么使用

今天小编给大家分享一下SpringMVC HttpMessageConverter消息转换器怎么使用的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。

    Spring MVC 为开发者提供了方便的开发方式和丰富的功能。其中,HttpMessageConverter 是Spring MVC中非常重要的一个组件,它负责将客户端提交的请求数据(如JSON、XML等)转换为Java对象,同时也负责将 Java 对象转换为客户端需要的数据格式。

    作用

    在 Spring MVC 中,客户端通过发送请求,向服务器端请求数据,服务器端接收到请求后需要将请求参数转换为 Java 对象进行处理,这就需要使用 HttpMessageConverter,它主要负责将HTTP请求中的请求参数转换为 Java 对象或将 Java 对象转换为 HTTP 响应中的内容。

    HttpMessageConverter 是一个接口,Spring MVC 中有很多实现类,用于处理不同的数据类型。常见的 HttpMessageConverter 实现类有:

    • ByteArrayHttpMessageConverter:用于处理字节数组类型的数据。

    • StringHttpMessageConverter:用于处理字符串类型的数据。

    • FormHttpMessageConverter:用于处理表单类型的数据。

    • MappingJackson2HttpMessageConverter:用于处理JSON类型的数据。

    • Jaxb2RootElementHttpMessageConverter:用于处理XML类型的数据。

    HttpMessageConverter 接口定义了两个方法:canRead() 和 canWrite(),分别用于判断当前的 HttpMessageConverter 是否可以读取或写入指定的数据类型。

    • 如果 canRead() 方法返回 true,那么当前的 HttpMessageConverter 就可以将 HTTP 请求中的请求参数转换为 Java 对象;

    • 如果 canWrite() 方法返回 true,那么当前的 HttpMessageConverter 就可以将Java对象转换为 HTTP 响应中的内容。

    源码实现

    下面以 MappingJackson2HttpMessageConverter 为例,讲解 HttpMessageConverter 的源码实现。

    MappingJackson2HttpMessageConverter 是一个用于处理 JSON 类型数据的 HttpMessageConverter 实现类。它继承了 AbstractJackson2HttpMessageConverter 类,并实现了 HttpMessageConverter 接口。

    canRead()

    @Override
    public boolean canRead(Class<?> clazz, @Nullable MediaType mediaType) {
        JavaType javaType = getJavaType(clazz, null);
        return (this.objectMapper.canDeserialize(javaType) && canRead(mediaType));
    }

    方法首先调用了 getJavaType() 方法获取 JavaType 对象

    然后判断当前的 ObjectMapper 是否可以反序列化 JavaType 对象。

    如果当前的 HttpMessageConverter 可以反序列化 JavaType 对象并且当前的 MediaType 可以被处理,那么就返回 true,否则返回 false。

    canWrite()

    @Override
    public boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType) {
        return (this.objectMapper.canSerialize(clazz) && canWrite(mediaType));
    }

    方法首先判断当前的 ObjectMapper 是否可以序列化指定的 Java 对象

    如果可以序列化并且当前的 MediaType 可以被处理,那么就返回 true,否则返回 false。

    read()

    @Override
    public T readInternal(Class<? extends T> clazz, HttpInputMessage inputMessage)throws IOException, HttpMessageNotReadableException {
        JavaType javaType = getJavaType(clazz, null);
        try {
            return this.objectMapper.readValue(inputMessage.getBody(), javaType);
        }
        catch (JsonProcessingException ex) {
            throw new HttpMessageNotReadableException("JSON parse error: " + ex.getMessage(), ex, inputMessage);
        }
    }

    方法首先调用 getJavaType() 方法获取 JavaType 对象

    然后通过 ObjectMapper 的 readValue() 方法将HTTP请求中的请求参数转换为 Java 对象。

    如果在转换的过程中出现了异常,那么就抛出 HttpMessageNotReadableException 异常。

    write()

    @Override
    protected void writeInternal(T t, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
        try {
            JsonEncoding encoding = getJsonEncoding(outputMessage.getHeaders().getContentType());
            JsonGenerator jsonGenerator = this.objectMapper.getFactory().createGenerator(outputMessage.getBody(), encoding);
            writePrefix(jsonGenerator, t);
            this.objectMapper.writeValue(jsonGenerator, t);
            writeSuffix(jsonGenerator, t);
            jsonGenerator.flush();
        }
        catch (JsonProcessingException ex) {
            throw new HttpMessageNotWritableException("Could not write JSON: " + ex.getMessage(), ex);
        }
    }

    方法首先通过 getJsonEncoding() 方法获取JSON编码格式

    然后通过 ObjectMapper 的 writeValue() 方法将 Java 对象转换为 JSON 格式的字符串

    并将结果输出到 HTTP 响应中。如果在转换的过程中出现了异常,那么就抛出 HttpMessageNotWritableException 异常。

    异同

    大家是不是觉得与前面文章所讲的 MethodArgumentResolver 很相似,都能够将请求参数转换为Java对象,但它们的作用和处理流程不同:

    • HttpMessageConverter 会在请求到达 Controller 方法之前进行处理,这意味着它只处理请求参数,而不管 Controller 方法的签名和参数类型;

    • MethodArgumentResolver 会在 Controller 方法执行之前进行处理,它的作用是将请求参数按照 Controller 方法的参数顺序进行解析,并将解析结果映射到 Controller 方法的参数上,然后再调用 Controller 方法

    以上就是“SpringMVC HttpMessageConverter消息转换器怎么使用”这篇文章的所有内容,感谢各位的阅读!相信大家阅读完这篇文章都有很大的收获,小编每天都会为大家更新不同的知识,如果还想学习更多的知识,请关注编程之家行业资讯频道。

    相关文章

    这篇文章主要介绍了spring的事务传播属性REQUIRED_NESTED的原...
    今天小编给大家分享的是一文解析spring中事务的传播机制,相...
    这篇文章主要介绍了SpringCloudAlibaba和SpringCloud有什么区...
    本篇文章和大家了解一下SpringCloud整合XXL-Job的几个步骤。...
    本篇文章和大家了解一下Spring延迟初始化会遇到什么问题。有...
    这篇文章主要介绍了怎么使用Spring提供的不同缓存注解实现缓...