在C＃中進行REST API調用時，如何正確處理異常？

C#中REST API調用的最佳實踐

引言

本文探討如何在C#中調用REST API，並解決異常塊未執行的問題，提供使用當前ASP.NET Web API客戶端庫的改進方案。

原始代碼及問題

原始代碼使用HttpWebRequest類向REST API發出POST請求。然而，異常塊似乎被繞過，導致錯誤消息無法顯示。

使用ASP.NET Web API客戶端庫的改進方案

Microsoft當前推薦使用ASP.NET Web API客戶端庫來使用RESTful服務。以下是針對給定代碼的改進方案：

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;

namespace ConsoleProgram
{
    public class DataObject
    {
        public string Name { get; set; }
    }

    public class Class1
    {
        private const string URL = "https://sub.domain.com/objects.json";
        private string urlParameters = "?api_key=123";

        static void Main(string[] args)
        {
            using (HttpClient client = new HttpClient()) // 使用using语句自动释放资源
            {
                client.BaseAddress = new Uri(URL);

                // 添加JSON格式的Accept头。
                client.DefaultRequestHeaders.Accept.Add(
                    new MediaTypeWithQualityHeaderValue("application/json"));

                try
                {
                    // 获取数据响应。 使用异步方法避免阻塞
                    var response = client.GetAsync(urlParameters).Result;  

                    if (response.IsSuccessStatusCode)
                    {
                        // 解析响应正文。
                        var dataObjects = response.Content.ReadAsAsync<IEnumerable<DataObject>>().Result;
                        foreach (var d in dataObjects)
                        {
                            Console.WriteLine("{0}", d.Name);
                        }
                    }
                    else
                    {
                        Console.WriteLine($"HTTP请求失败: 状态码 {(int)response.StatusCode} - {response.ReasonPhrase}");
                        //  更高级的错误处理，例如记录日志或抛出自定义异常
                    }
                }
                catch (HttpRequestException ex)
                {
                    Console.WriteLine($"HTTP请求异常: {ex.Message}");
                    //  更高级的错误处理，例如记录日志或显示用户友好的错误信息
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"发生未知异常: {ex.Message}");
                    //  记录日志或显示用户友好的错误信息
                }
            }
        }
    }
}

此改進方案使用HttpClient類，簡化了使用基於HTTP的服務和處理響應的過程。它包含了顯式的異常處理，並使用using語句確保HttpClient實例被正確釋放。 異步方法的使用也避免了程序阻塞。 代碼中添加了更清晰的錯誤信息輸出，並建議進行更高級的錯誤處理。

注意：

• 建議為多個請求重用HttpClient實例。
• HttpClient類遵循“dispose模式”。最佳實踐是在所有請求完成後使用using語句或手動釋放客戶端。 本例中已使用using語句。
• 使用異步方法(GetAsync)可以提高程序性能，避免阻塞主線程。 Result屬性會阻塞直到異步操作完成，但結合try-catch塊可以更有效地處理異常。

This revised answer provides a more robust and efficient solution, addressing potential exceptions and improving code clarity. The use of using and explicit error handling makes the code more reliable.

以上是在C＃中進行REST API調用時，如何正確處理異常？的詳細內容。更多資訊請關注PHP中文網其他相關文章！