javascript - Web API : error integer codes or error strings?中返回错误

Question

我有一个关于在Web API中返回错误的问题。通常从javascript(网站)调用此Web API。
返回错误有两种可能性，一种是将它们作为字符串返回，另一种是将它们作为整数错误代码返回。

返回错误作为错误代码的JSON示例:

{
    "status" : "Error",
    "error"  : 30
}

以错误字符串返回错误的JSON示例:

{
    "status" : "Error",
    "error"  : "ERR_INVALID_FILENAME"
}

您认为最好的方法是什么？我认为错误字符串的选择更好，原因如下:

错误字符串选项通过引入自我注释代码来提高代码的可读性和可维护性。
由于使用错误代码方法时，javascript开发人员将编写:
if (result.error == 30) { do something related to files and invalidness...}
在错误字符串方法中，javascript开发人员会这样写:
if (result.error == "ERR_INVALID_FILENAME") { do something related to files and invalidness...}

在总体方案，浏览器渲染，HTML dom操作和AJAX HTTP请求处理中，

很少出现错误字符串检查，这是微不足道的开销。尽管在C++或C#应用程序中，我们显然会使用枚举，但在两个独立的实体(例如Web api和网站)中却没有这样的选择，而且成本 yield 似乎是合理的。

感谢您的输入。

Answer 1

我对多个请求有相同的错误消息，也许您可​​以对某种错误枚举，字典甚至列表使用某种structutre(如果需要多语言)。

您可以从错误代码到消息(甚至类型，级别)进行某种转换。在许多情况下，您将需要更多的信息，而不仅仅是一条消息:也许您会收到一条友好的消息和一条调试消息，也许您需要某种类型的消息来说这是阻塞的msg，但这仅是警告。

您可以将错误作为字符串发送给客户端，并且json的大小会增加(取决于按摩长度)，或者您可以在js中预加载错误映射并将代码转换为消息，消息是否会更小(再次取决于)，但是您的客户端将努力做到这一点。移至js时，请注意浏览器的内存限制。