Question

我开始在JAX-RS中使用新的客户端API库，并且到目前为止真的非常喜欢它。我找到了一件我无法弄清楚的事情。我使用的API有一个自定义错误消息格式，例如：

{
    "code": 400,
    "message": "This is a message which describes why there was a code 400."
}

它返回400作为状态代码，但还包含一条描述性错误消息，告诉您错误。

然而，JAX-RS 2.0客户端正在将400状态重新映射到通用的状态，并且我丢失了良好的错误消息。它正确地将它映射到BadRequestException，但是使用了泛型＆＃34; HTTP 400 Bad Request＆＃34;消息。

javax.ws.rs.BadRequestException: HTTP 400 Bad Request
    at org.glassfish.jersey.client.JerseyInvocation.convertToException(JerseyInvocation.java:908)
    at org.glassfish.jersey.client.JerseyInvocation.translate(JerseyInvocation.java:770)
    at org.glassfish.jersey.client.JerseyInvocation.access$500(JerseyInvocation.java:90)
    at org.glassfish.jersey.client.JerseyInvocation$2.call(JerseyInvocation.java:671)
    at org.glassfish.jersey.internal.Errors.process(Errors.java:315)
    at org.glassfish.jersey.internal.Errors.process(Errors.java:297)
    at org.glassfish.jersey.internal.Errors.process(Errors.java:228)
    at org.glassfish.jersey.process.internal.RequestScope.runInScope(RequestScope.java:424)
    at org.glassfish.jersey.client.JerseyInvocation.invoke(JerseyInvocation.java:667)
    at org.glassfish.jersey.client.JerseyInvocation$Builder.method(JerseyInvocation.java:396)
    at org.glassfish.jersey.client.JerseyInvocation$Builder.get(JerseyInvocation.java:296)

是否存在可以注入的某种拦截器或自定义错误处理程序，以便我可以访问真正的错误消息。我一直在查看文档，但看不到任何方法。

我现在正在使用Jersey，但我尝试使用CXF并得到了相同的结果。这是代码的样子。

Client client = ClientBuilder.newClient().register(JacksonFeature.class).register(GzipInterceptor.class);
WebTarget target = client.target("https://somesite.com").path("/api/test");
Invocation.Builder builder = target.request()
                                   .header("some_header", value)
                                   .accept(MediaType.APPLICATION_JSON_TYPE)
                                   .acceptEncoding("gzip");
MyEntity entity = builder.get(MyEntity.class);

更新：

我实施了以下评论中列出的解决方案。它略有不同，因为类在JAX-RS 2.0客户端API中有所改变。我仍然认为默认行为是提供一般错误消息并丢弃真实错误消息是错误的。我理解为什么它不会解析我的错误对象，但应该返回未解析的版本。我最终得到了库已经执行的复制异常映射。

感谢您的帮助。

这是我的过滤器类：

@Provider
public class ErrorResponseFilter implements ClientResponseFilter {

    private static ObjectMapper _MAPPER = new ObjectMapper();

    @Override
    public void filter(ClientRequestContext requestContext, ClientResponseContext responseContext) throws IOException {
        // for non-200 response, deal with the custom error messages
        if (responseContext.getStatus() != Response.Status.OK.getStatusCode()) {
            if (responseContext.hasEntity()) {
                // get the "real" error message
                ErrorResponse error = _MAPPER.readValue(responseContext.getEntityStream(), ErrorResponse.class);
                String message = error.getMessage();

                Response.Status status = Response.Status.fromStatusCode(responseContext.getStatus());
                WebApplicationException webAppException;
                switch (status) {
                    case BAD_REQUEST:
                        webAppException = new BadRequestException(message);
                        break;
                    case UNAUTHORIZED:
                        webAppException = new NotAuthorizedException(message);
                        break;
                    case FORBIDDEN:
                        webAppException = new ForbiddenException(message);
                        break;
                    case NOT_FOUND:
                        webAppException = new NotFoundException(message);
                        break;
                    case METHOD_NOT_ALLOWED:
                        webAppException = new NotAllowedException(message);
                        break;
                    case NOT_ACCEPTABLE:
                        webAppException = new NotAcceptableException(message);
                        break;
                    case UNSUPPORTED_MEDIA_TYPE:
                        webAppException = new NotSupportedException(message);
                        break;
                    case INTERNAL_SERVER_ERROR:
                        webAppException = new InternalServerErrorException(message);
                        break;
                    case SERVICE_UNAVAILABLE:
                        webAppException = new ServiceUnavailableException(message);
                        break;
                    default:
                        webAppException = new WebApplicationException(message);
                }

                throw webAppException;
            }
        }
    }
}

Answer 1

我相信你想做这样的事情：

Response response = builder.get( Response.class );
if ( response.getStatusCode() != Response.Status.OK.getStatusCode() ) {
    System.out.println( response.getStatusType() );
    return null;
}

return response.readEntity( MyEntity.class );

你可以尝试的另一件事（因为我不知道这个API放在哪里 - 即在标题或实体中或者是什么）：

Response response = builder.get( Response.class );
if ( response.getStatusCode() != Response.Status.OK.getStatusCode() ) {
    // if they put the custom error stuff in the entity
    System.out.println( response.readEntity( String.class ) );
    return null;
}

return response.readEntity( MyEntity.class );

如果您希望通常将REST响应代码映射到Java异常，可以添加客户端过滤器来执行此操作：

class ClientResponseLoggingFilter implements ClientResponseFilter {

    @Override
    public void filter(final ClientRequestContext reqCtx,
                       final ClientResponseContext resCtx) throws IOException {

        if ( resCtx.getStatus() == Response.Status.BAD_REQUEST.getStatusCode() ) {
            throw new MyClientException( resCtx.getStatusInfo() );
        }

        ...

在上面的过滤器中，您可以为每个代码创建特定的异常，或者创建一个包装Response代码和实体的通用异常类型。

Answer 2

除了编写自定义过滤器之外，还有其他方法可以向Jersey客户端获取自定义错误消息。（虽然过滤器是一个很好的解决方案）

1）在HTTP标头字段中传递错误消息。 详细错误消息可能位于JSON响应和附加标头字段中，例如“x-error-message”。

服务器会添加HTTP错误标题。

ResponseBuilder rb = Response.status(respCode.getCode()).entity(resp);
if (!StringUtils.isEmpty(errMsg)){
    rb.header("x-error-message", errMsg);
}
return rb.build();

客户端捕获异常，在我的情况下是NotFoundException，并读取响应头。

try {
    Integer accountId = 2222;
    Client client = ClientBuilder.newClient();
    WebTarget webTarget = client.target("http://localhost:8080/rest-jersey/rest");
    webTarget = webTarget.path("/accounts/"+ accountId);
    Invocation.Builder ib = webTarget.request(MediaType.APPLICATION_JSON);
    Account resp = ib.get(new GenericType<Account>() {
    });
} catch (NotFoundException e) {
    String errorMsg = e.getResponse().getHeaderString("x-error-message");
    // do whatever ...
    return;
}

2）另一个解决方案是捕获异常并阅读响应内容。

try {
    // same as above ...
} catch (NotFoundException e) {
    String respString = e.getResponse().readEntity(String.class);
    // you can convert to JSON or search for error message in String ...
    return;
}

Answer 3

类WebApplicationException是为此而设计的，但由于某种原因，它会忽略并覆盖您指定的消息参数。

出于这个原因，我创建了自己的扩展WebAppException来尊重参数。它是一个单独的类，它不需要任何响应过滤器或映射器。

我更喜欢例外，而不是创建Response，因为它可以在处理时从任何地方抛出。

简单用法：

throw new WebAppException(Status.BAD_REQUEST, "Field 'name' is missing.");

班级：

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import javax.ws.rs.core.Response.Status.Family;
import javax.ws.rs.core.Response.StatusType;

public class WebAppException extends WebApplicationException {
    private static final long serialVersionUID = -9079411854450419091L;

    public static class MyStatus implements StatusType {
        final int statusCode;
        final String reasonPhrase;

        public MyStatus(int statusCode, String reasonPhrase) {
            this.statusCode = statusCode;
            this.reasonPhrase = reasonPhrase;
        }

        @Override
        public int getStatusCode() {
            return statusCode;
        }
        @Override
        public Family getFamily() {
            return Family.familyOf(statusCode);
        }
        @Override
        public String getReasonPhrase() {
            return reasonPhrase;
        }
    }

    public WebAppException() {
    }

    public WebAppException(int status) {
        super(status);
    }

    public WebAppException(Response response) {
        super(response);
    }

    public WebAppException(Status status) {
        super(status);
    }

    public WebAppException(String message, Response response) {
        super(message, response);
    }

    public WebAppException(int status, String message) {
        super(message, Response.status(new MyStatus(status, message)). build());
    }

    public WebAppException(Status status, String message) {
        this(status.getStatusCode(), message);
    }

    public WebAppException(String message) {
        this(500, message);
    }

}

Answer 4

以下为我工作

Response.status(Response.Status.BAD_REQUEST).entity(e.getMessage()).build();

Answer 5

对于任何绊脚石的人来说，这是一个更简洁的解决方案：

调用.get(Class<T> responseType)或将结果类型作为参数Invocation.Builder的任何其他方法将返回所需类型的值而不是Response。作为副作用，这些方法将检查收到的状态代码是否在2xx范围内，否则抛出适当的WebApplicationException。

来自documentation：

抛出：WebApplicationException，以防响应状态代码为服务器返回的响应不成功指定的响应类型不是响应。

这允许捕获WebApplicationException，检索实际的Response，将包含的实体作为异常详细信息（ApiExceptionInfo）处理并抛出适当的异常（ApiException）。

public <Result> Result get(String path, Class<Result> resultType) {
    return perform("GET", path, null, resultType);
}

public <Result> Result post(String path, Object content, Class<Result> resultType) {
    return perform("POST", path, content, resultType);
}

private <Result> Result perform(String method, String path, Object content, Class<Result> resultType) {
    try {
        Entity<Object> entity = null == content ? null : Entity.entity(content, MediaType.APPLICATION_JSON);
        return client.target(uri).path(path).request(MediaType.APPLICATION_JSON).method(method, entity, resultType);
    } catch (WebApplicationException webApplicationException) {
        Response response = webApplicationException.getResponse();
        if (response.getMediaType().equals(MediaType.APPLICATION_JSON_TYPE)) {
            throw new ApiException(response.readEntity(ApiExceptionInfo.class), webApplicationException);
        } else {
            throw webApplicationException;
        }
    }
}

ApiExceptionInfo是我的应用程序中的自定义数据类型：

import lombok.Data;

@Data
public class ApiExceptionInfo {

    private int code;

    private String message;

}

ApiException是我的应用程序中的自定义异常类型：

import lombok.Getter;

public class ApiException extends RuntimeException {

    @Getter
    private final ApiExceptionInfo info;

    public ApiException(ApiExceptionInfo info, Exception cause) {
        super(info.toString(), cause);
        this.info = info;
    }

}

Answer 6

[至少使用Resteasy] @Chuck M提供的基于ClientResponseFilter的解决方案有一个很大的缺点。

当您基于ClientResponseFilter使用它时，BadRequestException，NotAuthorizedException，...例外由javax.ws.rs.ProcessingException包装。

不得强制您的代理客户端捕获此javax.ws.rs.ResponseProcessingException异常。

没有过滤器，我们得到原始的休息异常。如果我们默认捕获并处理，则不会给我们太多帮助。

catch (WebApplicationException e) {
 //does not return response body:
 e.toString();
 // returns null:
 e.getCause();
}

当您从错误中提取描述时，可以在另一个级别上解决该问题。 WebApplicationException异常是所有其余异常的父级，包含javax.ws.rs。 .core.Response。只需编写一个辅助方法，以防万一WebApplicationException类型的异常，它也会检查响应主体。这是Scala中的代码，但是思路应该很清楚。方法返回对其余异常的清晰描述：

  private def descriptiveWebException2String(t: WebApplicationException): String = {
    if (t.getResponse.hasEntity)
      s"${t.toString}. Response: ${t.getResponse.readEntity(classOf[String])}"
    else t.toString
  }

现在，我们将责任转移给客户，以显示确切的错误。只需使用共享的异常处理程序以最大程度地减少客户端的工作量。

在JAX-RS 2.0客户端库中处理自定义错误响应

6 个答案: