从 01 开始 从 01 开始
首页
  • 📚 计算机基础

    • 计算机简史
    • 数字电路
    • 计算机组成原理
    • 操作系统
    • Linux
    • 计算机网络
    • 数据库
    • 编程工具
    • 装机
  • 🎨 前端

    • Node
  • JavaSE
  • Java 高级
  • JavaEE

    • 构建、依赖管理
    • Ant
    • Maven
    • 日志框架
    • Junit
    • JDBC
    • XML-JSON
  • JavaWeb

    • 服务器软件
    • 环境管理和配置管理-科普篇
    • Servlet
  • Spring

    • Spring基础
  • 主流框架

    • Redis
    • Mybatis
    • Lucene
    • Elasticsearch
    • RabbitMQ
    • MyCat
    • Lombok
  • SpringMVC

    • SpringMVC 基础
  • SpringBoot

    • SpringBoot 基础
  • Windows 使用技巧
  • 手机
  • 最全面的输入法教程
  • 最全面的浏览器教程
  • Office
  • 图片类工具
  • 效率类工具
  • RSS
  • 码字工具
  • 各大平台
  • 校招
  • 五险一金等
  • 职场规划
  • 关于离职
  • 杂谈
  • 📖 读书

    • 读书工具
    • 读书笔记
  • 🌍 英语

    • 从零开始学英语
    • 英语兔的相关视频
    • Larry 想做技术大佬的相关视频
  • 🏛️ 政治

    • 反腐
    • GFW
    • 404 内容
    • 审查与自我审查
    • 互联网
    • 战争
  • 💰 经济

    • 关于税
    • 理财
  • 💪 健身

    • 睡眠
    • 皮肤
    • 口腔健康
    • 学会呼吸
    • 健身日志
  • 🏠 其他

    • 驾驶技能
    • 租房与买房
    • 厨艺
  • 电影

    • 电影推荐
  • 电视剧
  • 漫画

    • 漫画软件
    • 漫画推荐
  • 游戏

    • Steam
    • 三国杀
    • 求生之路
  • 小说
  • 关于本站
  • 关于博主
  • 打赏
  • 网站动态
  • 友人帐
  • 从零开始搭建博客
  • 搭建邮件服务器
  • 本站分享
  • 🌈 生活

    • 2022
    • 2023
    • 2024
    • 2025
  • 📇 文章索引

    • 文章分类
    • 文章归档

晓林

程序猿,自由职业者,博主,英语爱好者,健身达人
首页
  • 📚 计算机基础

    • 计算机简史
    • 数字电路
    • 计算机组成原理
    • 操作系统
    • Linux
    • 计算机网络
    • 数据库
    • 编程工具
    • 装机
  • 🎨 前端

    • Node
  • JavaSE
  • Java 高级
  • JavaEE

    • 构建、依赖管理
    • Ant
    • Maven
    • 日志框架
    • Junit
    • JDBC
    • XML-JSON
  • JavaWeb

    • 服务器软件
    • 环境管理和配置管理-科普篇
    • Servlet
  • Spring

    • Spring基础
  • 主流框架

    • Redis
    • Mybatis
    • Lucene
    • Elasticsearch
    • RabbitMQ
    • MyCat
    • Lombok
  • SpringMVC

    • SpringMVC 基础
  • SpringBoot

    • SpringBoot 基础
  • Windows 使用技巧
  • 手机
  • 最全面的输入法教程
  • 最全面的浏览器教程
  • Office
  • 图片类工具
  • 效率类工具
  • RSS
  • 码字工具
  • 各大平台
  • 校招
  • 五险一金等
  • 职场规划
  • 关于离职
  • 杂谈
  • 📖 读书

    • 读书工具
    • 读书笔记
  • 🌍 英语

    • 从零开始学英语
    • 英语兔的相关视频
    • Larry 想做技术大佬的相关视频
  • 🏛️ 政治

    • 反腐
    • GFW
    • 404 内容
    • 审查与自我审查
    • 互联网
    • 战争
  • 💰 经济

    • 关于税
    • 理财
  • 💪 健身

    • 睡眠
    • 皮肤
    • 口腔健康
    • 学会呼吸
    • 健身日志
  • 🏠 其他

    • 驾驶技能
    • 租房与买房
    • 厨艺
  • 电影

    • 电影推荐
  • 电视剧
  • 漫画

    • 漫画软件
    • 漫画推荐
  • 游戏

    • Steam
    • 三国杀
    • 求生之路
  • 小说
  • 关于本站
  • 关于博主
  • 打赏
  • 网站动态
  • 友人帐
  • 从零开始搭建博客
  • 搭建邮件服务器
  • 本站分享
  • 🌈 生活

    • 2022
    • 2023
    • 2024
    • 2025
  • 📇 文章索引

    • 文章分类
    • 文章归档
  • JavaSE

  • JavaSenior

  • JavaEE

  • JavaWeb

  • Spring

  • 主流框架

  • SpringMVC

  • SpringBoot

    • SpringBoot教程-尚硅谷

      • SpringBoot 课程介绍
      • Spring 和 SpringBoot
      • HelloWorld
      • 了解自动配置原理
      • 底层注解-@Configuration 详解
      • 底层注解-@Import 导入组件
      • 底层注解-@Conditional 条件装配
      • 原生配置文件引入-@ImportResource
      • 底层注解-配置绑定 @ConfigurationProperties
      • 自动配置原理
      • 自动配置流程
      • Lombok 简化开发
      • DevTools
      • Spring-Initailizr
      • 配置文件-Yaml 用法
      • Web 开发简介
      • web 开发-静态资源规则于定制化
      • 静态资源配置原理
      • Rest 映射及源码解析
      • 请求映射原理
      • 常用参数注解使用
      • MatrixVariable:矩阵变量
      • 各种类型参数解析原理
      • Servlet-API 参数解析原理
      • Model、Map 参数解析原理
      • 自定义对象参数绑定原理
      • 自定义 Converter 原理
      • 数据响应原理
      • 内容协商原理
      • 基于请求参数的内容原理
      • 自定义 MessageConverter 原理
        • 需求
        • 加载 Converter 的过程
        • 新建 Converter 类
        • 如何添加自定义 Converter
        • 以请求参数的方式完成内容协商
        • 源码
      • Thymeleaf 初体验
      • web 实验-后台管理系统
      • web 实验-抽取公共页面
      • web 实验-遍历数据
      • 源码分析-视图解析器与视图
      • 拦截器-登录检查与静态资源放行
      • 拦截器的执行时机和原理
      • 单文件和多文件上传的使用
      • 文件上传原理
      • 错误处理机制
      • 错误处理-底层组件源码分析
      • 异常处理流程
      • 几种异常处理原理
      • Web 原生对象注入
      • 嵌入式 Servlet 容器
      • 定制化原理
      • 数据库场景的自动配置分析和整合测试
      • 自定义方式整合 Druid
      • 通过 starter 整合 Druid
      • 整合 Mybatis
      • 使用注解整合 Mybatis
      • 整合 MybatisPlus 操作数据库
      • MybatisPlus-列表分页展示
      • 整合 Redis
      • 单元测试-Junit5
      • 单元测试-断言机制
      • 单元测试-前置条件
      • 单元测试-嵌套测试
      • 单元测试-参数化测试
      • 指标监控-基本概念
      • 指标监控-配置 EndPoint
      • 指标监控-可视化
      • 原理解析-Profile 功能
      • 配置文件深入
      • 自定义 Starter
      • SpringApplication 初始化过程
      • SpringBoot 完整启动过程
  • Java
  • SpringBoot
  • SpringBoot教程-尚硅谷
2023-08-22
目录

自定义 MessageConverter 原理

# 310.自定义 MessageConverter 原理

之前我们分析了内容协商原理,现在就来讲讲自定义 Converter 的原理 ‍

# 需求

有什么我们会遇到这样的需求:

  1. 一个接口用来返回数据;
  2. 如果是浏览器发送的请求,则返回 XML
  3. 如果是 Ajax 发送的请求,则返回 JSON
  4. 如果是 App 端发送的请求,则返回自定义协议数据(假设协议名字叫 x-guigu)

如果是之前,一般是要写 3 个方法,分别给浏览器、Ajax 和 App 返回数据。有了内容协商,我们就可以用一个方法兼容各种请求,根据不同请求返回不同类型,只需前端在发送请求的时候,加上想要的数据类型即可 ‍ 实现步骤:

  1. 添加自定义的 MessageConverter,到系统底层的 Converter 集合中
  2. 项目启动时,系统底层就会统计出所有 MessageConverter 能操作哪些类型
  3. 客户端发送数据,服务器返回数据 ‍ 我们先分析下系统默认的 Converter 是如何加载的,再说下如何添加 ‍

# 加载 Converter 的过程

SpringBoot 是用 xxxAutoConfiguration 类来加载配置的,web 开发相关的则是 WebMvcAutoConfiguration 类;

在 214 行,有这样的配置:

@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
	this.messageConvertersProvider.ifAvailable((customConverters) -> converters.addAll(customConverters.getConverters()));
}
1
2
3
4

‍ 我们点进 customConverters.getConverters() 方法,就会来点 HttpMessageConverters 类:

public List<HttpMessageConverter<?>> getConverters() {
	return this.converters;
}
1
2
3

‍ 而 converters 这个成员变量,是在 HttpMessageConverters 创建的时候,就会初始化的:

public HttpMessageConverters(boolean addDefaultConverters, Collection<HttpMessageConverter<?>> converters) {
	List<HttpMessageConverter<?>> combined = getCombinedConverters(converters,
			addDefaultConverters ? getDefaultConverters() : Collections.emptyList());
	combined = postProcessConverters(combined);
	this.converters = Collections.unmodifiableList(combined);
}
1
2
3
4
5
6

‍ 也就是会将调用 addDefaultConverters 方法,获取默认的 Converter;而 addDefaultConverters 则是调用父类的 getMessageConverters 方法( 在 185 行):

‍

我们逐步分析,就会来到 WebMvcConfigurationSupport 类,然后其就会加载 Converter(例如前几行代码就加了不少 Converter):

protected final void addDefaultHttpMessageConverters(List<HttpMessageConverter<?>> messageConverters) {
    messageConverters.add(new ByteArrayHttpMessageConverter());
    messageConverters.add(new StringHttpMessageConverter());
    messageConverters.add(new ResourceHttpMessageConverter());
    messageConverters.add(new ResourceRegionHttpMessageConverter());
    try {
	messageConverters.add(new SourceHttpMessageConverter<>());
    }
    catch (Throwable ex) {
	// Ignore when no TransformerFactory implementation is available...
    }
    messageConverters.add(new AllEncompassingFormHttpMessageConverter());
  
    if (romePresent) {
	messageConverters.add(new AtomFeedHttpMessageConverter());
	messageConverters.add(new RssChannelHttpMessageConverter());
    }

    if (jackson2XmlPresent) {
	Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.xml();
	if (this.applicationContext != null) {
		builder.applicationContext(this.applicationContext);
	}
        messageConverters.add(new MappingJackson2XmlHttpMessageConverter(builder.build()));
    }
    else if (jaxb2Present) {
    	messageConverters.add(new Jaxb2RootElementHttpMessageConverter());
    }
    //....
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

‍ 第 19 行,还可以看到其会判断是否导入了 Jackson 的依赖,是就会加载响应的 Converter

ps:jackson2XmlPresent 这个变量,是在 WebMvcConfigurationSupport 的静态代码块加载的:

static {
    ClassLoader classLoader = WebMvcConfigurationSupport.class.getClassLoader();
    romePresent = ClassUtils.isPresent("com.rometools.rome.feed.WireFeed", classLoader);
    jaxb2Present = ClassUtils.isPresent("javax.xml.bind.Binder", classLoader);
    jackson2Present = ClassUtils.isPresent("com.fasterxml.jackson.databind.ObjectMapper", classLoader) && ClassUtils.isPresent("com.fasterxml.jackson.core.JsonGenerator", classLoader);
    jackson2XmlPresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.xml.XmlMapper", classLoader);
    jackson2SmilePresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.smile.SmileFactory", classLoader);
    jackson2CborPresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.cbor.CBORFactory", classLoader);
    gsonPresent = ClassUtils.isPresent("com.google.gson.Gson", classLoader);
    jsonbPresent = ClassUtils.isPresent("javax.json.bind.Jsonb", classLoader);
}
1
2
3
4
5
6
7
8
9
10
11

‍

# 新建 Converter 类

我们新增一个类 GuiguMessageConverter,实现 HttpMessageConverter 接口,并且是操作 Person 类型的数据,然后实现接口中的方法:

package com.peterjxl.boot.converter;

import com.peterjxl.boot.bean.Person;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;

import java.io.IOException;
import java.util.List;

public class GuiguMessageConverter implements HttpMessageConverter<Person> {

    @Override
    public boolean canRead(Class<?> clazz, MediaType mediaType) {
        return false;
    }

    @Override
    public boolean canWrite(Class<?> clazz, MediaType mediaType) {
        return false;
    }

    @Override
    public List<MediaType> getSupportedMediaTypes() {
        return null;
    }

    @Override
    public Person read(Class<? extends Person> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
        return null;
    }

    @Override
    public void write(Person person, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {

    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

‍ canRead 方法:我们目前只关系转换数据,因此可读就直接返回 false;

canWrite 方法:是否可转换,我们只需判断类型是否一致即可,因此修改为:

@Override
public boolean canWrite(Class<?> clazz, MediaType mediaType) {
    return clazz.isAssignableFrom(Person.class);
}
1
2
3
4

‍ getSupportedMediaTypes:获取支持的媒体类型,这个很重要,SpringBoot 就是根据该方法,统计所有 Converter 能写出的媒体类型,例如 application/xml。这里修改如下:

@Override
public List<MediaType> getSupportedMediaTypes() {
    return MediaType.parseMediaTypes("application/x-guigu");
}
1
2
3
4

‍ read 方法:忽略

write 方法,就是用来转换自定义数据为 Person 对象的了。这里假设自定义类型的数据,格式是这样的:属性值1:属性值2;,因此代码如下:

@Override
public void write(Person person, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
    String data = person.getUserName() + ";" + person.getAge() + ";" + person.getBirth();
    outputMessage.getBody().write(data.getBytes());
}
1
2
3
4
5

# 如何添加自定义 Converter

首先,我们明确一点:修改 SpringMVC 的功能,都是通过在容器中添加一个 WebMvcConfigurer 组件即可,在该组件内定制功能。、

WebMvcConfigurer 是一个接口,里面有这两个方法:

default void configureMessageConverters(List<HttpMessageConverter<?>> converters) {}
default void extendMessageConverters(List<HttpMessageConverter<?>> converters) {}
1
2

用 configureMessageConverters,相当于会覆盖默认的 Converter;

用 extendMessageConverters,则是扩展,相当于在默认的 Converter 里添加新的 Converter ‍ 我们在配置类 WebConfig 中添加代码(第 5 ~ 8 行):

@Bean
public WebMvcConfigurer webMvcConfigurer(){
    return new WebMvcConfigurer() {

        @Override
        public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
            converters.add(new GuiguMessageConverter());
        }

        //.......
1
2
3
4
5
6
7
8
9
10

‍ 为了方便编辑请求头,我们使用 Postman 来发送 HTTP 请求,在 Accept 字段上加上 application/x-guigu,然后发送,可以看到能正常返回数据:

至于添加了 Converter 后,内容协商的过程,其实是一样的,这里就不赘述了,感兴趣的同学可以自行 debug 来观察

# 以请求参数的方式完成内容协商

刚刚我们是用 HTTP 请求头的方式,现在我们就用请求参数的方式来完成。首先,默认情况下,基于请求参数的内容协商,只支持 XML 和 JSON 的格式:

那怎么办呢?很简单,我们自定义一个策略,然后放入策略管理器即可。在 WebMvcConfigurer 类中,就有相关的方法(第 66 行):

default void configureContentNegotiation(ContentNegotiationConfigurer configurer) {}
1

‍ 我们来到 WebConfig 配置类,添加如下代码:

@Override
public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
	Map<String, MediaType> mediaTypes = new HashMap<>();
	mediaTypes.put("json", MediaType.APPLICATION_JSON);
	mediaTypes.put("xml", MediaType.APPLICATION_XML);
	mediaTypes.put("gg", MediaType.parseMediaType("application/x-guigu"));
	ParameterContentNegotiationStrategy parameterContentNegotiationStrategy = new ParameterContentNegotiationStrategy(mediaTypes);

	HeaderContentNegotiationStrategy headerContentNegotiationStrategy = new HeaderContentNegotiationStrategy();
	configurer.strategies(Arrays.asList(parameterContentNegotiationStrategy, headerContentNegotiationStrategy));
}
1
2
3
4
5
6
7
8
9
10
11

注意:覆盖 configureContentNegotiation 方法后,就得自行添加基于请求头的策略了,否则就只会有我们自己定义的策略

此时我们重启,能看到正常访问:

扩展知识点:我们请求参数中,名字默认是 format,是可以自行修改的,例如改为 ff:

parameterContentNegotiationStrategy.setParameterName("ff")
1

# 源码

已将本文源码上传到 Gitee (opens new window) 或 GitHub (opens new window) 的分支 demo1,读者可以通过切换分支来查看本文的示例代码

上次更新: 2025/5/17 12:26:09
基于请求参数的内容原理
Thymeleaf 初体验

← 基于请求参数的内容原理 Thymeleaf 初体验→

最近更新
01
吐槽一下《僵尸校园》
05-15
02
2025 年 4 月记
04-30
03
山西大同 “订婚强奸案” 将会给整个社会带来的影响有多严重? - 知乎 转载
04-26
更多文章>
Theme by Vdoing | Copyright © 2022-2025 | 粤 ICP 备 2022067627 号 -1 | 粤公网安备 44011302003646 号 | 点击查看十年之约
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式