Basit Bir Rest Api Client Geliştirelim 5
2023-05-12
Daha fazla işlevsellik eklemek için, hata günlüğü ve otomatik hata izleme ekleyebiliriz. Bu, hataların daha kolay izlenmesine ve işlenmesine olanak sağlar. Bunun için, ILogger
arabirimi kullanılarak hataların kaydedilmesini sağlayabiliriz.
using Polly;
using Polly.Caching;
using Polly.Caching.Memory;
using Polly.Registry;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
public class MyHttpClient : IDisposable
{
private readonly HttpClient _client;
private readonly IPolicyRegistry<string> _policyRegistry;
private readonly ILogger<MyHttpClient> _logger;
public MyHttpClient(HttpClient client, IPolicyRegistry<string> policyRegistry, ILogger<MyHttpClient> logger, string baseAddress, TimeSpan? timeout = null, HttpMessageHandler handler = null)
{
_client = handler == null ? client : new HttpClient(handler);
_client.BaseAddress = new Uri(baseAddress);
if (timeout.HasValue)
{
_client.Timeout = timeout.Value;
}
_policyRegistry = policyRegistry;
_logger = logger;
}
private HttpRequestMessage CreateRequest(string uri, HttpMethod method, string jsonData = null, Dictionary<string, string> headers = null)
{
var request = new HttpRequestMessage(method, uri);
if (headers != null)
{
foreach (var header in headers)
{
request.Headers.Add(header.Key, header.Value);
}
}
if (!string.IsNullOrWhiteSpace(jsonData))
{
request.Content = new StringContent(jsonData, Encoding.UTF8, "application/json");
}
return request;
}
public async Task<HttpResponseMessage> SendRequestAsync(string uri, HttpMethod method, string jsonData = null, Dictionary<string, string> headers = null)
{
var request = CreateRequest(uri, method, jsonData, headers);
try
{
var policyWrap = Policy.WrapAsync(_policyRegistry.Get<IAsyncPolicy<HttpResponseMessage>>("RetryPolicy"),
_policyRegistry.Get<IAsyncPolicy<HttpResponseMessage>>("CachePolicy"));
var response = await policyWrap.ExecuteAsync(async () => await _client.SendAsync(request));
response.EnsureSuccessStatusCode();
return response;
}
catch (HttpRequestException ex)
{
_logger.LogError(ex, $"{method} request to {uri} failed.");
throw new Exception($"{method} request to {uri} failed.", ex);
}
}
public async Task<string> GetAsync(string uri, Dictionary<string, string> headers = null) =>
(await SendRequestAsync(uri, HttpMethod.Get, null, headers)).Content.ReadAsStringAsync().Result;
public async Task<string> PostAsync(string uri, string jsonData, Dictionary<string, string> headers = null) =>
(await SendRequestAsync(uri, HttpMethod.Post, jsonData, headers)).Content.ReadAsStringAsync().Result;
public async Task<string> PutAsync(string uri, string jsonData, Dictionary<string, string> headers = null) =>
(await SendRequestAsync(uri, HttpMethod.Put, jsonData, headers)).Content.ReadAsStringAsync().Result;
public async Task<string> DeleteAsync(string uri, Dictionary<string, string> headers = null) =>
(await SendRequestAsync(uri, HttpMethod.Delete, null, headers)).Content.ReadAsStringAsync().Result;
public void SetAuthorizationHeader(string scheme, string parameter)
{
_client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(scheme, parameter);
}
public void Dispose()
{
_client?.Dispose();
}
}
Bu kod parçacığı, ILogger
arabirimini kullanarak hata izleme ve kaydetme özelliklerini ekler. Bir
HttpRequestException
hata durumunda, hata ve hata mesajı otomatik olarak kaydedilir.
Bu değişiklik, hataların daha kolay izlenmesini ve hataların neden olduğu sorunların daha hızlı çözülmesini sağlar. Ayrıca,
ILogger
arabirimi, log kayıtlarınızı bir dosyaya, bir veritabanına veya başka bir hedefe yönlendirebileceğiniz şekilde yapılandırılabilir.
Ayrıca, ILogger
arabirimi .NET Core ve .NET 5’te yerleşik olarak mevcuttur ve çeşitli log kaydedicileri destekler, örneğin Console, Debug, EventSource ve EventLog. Ayrıca, üçüncü taraf log kaydedicileri ile de kullanılabilir, örneğin Serilog, NLog ve log4net.
Şimdi de isteğe özel zaman aşımı ayarlayabilme yeteneği ekleyelim. Bu özellik, belirli bir HTTP isteği için özel bir zaman aşımı süresi belirlememize olanak sağlar.
using Polly;
using Polly.Caching;
using Polly.Caching.Memory;
using Polly.Registry;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
public class MyHttpClient : IDisposable
{
private readonly HttpClient _client;
private readonly IPolicyRegistry<string> _policyRegistry;
private readonly ILogger<MyHttpClient> _logger;
public MyHttpClient(HttpClient client, IPolicyRegistry<string> policyRegistry, ILogger<MyHttpClient> logger, string baseAddress, TimeSpan? timeout = null, HttpMessageHandler handler = null)
{
_client = handler == null ? client : new HttpClient(handler);
_client.BaseAddress = new Uri(baseAddress);
if (timeout.HasValue)
{
_client.Timeout = timeout.Value;
}
_policyRegistry = policyRegistry;
_logger = logger;
}
private HttpRequestMessage CreateRequest(string uri, HttpMethod method, string jsonData = null, Dictionary<string, string> headers = null, TimeSpan? timeout = null)
{
var request = new HttpRequestMessage(method, uri);
if (headers != null)
{
foreach (var header in headers)
{
request.Headers.Add(header.Key, header.Value);
}
}
if (!string.IsNullOrWhiteSpace(jsonData))
{
request.Content = new StringContent(jsonData, Encoding.UTF8, "application/json");
}
if (timeout.HasValue)
{
_client.Timeout = timeout.Value;
}
return request;
}
public async Task<HttpResponseMessage> SendRequestAsync(string uri, HttpMethod method, string jsonData = null, Dictionary<string, string> headers = null, TimeSpan? timeout = null)
{
var request = CreateRequest(uri, method, jsonData, headers, timeout);
try
{
var policyWrap = Policy.WrapAsync(_policyRegistry.Get<IAsyncPolicy<HttpResponseMessage>>("RetryPolicy"),
_policyRegistry.Get<IAsyncPolicy<HttpResponseMessage>>("CachePolicy"));
var response = await policyWrap.ExecuteAsync(async () => await _client.SendAsync(request));
response.EnsureSuccessStatusCode();
return response;
}
catch (HttpRequestException ex)
{
_logger.LogError(ex, $"{method} request to {uri} failed.");
throw new Exception($"{method} request to {uri} failed.", ex);
}
}
public async Task<string> GetAsync(string uri, Dictionary<string, string> headers = null, TimeSpan? timeout = null) =>
(await SendRequestAsync(uri, HttpMethod.Get, null, headers, timeout)).Content.ReadAsStringAsync().Result;
public async Task<string> PostAsync(string uri, string jsonData, Dictionary<string, string> headers = null, TimeSpan? timeout = null) =>
(await SendRequestAsync(uri, HttpMethod.Post, jsonData, headers, timeout)).Content.ReadAsStringAsync().Result;
public async Task<string> PutAsync(string uri, string jsonData, Dictionary<string, string> headers = null, TimeSpan? timeout = null) =>
(await SendRequestAsync(uri, HttpMethod.Put, jsonData, headers, timeout)).Content.ReadAsStringAsync().Result;
public async Task<string> DeleteAsync(string uri, Dictionary<string, string> headers = null, TimeSpan? timeout = null) =>
(await SendRequestAsync(uri, HttpMethod.Delete, null, headers, timeout)).Content.ReadAsStringAsync().Result;
public void SetAuthorizationHeader(string scheme, string parameter)
{
_client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(scheme, parameter);
}
public void Dispose()
{
_client?.Dispose();
}
}
Bu son değişiklikler, her bir HTTP isteği için özel bir zaman aşımı süresi belirleyebilmenizi sağlar. Bu, bazı isteklerin diğerlerinden daha uzun sürebileceği durumlar için kullanışlıdır. Örneğin, büyük bir dosyanın indirilmesi gibi bir işlem, normal bir GET isteğinden daha uzun sürebilir.
Bu özelliği kullanmak için, SendRequestAsync
yöntemine bir TimeSpan
nesnesi olarak bir zaman aşımı değeri ekleyin. Bu değer, HTTP isteği için maksimum zaman aşımı süresini belirler. Bu süre dolduğunda, HttpClient
bir TaskCanceledException
özel durumunu fırlatır. Bu özel durum, genellikle bir catch
bloğunda işlenir ve uygun bir hata mesajı gösterilir.