SpringMVC内容协商

news/2024/12/5 11:45:41/

SpringMVC内容协商主要的功能是:根据请求头或请求参数来控制接口返回的数据格式。通过HttpMessageConvert实现。

主要有两种控制接口返回格式的方式:

  • 通过accept请求头控制,在请求时加上accept头并制定返回格式。这种模式是默认开启的。
  • 通过format请求参数控制,这种默认关闭,如需开启需要修改配置文件配置。

SpringMVC内置了很多格式的转换器

//源码RequestMappingHandlerAdapter第360行有注入所有HttpMessageConverter
//常见的有
MappingJackson2HttpMessageConvert
MappingJackson2XmlHttpMessageConvert

我们可以利用这个功能来控制接口的返回格式。如:通过format控制接口返回xml

  1. 引入依赖

    <dependency><groupId>com.fasterxml.jackson.dataformat</groupId><artifactId>jackson-dataformat-xml</artifactId>
    </dependency>
    
  2. 开启参数模式

    #开启内容协商参数模式支持
    spring.mvc.contentnegotiation.favor-parameter=true
    #内容协商请求参数名(默认为format)
    spring.mvc.contentnegotiation.parameter-name=format
    
  3. 访问测试:http://localhost:8080/test?format=xml

新增返回类型

如果我们自己定义了一套前后端交互逻辑,可以新增一种接口的返回类型

  1. 编写转换类继承AbstractHttpMessageConverter

    public class MyYamlConverter extends AbstractHttpMessageConverter<Object> {private final ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory().disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER));public MyYamlConverter(){//告诉SpringBoot这个MessageConverter支持哪种媒体类型  此为yaml类型super(new MediaType("text", "yaml", StandardCharsets.UTF_8));}@Overrideprotected boolean supports(Class<?> clazz) {return true;}@Overrideprotected Object readInternal(Class<?> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {return null;}@Overrideprotected void writeInternal(Object methodReturnValue, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {try(OutputStream os = outputMessage.getBody()){this.objectMapper.writeValue(os,methodReturnValue);}}
    }
    
  2. 注册该配置类

    @Configuration
    public class WebConfigurer implements WebMvcConfigurer {@Overridepublic void extendMessageConverters(List<HttpMessageConverter<?>> converters) {converters.add(new MyYamlConverter());}
    }
    
  3. 配置配置文件

    #新增一种媒体类型,要和配置类对应上
    spring.mvc.contentnegotiation.media-types.yaml=text/yaml
    

    4.访问 http://localhost:8080/test?format=yaml


http://www.ppmy.cn/news/222846.html

相关文章

【Unity Shader】Unity前向渲染

unity前向渲染Pass ForwardBase Pass&#xff08;优先渲染&#xff09;&#xff0c;渲染一个逐像素平行光和所有的顶点/球面调和光&#xff0c;阴影只和平行光有关系&#xff0c;那阴影应该是这个Pass中实现的 ForwardAdd Pass&#xff08;需要和Base配合使用&#xff0c;否则…

港联证券|龙头齐聚,本周7股将申购!今年第三高价新股也要来了?

本周&#xff08;6月5日—6月9日&#xff09;&#xff0c;共有7只新股将进行申购&#xff0c;其中创业板5只&#xff08;康力源、飞沃科技、恒勃股份、威士顿、海看股份&#xff09;、科创板2只&#xff08;西高院、智翔金泰&#xff09;。 资料显示&#xff0c;康力源是国内健…

ABeam×Startup丨德硕管理咨询(深圳)创新研究团队拜访「超次元」,探索元宇宙

右一&#xff1a;超次元商务总监 卢佩瑜 左一、中&#xff1a;ABeam-SZ StartUp创新研究团队 ABeam旗下德硕管理咨询&#xff08;深圳&#xff09;有限公司&#xff08;以下简称“ABeam-SZ”&#xff09;创新研究团队一行前往广州&#xff0c;拜访了海南超次元数码科技有限公司…

联想笔记本 ThinkPad T440 Wifi无法联网的解决方法

操作系统 Windows Server 2008(r2) 64bit 一、确保已经安装了无线 Wifi 驱动 二、Win R 呼出运行窗口&#xff0c;输入 ServerManager.msc 1. 在服务器管理器中依次点击功能 - 在右边点击添加功能 2. 在功能添加向导中滚动条拉到最下面&#xff0c;勾选无线 LAN 服务&…

联想Lenovo M3410 驱动

联想Lenovo M3410 驱动是官方提供的一款一体机&#xff08;打印/扫描&#xff09;驱动&#xff0c;本站收集提供高速下载&#xff0c;用于解决一体机与电脑连接不了&#xff0c;无法正常使用的问题&#xff0c;本动适用于&#xff1a;Windows XP / Windows 7 / Windows 8 / Win…

记录联想Thinkpad s430添加内存条过程

添加内存条主要注意类型和频率即可&#xff0c;淘宝上都能买得到。第一次拆机&#xff0c;没搞懂怎么拆开&#xff0c;还是上网查看才明白。Thinkpad S430要敲开键盘才能拆开&#xff0c;看到内存硬盘CPU等。 总结一下这个过程: 查看笔记本原装内存条信息&#xff1b; 选购内存…

联想RS550服务器安装Ubuntu16.04

近日实验室采购了一批&#xff08;一个T_T&#xff09;SR550服务器&#xff0c;着手进行安装工作 2018/10/01 Lenovo ThinkSystem SR5502u机架式服务器 基本信息&#xff1a; 参数内容型号Lenovo ThinkSystem SR550处理器支持2个Intel Xeon Scalable系列处理器&#xff0c;功…

【框架源码】Spring源码解析之Bean生命周期流程

观看本文前&#xff0c;我们先思考一个问题&#xff0c;什么是Spring的bean的生命周期&#xff1f;这也是我们在面试的时候&#xff0c;面试官常问的一个问题。 在没有Spring之前&#xff0c;我们创建对象的时候&#xff0c;采用new的方式&#xff0c;当对象不在被使用的时候&…