Dependency injection: HttpClient or HttpClientFactory?

procma picture procma · Dec 11, 2019 · Viewed 10k times · Source

Everywhere I can see three main approaches to create clients (basic, named, typed) in DI, but I have found nowhere if to inject IHttpClientFactory or HttpClient (both possible).

Q1: What is the difference between injecting IHttpClientFactory or HttpClient please?

Q2: And if IHttpClientFactory is injected, should I use factory.CreateClient() for each call?

Answer

edo.n picture edo.n · Dec 11, 2019

Summary

  • HttpClient can only be injected inside Typed clients
  • for other usages, you need IHttpClientFactory
  • In both scenarios, the lifetime of HttpClientMessageHandler is managed by the framework, so you are not worried about (incorrectly) disposing the HttpClients.

Examples

In order to directly inject HttpClient, you need to register a specific Typed service that will receive the client:

services.AddHttpClient<GithubClient>(c => c.BaseAddress = new System.Uri("https://api.github.com"));

Now we can inject that inside the typed GithubClient

public class GithubClient
{
    public GithubClient(HttpClient client)
    {
        // client.BaseAddress is "https://api.github.com"
    }
}

You can't inject the HttpClient inside AnotherClient, because it is not typed to AnotherClient

public class AnotherClient
{
    public AnotherClient(HttpClient client)
    {
        // InvalidOperationException, can't resolve HttpClient 
    }
}

You can, however:
1. Inject the IHttpClientFactory and call CreateClient(). This client will have BaseAddress set to null.
2. Or configure AnotherClient as a different typed client with, for example, a different BaseAdress.

Update

Based on your comment, you are registering a Named client. It is still resolved from the IHttpClientFactory.CreateClient() method, but you need to pass the 'name' of the client

Registration

services.AddHttpClient("githubClient", c => c.BaseAddress = new System.Uri("https://api.github.com"));

Usage

// note that we inject IHttpClientFactory
public HomeController(IHttpClientFactory factory)
{
    this.defaultClient = factory.CreateClient(); // BaseAddress: null
    this.namedClient = factory.CreateClient("githubClient"); // BaseAddress: "https://api.github.com"
}