SpringMVC 接口能返回 JSON 又能返回 XML

Myth丶恋晨 2022-09-11 06:12 166阅读 0赞

# 叙述 #

**我们有一个接口服务为下游的系统提供数据服务，本来好好的大家都愉快地传递JSON，非常和谐。可最近有个新需求去对接一个很老的系统，这倒是不算啥，可这个老系统数据不是以JSON传递的而是以XML传递的。**

**同事小王想了个馊主意，把原来的接口原版拷贝一遍统一把返回类型改成XML不就行了？嗯，接口路径需要占用一套，权限配置多了一套，还要额外维护一套代码，这主意太馊了。经过大家的研究发现了Spring MVC的某个机制可以满足需求。**

## 解决方案 ##

**在HTTP协议里，当客户端发起一个HTTP请求时，可以携带一个请求头`Accept`来告诉服务端，客户端可以接受哪些响应类型（MIME），可以是一个也可以是多个。现在前后端分离普遍使用这种：**

Accept:application/json

**对于Spring MVC框架来说接受到对应的`Accept`会根据一定的策略找到对应的****`HttpMessageConverter `****来处理响应数据的格式。因此我们只需要找到一个动态指定`Accept`的方法就行了。**

**听起来就很好理解，需要什么内容大家协商，共同解决问题。Spring MVC提供了一种被称作 ****内容协商**** 的机制，客户端在请求时声明需要的 ****MIME**** 类型，服务端只需要配置一些策略就是实现一个接口返回不同 ****MIME ****类型的数据格式，想要JSON返回JSON,想要XML返回XML。**

内容协商的配置由Spring MVC中的 **`ContentNegotiationManager `**负责，我们可以通过**`ContentNegotiationConfigurer `**配置它。

首先要在Spring MVC项目中加入Jackson的XML处理库：

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

**然后配置 ****`WebMvcConfigurer `****中的内容协商配置：**

@Configuration
    public class WebConfig implements WebMvcConfigurer {
        @Override
        public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
            configurer.favorParameter(true)
                    // 客户端请求url需要携带一个query参数 默认名称是 format
                    .parameterName("format")
                    // 如果不声明 该query参数 返回的是json  如果你想指定默认返回类型就需要声明
                    // .defaultContentType(MediaType.APPLICATION_XML)
                    .mediaType("xml", MediaType.APPLICATION_XML)
                    .mediaType("json", MediaType.APPLICATION_JSON);
        }
    }

**这样声明以后客户端请求接口中要携带一个query参数（参数名称默认为****`format`****，你可以修改它）来指定`MIME`的代号。**

**如果你需要返回JSON:**

https://yourapi?format=json

**你也可以不携带`format`参数，因为默认就是JSON，修改默认的MIME类型需要调用****`defaultContentType`****。**

**如果你需要返回XML:**

https://yourapi?format=xml

**服务端的接口也需要简单的改造：**

@GetMapping(value = "/get",produces = {"application/json","application/xml"})
        public Map<String, String> doGet(@RequestParam String foo, String bar) {
    
            Map<String, String> map = new HashMap<>();
            map.put("foo", foo);
            map.put("bar", bar);
            return map;
        }

**需要根据配置在`@RequestMapping`或其简化注解中声明对应的****`produce`****，这一点非常重要。这样我们改动的地方就非常的少了，能够适应更多的场景，而且维护起来也很简单。**