Microsoft.Extensions.DependencyInjection 之三：反射可以一战（附源代码）

[TOC]

前文回顾

Microsoft.Extensions.DependencyInjection 之一：解析实现提到了 Microsoft.Extensions.DependencyInjection 包含以下核心组件。

IServiceCallSite

组件实例化上下文，包含许多实现，仅列举其中的ConstantCallSite，CreateInstanceCallSite，ConstructorCallSite如下。

ConstructorCallSite既是IServiceCallSite的实现类，又复合引用IServiceCallSite，以表达自身参数的构建形式。

组件生命周期也使用IServiceCallSite表达，它们既从IServiceCallSite继承，也引用IServiceCallSite。

CallSiteFactory

当组件需要被实例化时，CallSiteFactory从维护的ServiceDescriptor查找注入方式，对类型注入的组件使用反射解析其构造函数，并递归解析其参数，最后缓存得到的IServiceCallSite实例。

ServiceProviderEngine

ServiceProviderEngine是抽象类，内部依赖CallSiteRuntimeResolver完成基于反射的组件实例化，并缓存了组件实例化的委托。

CompiledServiceProviderEngine

CompiledServiceProviderEngine从ServiceProviderEngine继承，内部依赖ExpressionResolverBuilder完成基于表达式树的组件实例化的委托。

DynamicServiceProviderEngine

DynamicServiceProviderEngine从CompiledServiceProviderEngine继承，它创建的委托比较特殊：

该委托第1次执行实际是 ServiceProviderEngine 内部的CallSiteRuntimeResolver调用
该委托第2次执行时开启异步任务，调用CompiledServiceProviderEngine内部的ExpressionResolverBuilder编译出委托并覆盖ServiceProviderEngine内部缓存。

为了印证该逻辑，这里使用 LINQPad 6 进行探索，该代码可以在控制台中运行，但部分语句仅在 LINQPad 中生效。

void Main() {
    var services = new ServiceCollection()
        .AddTransient<IFoo1, Foo1>()
        .BuildServiceProvider();
    var engine = ReflectionExtensions.GetNonPublicField(services, "_engine");
    var realizedServices = (System.Collections.IDictionary)ReflectionExtensions.GetNonPublicProperty(engine, "RealizedServices");

    for (int i = 0; i < 3; i++) {
        services.GetRequiredService<IFoo1>(); //组件实例化
        foreach (DictionaryEntry item in realizedServices) {
            var title = String.Format("Loop {0}, type {1}, hash {2}", i, ((Type)item.Key).FullName, item.Value.GetHashCode());
            item.Value.Dump(title, depth: 2); //仅被 LINQPad 支持
        }
        Thread.Sleep(10); //确保异步任务完成
    }
}

class ReflectionExtensions {
    public static Object GetNonPublicField(Object instance, String name) {
        var type = instance.GetType();
        var field = type.GetField(name, BindingFlags.NonPublic | BindingFlags.Instance);
        return field.GetValue(instance);
    }

    public static Object GetNonPublicProperty(Object instance, String name) {
        var type = instance.GetType();
        var property = type.GetProperty(name, BindingFlags.NonPublic | BindingFlags.Instance);
        return property.GetValue(instance);
    }
}

interface IFoo1 {
    void Hello();
}

class Foo1 : IFoo1 {
    public void Hello() {
        Console.WriteLine("Foo1.Hello()");
    }
}

运行该脚本，可以看到

第1次和第2次组件实例化，委托相同，hash 值都是 688136691，都是Microsoft.Extensions.DependencyInjection.ServiceLookup.DynamicServiceProviderEngine的内部委托；
第1次和第2次组件实例化的 callSite计数从1谈到2；
第3次组件实例例，委托变成了System.Object lambda_method(...)，hash 值变成了 1561307880；

LINQPad 5 运行该脚本未能看到 hash 值变化，猜测是优化相关所致，考虑到DEBUG、单元测试和 LINQPad 6 已经实证，不再研究。

Microsoft.Extensions.DependencyInjection 之二：使用诊断工具观察内存占用对比了组件实例化前后的内存变化如下图，从第3次开始组件实例化的性能大幅提升。

在以上基础上得到作了小结：

Microsoft.Extensions.DependencyInjection 并非是银弹，它的便利性是一种空间换时间的典型，我们需要对以下情况有所了解：

重度使用依赖注入的大型项目启动过程相当之慢；

如果单次请求需要实例化的组件过多，前期请求的内存开销不可轻视；

由于实例化伴随着递归调用，过深的依赖将不可避免地导致堆栈溢出；

测试参数

Microsoft.Extensions.DependencyInjection 中抽象类Microsoft.Extensions.DependencyInjection.ServiceLookup.ServiceProviderEngine有以下实现

Microsoft.Extensions.DependencyInjection.ServiceLookup.CompiledServiceProviderEngine
Microsoft.Extensions.DependencyInjection.ServiceLookup.DynamicServiceProviderEngine
Microsoft.Extensions.DependencyInjection.ServiceLookup.ExpressionsServiceProviderEngine
Microsoft.Extensions.DependencyInjection.ServiceLookup.RuntimeServiceProviderEngine
Microsoft.Extensions.DependencyInjection.ServiceLookup.ILEmitServiceProviderEngine

RuntimeServiceProviderEngine 是对 ServiceProviderEngine 的原样继承可以忽略，ExpressionsServiceProviderEngine 和CompiledServiceProviderEngine都是表达式树的使用也没有差异。ILEmitServiceProviderEngine是 emit 相关的实现。

从aspnet/DependencyInjection 获取到的分支release/2.1 后，提取到ServiceProviderEngine、CompiledServiceProviderEngine和ILEmitServiceProviderEngine等核心实现，再编写控制台程序，对依赖注入中反射、表达式树、emit 3种实现方式的开销和性能上进行探索。

程序使用启动参数控制组件实例化行为，并记录测试结果，以下是程序启动参数的解释。

-m|method

实例化方式，使用反射、表达式树与 Emit 参与了测试，分别对应：

ref：使用反射实例化组件，实质是对 CallSiteRuntimeResolver 的调用；
exp：使用表达式树实例化组件，实质是对 ExpressionResolverBuilder 的调用；
emit：使用 emit 实例化组件，实质是对 ILEmitResolverBuilder 的调用；

Action<Type, Boolean> handle = default;
if (method == "ref")
{
	handle = GetRefService;
}
else if (method == "exp")
{
	handle = GetExpService;
}
else if (method == "emit")
{
	handle = GetEmitService;
}

-t|target

实例化目标，使用选取以下两种，配合参数 -n|number 使用

foo：使用 IFoo_{n} 作为实例化目标，已定义了 IFoo_0、IFoo_1、IFoo_2 至 IFoo_9999 共1万个接口与对应实现
bar：使用 IBar_{n} 作为实例化目标，只定义了 IBar_100、IBar_1000、IBar_5000、IBar_10000 共4个接口，每个实现均以 IFoo 作为构造函数的参数，
- IBar_100：使用 IFoo_0、IFoo_1 至 IFoo_99 作为构造函数参数；
- IBar_1000：使用 IFoo_0、IFoo_1 至 IFoo_999 作为构造函数参数；
- IBar_5000：使用 IFoo_0、IFoo_1 至 IFoo_4999 作为构造函数参数；
- IBar_10000：使用 IFoo_0、IFoo_1 至 IFoo_9999 作为构造函数参数；

该部分同大量接口与实现类的生成一样仍然使用脚本生成。

-n|number

帮助指示实例化的目标及数量

100：target = foo 为从 IFoo_0、IFoo_1 至 IFoo_100 共100个接口，target =bar 则仅为 IBar_100；
1000：target = foo 为从 IFoo_0、IFoo_1 至 IFoo_1000 共1000个接口，target = bar 则仅为 IBar_1000；
5000：target = foo 为从 IFoo_0、IFoo_1 至 IFoo_5000 共5000个接口，target =bar 则仅为 IBar_5000；
10000：target = foo 为从 IFoo_0、IFoo_1 至 IFoo_10000 共10000个接口，target =bar 则仅为 IBar_10000；

-c|cache

缓存行为，cache = false 时每次都构建委托，cache = true 则把构建委托缓存起来重复使用。GetRefService()实现如下，GetExpService()和GetEmitService()相似。

static void GetRefService(Type type, Boolean cache)
{
    var site = _expEngine.CallSiteFactory.CreateCallSite(type, new CallSiteChain());
    Func<ServiceProviderEngineScope, object> func;
    if (cache)
    {
        func = _expEngine.RealizedServices.GetOrAdd(type, scope => _expEngine.RuntimeResolver.Resolve(site, scope));
    }
    else
    {
        func = scope => _expEngine.RuntimeResolver.Resolve(site, scope);
        _expEngine.RealizedServices[type] = func;
    }
    if (func == null)
    {
        _logger.Warn("Cache miss");
        return;
    }
    var obj = func(_expEngine.Root);
    if (obj == null)
    {
        throw new NotImplementedException();
    }
}

-l|loop

重复执行若干次，每次均记录测试时长

static void TestBar(Action<Type, Boolean> handle, String method, Boolean cache, Type type)
{
    _watch.Restart();
    handle(type, cache);
    _watch.Stop();
    _logger.Info("method {0}, cache {1}, target {2}, cost {3}",
        method, cache, type.Name, _watch.ElapsedMilliseconds);
}

...
TestBar(handle, method, false, number);
for (int i = 1; i < loop; i++)
{
    TestBar(handle, method, cache, number);
}

由于本测试的重点是对比使用反射、表达式树与 emit 的性能与开销，故程序启动后首先遍历 ServiceCollection 对每个组件调用 CallSiteFactory.CreateCallSite(Type serviceType)，确保组件的上下文已经被创建和缓存。

启动测试

对以上参数进行组合，得到以下启动方式，测试结果异步写入日志文件供后续解析。

# 启用委托缓存行为，实例化以 IFoo_ 作为命名前缀注入的服务
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t foo -c true -n 100 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t foo -c true -n 1000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t foo -c true -n 5000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t foo -c true -n 10000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t foo -c true -n 100 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t foo -c true -n 1000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t foo -c true -n 5000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t foo -c true -n 10000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t foo -c true -n 100 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t foo -c true -n 1000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t foo -c true -n 5000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t foo -c true -n 10000 -l 100

# 禁用委托缓存行为，实例化以 IFoo_ 作为命名前缀注入的服务
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t foo -c false -n 100 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t foo -c false -n 1000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t foo -c false -n 5000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t foo -c false -n 10000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t foo -c false -n 100 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t foo -c false -n 1000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t foo -c false -n 5000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t foo -c false -n 10000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t foo -c false -n 100 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t foo -c false -n 1000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t foo -c false -n 5000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t foo -c false -n 10000 -l 50

# 启用委托缓存行为，实例化 IBar_100、IBar_1000、IBar_5000、IBar_10000
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t bar -c true -n 100 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t bar -c true -n 1000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t bar -c true -n 5000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t bar -c true -n 10000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t bar -c true -n 100 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t bar -c true -n 1000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t bar -c true -n 5000 -l 100
# ./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t bar -c true -n 10000 -l 100 # 请求无法完成，抛出 IL 相关异常
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t bar -c true -n 100 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t bar -c true -n 1000 -l 100
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t bar -c true -n 5000 -l 100
# ./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t bar -c true -n 10000 -l 100 # 请求无法完成，抛出 IL 相关异常

# 禁用委托缓存行为，实例化 IBar_100、IBar_1000、IBar_5000、IBar_10000
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t bar -c false -n 100 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t bar -c false -n 1000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t bar -c false -n 5000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m ref -t bar -c false -n 10000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t bar -c false -n 100 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t bar -c false -n 1000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t bar -c false -n 5000 -l 50
# ./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m exp -t bar -c false -n 10000 -l 50 # 请求无法完成，抛出 IL 相关异常
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t bar -c false -n 100 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t bar -c false -n 1000 -l 50
./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t bar -c false -n 5000 -l 50
# ./LeoninewAxe.Scaffold.DependencyInjection.App.exe -m emit -t bar -c false -n 10000 -l 50 # 请求无法完成，抛出 IL 相关异常

值得一提的是，表达式树和 emit 均无法完成 IBar_10000 的实例化，执行中抛出相同异常 "System.InvalidProgramException: The JIT compiler encountered invalid IL code or an internal limitation."