如何在json中产生错误响应

Question

我正在编写一个 Restful Webservice Impl，我通过注释 @Produces("application/json") 以 JSON 格式消费和产生响应。我也在产生 JSON 响应。这里正在处理具有错误代码和错误消息的类的异常。当出现异常时，它不会以application/json 格式生成。我使用ExceptionMapper 找到了解决方案，但它是`text/plain 格式。

sn-p

public Class Confiuration{
    @Path("getData")
    @Consumes("application/json")
    @Produces("application/json")
    public JSONGetDataResponseVo getData(GetDataRequestVo datarequestVO)
                                                          throws FaultResponse {
        JSONGetDataResponseVo response=new JSONGetDataResponseVo ();
        DataServiceValidator.validateGetConfigurationAndDataRequest(datarequestVO);
        ....
        ....
        }catch(ApplicationException applicationException){
            throw new FaultResponse(applicationException,locale);
        }  
}

故障响应映射器

@Provider
public class FaultResponseMapper implements ExceptionMapper<FaultResponse> {

    @Context
    private HttpHeaders headers;

    public Response toResponse(FaultResponse faultResponse) {
        return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
                .entity(faultResponse).type(MediaType.APPLICATION_JSON).build();
    }

}

应用程序异常

public abstract class ApplicationException extends Exception{

    private java.lang.String errorCode;

    public ApplicationException(String errorCode, String message) {
        super(message);
        this.errorCode = errorCode;
    }


    public ApplicationException(String message) {
        super(message);
    }



    public java.lang.String getErrorCode() {
        return this.errorCode;
    }


    public abstract String getLocaleMessage(Locale locale);

}

故障响应

public class FaultResponse extends WebApplicationException {

    private String errorCode;
    private String errorMessage;
    private String localErrorMessage;

    public FaultResponse(String errorCode, String errorMessage,
            String localErrorMessage) {
        this.errorCode = errorCode;
        this.errorMessage = errorMessage;
        this.localErrorMessage = localErrorMessage;
    }

    public FaultResponse(ApplicationException applicationException,
            Locale locale) {
        this.errorCode = applicationException.getErrorCode();
        this.errorMessage = applicationException.getMessage();
        if (locale != null
                && applicationException.getLocaleMessage(locale) != null) {
            this.localErrorMessage = applicationException
                    .getLocaleMessage(locale);
        } else {
            this.localErrorMessage = applicationException.getMessage();
        }
    }
}

那么我怎样才能以 JSON 格式生成我的 faultResponse。

Answer 1

这与您返回异常作为响应的事实有关。我会

1. 为ApplicationException 制作异常映射器。
2. 重构 FaultResponse 以不扩展和异常。只需在映射器中创建即可。
3. 要查看响应，您需要发送除“无内容”以外的状态。你不能有一个身体在里面。发送错误请求之类的内容。
4. 您可以将资源方法声明为throws ApplicationException。您无需抓住它并重新投掷。

我已经进行了这些更改，并且效果很好。

---

更新：完整测试

向FaultResponse 添加了getter（编组所需）并删除了异常扩展

public class FaultResponse {
    ...
    public String getErrorCode() { return errorCode; }
    public String getErrorMessage() { return errorMessage; }
    public String getLocalErrorMessage() { return localErrorMessage; }
    ...
}

为测试和ApplicationException 实现创建了一个服务

public class ApplicationExceptionImpl extends ApplicationException { 
    public ApplicationExceptionImpl(){
        this("400", "Bad Request");
    }

    public ApplicationExceptionImpl(String errorCode, String message) {
        super(errorCode, message);
    }

    @Override
    public String getLocaleMessage(Locale locale) {
        return "Bad Request";
    }  
}

public class FaultService {
    public void doSomething() throws ApplicationException {
        throw new ApplicationExceptionImpl();
    }
}

资源类

@Path("fault")
public class FaultResource {
    
    FaultService service = new FaultService();
    
    @GET
    public Response getException() throws ApplicationException {
        service.doSomething();
        return Response.ok("Cool").build();
    }
}

异常映射器

@Provider
public class ApplicationExceptionMapper implements ExceptionMapper<ApplicationException> {

    @Override
    public Response toResponse(ApplicationException exception) {
        FaultResponse response = new FaultResponse(exception, Locale.ENGLISH);
        return Response.status(Response.Status.BAD_REQUEST)
                .entity(response).type(MediaType.APPLICATION_JSON).build();
    }  
}

ApplicationException 类保持不变

curl -v http://localhost:8080/api/fault
{"errorCode":"400","errorMessage":"Bad Request","localErrorMessage":"Bad Request"}

如果在此之后您仍然看不到 JSON，可能是您没有配置提供程序。如果是这种情况，请显示您的应用程序配置以及您的项目依赖项。