私は現在、Web ベースの API を提供する新しいプロジェクトに取り組んでいます。もちろん、要求された操作が失敗し、API がこの失敗の理由について報告する必要がある場合は、多くの場合があります。
以前は、応答に数値のエラー コードとより人間にわかりやすいエラー メッセージが含まれている従来の方法を使用していましたが、エラー コード リストを維持し、コードと内部例外との間のマッピングを維持するのは少し面倒でした。
たとえば、例外名から生成されたシンボリック エラー コードを使用する方が便利かもしれないと考えました。
このアイデアには次の利点があります。
- 例外から数値へのマッピングは不要です。
- 同じエラー コードを異なるエラー タイプ (私の場合は例外) に割り当てることはできません。
- エラー コードは、API を単独で使用する開発者にとってより有益なものになります。
そして短所：
- カプセル化の観点から、例外名を公開することはあまり良い考えではないかもしれません。
- エラー コードは主に API クライアント アプリケーションでエラーの種類を判断するために使用されるため、文字列の比較にはコストがかかります。
- 中央の例外 -> errcode レジストリが不要になると、ドキュメント内の一部のエラー コードを見逃す可能性が高くなります。
では、記号エラー コードと数値エラー コードのどちらを使用するのがよいでしょうか。