Spring RestTemplate 解析自定义错误响应

Question

给定一个 REST 服务调用

http://acme.com/app/widget/123

返回：

<widget>
  <id>123</id>
  <name>Foo</name>
  <manufacturer>Acme</manufacturer>
</widget>

此客户端代码有效：

RestTemplate restTemplate = new RestTemplate();
XStreamMarshaller xStreamMarshaller = new XStreamMarshaller();
xStreamMarshaller.getXStream().processAnnotations(
    new Class[] { 
        Widget.class,
        ErrorMessage.class
    });

HttpMessageConverter<?> marshallingConverter = new MarshallingHttpMessageConverter(
    xStreamMarshaller, xStreamMarshaller);

List<HttpMessageConverter<?>> converters = new ArrayList<HttpMessageConverter<?>>();
    converters.add(marshallingConverter);

restTemplate.setMessageConverters(converters);

Widget w = restTemplate.getForObject(
    "http://acme.com/app/widget/{id}", Widget.class, 123L);

但是，调用 http://acme.com/app/widget/456 会返回：

<error>
    <message>Widget 456 does not exist</message>
    <timestamp>Wed, 12 Mar 2014 10:34:37 GMT</timestamp>
</error>

但是这个客户端代码抛出异常：

Widget w = restTemplate.getForObject(
    "http://acme.com/app/widget/{id}", Widget.class, 456L);

org.springframework.web.client.HttpClientErrorException: 404 Not Found

我试过了：

try {
    Widget w = restTemplate.getForObject(
       "http://acme.com/app/widget/{id}", Widget.class, 456L);
}
catch (HttpClientErrorException e) {
    ErrorMessage errorMessage = restTemplate.getForObject(
       "http://acme.com/app/widget/{id}", ErrorMessage.class, 456L);

   // etc...
}

第二次调用只是抛出了另一个 HttpClientErrorException，而且两次调用服务感觉不对。

有没有办法调用一次服务并将响应解析为成功时的 Widget 和未找到时的 ErrorMessage？

Answer 1

我在 Spring 库中也发现这是一个令人不安的变化。您曾经能够抛出 ResponseStatusException 并将 HttpStatus 代码和自定义消息传递给它，然后捕获 HttpClientErrorException 并简单地打印 getMessage() 以查看自定义错误。这不再有效。为了打印自定义错误，我必须在 HttpClientErrorException 上将 ResponseBody 捕获为字符串，getResponseBodyAsString。然后我需要把它解析为一个字符串，做一些非常狡猾的子字符串操作。这样做会从 ResponseBody 中去除信息，并给出我的服务器发送的消息。执行此操作的代码如下：

String message = hce.getResponseBodyAsString();
int start, end;
start =  message.lastIndexOf(":", message.lastIndexOf(",")-1) + 2;
end = message.lastIndexOf(",") -1;
message = message.substring(start, end);
System.out.println(message);

当我使用 ARC 或 Postman 进行测试时，在我将 server.error.include-message=always 添加到服务器上的 application.properties 文件后，它们可以显示正确的消息。我不确定他们使用什么方法来提取消息，但很高兴知道。

Answer 2

如果您愿意，也可以从错误响应正文创建一个对象：

ObjectMapper om = new ObjectMapper();
String errorResponse = ex.getResponseBodyAsString();

MyClass obj = om.readValue(errorResponse, MyClass.class);

Answer 3

由于您已经捕获了 HttpClientErrorException 对象，它应该允许您轻松提取有关错误的有用信息并将其传递给调用者。

例如：

try{
    <call to rest endpoint using RestTemplate>
} catch(HttpClientErrorException e){
    HttpStatus statusCode = e.getStatusCode();
    String body = e.getResponseBodyAsString();
}

IMO 如果需要进一步将错误消息 body 反序列化为某个相关对象，则可以在 catch 语句范围之外的某处进行处理。

Answer 4

根据我的评论，我检查了HttpClientErrorException JavaDoc，它确实支持设置/获取statusText 以及responseBody。但是它们是可选的，RestTemplate 可能不会填充它们 - 您需要尝试以下操作：

try {
    Widget w = restTemplate.getForObject(
       "http://acme.com/app/widget/{id}", Widget.class, 456L);
}
catch (HttpClientErrorException e) {
    String responseBody = e.getResponseBodyAsString();
    String statusText = e.getStatusText();
    // log or process either of these...
    // you'll probably have to unmarshall the XML manually (only 2 fields so easy)
}

如果它们都是空/null，那么您可能必须扩展所涉及的 RestTemplate 类并自己填充这些字段和/或在 Spring 站点上提出 Jira 问题。