ASP.NET Web API での即時エラー処理と累積エラー処理: どちらのアプローチが最適ですか?

ASP.NET Web API でのエラー処理のベスト プラクティス

ASP.NET Web API でのエラー処理のベスト アプローチについて疑問が生じます。エラーは、発生したらすぐに返されるべきですか?それとも蓄積されてまとめて返されるべきですか?

即時エラー処理

このメソッドでは、エラーは HttpResponseException オブジェクトとしてスローされ、その後の処理が直ちに停止されます。例:

public void Post(Customer customer)
{
    if (string.IsNullOrEmpty(customer.Name))
    {
        throw new HttpResponseException("Customer Name cannot be empty", HttpStatusCode.BadRequest); 
    }
    if (customer.Accounts.Count == 0)
    {
         throw new HttpResponseException("Customer does not have any account", HttpStatusCode.BadRequest); 
    }
}

即時エラー処理の長所:

• 実装が簡単
• エラーは即座にクライアントに通知される
• 不要なものを防ぐ処理

即時エラー処理の短所:

• 同じリクエストに対して複数の例外がスローされる可能性があります
• カスタムが必要各例外のエラー処理

累積エラー処理

このアプローチでは、エラーがリストに収集され、HttpResponseException オブジェクトとしてまとめて返されます。例:

public void Post(Customer customer)
{
    List<string> errors = new List<string>();
    if (string.IsNullOrEmpty(customer.Name))
    {
        errors.Add("Customer Name cannot be empty"); 
    }
    if (customer.Accounts.Count == 0)
    {
         errors.Add("Customer does not have any account"); 
    }
    var responseMessage = new HttpResponseMessage<List<string>>(errors, HttpStatusCode.BadRequest);
    throw new HttpResponseException(responseMessage);
}

累積エラー処理の長所:

• すべてのエラーの包括的なリストを提供します
• カスタム エラーを許可します中央で処理するlocation

累積エラー処理の短所:

• 実装がより複雑になる可能性がある
• クライアントがエラーを受信するのが遅れる可能性がある情報
• エラーが大きい場合は追加の帯域幅が必要ですlists

推奨事項

即時エラー処理と累積エラー処理のどちらを選択するかは、アプリケーションの要件によって異なります。単純なシナリオの場合は、即時のエラー処理で十分です。より複雑なシナリオの場合は、累積エラー処理の方が適している可能性があります。

更新

この質問が回答されて以来、いくつかのブログ投稿でこのトピックが取り上げられています。以下を含む:

• https://weblogs.asp.net/fredriknormen/asp-net-web-api-Exception-handling
• https://learn.microsoft.com/archive/blogs/youssefm/error-handling-in-asp-net-webapi

最近プラクティス

現在のエラー処理プラクティスには、次のものが含まれます。

• 一般的なエラーに対する即時応答: HttpResponseException を使用して、見つからないパラメータや無効なパラメータなどの一般的なエラーを報告します。
• サーバー エラーの累積応答: 例外を許可します。グローバル例外フィルターにバブルアップし、エラーをログに記録し、わかりやすいメッセージを提供します。
• カスタム IHttpActionResult クラス: System.Web.Http.Results での組み込みクラスまたはカスタム クラスの使用特定のエラー メッセージを返す名前空間 (NotFoundWithMessageResult など)。

以上がASP.NET Web API での即時エラー処理と累積エラー処理: どちらのアプローチが最適ですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。