天天看點

WebApiClient與Asp.net core DI的結合

1 WebApiClient

一款基于HttpClient封裝,隻需要定義c#接口并修飾相關特性,即可異步調用遠端http接口的用戶端庫
  • WebApiClient
  • WebApiClient.Extensions
  • WebApiClient.Tools

2 Http接口的注冊與提供

2.1 聲明遠端端http接口

public interface IBaiduApi : IHttpApi
{
    [HttpGet("/s")]
    ITask<string> GetAsync(string word);
}           

2.2 遠端端http的注冊

使用HttpClientFactory管理HttpClient的建立,利用AddTypedClient建立遠端http接口的WebApiClient調用代理,同時給HttpApiConfig配置ServiceProvider執行個體。
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpApiTypedClient<IBaiduApi>().ConfigureHttpApiConfig((c, p) =>
    {
        c.HttpHost = new Uri("http://www.baidu.com/");
    });
}           
/// <summary>
/// 添加HttpApiClient的别名HttpClient
/// </summary>
/// <typeparam name="TInterface">接口類型</typeparam>
/// <param name="services"></param>
/// <param name="configOptions">配置選項</param>
/// <exception cref="ArgumentNullException"></exception>
/// <returns></returns>
public static IHttpClientBuilder AddHttpApiTypedClient<TInterface>(this IServiceCollection services, Action<HttpApiConfig, IServiceProvider> configOptions)
    where TInterface : class, IHttpApi
{
    if (configOptions == null)
    {
        throw new ArgumentNullException(nameof(configOptions));
    }

    return services
        .AddHttpClient<TInterface>()
        .AddTypedClient((httpClient, provider) =>
        {
            var httpApiConfig = new HttpApiConfig(httpClient)
            {
                ServiceProvider = provider
            };
            configOptions.Invoke(httpApiConfig, provider);
            return HttpApiClient.Create<TInterface>(httpApiConfig);
        });
}           

2.3 遠端端http接口的提供

可以使用構造器注入IBaiduApi或[FromServices]特性得到遠端接口代理執行個體。
public class HomeController : Controller
{   
    // GET: /<controller>/
    public async Task<IActionResult> Index([FromServices] IBaiduApi baiduApi)
    {
        var html = await baiduApi.GetAsync("WebApiClient");
        return Content(html);
    }
}           

3 WebApiClient過濾器的服務提供

3.1 在接口上使用自定義LogFilter

[LogFilter]
public interface IBaiduApi : IHttpApi
{
    [HttpGet("/s")]
    ITask<string> GetAsync(string word);
}           

3.2 使用context.GetService擷取服務執行個體

class LogFilter : ApiActionFilterAttribute
{
    public override Task OnBeginRequestAsync(ApiActionContext context)
    {
        var logger = context.GetService<ILoggerFactory>().CreateLogger("Baidu");
        logger.LogWarning($"request {context.ApiActionDescriptor.Name} {context.RequestMessage.RequestUri}");

        return base.OnBeginRequestAsync(context);
    }
}           

3.3 日志服務輸出日志樣例

warn: Baidu[0]
      request GetAsync http://www.baidu.com/s?word=WebApiClient