聊一聊如何整合Microsoft.Extensions.DependencyInjection和Castle.Core(完结篇)

前言

书接上回，上回我们了解了 castle 代理的一些缺点，本文将开始操作整合 Microsoft.Extension.Dependency和Castle,以让默认的容器可以支持拦截器

我们将以进阶的形式逐步完善我们的封装，以实现一个更方便易用、普适、高性能的基础设施库。

基础版

还是先上代码，这是基础版本我们要达成的目标，仅需定义一个特性即可完成拦截的目标

/// <summary>

///

/// </summary>

public abstract class InterceptorBaseAttribute : Attribute, IInterceptor

{

    void IInterceptor.Intercept(IInvocation invocation)

    {

        var returnType = invocation.Method.ReturnType;

        var builder = AsyncMethodBuilder.TryCreate(returnType);

        if (builder != null)

        {

            var asyncInvocation = new AsyncInvocation(invocation);

            var stateMachine = new AsyncStateMachine(asyncInvocation, builder, task: InterceptAsync(asyncInvocation));

            builder.Start(stateMachine);

            invocation.ReturnValue = builder.Task();

        }

        else

        {

            Intercept(invocation);

        }

    }

    protected virtual void Intercept(IInvocation invocation) { }

    protected abstract ValueTask InterceptAsync(IAsyncInvocation invocation);

    ......

}

如上是我们定义的拦截器基类，我们想要达到的目标是，只要继承该基类，并覆写InterceptAsync 方法即可实现具有特定功能的拦截类，而容器会自动代理到该拦截类，实现拦截。

这里要感谢 https://github.com/stakx/DynamicProxy.AsyncInterceptor 的作者，该库采用 MIT 的许可使用协议，我们可以直接参考使用。

接下来，是重头戏，考虑到易用性，我们以 Microsoft.Extension.DependencyInjection 为基本库，实现一个扩展类，用于实现拦截器功能。

代码如下：

public static class CastleServiceCollectionExtensions

{

    public static IServiceCollection ConfigureCastleDynamicProxy(this IServiceCollection services)

    {

        services.TryAddSingleton<ProxyGenerator>(sp => new ProxyGenerator());

        //TODO:1.从IServiceCollection中获取 方法定义InterceptorBaseAttribute特性子类的ServiceDescriptor

        //TODO:2.逐个处理，获取每个ServiceDescriptor中的ServiceType，识别是具体类还是接口，然后获取InterceptorBaseAttribute特性子类的实例

        //作为拦截器,借用proxyGenerator 去创建对应的代理然后添加到IServiceCollection中

        //TODO:3 移除原始对应的ServiceType注册

        return services;

    }

}

在注释中我们简单描述了该扩展方法的实现过程，我们采用移花接木的方式替换掉原有ServiceType的注册，将代理对象注册为ServiceType的实现即可。

第一步我们这么实现

var descriptors = services.Where(svc =>svc.ServiceType.GetMethods()

    .Any(i => i.GetCustomAttributes(false).Any(i => i.GetType().IsAssignableTo(typeof(InterceptorBaseAttribute))))).ToList();

第二步的核心是 ServiceDescriptor 中三种生成场景的分开处理，至于是哪三种场景可以看下我的第一篇文章 https://www.cnblogs.com/gainorloss/p/17961153

descriptor.ImplementationType 有值：已知ServiceType和ImplementationType

伪代码如下

implementationFactory = sp =>

{

    var generator = sp.GetRequiredService<ProxyGenerator>();

    var interceptors = GetInterceptors(descriptor.ServiceType);//获取拦截器 galoS@2024-1-12 14:47:47

    var proxy = descriptor.ServiceType.IsClass

    ? generator.CreateClassProxy(descriptor.ServiceType,  interceptors.ToArray())

    : generator.CreateInterfaceProxyWithoutTarget(descriptor.ServiceType, interceptors.ToArray());

    return proxy;

};

descriptor.ImplementationInstance 有值：已知ServiceType和实现对象实例

implementationFactory = sp =>

{

    var generator = sp.GetRequiredService<ProxyGenerator>();

    var interceptors = GetInterceptors(descriptor.ServiceType, sp);//获取拦截器 galoS@2024-1-12 14:47:47

    var proxy = descriptor.ServiceType.IsClass

    ? generator.CreateClassProxyWithTarget(descriptor.ServiceType, descriptor.ImplementationInstance, interceptors.ToArray())

    : generator.CreateInterfaceProxyWithTarget(descriptor.ServiceType, descriptor.ImplementationInstance, interceptors.ToArray());

    return proxy;

};

descriptor.ImplementationFactory 有值：已知ServiceType和实现工厂方法

implementationFactory = sp =>

{

    var generator = sp.GetRequiredService<ProxyGenerator>();

    var interceptors = GetInterceptors(descriptor.ServiceType, sp);//获取拦截器 galoS@2024-1-12 14:47:47

    var proxy = descriptor.ServiceType.IsClass

    ? generator.CreateClassProxyWithTarget(descriptor.ServiceType, descriptor.ImplementationInstance, interceptors.ToArray())

    : generator.CreateInterfaceProxyWithTarget(descriptor.ServiceType, descriptor.ImplementationInstance, interceptors.ToArray());

    return proxy;

};

可以看到 2,3比较雷同，因为拿到实例和通过委托传入IServiceProvider拿到实例，其实结果是相似的，最终我们都使用工厂注入的形式生成新的 ServiceDescriptor services.AddTransinet(descriptor.ServiceType, implementationFactory);。

最后一步移除即可

伪代码如下

services.Remove(descriptor);

改造一下之前的代码并测试

 var services = new ServiceCollection();

services.AddLogging();//此处添加日志服务 伪代码 以便获取ILogger<SampleService>

services.TryAddTransient<SampleService>();

services.TryAddTransient<ISampleService, SampleService>();

services.ConfigureCastleDynamicProxy();//一定要在最后，不然会有些服务无法代理到 2024-1-13 13:53:05

var sp = services.BuildServiceProvider();

var proxy = sp.GetRequiredService<SampleService>();

var name = await proxy.ShowAsync();

/// <summary>

/// 异常捕获、日志记录和耗时监控 拦截器 2024-1-12 21:28:22

/// </summary>

[AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)]

public class CatchLoggingInterceptor : InterceptorBaseAttribute

{

   protected override async ValueTask InterceptAsync(IAsyncInvocation invocation)

   {

       //TODO:类注释所写的逻辑

       await Console.Out.WriteLineAsync("Interceptor  starting...");

       Console.WriteLine("Interceptor  starting...");

       await invocation.ProceedAsync();

       await Console.Out.WriteLineAsync("Interceptor  ended...");

   }

}

运行如下

,

可以看到拦截器这时候是异步方法，并且可以明显看到注入被简化了。

大家可以考虑下为什么 services.ConfigureCastleDynamicProxy() 一定要在BuildServiceProvider()之前，其他注入之后

进阶版本

进阶版本这里我们不再详细描述，直接看源码 https://gitee.com/gainorloss_259/microsoft-castle.git

主要解决的问题是castle 拦截器不支持依赖ioc的服务

使用伪代码如下

public class SampleService : ISampleService

{

   [CatchLoggingInterceptor]

   [Interceptor(typeof(LoggingInterceptor))]//第二种使用方式

   public virtual Task<string> ShowAsync()

   {

       Console.WriteLine(nameof(ShowAsync));

       return Task.FromResult(nameof(ShowAsync));

   }

}

//定义拦截器

internal class LoggingInterceptor : InterceptorBase

{

   private readonly ILogger<LoggingInterceptor> _logger;

   public LoggingInterceptor(ILogger<LoggingInterceptor> logger)

   {

       _logger = logger;

   }

   protected override async ValueTask InterceptAsync(IAsyncInvocation invocation)

   {

       await Console.Out.WriteLineAsync(nameof(LoggingInterceptor));

       await invocation.ProceedAsync();

   }

}

总结

以上整合的核心方案及细节已经介绍完毕了，接下来有时间的话可以出一篇对本整合做性能测试的文章;

AOP 是一个很强大的东西，我们基本已经完成了一个比较普适、比较易用的aop底层整理。接下来我们可以做很多东西，比如事务拦截器、幂等拦截器、重试拦截器、缓存拦截器等等

打好基础，后续可以自己去实现。

这里还有几个问题，大家可以思考下

我们如何能整合两种拦截器既可以传一些常量又不影响我们的服务注入拦截器
拦截器是否可以再套用拦截器
假设我们再日志拦截器上打了日志拦截器会怎么样

这些都是一些比较有意思的问题，相信这些问题的思考会让大家对动态代理的理解更深，并可以灵活的将其用到自己的项目中。

源码及声明

当前示例代码已传至 https://gitee.com/gainorloss_259/microsoft-castle.git

如转载请注明出处，谢谢！