C#中REST API調(diào)用的最佳實(shí)踐

引言

本文探討如何在C#中調(diào)用REST API，並解決異常塊未執(zhí)行的問題，提供使用當(dāng)前ASP.NET Web API客戶端庫的改進(jìn)方案。

原始代碼及問題

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

使用ASP.NET Web API客戶端庫的改進(jìn)方案

Microsoft當(dāng)前推薦使用ASP.NET Web API客戶端庫來使用RESTful服務(wù)。以下是針對給定代碼的改進(jìn)方案：

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
                {
                    // 獲取數(shù)據(jù)響應(yīng)。 使用異步方法避免阻塞
                    var response = client.GetAsync(urlParameters).Result;  

                    if (response.IsSuccessStatusCode)
                    {
                        // 解析響應(yīng)正文。
                        var dataObjects = response.Content.ReadAsAsync<IEnumerable<DataObject>>().Result;
                        foreach (var d in dataObjects)
                        {
                            Console.WriteLine("{0}", d.Name);
                        }
                    }
                    else
                    {
                        Console.WriteLine($"HTTP請求失敗: 狀態(tài)碼 {(int)response.StatusCode} - {response.ReasonPhrase}");
                        //  更高級的錯(cuò)誤處理，例如記錄日志或拋出自定義異常
                    }
                }
                catch (HttpRequestException ex)
                {
                    Console.WriteLine($"HTTP請求異常: {ex.Message}");
                    //  更高級的錯(cuò)誤處理，例如記錄日志或顯示用戶友好的錯(cuò)誤信息
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"發(fā)生未知異常: {ex.Message}");
                    //  記錄日志或顯示用戶友好的錯(cuò)誤信息
                }
            }
        }
    }
}

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

注意：

• 建議為多個(gè)請求重用HttpClient實(shí)例。
• HttpClient類遵循“dispose模式”。最佳實(shí)踐是在所有請求完成後使用using語句或手動釋放客戶端。 本例中已使用using語句。
• 使用異步方法(GetAsync)可以提高程序性能，避免阻塞主線程。 Result屬性會阻塞直到異步操作完成，但結(jié)合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＃中進(jìn)行REST API調(diào)用時(shí)，如何正確處理異常？的詳細(xì)內(nèi)容。更多資訊請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！