Spring-boot 从控制器返回 json 和 xml

Question

我有一个 spring-boot 1.1.7 应用程序，它在大部分 UI 中使用 Thymeleaf，所以我的控制器的响应并不是一个真正的问题。但是，现在我需要在用户通过 URL 提交请求时提供 XML 响应。

这是一个典型的请求：

http://localhost:9001/remote/search?sdnName=Victoria&address=123 Maple Ave

这是我的大部分 gradle 配置：

project.ext {
    springBootVersion = '1.1.7.RELEASE'
}

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web:$springBootVersion")
    compile("org.springframework.boot:spring-boot-starter-thymeleaf")
    compile("org.springframework.boot:spring-boot-starter-security")
    compile("org.springframework.boot:spring-boot-starter-data-jpa:$springBootVersion")
    compile("org.springframework.security:spring-security-web:4.0.0.M1")
    compile("org.springframework.security:spring-security-config:4.0.0.M1")
    compile('org.thymeleaf.extras:thymeleaf-extras-springsecurity3:2.1.1.RELEASE')
    compile("org.springframework.boot:spring-boot-starter-actuator")
    compile('com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.5.0')
}

这是我的控制器：

@Controller
public class RemoteSearchController {

    @Autowired
    private SdnSearchService sdnSearchService;

    @RequestMapping(value = "/remote/search", method = RequestMethod.GET, produces = MediaType.APPLICATION_XML_VALUE)
    public List<Sdn> search(@ModelAttribute SdnSearch sdnSearch) {
        List<Sdn> foundSdns = sdnSearchService.find( sdnSearch );
        return foundSdns;
}

这是我要返回的对象：

@Entity
public class Sdn {

    @Id
    private long entNum;
    private String sdnName;
...
//getters & setters here
}

我能够通过 REST 客户端（例如 CocoaREST）接收请求并进行处理。但是当我返回 SDN 列表时，我得到以下异常，即使我的类路径上有 Jackson 和 jackson-dataformat-xml：

org.springframework.web.HttpMediaTypeNotAcceptableException: Could not find acceptable representation
    at org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping.handleNoMatch(RequestMappingInfoHandlerMapping.java:229)
    at org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.lookupHandlerMethod(AbstractHandlerMethodMapping.java:301)
    at org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getHandlerInternal(AbstractHandlerMethodMapping.java:248)
    at org.springframework.web.servlet.handler.AbstractHandlerMethodMapping.getHandlerInternal(AbstractHandlerMethodMapping.java:57)
    at org.springframework.web.servlet.handler.AbstractHandlerMapping.getHandler(AbstractHandlerMapping.java:299)

我的 REST 客户端包含一个“text/xml”的接受标头（但老实说，我希望他们不必设置它。理想情况下，无论标头是否存在，对该控制器的任何调用都将始终获得 XML）。

有没有办法解决这个问题？我认为媒体转换器已包含在内，只是返回了控制器告诉他们的任何内容？

解决方案： 请参阅下面的我发布的答案。

Answer 1

我遇到了完全相同的问题，我在 Spring 文档网站上找到了解决方案：here

在综合中，我在我的项目的pom.xml 中添加了以下依赖项：

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

然后我将以下代码块添加到服务必须返回的类中：

 import javax.xml.bind.annotation.XmlRootElement;

 @XmlRootElement
 public class Greeting {...}

它奏效了。

Answer 2

解决方案：我使用了以下两个答案的组合（非常感谢！）。我在这里发帖以防其他人需要帮助。

我修改后的控制器：

@Controller
public class RemoteSearchController {

    @Autowired
    private SdnSearchService sdnSearchService;

    @RequestMapping(value = "/remote/search", method = RequestMethod.GET, produces = { "application/xml", "text/xml" }, consumes = MediaType.ALL_VALUE )
    @ResponseBody
    public SdnSearchResults search(@ModelAttribute SdnSearch sdnSearch) {
        List<Sdn> foundSdns = sdnSearchService.find( sdnSearch );
        SdnSearchResults results = new SdnSearchResults();
        results.setSdns( foundSdns );
        return results;
    }
}

在我的客户端上，我设置了请求标头：

内容类型：应用程序/文本 接受：文本/xml 我认为最终的问题是我的客户端标头设置不正确，因此我可能不必进行其中一些更改。但我喜欢包含结果列表的 SearchResults 类的想法：

@XmlRootElement
public class SdnSearchResults {
    private List<Sdn> sdns;
...
}

Answer 3

创建一个新类可能会更好：

public class SdnSearchResult {
  private List<Sdn> sdns;
  ...
}

然后，需要对现有类进行如下轻微更改：

public interface SdnSearchService {
  SdnSearchResult find(SdnSearch sdnSearch);
}

@Controller
public class UISearchController {
  @Autowired
  private SdnSearchService sdnSearchService;

  @RequestMapping("/search")
  public ModelAndView search(@ModelAttribute SdnSearch sdnSearch) {
    return new ModelAndView("pages/search/results", "sdns", sdnSearchService.find(sdnSearch).getSdns());
  }
}

一旦完成，另一个控制器必须编码为：

@Controller
public class RemoteSearchController {
  @Autowired
  private SdnSearchService sdnSearchService;

  @RequestMapping("/remote/search")
  @ResponseBody
  public SdnSearchResult search(@RequestBody SdnSearch sdnSearch) {
    return sdnSearchService.find(sdnSearch);
  }
}

对代码更改的简要说明：

1. @RequestBody 将自动将整个 HTTP 请求正文反序列化为 SdnSearch 实例。外部应用程序通常会将请求数据作为 HTTP 正文提交，因此@RequestBody 将确保自动反序列化为 Java 对象。
2. @ResponseBody 将根据外部客户端的能力和类路径上可用的库自动序列化返回值。如果 Jackson 在类路径上可用并且客户端已指示他们可以接受 JSON，则返回值将自动作为 JSON 发送。如果 JRE 是 1.7 或更高版本（这意味着 JRE 中包含 JAXB）并且客户端已指示他们可以接受 XML，则返回值将自动以 XML 形式发送。
3. List<Sdn> 需要更改为 SdnSearchResult 以确保应用程序可以使用单个控制器方法交换 JSON、XML、RSS 和 ATOM 格式，因为 XML（和基于 XML 的格式）需要在输出中使用根标签，这List<Sdn> 无法翻译成。

完成这些更改后，启动 REST 客户端（例如 Chrome 的 Postman 扩展程序）并向 /remote/search 提交请求，并提供以下信息：

1. 请求标头Accepts设置为application/json。
2. 请求标头Content-Type 设置为application/json。
3. 请求正文设置为 JSON 字符串 { "sdnName" : "Victoria", "address" : "123 Maple Ave" }。

这会给你一个 JSON 响应。

Answer 4

您已将控制器方法标记为产生 application/xml 响应 (produces = MediaType.APPLICATION_XML_VALUE)。请求的接受标头 (Accept: text/xml) 不匹配，因此 Spring 确定您的 search 方法无法处理该请求。

根据您的具体要求，有几种不同的方法可以在服务器上解决此问题：

• 您可以完全删除 produces 属性
• 您可以指定多种媒体类型：produces = { "application/xml", "text/xml" }

Answer 5

非常简单，只需在 pom.xml 文件中添加 jackson-dataformat-xml 依赖项，然后您的项目就可以处理 xml/json 请求或响应。添加

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

依赖并添加标题内容类型或根据您的需要接受spring boot将处理json/xml中的请求或响应。全文访问：How to handle xml/json in spring boot

Answer 6

我不确定您的 Spring Boot (1.1.7.RELEASE) 版本，但我使用的是 1.5.2.RELEASE 版本，并且此 xml 转换/序列化自动发生，无需使用任何 jackson 依赖项，如少数答案。

我猜这是因为org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter 是自 Spring Boot 版本 1.5.1.RELEASE 以来自动配置的，并且该转换器使用 JRE 的默认 JAXB 实现（因此不需要显式的 xml 转换依赖项）。

其次，客户端在请求中设置的Accept标头决定了预期的输出格式，因此如下所示的请求映射（即单个端点），

@RequestMapping(method = RequestMethod.GET, value = "/remote/search", produces = {
        MediaType.APPLICATION_JSON_VALUE, MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE })

可用于生成 xml 和 JSON 响应（如果 Accept 标头分别设置为 text/xml 或 application/xml 和 application/json。

注意 1：如果 Java 类需要 xml 响应，则需要在根类上指定 javax.xml.bind.annotation.XmlRootElement。这是强制性的。

注意 2：Jackson for json 已经包含在 Spring Boot 中，因此不会明确包含在 json 输出中

注 3：接受标头 - 输出 匹配由框架自动发生，开发人员无需为此编写任何特定代码。

因此，在我看来，如果您只将XmlRootElement 添加到您的基类并升级您的 Spring Boot 版本，那么您的服务器端已经准备就绪。设置正确的 Accept 标头的责任在于客户。

Answer 7

除了 Michael 在他的 answer 中所说的之外，我还在 pom.xml 中添加了以下依赖项

<dependency>
    <groupId>org.codehaus.woodstox</groupId>
    <artifactId>woodstox-core-asl</artifactId>
    <version>4.4.1</version>
</dependency>

由于某种原因，单独的 jackson-dataformat-xml 没有帮助。 我还确保在 get 调用中返回了 ResponseEntity，并从 RequestMapping 注释中删除了produces=MediaType。

通过这些更改，我能够获得正确的数据，但我必须在 get 调用期间将 mime 类型的扩展名提供给 REST URL。即，在浏览器中明确指定为：http://localhost:8080/hello.xml 或 http://localhost:8080/hello.json

Answer 8

在我的例子中，我想返回一个格式化的 XML 字符串，并将其全部合并到一行中。

将produces = { "application/xml", "text/xml" } 添加到请求映射中足以将字符串作为格式化的 XML（带缩进）返回。

示例：

@RequestMapping(method= RequestMethod.GET, value="/generate/{blabla}", produces = { "application/xml", "text/xml" })
    public String getBlaBla(@PathVariable("param") String param) throws IOException {
}

祝你好运。