如何在Cloud Endpoints中返回自定义错误代码？

Question

如此处所述https://cloud.google.com/appengine/docs/java/endpoints/exceptions Google Cloud Endpoints仅返回非常有限的http状态代码范围，即：

HTTP 400 BadRequestException
HTTP 401 UnauthorizedException
HTTP 403 ForbiddenException
HTTP 404 NotFoundException (also: Timeout)
HTTP 405
HTTP 408
HTTP 409 ConflictException
HTTP 410
HTTP 412
HTTP 413

Google建议使用现有状态代码返回自定义错误：

“在许多情况下，您可能希望使用常见的HTTP状态代码来指示用户的API请求是成功还是失败。例如，如果用户尝试检索不存在的实体，则可能希望发送HTTP 404状态码，表示不存在ID为EntityId的实体，您可以通过抛出端点库提供的异常来发送此类常见的HTTP状态码，如下所示：

String message = "No entity exists with ID: " + entityId;
throw new NotFoundException(message);

“

在同一文档中，Google进一步声明：

“任何其他HTTP 4xx代码将作为错误404返回”

这是什么问题？ 如果找不到我的实体，我会抛出404，但是Google也会为几乎所有其他出错的地方抛出404。

除了401、403和409（我可以用来告诉我的客户确切的错误是什么（授权，禁止或冲突））之外，对于其他所有状态代码，我需要分别使用400和404，结果是我的客户永远不知道到底是什么问题。

当然，我可以包括一条人类可读的错误消息，但这是针对服务器代码中发生的RuntimeException的，而不是告诉我的客户端它发送的数据有问题。

当然，我也可以使用错误描述的前几位来发送特定于应用程序的错误代码并发送通用的400 Bad Request，但是我想这不是应该这样做的方式。

任何输入表示赞赏。 您如何返回客户可以用来解决特定于应用程序的问题的特定于应用程序的错误代码？

Answer 1

阅读了以下内容和其他帖子

• http://archive.oreilly.com/pub/post/restful_error_handling.html
• 标准JSON API响应格式？

我几乎可以说Google的建议是错误的，因为http状态代码和应用程​​序代码之间没有明显的区别。 两者都发生在不同的层上，并且客户端无法告知是否发出了错误的请求，例如违反合同（例如，调用不存在的端点，本质上是运行时错误）或传递错误的ID（应用程序层）错误）。

文章提出了以下解决方案：

• 使用http错误代码：如上所述并非总是可能的
• 将应用程序错误添加为自定义响应标头：我不会选择它，因为它不会出现在日志中，这会使调试变得困难。
• 总是返回200并将结果包装在JSON中（就像sockets.io一样）：在端点上不可行

我提出了另一个解决方案，我承认这是一个折衷方案（实际上是违反错误消息），但是我认为这是将各个应用程序错误代码最合适地集成到Cloud Endpoints中的一种解决方案：

• 我扩展了400 BadRequestException，以便将任何错误消息作为JSON返回。 客户端仍然接收到HTTP状态代码400，但是它接收到的是JSON字符串，而不是String错误消息：

{“代码”：400，“消息”：“这是人类可读的错误消息。” }

这里有两个选项：或者返回代码400，这意味着客户端实际上违反了合同，这是BadRequestException，或者返回了客户端可以轻松解析和处理的任何其他应用程序特定代码。

我的ApplicationException看起来像这样（它使用了自定义的JSONizer，因此它对您不起作用，但是您可以使用JSONObject，GSON，Jackson等）：

import com.google.api.server.spi.response.BadRequestException;

public class ApplicationException extends BadRequestException {
    private static final int DEFAULT_APPLICATION_CODE = 400; // use this code for all requests without explicit code

    public ApplicationException(int code, String message) {
        super(JsonResponse.build()
                .add("code", code)
                .add("message", message)
                .toString());
    }
    public ApplicationException(String message) {
        super(JsonResponse.build()
                .add("code", DEFAULT_APPLICATION_CODE)
                .add("message", message)
                .toString());
    }
    public ApplicationException(String message, Throwable cause) {
        super(JsonResponse.build()
                .add("code", DEFAULT_APPLICATION_CODE)
                .add("message", message)
                .toString());
    }

}

我尚未将答案标记为正确，因为如果您认为有更好的方法可以继续发表进一步的建议和意见。