基于C#實現(xiàn)任意格式JSON文本的HTTP交互抽象類

更新時間：2025年03月17日 08:41:09 作者：老胖閑聊

為了實現(xiàn)一個支持任意格式JSON交互的抽象類,并且在整個過程中不需要對JSON格式數(shù)據(jù)進行序列化和反序列化操作,可以使用C#中的HttpClient類來進行HTTP請求和響應,本文給大家介紹了基于C#實現(xiàn)任意格式JSON文本的HTTP交互抽象類,需要的朋友可以參考下

引言

為了實現(xiàn)一個支持任意格式JSON交互的抽象類，并且在整個過程中不需要對JSON格式數(shù)據(jù)進行序列化和反序列化操作，可以使用C#中的HttpClient類來進行HTTP請求和響應。下面將創(chuàng)建一個抽象類JsonHttpClient，它封裝了HTTP請求和響應的邏輯，并且允許直接處理JSON字符串。

1. 創(chuàng)建抽象類 JsonHttpClient

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

public abstract class JsonHttpClient
{
    // HttpClient實例，用于發(fā)送HTTP請求
    private readonly HttpClient _httpClient;

    // 構造函數(shù)，初始化HttpClient
    protected JsonHttpClient()
    {
        _httpClient = new HttpClient();
    }

    // 發(fā)送HTTP請求的抽象方法，子類必須實現(xiàn)
    protected abstract Task<HttpResponseMessage> SendRequestAsync(HttpRequestMessage request);

    // 發(fā)送HTTP GET請求
    public async Task<string> GetAsync(string uri)
    {
        // 創(chuàng)建HTTP GET請求
        var request = new HttpRequestMessage(HttpMethod.Get, uri);

        // 發(fā)送請求并獲取響應
        var response = await SendRequestAsync(request);

        // 確保響應成功
        response.EnsureSuccessStatusCode();

        // 讀取響應內容并返回
        return await response.Content.ReadAsStringAsync();
    }

    // 發(fā)送HTTP POST請求
    public async Task<string> PostAsync(string uri, string jsonContent)
    {
        // 創(chuàng)建HTTP POST請求
        var request = new HttpRequestMessage(HttpMethod.Post, uri)
        {
            Content = new StringContent(jsonContent, Encoding.UTF8, "application/json")
        };

        // 發(fā)送請求并獲取響應
        var response = await SendRequestAsync(request);

        // 確保響應成功
        response.EnsureSuccessStatusCode();

        // 讀取響應內容并返回
        return await response.Content.ReadAsStringAsync();
    }

    // 發(fā)送HTTP PUT請求
    public async Task<string> PutAsync(string uri, string jsonContent)
    {
        // 創(chuàng)建HTTP PUT請求
        var request = new HttpRequestMessage(HttpMethod.Put, uri)
        {
            Content = new StringContent(jsonContent, Encoding.UTF8, "application/json")
        };

        // 發(fā)送請求并獲取響應
        var response = await SendRequestAsync(request);

        // 確保響應成功
        response.EnsureSuccessStatusCode();

        // 讀取響應內容并返回
        return await response.Content.ReadAsStringAsync();
    }

    // 發(fā)送HTTP DELETE請求
    public async Task<string> DeleteAsync(string uri)
    {
        // 創(chuàng)建HTTP DELETE請求
        var request = new HttpRequestMessage(HttpMethod.Delete, uri);

        // 發(fā)送請求并獲取響應
        var response = await SendRequestAsync(request);

        // 確保響應成功
        response.EnsureSuccessStatusCode();

        // 讀取響應內容并返回
        return await response.Content.ReadAsStringAsync();
    }
}

2. 實現(xiàn)具體的HTTP客戶端類

可以創(chuàng)建一個具體的HTTP客戶端類，繼承自JsonHttpClient，并實現(xiàn)SendRequestAsync方法。

public class MyHttpClient : JsonHttpClient
{
    // 實現(xiàn)SendRequestAsync方法
    protected override async Task<HttpResponseMessage> SendRequestAsync(HttpRequestMessage request)
    {
        // 使用HttpClient發(fā)送請求并返回響應
        return await _httpClient.SendAsync(request);
    }
}

3. 使用案例

下面是一個從發(fā)送HTTP請求到獲取響應并顯示在控制臺的完整案例。

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // 創(chuàng)建MyHttpClient實例
        var httpClient = new MyHttpClient();

        // 定義API的URL
        string apiUrl = "https://jsonplaceholder.typicode.com/posts";

        try
        {
            // 發(fā)送HTTP GET請求
            string response = await httpClient.GetAsync(apiUrl);

            // 將響應內容顯示在控制臺
            Console.WriteLine("Response from GET request:");
            Console.WriteLine(response);

            // 發(fā)送HTTP POST請求
            string postData = "{\"title\": \"foo\", \"body\": \"bar\", \"userId\": 1}";
            string postResponse = await httpClient.PostAsync(apiUrl, postData);

            // 將響應內容顯示在控制臺
            Console.WriteLine("Response from POST request:");
            Console.WriteLine(postResponse);
        }
        catch (HttpRequestException e)
        {
            // 處理HTTP請求異常
            Console.WriteLine("HTTP Request Error: " + e.Message);
        }
        catch (Exception e)
        {
            // 處理其他異常
            Console.WriteLine("Error: " + e.Message);
        }
    }
}

4. 代碼注解

HttpClient: HttpClient是C#中用于發(fā)送HTTP請求和接收HTTP響應的類。它是線程安全的，建議在應用程序中重用同一個HttpClient實例。
HttpRequestMessage: 表示一個HTTP請求消息，包含請求方法（GET、POST等）、請求URI、請求頭、請求內容等信息。
HttpResponseMessage: 表示一個HTTP響應消息，包含響應狀態(tài)碼、響應頭、響應內容等信息。
StringContent: 用于將字符串內容作為HTTP請求的內容發(fā)送。我們可以指定內容的編碼和媒體類型（如application/json）。
EnsureSuccessStatusCode: 確保HTTP響應的狀態(tài)碼表示成功（2xx），否則拋出HttpRequestException異常。
ReadAsStringAsync: 異步讀取HTTP響應的內容并返回為字符串。