13518219792
本篇文章给大家分享的是有关如何在Asp.Net Core中使用Refit，小编觉得挺实用的，因此分享给大家学习，希望大家阅读完这篇文章后可以有所收获，话不多说，跟着小编一起来看看吧。
ASP.NET 是开源，跨平台，高性能，轻量级的 Web 应用构建框架，常用于通过 HTML、CSS、JavaScript 以及服务器脚本来构建网页和网站。
在常规的方式中我们一般使用IHttpClientFactory来创建HttpClient对象，然后使用这个对象来发送和接收消息,至于为什么要使用这个接口来创建HttpClient对象而不是使用using new HttpClient的原因请点击这里了解更多的信息，我们先来看下面的这个例子。
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using System.Web;
using Abp.Domain.Services;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
namespace Sunlight.Dms.Parts.Domain.Web {
///
/// HttpClient的帮助类
///
public class DcsPartClientService : DomainService {
private readonly HttpClient _httpClient;
private readonly ILogger _loggerHelper;
public DcsPartClientService(IHttpClientFactory httpClientFactory,
ILogger loggerHelper) {
_loggerHelper = loggerHelper;
_httpClient = httpClientFactory.CreateClient(PartsConsts.DcsPartClientName);
if (_httpClient.BaseAddress == null) {
throw new ArgumentNullException(nameof(httpClientFactory), $"没有配置名称为 {PartsConsts.DcsPartClientName} 的HttpClient，或者接口服务的地址为空");
}
}
///
/// Post请求返回实体
///
/// 请求相对路径
/// 请求数据
/// 实体T
public async Task> PostResponse(string relativeUrl, object postObj) where T : class {
var postData = JsonConvert.SerializeObject(postObj);
_httpClient.DefaultRequestHeaders.Add("user-agent", "Dcs-Parts");
_httpClient.CancelPendingRequests();
_httpClient.DefaultRequestHeaders.Clear();
HttpContent httpContent = new StringContent(postData);
httpContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");
var result = default(List);
var response = await _httpClient.PostAsync(_httpClient.BaseAddress + relativeUrl, httpContent);
if (response.StatusCode == HttpStatusCode.NotFound) {
throw new ValidationException("找不到对应的DcsParts服务");
}
var responseContent = await response.Content.ReadAsAsync>>();
if (response.IsSuccessStatusCode) {
result = responseContent?.Payload;
} else {
if (!string.IsNullOrWhiteSpace(responseContent?.Message)) {
throw new ValidationException(responseContent.Message);
}
_loggerHelper.LogDebug($"请求返回结果：{0} 请求内容：{1}", response.StatusCode, postData);
}
return await Task.FromResult(result);
}
public async Task> GetResponse(string relativeUrl, object queryObj) where T : class {
var queryData = ModelToUriQueryParam(queryObj);
_httpClient.DefaultRequestHeaders.Add("user-agent", "Dcs-Parts");
_httpClient.CancelPendingRequests();
_httpClient.DefaultRequestHeaders.Clear();
_httpClient.DefaultRequestHeaders.Add("accept", "application/json");
var result = default(List);
var response = await _httpClient.GetAsync(_httpClient.BaseAddress + relativeUrl + queryData);
if (response.StatusCode == HttpStatusCode.NotFound) {
throw new ValidationException("找不到对应的DcsParts服务");
}
var responseContent = await response.Content.ReadAsAsync>>();
if (response.IsSuccessStatusCode) {
result = responseContent?.Payload;
} else {
if (!string.IsNullOrWhiteSpace(responseContent?.Message)) {
throw new ValidationException(responseContent.Message);
}
}
return await Task.FromResult(result);
}
private string ModelToUriQueryParam(T t, string url = "") {
var properties = t.GetType().GetProperties();
var sb = new StringBuilder();
sb.Append(url);
sb.Append("?");
foreach (var p in properties) {
var v = p.GetValue(t, null);
if (v == null)
continue;
sb.Append(p.Name);
sb.Append("=");
sb.Append(HttpUtility.UrlEncode(v.ToString()));
sb.Append("&");
}
sb.Remove(sb.Length - 1, 1);
return sb.ToString();
}
}
public class ReceiveResponseBody where T : class {
public string Message { get; set; }
public T Payload { get; set; }
}
public class ReceiveResponseBody {
public string Message { get; set; }
}
} 在这个过程中我们通过构造函数来注入IHttpClientFactory接口，然后用这个接口的CreateClient方法来创建一个的HttpClient对象，在这里我们一般都会同步注入ILogger接口来记录日志信息从而便于我们排查线上问题，这里我们在CreateClient方法中传入了一个字符串类型的参数用于标记自己创建的HttpClient对象的性。这里我们可以看到在构造函数中我们会去判断当前创建的HttpClient的BaseAddress，如果没有这个基地址那么程序会直接抛出错误提示，那么问题来了我们的HttpClient的BaseAddress到底在哪里配置呢？熟悉Asp.Net Core机制的朋友肯定一下子就会想到在Startup类中配置，那么我们来看看需要怎么配置。
public IServiceProvider ConfigureServices(IServiceCollection services) {
//dcs.part服务
services.AddHttpClient(PartsConsts.DcsPartClientName, config => {
config.BaseAddress = new Uri(_appConfiguration["DependencyServices:DcsParts"]);
config.Timeout = TimeSpan.FromSeconds(60);
});
} 这里我只是简要截取了一小段内容，这里我们看到AddHttpClient的第一个参数也是一个字符串常量，这个常量应该是和IHttpClientFactory的CreateClient的方法中的那个常量保持绝对的一致，只有这样我们才能够标识的标识一个HttpClient对象，创建完了之后我们就能够在这个里面去配置这个HttpClient的各种参数了，另外在上面的这段代码中_appConfiguration这个对象是通过Startup的构造函数注入的，具体的代码请参考下面。
public Startup(IHostingEnvironment env) {
_appConfiguration = env.GetAppConfiguration();
Clock.Provider = ClockProviders.Local;
Environment = env;
Console.OutputEncoding = System.Text.Encoding.UTF8;
} 另外我们还需要配置一些HttpClient所必须的属性包括基地址、超时时间......等等，当然这个基地址我们是配置在appsetting.json中的，具体的配置如下所示。
"DependencyServices": {
"BlobStorage": "http://blob-storage/",
"DcsParts": "http://dcs-parts/",
"DmsAfterSales": "http://dms-after-sales/"
}有了这些我们就能够具备创建一个HttpClient对象的条件了，后面我们来看看我们怎么使用这个HttpClient进行发送和接收数据。
