SpringMVC系列-5 消息转换器

背景

SpringMVC系列的第五篇介绍消息转换器，本文讨论的消息转换指代调用Controller接口后，对结果进行转换处理的过程。

内容包括介绍自定义消息转换器、SpringMVC常见的消息转换器、Spring消息转换器工作原理等三部分。

本文以 SpringMVC系列-2 HTTP请求调用链和 SpringMVC系列-4 参数解析器为基础，对相同内容不再重述。

1.自定义消息转换器

自定义消息转换器，需要实现HttpMessageConverter接口，该接口定义如下：

java 复制代码

public interface HttpMessageConverter<T> {
	boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);

	void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;

	List<MediaType> getSupportedMediaTypes();
	
	// ⚠️：read相关逻辑不是本文关注的部分
	boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
	T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;
}

有三个比较重要的方法：

(1) getSupportedMediaTypes方法返回该解析器支持的MIME媒体类型；

(2) canWrite方法判断该解析器能否将目标类型的对象转化为指定的MIME媒体类型；

(3) write方法将目标对象转化为mediaType的二进制流并写入到outputMessage流对象中。

自定义消息转换器：

java 复制代码

public class UserInfoHttpMessageConverter implements HttpMessageConverter<UserInfo> {
    @Override
    public boolean canWrite(Class clazz, MediaType mediaType) {
        return clazz == UserInfo.class;
    }

    @Override
    public List<MediaType> getSupportedMediaTypes() {
        return Collections.singletonList(MediaType.APPLICATION_JSON);
    }

    @Override
    public void write(UserInfo userInfo, MediaType contentType, HttpOutputMessage outputMessage)
        throws IOException, HttpMessageNotWritableException {
        String result = userInfo.getId() + "_" + userInfo.getName() + "_" + LocalDateTime.now();
        outputMessage.getBody().write(result.getBytes(StandardCharsets.UTF_8));
    }
    //...read Ignore
}

该自定义转换器表示可以将UserInfo类型的消息以"application/json"媒体格式写出。

将自定义的消息转换器注册到SpringMVC：

java 复制代码

@Configuration
public class MyWebMvcConfigurer implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(0, new UserInfoHttpMessageConverter());
    }
}

注意：这里通过SpringMVC的配置类WebMvcConfigurer进行注册，注册原理在本文第三章中说明。

用例涉及的Controller接口和基础类：

java 复制代码

@RestController
@RequestMapping("/api/user")
public class UserInfoController {
    @GetMapping("/query")
    public UserInfo query() {
        return new UserInfo().setName("test_sy").setId(28);
    }
}

@Data
@Accessors(chain = true)
public class UserInfo {
    private Integer id;

    private String name;
}

使用postman调用结果如下所示：

2.消息转换器

SpringBoot版本为2.3.2.RELEASE

2.1 框架内置的消息解析器

框架内置的消息解析器支持的MIME类型分布如下所示：
ByteArrayHttpMessageConverter：用于处理字节数组（byte array）的转换。

python 复制代码

ByteArrayHttpMessageConverter
    application/octet-stream
    */*

StringHttpMessageConverter：用于处理字符串的转换。

python 复制代码

StringHttpMessageConverter
    text/plain
    */*
   
StringHttpMessageConverter
    text/plain
    */*

ResourceHttpMessageConverter：用于处理Spring Resource的实现类的转换。Spring Resource是一个抽象类，它封装了对各种资源（如文件、数据库连接等）的操作。

python 复制代码

ResourceHttpMessageConverter
    */*

ResourceRegionHttpMessageConverter：这个类是ResourceHttpMessageConverter的子类，它用于处理Resource的某个特定区域（如文件的某个部分）。

python 复制代码

ResourceRegionHttpMessageConverter
    */*

SourceHttpMessageConverter：用于处理javax.xml.transform.Source的转换。javax.xml.transform.Source是用于XML转换的接口。

python 复制代码

SourceHttpMessageConverter
    application/xml   
    text/xml 
    application/*+xml

AllEncompassingFormHttpMessageConverter：用于处理表单提交请求，能解析复杂的form表单，包括文件上传等。

python 复制代码

AllEncompassingFormHttpMessageConverter
    application/x-www-form-urlencoded
    multipart/form-data
    multipart/mixed

MappingJackson2HttpMessageConverter：用于处理JSON序列化和反序列化。

python 复制代码

MappingJackson2HttpMessageConverter
    application/json   
    application/*+json

MappingJackson2HttpMessageConverter
    application/json
    application/*+json

Jaxb2RootElementHttpMessageConverter：这个类使用JAXB（Java Architecture for XML Binding）进行XML序列化和反序列化。

python 复制代码

Jaxb2RootElementHttpMessageConverter
    application/xml
    text/xml
    application/*+xml

上述内置转换器中包括2个StringHttpMessageConverter和2个MappingJackson2HttpMessageConverter。转换器的顺序决定了其优先级，因此第二个StringHttpMessageConverter和MappingJackson2HttpMessageConverter处于失效状态：