-
Notifications
You must be signed in to change notification settings - Fork 60
/
RestClient.cs
338 lines (273 loc) · 13.4 KB
/
RestClient.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
namespace Easy.Common;
using Easy.Common.Extensions;
using Easy.Common.Interfaces;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
/// <summary>
/// An abstraction over <see cref="HttpClient"/> to address the following issues:
/// <para><see href="http://aspnetmonsters.com/2016/08/2016-08-27-httpclientwrong/"/></para>
/// <para><see href="http://byterot.blogspot.co.uk/2016/07/singleton-httpclient-dns.html"/></para>
/// <para><see href="http://naeem.khedarun.co.uk/blog/2016/11/30/httpclient-dns-settings-for-azure-cloud-services-and-traffic-manager-1480285049222/"/></para>
/// </summary>
public sealed class RestClient : IRestClient
{
private const int MAX_CONNECTION_PER_SERVER = 20;
private static readonly TimeSpan ConnectionLifeTime = 1.Minutes();
private readonly HttpClient _client;
static RestClient() => ConfigureServicePointManager();
/// <summary>
/// Creates an instance of the <see cref="RestClient"/>.
/// </summary>
public RestClient(
IDictionary<string, IEnumerable<string>>? defaultRequestHeaders = default,
HttpMessageHandler? handler = default,
Uri? baseAddress = default,
bool disposeHandler = true,
TimeSpan? timeout = null,
ulong? maxResponseContentBufferSize = null)
{
_client = new HttpClient(handler ?? GetHandler(), disposeHandler);
AddBaseAddress(baseAddress);
AddDefaultHeaders(defaultRequestHeaders);
AddRequestTimeout(timeout);
AddMaxResponseBufferSize(maxResponseContentBufferSize);
}
private static HttpMessageHandler GetHandler() =>
new SocketsHttpHandler
{
// https://github.com/dotnet/corefx/issues/26895
// https://github.com/dotnet/corefx/issues/26331
// https://github.com/dotnet/corefx/pull/26839
PooledConnectionLifetime = ConnectionLifeTime,
PooledConnectionIdleTimeout = ConnectionLifeTime,
MaxConnectionsPerServer = MAX_CONNECTION_PER_SERVER
};
/// <inheritdoc/>
public IReadOnlyDictionary<string, string[]> DefaultRequestHeaders =>
_client.DefaultRequestHeaders.ToDictionary(x => x.Key, x => x.Value.ToArray());
/// <inheritdoc/>
public TimeSpan Timeout => _client.Timeout;
/// <inheritdoc/>
public uint MaxResponseContentBufferSize => (uint)_client.MaxResponseContentBufferSize;
/// <inheritdoc/>
public Uri? BaseAddress => _client.BaseAddress;
/// <inheritdoc/>
public Task<HttpResponseMessage> SendAsync(HttpRequestMessage request) =>
SendAsync(request, HttpCompletionOption.ResponseContentRead, CancellationToken.None);
/// <inheritdoc/>
/// <exception cref="ArgumentNullException"/>
public Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cToken) =>
SendAsync(request, HttpCompletionOption.ResponseContentRead, cToken);
/// <inheritdoc/>
public Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, HttpCompletionOption option) =>
SendAsync(request, option, CancellationToken.None);
/// <inheritdoc/>
public Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, HttpCompletionOption option, CancellationToken cToken)
{
ArgumentNullException.ThrowIfNull(request);
return _client.SendAsync(request, option, cToken);
}
/// <inheritdoc/>
public Task<HttpResponseMessage> GetAsync(string uri) => SendAsync(new HttpRequestMessage(HttpMethod.Get, uri));
/// <inheritdoc/>
public Task<HttpResponseMessage> GetAsync(string uri, TimeSpan timeout) => GetAsync(new Uri(uri, UriKind.RelativeOrAbsolute), timeout);
/// <inheritdoc/>
public Task<HttpResponseMessage> GetAsync(Uri uri) => SendAsync(new HttpRequestMessage(HttpMethod.Get, uri));
/// <inheritdoc/>
public async Task<HttpResponseMessage> GetAsync(Uri uri, TimeSpan timeout)
{
using CancellationTokenSource cts = new(timeout);
return await SendAsync(new HttpRequestMessage(HttpMethod.Get, uri), cts.Token).ConfigureAwait(false);
}
/// <inheritdoc/>
public Task<HttpResponseMessage> GetAsync(string uri, CancellationToken cToken) => SendAsync(new HttpRequestMessage(HttpMethod.Get, uri), cToken);
/// <inheritdoc/>
public Task<HttpResponseMessage> GetAsync(Uri uri, CancellationToken cToken) => SendAsync(new HttpRequestMessage(HttpMethod.Get, uri), cToken);
/// <inheritdoc/>
public Task<HttpResponseMessage> GetAsync(string uri, HttpCompletionOption option) => SendAsync(new HttpRequestMessage(HttpMethod.Get, uri), option);
/// <inheritdoc/>
public Task<HttpResponseMessage> GetAsync(Uri uri, HttpCompletionOption option) => SendAsync(new HttpRequestMessage(HttpMethod.Get, uri), option);
/// <inheritdoc/>
public Task<HttpResponseMessage> GetAsync(string uri, HttpCompletionOption option, CancellationToken cToken) =>
SendAsync(new HttpRequestMessage(HttpMethod.Get, uri), option, cToken);
/// <inheritdoc/>
public Task<HttpResponseMessage> GetAsync(Uri uri, HttpCompletionOption option, CancellationToken cToken) =>
SendAsync(new HttpRequestMessage(HttpMethod.Get, uri), option, cToken);
/// <inheritdoc/>
public Task<HttpResponseMessage> PutAsync(string uri, HttpContent content) =>
SendAsync(new HttpRequestMessage(HttpMethod.Put, uri) { Content = content });
/// <inheritdoc/>
public Task<HttpResponseMessage> PutAsync(string uri, HttpContent content, TimeSpan timeout) =>
PutAsync(new Uri(uri, UriKind.RelativeOrAbsolute), content, timeout);
/// <inheritdoc/>
public Task<HttpResponseMessage> PutAsync(Uri uri, HttpContent content) =>
SendAsync(new HttpRequestMessage(HttpMethod.Put, uri) { Content = content });
/// <inheritdoc/>
public async Task<HttpResponseMessage> PutAsync(Uri uri, HttpContent content, TimeSpan timeout)
{
using CancellationTokenSource cts = new(timeout);
return await SendAsync(new HttpRequestMessage(HttpMethod.Put, uri) { Content = content }, cts.Token).ConfigureAwait(false);
}
/// <inheritdoc/>
public Task<HttpResponseMessage> PutAsync(Uri uri, HttpContent content, CancellationToken cToken) =>
SendAsync(new HttpRequestMessage(HttpMethod.Put, uri) { Content = content }, cToken);
/// <inheritdoc/>
public Task<HttpResponseMessage> PutAsync(string uri, HttpContent content, CancellationToken cToken) =>
SendAsync(new HttpRequestMessage(HttpMethod.Put, uri) { Content = content }, cToken);
/// <inheritdoc/>
public Task<HttpResponseMessage> PostAsync(string uri, HttpContent content) =>
SendAsync(new HttpRequestMessage(HttpMethod.Post, uri) { Content = content });
/// <inheritdoc/>
public Task<HttpResponseMessage> PostAsync(string uri, HttpContent content, TimeSpan timeout) =>
PostAsync(new Uri(uri, UriKind.RelativeOrAbsolute), content, timeout);
/// <inheritdoc/>
public Task<HttpResponseMessage> PostAsync(Uri uri, HttpContent content) =>
SendAsync(new HttpRequestMessage(HttpMethod.Post, uri) { Content = content });
/// <inheritdoc/>
public async Task<HttpResponseMessage> PostAsync(Uri uri, HttpContent content, TimeSpan timeout)
{
using CancellationTokenSource cts = new(timeout);
return await SendAsync(new HttpRequestMessage(HttpMethod.Post, uri) { Content = content }, cts.Token).ConfigureAwait(false);
}
/// <inheritdoc/>
public Task<HttpResponseMessage> PostAsync(Uri uri, HttpContent content, CancellationToken cToken) =>
SendAsync(new HttpRequestMessage(HttpMethod.Post, uri) { Content = content }, cToken);
/// <inheritdoc/>
public Task<HttpResponseMessage> PostAsync(string uri, HttpContent content, CancellationToken cToken) =>
SendAsync(new HttpRequestMessage(HttpMethod.Post, uri) { Content = content }, cToken);
/// <inheritdoc/>
public Task<HttpResponseMessage> DeleteAsync(string uri) => SendAsync(new HttpRequestMessage(HttpMethod.Delete, uri));
/// <inheritdoc/>
public Task<HttpResponseMessage> DeleteAsync(string uri, TimeSpan timeout) => DeleteAsync(new Uri(uri, UriKind.RelativeOrAbsolute), timeout);
/// <inheritdoc/>
public Task<HttpResponseMessage> DeleteAsync(Uri uri) => SendAsync(new HttpRequestMessage(HttpMethod.Delete, uri));
/// <inheritdoc/>
public async Task<HttpResponseMessage> DeleteAsync(Uri uri, TimeSpan timeout)
{
using CancellationTokenSource cts = new(timeout);
return await SendAsync(new HttpRequestMessage(HttpMethod.Delete, uri), cts.Token).ConfigureAwait(false);
}
/// <inheritdoc/>
public Task<HttpResponseMessage> DeleteAsync(string uri, CancellationToken cToken) =>
SendAsync(new HttpRequestMessage(HttpMethod.Delete, uri), cToken);
/// <inheritdoc/>
public Task<HttpResponseMessage> DeleteAsync(Uri uri, CancellationToken cToken) => SendAsync(new HttpRequestMessage(HttpMethod.Delete, uri), cToken);
/// <inheritdoc/>
public Task<string> GetStringAsync(string uri)
{
Ensure.NotNullOrEmptyOrWhiteSpace(uri);
return GetStringAsync(new Uri(uri, UriKind.RelativeOrAbsolute));
}
/// <inheritdoc/>
public Task<string> GetStringAsync(string uri, TimeSpan timeout)
{
Ensure.NotNullOrEmptyOrWhiteSpace(uri);
return GetStringAsync(new Uri(uri, UriKind.RelativeOrAbsolute), timeout);
}
/// <inheritdoc/>
public Task<string> GetStringAsync(Uri uri)
{
ArgumentNullException.ThrowIfNull(uri);
return _client.GetStringAsync(uri);
}
/// <summary>
/// Sends a <c>GET</c> request to the specified <paramref name="uri"/> with the given <paramref name="timeout"/>.
/// </summary>
///<exception cref="ArgumentNullException"/>
public async Task<string> GetStringAsync(Uri uri, TimeSpan timeout)
{
ArgumentNullException.ThrowIfNull(uri);
HttpResponseMessage resp = await GetAsync(uri, timeout).ConfigureAwait(false);
resp.EnsureSuccessStatusCode();
return await resp.Content.ReadAsStringAsync().ConfigureAwait(false);
}
/// <inheritdoc/>
public Task<Stream> GetStreamAsync(string uri)
{
Ensure.NotNullOrEmptyOrWhiteSpace(uri);
return GetStreamAsync(new Uri(uri, UriKind.RelativeOrAbsolute));
}
/// <inheritdoc/>
public Task<Stream> GetStreamAsync(string uri, TimeSpan timeout)
{
Ensure.NotNullOrEmptyOrWhiteSpace(uri);
return GetStreamAsync(new Uri(uri, UriKind.RelativeOrAbsolute), timeout);
}
/// <inheritdoc/>
public Task<Stream> GetStreamAsync(Uri uri)
{
ArgumentNullException.ThrowIfNull(uri);
return _client.GetStreamAsync(uri);
}
/// <inheritdoc/>
public async Task<Stream> GetStreamAsync(Uri uri, TimeSpan timeout)
{
ArgumentNullException.ThrowIfNull(uri);
HttpResponseMessage resp = await GetAsync(uri, timeout).ConfigureAwait(false);
resp.EnsureSuccessStatusCode();
return await resp.Content.ReadAsStreamAsync().ConfigureAwait(false);
}
/// <inheritdoc/>
public Task<byte[]> GetByteArrayAsync(string uri)
{
Ensure.NotNullOrEmptyOrWhiteSpace(uri);
return GetByteArrayAsync(new Uri(uri, UriKind.RelativeOrAbsolute));
}
/// <inheritdoc/>
public Task<byte[]> GetByteArrayAsync(string uri, TimeSpan timeout)
{
Ensure.NotNullOrEmptyOrWhiteSpace(uri);
return GetByteArrayAsync(new Uri(uri, UriKind.RelativeOrAbsolute), timeout);
}
/// <inheritdoc/>
public Task<byte[]> GetByteArrayAsync(Uri uri)
{
ArgumentNullException.ThrowIfNull(uri);
return _client.GetByteArrayAsync(uri);
}
/// <inheritdoc/>
public async Task<byte[]> GetByteArrayAsync(Uri uri, TimeSpan timeout)
{
ArgumentNullException.ThrowIfNull(uri);
HttpResponseMessage resp = await GetAsync(uri, timeout).ConfigureAwait(false);
resp.EnsureSuccessStatusCode();
return await resp.Content.ReadAsByteArrayAsync().ConfigureAwait(false);
}
/// <inheritdoc/>
public void CancelPendingRequests() => _client.CancelPendingRequests();
/// <inheritdoc/>
public void Dispose() => _client.Dispose();
private static void ConfigureServicePointManager()
{
// Default is 2 minutes, see https://msdn.microsoft.com/en-us/library/system.net.servicepointmanager.dnsrefreshtimeout(v=vs.110).aspx
ServicePointManager.DnsRefreshTimeout = (int)ConnectionLifeTime.TotalMilliseconds;
// Increases the concurrent outbound connections
ServicePointManager.DefaultConnectionLimit = MAX_CONNECTION_PER_SERVER;
}
private void AddBaseAddress(Uri? uri)
{
if (uri is null) { return; }
_client.BaseAddress = uri;
}
private void AddDefaultHeaders(IEnumerable<KeyValuePair<string, IEnumerable<string>>>? headers)
{
if (headers is null) { return; }
foreach (var item in headers)
{
_client.DefaultRequestHeaders.Add(item.Key, item.Value);
}
}
private void AddRequestTimeout(TimeSpan? timeout) =>
_client.Timeout = timeout ?? System.Threading.Timeout.InfiniteTimeSpan;
private void AddMaxResponseBufferSize(ulong? size)
{
if (!size.HasValue) { return; }
_client.MaxResponseContentBufferSize = (long)size.Value;
}
}