ASP.NET Core使用IHttpClientFactory發(fā)出HTTP請求

更新時間：2022年04月06日 15:08:54 作者：暗斷腸

這篇文章介紹了ASP.NET Core使用IHttpClientFactory發(fā)出HTTP請求的方法，文中通過示例代碼介紹的非常詳細(xì)。對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

1.HttpClient類使用存在的問題

HttpClient類的使用所存在的問題，百度搜索的文章一大堆，好多都是單純文字描述，讓人感覺不太好理解，為了更好理解HttpClient使用存在的問題，下面讓我們通過代碼跟示例來描述。

using(var client = new HttpClient())

傳統(tǒng)關(guān)閉連接方法如上述代碼所示，但當(dāng)使用using語句釋放HttpClient對象的時候，套接字（socket）也不會立即釋放，下面我們通過請求aspnetmonsters站點的示例來驗證下：

class Program
{
    static void Main(string[] args)
    {
        Console.WriteLine("Starting connections");
        var g = GetAsync();
        g.Wait();
        Console.WriteLine("Connections done");
        Console.ReadKey();
    }
    static async Task GetAsync()
    {
        for (int i = 0; i < 5; i++)
        {
            using (var client = new HttpClient())
            {
                var result = await client.GetAsync("http://aspnetmonsters.com/");
                Console.WriteLine(result.StatusCode);
            }
        }
    }
}

輸出結(jié)果：

控制臺打印出五條請求站點返回狀態(tài)的信息，下面我們通過netstat工具打印出五個請求連接套接字狀態(tài)：

應(yīng)用程序已經(jīng)運行結(jié)束了（結(jié)束連接），但是打印結(jié)果顯示連接狀態(tài)仍然是TIME_WAIT，也就是說在此狀態(tài)期間仍然在觀察是否有數(shù)據(jù)包進入連接（如果連接等待中有任何數(shù)據(jù)包仍然會通過），因為它們可能在某個地方被網(wǎng)絡(luò)延遲。

Windows將在此狀態(tài)下保持連接240秒（由其設(shè)置[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\TcpTimedWaitDelay]）。Windows可以快速打開新套接字的速度有限，因此如果您耗盡連接池，那么您可能會看到如下錯誤：

而怎么做才可以減少套接字的浪費呢？我們在上述代碼中把每次循環(huán)中創(chuàng)建的HttpClient對象拉到Main外定義為一個共享的靜態(tài)實例：

class Program
{
    private static HttpClient client = new HttpClient();
    static void Main(string[] args)
    {
        Console.WriteLine("Starting connections");
        var g = GetAsync();
        g.Wait();
        Console.WriteLine("Connections done");
        Console.ReadKey();
    }
    static async Task GetAsync()
    {
        for (int i = 0; i < 5; i++)
        {
            var result = await client.GetAsync("http://aspnetmonsters.com/");
            Console.WriteLine(result.StatusCode);
        }
    }
}

應(yīng)用程序運動完畢之后，我們再通過netstat工具打印出五個請求連接套接字狀態(tài)，這時候會看到信息如下：

通過共享一個實例，減少了套接字的浪費，實際上由于套接字重用而傳輸快一點。
總結(jié)：

在創(chuàng)建HttpClient實例的時候，最好是靜態(tài)（static ）實例。
不要用using包裝HttpClient對象。

在.NET Core 2.1版本之后引入的 HttpClientFactory解決了HttpClient的所有痛點。有了 HttpClientFactory，我們不需要關(guān)心如何創(chuàng)建HttpClient，又如何釋放它。通過它可以創(chuàng)建具有特定業(yè)務(wù)的HttpClient，而且可以很友好的和 DI 容器結(jié)合使用，更為靈活。下面以 ASP.NET Core為例介紹HttpClientFactory的四種使用方式。

2.HttpClientFactory 的多種使用方式

可以通過多種使用方式在應(yīng)用程序中使用HttpClientFactory。

2.1使用基本用法

在Startup.ConfigureServices方法中，通過在IServiceCollection上調(diào)用AddHttpClient擴展方法可以注冊IHttpClientFactory服務(wù)。
services.AddHttpClient();
注冊服務(wù)后，我們新建BasicUsageModel類使用IHttpClientFactory創(chuàng)建HttpClient實例：

public class BasicUsageModel
{
    private readonly IHttpClientFactory _clientFactory;
    public IEnumerable<GitHubBranch> Branches { get; private set; }
    public bool GetBranchesError { get; private set; }
    public BasicUsageModel(IHttpClientFactory clientFactory)
    {
        _clientFactory = clientFactory;
    }
    public async Task OnGet()
    {
        var request = new HttpRequestMessage(HttpMethod.Get,
            "https://api.github.com/repos/aspnet/AspNetCore.Docs/branches");
        request.Headers.Add("Accept", "application/vnd.github.v3+json");
        request.Headers.Add("User-Agent", "HttpClientFactory-Sample");
        var client = _clientFactory.CreateClient();
        var response = await client.SendAsync(request);
        if (response.IsSuccessStatusCode)
        {
            Branches = await response.Content
                .ReadAsAsync<IEnumerable<GitHubBranch>>();
        }
        else
        {
            GetBranchesError = true;
            Branches = Array.Empty<GitHubBranch>();
        }
    }
}
public class GitHubBranch
{
    public string name { get; set; }
}

以這種方式直接在使用IHttpClientFactory的類中調(diào)用CreateClient方法創(chuàng)建HttpClient實例。然后在Controller中調(diào)用BasicUsageModel類：

public class HomeController : Controller
{
    private readonly IHttpClientFactory _clientFactory;
    public HomeController(IHttpClientFactory clientFactory)
    {
        _clientFactory = clientFactory;
    }
    public IActionResult Index()
    {
        BasicUsageModel model = new BasicUsageModel(_clientFactory);
        var task = model.OnGet();
        task.Wait();
        List<GitHubBranch> list = model.Branches.ToList();
        return View(list);
    }
}

2.2使用命名客戶端

如果應(yīng)用程序需要有許多不同的HttpClient用法（每種用法的服務(wù)配置都不同），可以視情況使用命名客戶端。可以在HttpClient中注冊時指定命名Startup.ConfigureServices的配置。

services.AddHttpClient("github", c =>
{
    c.BaseAddress = new Uri("https://api.github.com/");
    // Github API versioning
    c.DefaultRequestHeaders.Add("Accept", "application/vnd.github.v3+json");
    // Github requires a user-agent
    c.DefaultRequestHeaders.Add("User-Agent", "HttpClientFactory-Sample");
});

上面的代碼調(diào)用AddHttpClient，同時提供名稱“github”。此客戶端應(yīng)用了一些默認(rèn)配置，也就是需要基址和兩個標(biāo)頭來使用GitHub API。每次調(diào)用CreateClient時，都會創(chuàng)建HttpClient 的新實例，并調(diào)用配置操作。要使用命名客戶端，可將字符串參數(shù)傳遞到CreateClient。指定要創(chuàng)建的客戶端的名稱：

public class NamedClientModel : PageModel
{
    private readonly IHttpClientFactory _clientFactory;
    public IEnumerable<GitHubPullRequest> PullRequests { get; private set; }
    public bool GetPullRequestsError { get; private set; }
    public bool HasPullRequests => PullRequests.Any();
    public NamedClientModel(IHttpClientFactory clientFactory)
    {
        _clientFactory = clientFactory;
    }
    public async Task OnGet()
    {
        var request = new HttpRequestMessage(HttpMethod.Get,
            "repos/aspnet/AspNetCore.Docs/pulls");
        var client = _clientFactory.CreateClient("github");
        var response = await client.SendAsync(request);
        if (response.IsSuccessStatusCode)
        {
            PullRequests = await response.Content
                .ReadAsAsync<IEnumerable<GitHubPullRequest>>();
        }
        else
        {
            GetPullRequestsError = true;
            PullRequests = Array.Empty<GitHubPullRequest>();
        }
    }
}
public class GitHubPullRequest
{
    public string url { get; set; }
    public int? id { get; set; }
    public string node_id { get; set; }
}

在上述代碼中，請求不需要指定主機名。可以僅傳遞路徑，因為采用了為客戶端配置的基址。在Controller中調(diào)用方法如上個示例。

2.3使用類型化客戶端

什么是“類型化客戶端”？它只是DefaultHttpClientFactory注入時配置的HttpClient。
下圖顯示了如何將類型化客戶端與HttpClientFactory結(jié)合使用：

類型化客戶端提供與命名客戶端一樣的功能，不需要將字符串用作密鑰。它們提供單個地址來配置特定HttpClient并與其進行交互。例如，單個類型化客戶端可能用于單個后端終結(jié)點，并封裝此終結(jié)點的所有處理邏輯。另一個優(yōu)勢是它們使用 DI 且可以被注入到應(yīng)用中需要的位置。
類型化客戶端在構(gòu)造函數(shù)中接收HttpClient參數(shù)：

public class GitHubService
{
    public HttpClient Client { get; }
    public GitHubService(HttpClient client)
    {
        client.BaseAddress = new Uri("https://api.github.com/");
        // GitHub API versioning
        client.DefaultRequestHeaders.Add("Accept",
            "application/vnd.github.v3+json");
        // GitHub requires a user-agent
        client.DefaultRequestHeaders.Add("User-Agent",
            "HttpClientFactory-Sample");
        Client = client;
    }
    public async Task<IEnumerable<GitHubIssue>> GetAspNetDocsIssues()
    {
        var response = await Client.GetAsync(
"/repos/aspnet/AspNetCore.Docs/issues?state=open&sort=created&direction=desc");
        response.EnsureSuccessStatusCode();
        var result = await response.Content
            .ReadAsAsync<IEnumerable<GitHubIssue>>();
        return result;
    }
}
public class GitHubIssue
{
    public string url { get; set; }
    public int? id { get; set; }
    public string node_id { get; set; }
}

在上述代碼中，配置轉(zhuǎn)移到了類型化客戶端中。HttpClient對象公開為公共屬性。可以定義公開HttpClient功能的特定于API的方法。GetAspNetDocsIssues方法從GitHub存儲庫封裝查詢和分析最新待解決問題所需的代碼。
要注冊類型化客戶端，可在Startup.ConfigureServices中使用通用的AddHttpClient擴展方法，指定類型化客戶端類：

services.AddHttpClient<GitHubService>();

使用DI將類型客戶端注冊為暫時客戶端?？梢灾苯硬迦牖蚴褂妙愋突蛻舳耍?/p>

public class TypedClientModel : PageModel
{
    private readonly GitHubService _gitHubService;
    public IEnumerable<GitHubIssue> LatestIssues { get; private set; }
    public bool HasIssue => LatestIssues.Any();
    public bool GetIssuesError { get; private set; }
    public TypedClientModel(GitHubService gitHubService)
    {
        _gitHubService = gitHubService;
    }
    public async Task OnGet()
    {
        try
        {
            LatestIssues = await _gitHubService.GetAspNetDocsIssues();
        }
        catch (HttpRequestException)
        {
            GetIssuesError = true;
            LatestIssues = Array.Empty<GitHubIssue>();
        }
    }
}

到此這篇關(guān)于ASP.NET Core使用IHttpClientFactory發(fā)出HTTP請求的文章就介紹到這了。希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: