SpringMVC内容协商

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));
       }
   
       @Override
       protected boolean supports(Class<?> clazz) {
           return true;
       }
   
       @Override
       protected Object readInternal(Class<?> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
           return null;
       }
   
       @Override
       protected 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 {
       @Override
       public 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