专栏首页WebApiClientWebApiClient进阶
原创

WebApiClient进阶

本章节将向读者讲解如何在不同的项目环境下,选择适合的方式来创建http声明接口的代理类。

1. 没有依赖注入的环境

1.1 使用HttpApiClient静态类(不推荐)

public interface IMyWebApi : IHttpApi
{
    [HttpGet("user/{id}")]
    ITask<UserInfo> GetUserAsync(string id);
}


// 创建myWebApi
var httpApiConfig = new HttpApiConfig
{
    HttpHost = new Uri("http://localhost:9999/"),
    LoggerFactory = new LoggerFactory().AddConsole(),
};
this.myWebApi = HttpApiClient.Create<IMyWebApi>(httpApiConfig);


// 调用http请求代码
var user = await this.myWebApi.GetUserAsync("id001");

你应该尽量将得到的myWebApi保持为全局变量,多次请求里共用一个myWebApi实例。如果频繁地每次请求都创建和释放myWebApi,实际等同于短连接到服务器,客户端和服务器的性能都受到影响。但全局单例的myWebApi可能不遵循守DNS生存时间(TTL)设置,请求的域名指向的ip变化之后,会产生不正确的请求。

1.2 使用HttpApiFactory静态类

public interface IMyWebApi : IHttpApi
{
    [HttpGet("user/{id}")]
    ITask<UserInfo> GetUserAsync(string id);
}


// 初始化HttpApiFactory代码 
HttpApiFactory.Add<IMyWebApi>().ConfigureHttpApiConfig(c =>
{
    c.HttpHost = new Uri("http://localhost:9999/");
    c.LoggerFactory = new LoggerFactory().AddConsole();
    c.FormatOptions.DateTimeFormat = DateTimeFormats.ISO8601_WithMillisecond;
});


// 调用http请求代码
var myWebApi = HttpApiFactory.Create<IMyWebApi>();
var user = await myWebApi.GetUserAsync("id001");

使用HttpApiFactory的好处是在入口处只配置一次IMyWebApi,由HttpApiFactory自动接理IMyWebApi的生命周期管理。在使用中,不用处理myWebApi实例的释放(手动Dispose也不会释放),在一定的时间内都是获取到同一个myWebApi实例,当实例生命超过配置的周期时,自动被跟踪释放,并提供返回下一个一样配置的myWebApi实例。

2. 有依赖注入的环境

除了可以像上面使用HttpApiFactory静态类之外,WebApiClient还提供IHttpApiFactory<>和HttpApiFactory<>类型,很容易应用于各种有依赖注入的环境,在服务里面获取到IMyWebApi的实例,而创建IMyWebApi实例的工作留给依赖注入组件来完成。

2.1 Asp.net MVC + Autofac

public interface IMyWebApi : IHttpApi
{
    [HttpGet("user/{id}")]
    ITask<UserInfo> GetUserAsync(string id);
}


// Global.asax.cs Application_Start
var builder = new ContainerBuilder();
builder.RegisterControllers(Assembly.GetExecutingAssembly()).PropertiesAutowired();

builder.Register(_ => new HttpApiFactory<IMyWebApi>()
    .ConfigureHttpApiConfig(c =>
    {
        c.HttpHost = new Uri("http://localhost:9999/");
        c.FormatOptions.DateTimeFormat = DateTimeFormats.ISO8601_WithMillisecond;
    }))
    .As<IHttpApiFactory<IMyWebApi>>()
    .SingleInstance();

builder.Register(c => c.Resolve<IHttpApiFactory<IMyWebApi>>().CreateHttpApi())
    .As<IMyWebApi>()
    .InstancePerHttpRequest();

DependencyResolver.SetResolver(new AutofacDependencyResolver(builder.Build()));



// Controller
public class HomeController : Controller
{
    public IMyWebApi MyWebApi { get; set; }

    public async Task<ActionResult> Index()
    {
        var user = await this.MyWebApi.GetUserAsync("id001");
        return View(user);
    }
}

2.2 Asp.net Core

public interface IMyWebApi : IHttpApi
{
    [HttpGet("user/{id}")]
    ITask<UserInfo> GetUserAsync(string id);
}


// Startup.cs配置依赖注入
public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<IHttpApiFactory<IMyWebApi>, HttpApiFactory<IMyWebApi>>(p =>
    {
        return new HttpApiFactory<IMyWebApi>().ConfigureHttpApiConfig(c =>
        {
            c.HttpHost = new Uri("http://localhost:9999/");
            c.LoggerFactory = p.GetRequiredService<ILoggerFactory>();
        });
    });

    services.AddTransient<IMyWebApi>(p =>
    {
        var factory = p.GetRequiredService<IHttpApiFactory<IMyWebApi>>();
        return factory.CreateHttpApi();
    });
}


// Controller代码 
public class HomeController : Controller
{
    public async Task<UserInfo> Index([FromServices]IMyWebApi myWebApi)
    {
        return await myWebApi.GetUserAsync("id001");
    }
}

2.3 Asp.net core + HttpClientFactory

public interface IMyWebApi : IHttpApi
{
    [HttpGet("user/{id}")]
    ITask<UserInfo> GetUserAsync(string id);
}


// Startup.cs配置依赖注入
public void ConfigureServices(IServiceCollection services)
{
    services.AddHttpClient<IMyWebApi>().AddTypedClient<IMyWebApi>((client, p) =>
    {
        var httpApiConfig = new HttpApiConfig(client)
        {
            HttpHost = new Uri("http://localhost:9999/"),
            LoggerFactory = p.GetRequiredService<ILoggerFactory>()
        };        
        return HttpApiClient.Create<IMyWebApi>(httpApiConfig);
    });
}


// Controller代码 
public class HomeController : Controller
{
    public async Task<UserInfo> Index([FromServices]IMyWebApi myWebApi)
    {
        return await myWebApi.GetUserAsync("id001");
    }
}

原创声明,本文系作者授权云+社区发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • WebApiClient高级

    这是一个用于调试追踪的过滤器,可以将请求与响应内容写入统一日志,统一日志工厂需要在HttpApiConfig的LoggerFactory配置。

    老九
  • WebApiClient基础

    如果接口IMyWebApi有多个方法且都指向同一服务器,可以将请求的域名抽出来放到HttpHost特性。

    老九
  • mybatis源码解读(一)——初始化环境

    IT可乐
  • C#实现Excel模板导出和从Excel导入数据

          午休时间写了一个Demo关于Excel导入导出的简单练习 1.窗体 ? 2.引用office命名空间 添加引用-程序集-扩展-Microsoft.O...

    用户1055830
  • 犀牛鸟沙龙迎来周志华教授及其团队

    近日,人工智能与机器学习领域专家周志华教授及其团队受邀到访腾讯,做客犀牛鸟沙龙,并与公司研发团队展开深入交流。 周志华教授现任南京大学计算机科学与技术系副主任,...

    腾讯高校合作
  • 腾讯云主机安全问题指南

    腾讯云基础安全
  • 联通疑似屏蔽工信部投诉网站,域名被指向127.0.0.1

    4月25日开始,陆续有用户在微博上反映,部分地区的联通用户无法正常访问工信部投诉网站,经过查证之后发现该地区联通用户在访问工信部投诉网站时IP地址竟然被解析到了...

    FB客服
  • DotNetCore 3.0 助力 WPF本地化

    随着我们的应用程序越来越受欢迎,我们的下一步将要开发多语言功能。方便越来越多的国家使用我们中国的应用程序, 基于 WPF 本地化,我们很多时候使用的是系统资源文...

    梁规晓
  • 了解ASP.NET MVC几种ActionResult的本质:EmptyResult & ContentResult

    在之前的两篇文章(《EmptyResult & ContentResult》和《FileResult》)我们剖析了EmptyResult、ContentResu...

    蒋金楠
  • 了解ASP.NET MVC几种ActionResult的本质:JavaScriptResult & JsonResult

    在之前的两篇文章(《EmptyResult & ContentResult》和《FileResult》)我们剖析了EmptyResult、ContentResu...

    蒋金楠

扫码关注云+社区

领取腾讯云代金券