.net？core？中？WebApiClientCore的使用示例代码（.net core中间件和请求管道）奔走相告

“IUserApi”: {
“HttpHost”: “http://www.webappiclient.com/”,
“UseParameterPropertyValidate”: false,
“UseReturnValuePropertyValidate”: false,
“JsonSerializeOptions”: {
“IgnoreNullValues”: true,
“WriteIndented”: false
}
}

services
.ConfigureHttpApi<IUserApi>(Configuration.GetSection(nameof(IUserApi)))
.ConfigureHttpApi<IUserApi>(o=>
{
// 符合国情的不标准时间格式，有些接口就是这么要求必须不标准
o.JsonSerializeOptions.Converters.Add(new JsonDateTimeConverter(“yyyy-MM-dd HH:mm:ss”));
});

/// <summary>
/// 表示HttpApi选项
/// </summary>
public class HttpApiOptions
{
/// <summary>
/// 获取或设置Http服务完整主机域名
/// 例如http://www.abc.com/或http://www.abc.com/path/
/// 设置了HttpHost值，HttpHostAttribute将失效
/// </summary>
public Uri? HttpHost { get; set; }

/// <summary>
/// 获取或设置是否使用的日志功能
/// </summary>
public bool UseLogging { get; set; }=true;

/// <summary>
/// 获取或设置请求头是否包含默认的UserAgent
/// </summary>
public bool UseDefaultUserAgent { get; set; }=true;

/// <summary>
/// 获取或设置是否对参数的属性值进行输入有效性验证
/// </summary>
public bool . { get; set; }=true;

/// <summary>
/// 获取或设置是否对返回值的属性值进行输入有效性验证
/// </summary>
public bool UseReturnValuePropertyValidate { get; set; }=true;

/// <summary>
/// 获取json序列化选项
/// </summary>
public JsonSerializerOptions JsonSerializeOptions { get; }=CreateJsonSerializeOptions();

/// <summary>
/// 获取json反序列化选项
/// </summary>
public JsonSerializerOptions JsonDeserializeOptions { get; }=CreateJsonDeserializeOptions();

/// <summary>
/// xml序列化选项
/// </summary>
public XmlWriterSettings XmlSerializeOptions { get; }=new XmlWriterSettings();

/// <summary>
/// xml反序列化选项
/// </summary>
public XmlReaderSettings XmlDeserializeOptions { get; }=new XmlReaderSettings();

/// <summary>
/// 获取keyValue序列化选项
/// </summary>
public KeyValueSerializerOptions KeyValueSerializeOptions { get; }=new KeyValueSerializerOptions();

/// <summary>
/// 获取自定义数据存储的字典
/// </summary>
public Dictionary<object, object> Properties { get; }=new Dictionary<object, object>();

/// <summary>
/// 获取接口的全局过滤器集合
/// </summary>
public IList<IApiFilter> GlobalFilters { get; }=new List<IApiFilter>();

/// <summary>
/// 创建序列化JsonSerializerOptions
/// </summary>
private static JsonSerializerOptions CreateJsonSerializeOptions()
{
return new JsonSerializerOptions
{
PropertyNameCaseInsensitive=true,
PropertyNamingPolicy=JsonNamingPolicy.CamelCase,
DictionaryKeyPolicy=JsonNamingPolicy.CamelCase,
Encoder=JavaScriptEncoder.UnsafeRelaxedJsonEscaping
};
}

/// <summary>
/// 创建反序列化JsonSerializerOptions
/// </summary>
/// <returns></returns>
private static JsonSerializerOptions CreateJsonDeserializeOptions()
{
var options=CreateJsonSerializeOptions();
options.Converters.Add(JsonCompatibleConverter.EnumReader);
options.Converters.Add(JsonCompatibleConverter.DateTimeReader);
return options;
}
}

public class TestTokenProvider : TokenProvider
{
private readonly IConfiguration _configuration;
public TestTokenProvider(IServiceProvider services,IConfiguration configuration) : base(services)
{
_configuration=configuration;
}

protected override Task<TokenResult> RefreshTokenAsync(IServiceProvider serviceProvider, string refresh_token)
{
return this.RefreshTokenAsync(serviceProvider, refresh_token);
}

protected override async Task<TokenResult> RequestTokenAsync(IServiceProvider serviceProvider)
{
LoginInput login=new LoginInput();
login.UserNameOrEmailAddress=”admin”;
login.Password=”bb123456″;
var result=await serviceProvider.GetRequiredService<ITestApi>().RequestToken(login).Retry(maxCount: 3);
return result;
}
}

services.AddTokenProvider<ITestApi,TestTokenProvider>();

class UriQueryOAuthTokenHandler : OAuthTokenHandler
{
/// <summary>
/// token应用的http消息处理程序
/// </summary>
/// <param name=”tokenProvider”>token提供者</param>
public UriQueryOAuthTokenHandler(ITokenProvider tokenProvider)
: base(tokenProvider)
{
}

/// <summary>
/// 应用token
/// </summary>
/// <param name=”request”></param>
/// <param name=”tokenResult”></param>
protected override void UseTokenResult(HttpRequestMessage request, TokenResult tokenResult)
{
// var builder=new UriBuilder(request.RequestUri);
// builder.Query +=”mytoken=” + Uri.EscapeDataString(tokenResult.Access_token);
// request.RequestUri=builder.Uri;

var uriValue=new UriValue(request.RequestUri).AddQuery(“myToken”, tokenResult.Access_token);
request.RequestUri=uriValue.ToUri();
}
}

services
.AddHttpApi<IUserApi>()
.AddOAuthTokenHandler((s, tp)=> new UriQueryOAuthTokenHandler(tp));
//自定义TokoenProvider使用自定义OAuthTokenHandler
apiBulider.AddOAuthTokenHandler<UrlTokenHandler>((sp,token)=>
{
token=sp.GetRequiredService<TestTokenProvider>();
return new UrlTokenHandler(token);
},WebApiClientCore.Extensions.OAuths.TypeMatchMode.TypeOrBaseTypes);

public interface IUserApi
{
[HttpPatch(“api/users/{id}”)]
Task<UserInfo> PatchAsync(string id, JsonPatchDocument<User> doc);
}

var doc=new JsonPatchDocument<User>();
doc.Replace(item=> item.Account, “laojiu”);
doc.Replace(item=> item.Email, “laojiu@qq.com”);

PATCH /api/users/id001 HTTP/1.1
Host: localhost:6000
User-Agent: WebApiClientCore/1.0.0.0
Accept: application/json; q=0.01, application/xml; q=0.01
Content-Type: application/json-patch+json

[]

try
{
var model=await api.GetAsync();
}
catch (HttpRequestException ex) when (ex.InnerException is ApiInvalidConfigException configException)
{
// 请求配置异常
}
catch (HttpRequestException ex) when (ex.InnerException is ApiResponseStatusException statusException)
{
// 响应状态码异常
}
catch (HttpRequestException ex) when (ex.InnerException is ApiException apiException)
{
// 抽象的api异常
}
catch (HttpRequestException ex) when (ex.InnerException is SocketException socketException)
{
// socket连接层异常
}
catch (HttpRequestException ex)
{
// 请求异常
}
catch (Exception ex)
{
// 异常
}

GetNumberTemplateForEditOutput put=new GetNumberTemplateForEditOutput();
var res=await _testApi.GetForEdit(id).Retry(maxCount: 1).WhenCatchAsync<ApiResponseStatusException>(async p=>
{
if (p.StatusCode==HttpStatusCode.Unauthorized)
{
await Token();//当http请求异常时报错,重新请求一次，保证token一直有效
}
});
put=res.Result;
return put;

[HttpHost(“请求地址”)]//请求地址域名
public interface ITestApi : IHttpApi
{
[OAuthToken]//权限
[JsonReturn]//设置返回格式
[HttpGet(“/api/services/app/NumberingTemplate/GetForEdit”)]//请求路径
ITask<AjaxResponse<GetNumberTemplateForEditOutput>> GetForEdit([Required] string id);//请求参数声明

[HttpPost(“api/TokenAuth/Authenticate”)]
ITask<string> RequestToken([JsonContent] AuthenticateModel login);
}

/// <summary>
/// WebApiClient扩展类
/// </summary>
public static class WebApiClientExentions
{
public static IServiceCollection AddWebApiClietHttp<THttp>(this IServiceCollection services, Action<HttpApiOptions>? options=null) where THttp : class, IHttpApi
{
HttpApiOptions option=new HttpApiOptions();
option.JsonSerializeOptions.Converters.Add(new JsonDateTimeConverter(“yyyy-MM-dd HH:mm:ss”));
option.UseParameterPropertyValidate=true;
if(options !=null)
{
options.Invoke(option);
}
services.AddHttpApi<THttp>().ConfigureHttpApi(p=> p=option);
return services;
}

public static IServiceCollection AddWebApiClietHttp<THttp>(this IServiceCollection services,IConfiguration configuration) where THttp : class, IHttpApi
{
services.AddHttpApi<THttp>().ConfigureHttpApi((Microsoft.Extensions.Configuration.IConfiguration)configuration);
return services;
}

public static IServiceCollection AddWebApiClientHttpWithTokeProvider<THttp, TTokenProvider>(this IServiceCollection services, Action<HttpApiOptions>? options=null) where THttp : class, IHttpApi
where TTokenProvider : class, ITokenProvider
{
services.AddWebApiClietHttp<THttp>(options);
services.AddTokenProvider<THttp,TTokenProvider>();
return services;
}

public static IServiceCollection AddWebApiClientHttpWithTokeProvider<THttp, TTokenProvider>(this IServiceCollection services, IConfiguration configuration) where THttp : class, IHttpApi
where TTokenProvider : class, ITokenProvider
{
services.AddWebApiClietHttp<THttp>(configuration);
services.AddTokenProvider<THttp, TTokenProvider>();
return services;
}
}

services.AddWebApiClientHttpWithTokeProvider<ITestApi, TestTokenProvider>();

您可能感兴趣的文章:.Net Core WebApi部署在Linux服务器上的方法.Net Core WebApi部署到Windows服务器上的步骤.net core webapi通过中间件获取请求和响应内容的方法.Net Core WebApi的简单创建以及使用方法ASP.NET Core实现自定义WebApi模型验证详解