Spring mvc：将默认响应格式从 xml 更改为 json

Question

我已经解决了其他类似的问题，但对我没有任何帮助。

我所有的 API 都返回 JSON 作为响应默认情况下：

由于一些 XML API，我不得不添加 jackson-xml

    <dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
    </dependency>

现在默认为“不带接受头”所有响应都是 XML。

我希望将 JSON 作为默认响应格式。

如文档中所述：

https://spring.io/blog/2013/05/11/content-negotiation-using-spring-mvc

我实现了以下配置：

@Override
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        configurer.favorPathExtension(false).favorParameter(true).parameterName("mediaType").ignoreAcceptHeader(true)    
                .useJaf(false).defaultContentType(MediaType.APPLICATION_JSON)
                .mediaType("xml", MediaType.APPLICATION_XML).mediaType("json", MediaType.APPLICATION_JSON);
    }

案例 1： 如果我创建 ignoreAcceptHeader(true)，那么一切都是 JSON，甚至 XML API 返回 JSON。

案例 2： 当ignoreAcceptHeader(false) 为默认值时为 XML。

我忘记提及我的 API 是这样的：

@RequestMapping(value = "/getXml", method = RequestMethod.GET)
public ResponseEntity<String> getXml( HttpServletRequest request)
        throws JAXBException {
    return returnXml();
}

我在这里很迷茫，我想要的只是默认（没有 AcceptHeader）应该是 JSON。 （API 将 XML 作为字符串返回）

当 Accept Header : "Application/xml" 被定义时，响应应该是 XML。

任何建议都会有很大帮助。

谢谢。

Answer 1

由于您已将 ignoreAcceptHeader 设置为 true 并将喜爱路径扩展设置为 false，因此 spring 将依赖其他替代方案进行内容协商。意味着它将查看您已配置 XML 和 JSON 的 URL 参数

所以@stan 指出 /getXml?mediaType=xml 应该返回 xml 响应，否则它将默认为 json(defaultContentType(MediaType.APPLICATION_JSON))

Answer 2

一般来说，如果你想获得 json 响应，你需要一个 jackson-databind 模块：

<dependency> 
    <groupId>com.fasterxml.jackson.core</groupId> 
    <artifactId>jackson-databind</artifactId> 
    <version>${json-jackson-version}</version> 
</dependency> 

然后你必须在你的配置中定义一个MappingJackson2HttpMessageConverter：

@Configuration
@EnableWebMvc
public class WebAppMainConfiguration extends WebMvcConfigurerAdapter {

    @Override 
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) { 
        converters.add(new MappingJackson2HttpMessageConverter());

        [..] 
        super.configureMessageConverters(converters); 
    }

    [...]
}

在您的情况下，您可以实现自己的AbstractGenericHttpMessageConverter，以便您可以根据媒体类型在不同的具体转换器之间切换此转换器。

检查方法AbstractGenericHttpMessageConverter#writeInternal(..)

Answer 3

对我来说，添加

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

    @Override
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        configurer.defaultContentType(MediaType.APPLICATION_JSON_UTF8);
    }

}

解决了问题。

如果请求中没有 Accept 标头，现在默认情况下所有 RestControllers 都返回 JSON。 此外，如果 Accept: application/xml 标头被传递，则结果为 XML。

另外，值得一读：https://spring.io/blog/2013/05/11/content-negotiation-using-spring-mvc