CXF/JAX-RS：从拦截器返回自定义响应

Question

REST 调用过程中发生异常时，我们需要返回自定义错误代码和错误消息。我们创建了一个异常映射器提供程序，它适用于应用程序代码中的异常。但是，当 CXF 代码发生异常时它不起作用（例如，形成我编写的 CustomValidationInterceptor）。

例如，如果我使用无效的路径参数（例如无效的电话号码）请求。在这种情况下，我们需要以 JSON 格式返回自定义错误代码和错误消息，但即使我们创建了一个异常映射器提供程序来处理 WebApplicationException，它也不起作用。

有什么方法可以处理来自 cxf 拦截器的异常并返回 以类似以下的方式回应用户？

{
"errorDetail": {
"errorCode": "404",
"errorMessage": "Bad Request"
}
}

我的 CustomValidationInterceptor 的代码片段：

public class CustomValidationInterceptor extends AbstractPhaseInterceptor<Message>{

    public CustomValidationInterceptor() {
        super(Phase.PRE_INVOKE); // Put this interceptor in this phase
    }

    public void handleMessage(Message message) {

        MetadataMap<String, String> metadataMap = (MetadataMap<String, String>) message.get("jaxrs.template.parameters");

        if(null != metadataMap) {
            List<String> list = metadataMap.get("phoneNumber");
            if(null != list) {
                String phoneNumber = list.get(0);
                boolean result = validatePhoneNumber(phoneNumber);
                if(!result){
                    throw new TelusServiceException(Response.status(Response.Status.BAD_REQUEST).build(), 400, "phone number not valid");
                }
            } else {
                throw new TelusServiceException(Response.status(Response.Status.BAD_REQUEST).build(), 400, "phone number not valid");
            }
        } else {
            throw new TelusServiceException(Response.status(Response.Status.BAD_REQUEST).build(), 400, "phone number not valid");
        }
    }

    public boolean validatePhoneNumber(String phoneNumber) {

          Pattern pattern = Pattern.compile("^[1-9]\\d{9}$");
          Matcher matcher = pattern.matcher(phoneNumber);

          if (!matcher.matches()) {
              return false;
          }
          return true;
     }

}

我的自定义异常映射器提供程序的代码片段

public class TelusExceptionHandler implements ExceptionMapper<TelusServiceException> {

    public Response toResponse(TelusServiceException exception) {
        return Response.status(exception.getErrorDetail().getErrorCode()).entity(exception.getErrorDetail()).build();
    }

}

TelusServiceException 的代码片段

public class TelusServiceException extends WebApplicationException{

// constructors and other methods 

    private ErrorDetail errorDetail = null;

        public ErrorDetail getErrorDetail() {
        return errorDetail;
    }

    public void setErrorDetail(ErrorDetail errorDetail) {
        this.errorDetail = errorDetail;
    }

      public TelusServiceException(Response response, int errorCode, String errorMessage) {
        super(response);

        errorDetail = new ErrorDetail();
        errorDetail.setErrorCode(errorCode);
        errorDetail.setErrorMessage(errorMessage);
    }

}

ErrorDetail 类的代码片段

@XmlRootElement(name="errorDetail")
public class ErrorDetail {

    private int errorCode;
    private String errorMessage;

    @XmlElement(name = "errorCode")
    public int getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(int errorCode) {
        this.errorCode = errorCode;
    }
    @XmlElement(name = "errorMessage")
    public String getErrorMessage() {
        return errorMessage;
    }

    public void setErrorMessage(String errorMessage) {
        this.errorMessage = errorMessage;
    }

}

Answer 1

我找到了一种从拦截器发送自定义响应的方法，但仍然无法找到从拦截器调用我的 CustomExceptionHandler 的方法

代码：

public void handleMessage(Message message) {

        MetadataMap<String, String> metadataMap = (MetadataMap<String, String>) message.get("jaxrs.template.parameters");

        if(null != metadataMap) {
            List<String> list = metadataMap.get("phoneNumber");
            if(null != list) {
                String phoneNumber = list.get(0);
                boolean result = validatePhoneNumber(phoneNumber);
                if(!result){
// Create a response object and set it in the message. 
// calling getExchange() will not call your service
                    Response response = Response
                .status(Response.Status.BAD_REQUEST)
                .entity(new ErrorDetail(Response.Status.BAD_REQUEST.getStatusCode(), Response.Status.BAD_REQUEST.toString()))
                .build();
        message.getExchange().put(Response.class, response);
// That's it
                }
            } else {
                Response response = Response
                .status(Response.Status.BAD_REQUEST)
                .entity(new ErrorDetail(Response.Status.BAD_REQUEST.getStatusCode(), Response.Status.BAD_REQUEST.toString()))
                .build();
        message.getExchange().put(Response.class, response);
            }
        } else {
            Response response = Response
                .status(Response.Status.BAD_REQUEST)
                .entity(new ErrorDetail(Response.Status.BAD_REQUEST.getStatusCode(), Response.Status.BAD_REQUEST.toString()))
                .build();
        message.getExchange().put(Response.class, response);
        }
    }

Answer 2

我在 cxf 用户组上提出过类似的问题，见：

http://cxf.547215.n5.nabble.com/Handling-exceptions-in-a-JAX-RS-fault-interceptor-when-using-Local-Transport-td5733958.html

我最终用 ContainerRequestFilter 和 ContainerResponseFilter 替换了我的拦截器，然后异常映射器愉快地处理了应用程序异常和过滤器抛出的异常。

希望这会有所帮助。