This repository has been archived by the owner on Nov 17, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 71
/
HttpClientBuilderExtensions.cs
463 lines (411 loc) · 21.9 KB
/
HttpClientBuilderExtensions.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Net.Http;
using System.Threading;
using Microsoft.Extensions.Http;
using Microsoft.Extensions.Options;
namespace Microsoft.Extensions.DependencyInjection
{
/// <summary>
/// Extension methods for configuring an <see cref="IHttpClientBuilder"/>
/// </summary>
public static class HttpClientBuilderExtensions
{
/// <summary>
/// Adds a delegate that will be used to configure a named <see cref="HttpClient"/>.
/// </summary>
/// <param name="builder">The <see cref="IServiceCollection"/>.</param>
/// <param name="configureClient">A delegate that is used to configure an <see cref="HttpClient"/>.</param>
/// <returns>An <see cref="IHttpClientBuilder"/> that can be used to configure the client.</returns>
public static IHttpClientBuilder ConfigureHttpClient(this IHttpClientBuilder builder, Action<HttpClient> configureClient)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (configureClient == null)
{
throw new ArgumentNullException(nameof(configureClient));
}
builder.Services.Configure<HttpClientFactoryOptions>(builder.Name, options => options.HttpClientActions.Add(configureClient));
return builder;
}
/// <summary>
/// Adds a delegate that will be used to create an additional message handler for a named <see cref="HttpClient"/>.
/// </summary>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <param name="configureHandler">A delegate that is used to create a <see cref="DelegatingHandler"/>.</param>
/// <returns>An <see cref="IHttpClientBuilder"/> that can be used to configure the client.</returns>
/// <remarks>
/// The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
/// is invoked.
/// </remarks>
public static IHttpClientBuilder AddHttpMessageHandler(this IHttpClientBuilder builder, Func<DelegatingHandler> configureHandler)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (configureHandler == null)
{
throw new ArgumentNullException(nameof(configureHandler));
}
builder.Services.Configure<HttpClientFactoryOptions>(builder.Name, options =>
{
options.HttpMessageHandlerBuilderActions.Add(b => b.AdditionalHandlers.Add(configureHandler()));
});
return builder;
}
/// <summary>
/// Adds a delegate that will be used to create an additional message handler for a named <see cref="HttpClient"/>.
/// </summary>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <param name="configureHandler">A delegate that is used to create a <see cref="DelegatingHandler"/>.</param> /// <returns>An <see cref="IHttpClientBuilder"/> that can be used to configure the client.</returns>
/// <remarks>
/// The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
/// is invoked.
/// </remarks>
public static IHttpClientBuilder AddHttpMessageHandler(this IHttpClientBuilder builder, Func<IServiceProvider, DelegatingHandler> configureHandler)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (configureHandler == null)
{
throw new ArgumentNullException(nameof(configureHandler));
}
builder.Services.AddTransient<IConfigureOptions<HttpClientFactoryOptions>>(services =>
{
return new ConfigureNamedOptions<HttpClientFactoryOptions>(builder.Name, (options) =>
{
options.HttpMessageHandlerBuilderActions.Add(b => b.AdditionalHandlers.Add(configureHandler(services)));
});
});
return builder;
}
/// <summary>
/// Adds an additional message handler from the dependency injection container for a named <see cref="HttpClient"/>.
/// </summary>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <returns>An <see cref="IHttpClientBuilder"/> that can be used to configure the client.</returns>
/// <typeparam name="THandler">
/// The type of the <see cref="DelegatingHandler"/>. The handler type must be registered as a transient service.
/// </typeparam>
public static IHttpClientBuilder AddHttpMessageHandler<THandler>(this IHttpClientBuilder builder)
where THandler : DelegatingHandler
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
builder.Services.AddTransient<IConfigureOptions<HttpClientFactoryOptions>>(services =>
{
return new ConfigureNamedOptions<HttpClientFactoryOptions>(builder.Name, (options) =>
{
options.HttpMessageHandlerBuilderActions.Add(b => b.AdditionalHandlers.Add(services.GetRequiredService<THandler>()));
});
});
return builder;
}
/// <summary>
/// Adds a delegate that will be used to configure the primary <see cref="HttpMessageHandler"/> for a
/// named <see cref="HttpClient"/>.
/// </summary>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <param name="configureHandler">A delegate that is used to create an <see cref="HttpMessageHandler"/>.</param>
/// <returns>An <see cref="IHttpClientBuilder"/> that can be used to configure the client.</returns>
/// <remarks>
/// The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
/// is invoked.
/// </remarks>
public static IHttpClientBuilder ConfigurePrimaryHttpMessageHandler(this IHttpClientBuilder builder, Func<HttpMessageHandler> configureHandler)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (configureHandler == null)
{
throw new ArgumentNullException(nameof(configureHandler));
}
builder.Services.Configure<HttpClientFactoryOptions>(builder.Name, options =>
{
options.HttpMessageHandlerBuilderActions.Add(b => b.PrimaryHandler = configureHandler());
});
return builder;
}
/// <summary>
/// Adds a delegate that will be used to configure the primary <see cref="HttpMessageHandler"/> for a
/// named <see cref="HttpClient"/>.
/// </summary>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <param name="configureHandler">A delegate that is used to create an <see cref="HttpMessageHandler"/>.</param>
/// <returns>An <see cref="IHttpClientBuilder"/> that can be used to configure the client.</returns>
/// <remarks>
/// The <see paramref="configureHandler"/> delegate should return a new instance of the message handler each time it
/// is invoked.
/// </remarks>
public static IHttpClientBuilder ConfigurePrimaryHttpMessageHandler(this IHttpClientBuilder builder, Func<IServiceProvider, HttpMessageHandler> configureHandler)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (configureHandler == null)
{
throw new ArgumentNullException(nameof(configureHandler));
}
builder.Services.AddTransient<IConfigureOptions<HttpClientFactoryOptions>>(services =>
{
return new ConfigureNamedOptions<HttpClientFactoryOptions>(builder.Name, (options) =>
{
options.HttpMessageHandlerBuilderActions.Add(b => b.PrimaryHandler = configureHandler(services));
});
});
return builder;
}
/// <summary>
/// Configures the primary <see cref="HttpMessageHandler"/> from the dependency inection container
/// for a named <see cref="HttpClient"/>.
/// </summary>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <returns>An <see cref="IHttpClientBuilder"/> that can be used to configure the client.</returns>
/// <typeparam name="THandler">
/// The type of the <see cref="DelegatingHandler"/>. The handler type must be registered as a transient service.
/// </typeparam>
public static IHttpClientBuilder ConfigurePrimaryHttpMessageHandler<THandler>(this IHttpClientBuilder builder)
where THandler : HttpMessageHandler
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
builder.Services.AddTransient<IConfigureOptions<HttpClientFactoryOptions>>(services =>
{
return new ConfigureNamedOptions<HttpClientFactoryOptions>(builder.Name, (options) =>
{
options.HttpMessageHandlerBuilderActions.Add(b => b.PrimaryHandler = services.GetRequiredService<THandler>());
});
});
return builder;
}
/// <summary>
/// Adds a delegate that will be used to configure message handlers using <see cref="HttpMessageHandlerBuilder"/>
/// for a named <see cref="HttpClient"/>.
/// </summary>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <param name="configureBuilder">A delegate that is used to configure an <see cref="HttpMessageHandlerBuilder"/>.</param>
/// <returns>An <see cref="IHttpClientBuilder"/> that can be used to configure the client.</returns>
public static IHttpClientBuilder ConfigureHttpMessageHandlerBuilder(this IHttpClientBuilder builder, Action<HttpMessageHandlerBuilder> configureBuilder)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (configureBuilder == null)
{
throw new ArgumentNullException(nameof(configureBuilder));
}
builder.Services.Configure<HttpClientFactoryOptions>(builder.Name, options => options.HttpMessageHandlerBuilderActions.Add(configureBuilder));
return builder;
}
/// <summary>
/// Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="HttpClient"/>
/// associated with the <see cref="IHttpClientBuilder"/>.
/// </summary>
/// <typeparam name="TClient">
/// The type of the typed client. They type specified will be registered in the service collection as
/// a transient service. See <see cref="ITypedHttpClientFactory" /> for more details about authoring typed clients.
/// </typeparam>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <remarks>
/// <para>
/// <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="HttpClient" />
/// can be retrieved from <see cref="IServiceProvider.GetService(Type)" /> (and related methods) by providing
/// <typeparamref name="TClient"/> as the service type.
/// </para>
/// <para>
/// Calling <see cref="HttpClientBuilderExtensions.AddTypedClient{TClient}(IHttpClientBuilder)"/> will register a typed
/// client binding that creates <typeparamref name="TClient"/> using the <see cref="ITypedHttpClientFactory" />.
/// </para>
/// </remarks>
public static IHttpClientBuilder AddTypedClient<TClient>(this IHttpClientBuilder builder)
where TClient : class
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
builder.Services.AddTransient<TClient>(s =>
{
var httpClientFactory = s.GetRequiredService<IHttpClientFactory>();
var httpClient = httpClientFactory.CreateClient(builder.Name);
var typedClientFactory = s.GetRequiredService<ITypedHttpClientFactory>();
return typedClientFactory.CreateClient<TClient>(httpClient);
});
return builder;
}
/// <summary>
/// Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="HttpClient"/>
/// associated with the <see cref="IHttpClientBuilder"/>. The created instances will be of type
/// <typeparamref name="TImplementation"/>.
/// </summary>
/// <typeparam name="TClient">
/// The declared type of the typed client. They type specified will be registered in the service collection as
/// a transient service. See <see cref="ITypedHttpClientFactory" /> for more details about authoring typed clients.
/// </typeparam>
/// <typeparam name="TImplementation">
/// The implementation type of the typed client. The type specified by will be instantiated by the
/// <see cref="ITypedHttpClientFactory"/>.
/// </typeparam>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <remarks>
/// <para>
/// <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="HttpClient" />
/// can be retrieved from <see cref="IServiceProvider.GetService(Type)" /> (and related methods) by providing
/// <typeparamref name="TClient"/> as the service type.
/// </para>
/// <para>
/// Calling <see cref="HttpClientBuilderExtensions.AddTypedClient{TClient,TImplementation}(IHttpClientBuilder)"/>
/// will register a typed client binding that creates <typeparamref name="TImplementation"/> using the
/// <see cref="ITypedHttpClientFactory" />.
/// </para>
/// </remarks>
public static IHttpClientBuilder AddTypedClient<TClient, TImplementation>(this IHttpClientBuilder builder)
where TClient : class
where TImplementation : class, TClient
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
builder.Services.AddTransient<TClient>(s =>
{
var httpClientFactory = s.GetRequiredService<IHttpClientFactory>();
var httpClient = httpClientFactory.CreateClient(builder.Name);
var typedClientFactory = s.GetRequiredService<ITypedHttpClientFactory>();
return typedClientFactory.CreateClient<TImplementation>(httpClient);
});
return builder;
}
/// <summary>
/// Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="HttpClient"/>
/// associated with the <see cref="IHttpClientBuilder"/>.
/// </summary>
/// <typeparam name="TClient">
/// The type of the typed client. They type specified will be registered in the service collection as
/// a transient service.
/// </typeparam>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <param name="factory">A factory function that will be used to construct the typed client.</param>
/// <remarks>
/// <para>
/// <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="HttpClient" />
/// can be retrieved from <see cref="IServiceProvider.GetService(Type)" /> (and related methods) by providing
/// <typeparamref name="TClient"/> as the service type.
/// </para>
/// <para>
/// Calling <see cref="HttpClientBuilderExtensions.AddTypedClient{TClient}(IHttpClientBuilder,Func{HttpClient,TClient})"/>
/// will register a typed client binding that creates <typeparamref name="TClient"/> using the provided factory function.
/// </para>
/// </remarks>
public static IHttpClientBuilder AddTypedClient<TClient>(this IHttpClientBuilder builder, Func<HttpClient, TClient> factory)
where TClient : class
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (factory == null)
{
throw new ArgumentNullException(nameof(factory));
}
builder.Services.AddTransient<TClient>(s =>
{
var httpClientFactory = s.GetRequiredService<IHttpClientFactory>();
var httpClient = httpClientFactory.CreateClient(builder.Name);
return factory(httpClient);
});
return builder;
}
/// <summary>
/// Configures a binding between the <typeparamref name="TClient" /> type and the named <see cref="HttpClient"/>
/// associated with the <see cref="IHttpClientBuilder"/>.
/// </summary>
/// <typeparam name="TClient">
/// The type of the typed client. They type specified will be registered in the service collection as
/// a transient service.
/// </typeparam>
/// <param name="builder">The <see cref="IHttpClientBuilder"/>.</param>
/// <param name="factory">A factory function that will be used to construct the typed client.</param>
/// <remarks>
/// <para>
/// <typeparamref name="TClient"/> instances constructed with the appropriate <see cref="HttpClient" />
/// can be retrieved from <see cref="IServiceProvider.GetService(Type)" /> (and related methods) by providing
/// <typeparamref name="TClient"/> as the service type.
/// </para>
/// <para>
/// Calling <see cref="HttpClientBuilderExtensions.AddTypedClient{TClient}(IHttpClientBuilder,Func{HttpClient,IServiceProvider,TClient})"/>
/// will register a typed client binding that creates <typeparamref name="TClient"/> using the provided factory function.
/// </para>
/// </remarks>
public static IHttpClientBuilder AddTypedClient<TClient>(this IHttpClientBuilder builder, Func<HttpClient, IServiceProvider, TClient> factory)
where TClient : class
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (factory == null)
{
throw new ArgumentNullException(nameof(factory));
}
builder.Services.AddTransient<TClient>(s =>
{
var httpClientFactory = s.GetRequiredService<IHttpClientFactory>();
var httpClient = httpClientFactory.CreateClient(builder.Name);
return factory(httpClient, s);
});
return builder;
}
/// <summary>
/// Sets the length of time that a <see cref="HttpMessageHandler"/> instance can be reused. Each named
/// client can have its own configured handler lifetime value. The default value is two minutes. Set the lifetime to
/// <see cref="Timeout.InfiniteTimeSpan"/> to disable handler expiry.
/// </summary>
/// <remarks>
/// <para>
/// The default implementation of <see cref="IHttpClientFactory"/> will pool the <see cref="HttpMessageHandler"/>
/// instances created by the factory to reduce resource consumption. This setting configures the amount of time
/// a handler can be pooled before it is scheduled for removal from the pool and disposal.
/// </para>
/// <para>
/// Pooling of handlers is desirable as each handler typially manages its own underlying HTTP connections; creating
/// more handlers than necessary can result in connection delays. Some handlers also keep connections open indefinitly
/// which can prevent the handler from reacting to DNS changes. The value of <paramref name="handlerLifetime"/> should be
/// chosen with an understanding of the application's requirement to respond to changes in the network environment.
/// </para>
/// <para>
/// Expiry of a handler will not immediately dispose the handler. An expired handler is placed in a separate pool
/// which is processed at intervals to dispose handlers only when they become unreachable. Using long-lived
/// <see cref="HttpClient"/> instances will prevent the underlying <see cref="HttpMessageHandler"/> from being
/// disposed until all references are garbage-collected.
/// </para>
/// </remarks>
public static IHttpClientBuilder SetHandlerLifetime(this IHttpClientBuilder builder, TimeSpan handlerLifetime)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
if (handlerLifetime != Timeout.InfiniteTimeSpan && handlerLifetime < HttpClientFactoryOptions.MinimumHandlerLifetime)
{
throw new ArgumentException(Resources.HandlerLifetime_InvalidValue, nameof(handlerLifetime));
}
builder.Services.Configure<HttpClientFactoryOptions>(builder.Name, options => options.HandlerLifetime = handlerLifetime);
return builder;
}
}
}