WebApiClient库支持AOT

1 库简介

WebApiClient是开源在github上的一个http客户端库，内部基于HttpClient开发，只需要定义c#接口(interface)，并打上相关特性，即可异步调用http-api。该库支持framework4.5+、netstandard1.3、netcoreapp2.1，包含以下特性：

• 原生的支持面向切面编程；
• 内置丰富的特性，支持自定义特性；
• 灵活和Filter、GlobalFilter和IParameterable；
• 功能强大的序列化工具；
• 与外部HttpMessageHandler无缝衔接；
• 独一无二的请求异常条件重试功能和异常处理链式语法功能

2 WebApiClient.JIT

JIT，即Just-in-time，动态(即时)编译，边运行边编译，WebApiClient.JIT在运行时，在需要的时候使用Emit创建Http请求接口的代理类。

2.1 动态代理

[HttpHost("http://www.webapiclient.com")] 
public interface IMyWebApi : IHttpApi
{
    // GET webapi/user?account=laojiu
    // Return 原始string内容
    [HttpGet("/webapi/user")]
    ITask<string> GetUserByAccountAsync(string account);

    // POST webapi/user  
    // Body Account=laojiu&password=123456
    // Return json或xml内容
    [HttpPost("/webapi/user")]
    ITask<UserInfo> UpdateUserWithFormAsync([FormContent] UserInfo user);
}

例如，开发者定义了如上请求接口，在调用到 HttpApiClient.Create<IMyWebApi>()时，才会自动创建一个动态模块，动态模块里定义一个实现了IMyWebApi接口的类型，使用IL实现接口的方法，最后实例化并返回此类型的实例，这些过程，都离不开Emit和JIT。

2.2 优势和劣势

优势：不依赖于编译器，在运行时用到接口的时候，按需默默地为开发者实现了请求接口的代理类，这些接口的定义可以在外部程序集，同时编写接口的语言只要是能编译为中间公共语言的就得到支持。

劣势：由于严重依赖于JIT，对于编译阶段就将IL翻译到平台本机指令的地方，将无法得到支持，比如unity3d、ios或uwp，因为需要在编译阶段将IL再编译为平台本机指令，而动态代理IL在这个时期还不存在，同时编译器也会禁止代码里使用Emit相关Api，因为运行时不会再有JIT的存在。

3 WebApiClient.AOT

AOT，Ahead Of Time，指运行前编译，WebApiClient.AOT在编译阶段，就自动插入Http请求接口的代理类IL指令。

3.1 编译时插入代理类IL

这类需求实际上是自动帮开发者补充接口实现类的代码，然后合并到项目一起编译。考虑到开发语言的众多，比如c#、vb.net、c++/cli和f#等等，而且语言特性也在不断变化，所以WebApiClient没有从代码语法分析和自动补充接口实现类代码这个角度来解决这个问题，而是在编译过程中，等待输出程序集之后，再往程序集文件里写入代理类的IL代码，这样就可以规避上层编程语言的语法分析难题。

.net的编译过程，实际上为msbuild的一系列任务组合完成，我们的项目文件.csproj，实际上msbuild脚本，WebApiClient需要做的是，给msbuild增加一个自定义的任务，用于在完成CoreCompile任务之后，使用mono.cecli修改编译得到的程序集，插入代理类的IL。

<?xml version="1.0" encoding="utf-16"?>
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

  <PropertyGroup>
    <Runtime Condition="'$(MSBuildRuntimeType)' == 'Core'">netcoreapp1.0</Runtime>
    <Runtime Condition="'$(MSBuildRuntimeType)' != 'Core'">net45</Runtime>

    <TaskAssembly>$(MSBuildThisFileDirectory)..\BuildTask\$(Runtime)\WebApiClient.AOT.Task.dll</TaskAssembly>
    <TargetAssembly>$(MSBuildProjectDirectory)\$(IntermediateOutputPath)$(TargetFileName)</TargetAssembly>
  </PropertyGroup>

  <UsingTask TaskName="WebApiClient.AOT.Task.ProxyTask" AssemblyFile="$(TaskAssembly)" />
  <Target Name="BuildProxy" AfterTargets="CoreCompile" DependsOnTargets="ResolveProjectReferences;ResolveAssemblyReferences">
    <Message Text="BuildProxy: $(TargetAssembly)" Importance="high" />
    <WebApiClient.AOT.Task.ProxyTask TargetAssembly="$(TargetAssembly)" References="@(_ResolveAssemblyReferenceResolvedFiles)" />
  </Target>
</Project>

3.2 优势和劣势

优势：支持的平台更广泛，在编译时就可以静态检查接口声明是否分的符合框架约定。

劣势：依赖于编译器和编译过程，必须在项目引用nuget包才支持，直接引用WebApiClient.AOT库开发的话，编译时不会插入IL代理指令。

4 如何选择

如果你不是用于unity3d、ios或uwp这些平台应用开发，选择WebApiClient.JIT将比较方便；如果你不确定未来项目是否也会用于上面这些平台，就选择WebApiClient.AOT。不过不管怎么样，两个提供Api是完全一致，区别只在于你看不到的编译过程或运行时过程。