.Net依赖注入神器Scrutor(上)

梦想又不占空间

前言

从.Net Core 开始，.Net 平台内置了一个轻量,易用的 IOC 的框架，供我们在应用程序中使用，社区内还有很多强大的第三方的依赖注入框架如：

• Autofac
  
• DryIOC
  
• Grace
  
• LightInject
  
• Lamar
  
• Stashbox
  
• Simple Injector
  

内置的依赖注入容器基本可以满足大多数应用的需求，除非你需要的特定功能不受它支持否则不建议使用第三方的容器。
我们今天介绍的主角Scrutor是内置依赖注入的一个强大的扩展，Scrutor有两个核心的功能:一是程序集的批量注入 Scanning，二是 Decoration 装饰器模式，今天的主题是Scanning。
开始之前在项目中安装 nuget 包:

1. Install-Package Scrutor

复制代码

学习Scrutor前我们先熟悉一个.Net依赖注入的万能用法。

1. builder.Services.Add(
2.     new ServiceDescriptor(/*"ServiceType"*/typeof(ISampleService), /*"implementationType"*/typeof(SampleService), ServiceLifetime.Transient)
3.     );

复制代码

第一个参数ServiceType通常用接口表示，第二个implementationType接口的实现，最后生命周期，熟悉了这个后面的逻辑理解起来就容易些。

Scrutor官方仓库和本文完整的源代码在文末

Scanning

Scrutor提供了一个IServiceCollection的扩展方法作为批量注入的入口,该方法提供了Action委托参数。

1. builder.Services.Scan(typeSourceSelector => { });

复制代码

我们所有的配置都是在这个委托内完成的，Setup by Setup 剖析一下这个使用过程。
第一步 获取 types

typeSourceSelector 支持程序集反射获取类型和提供类型参数
程序集选择

ITypeSourceSelector有多种获取程序集的方法来简化我们选择程序集

1. typeSourceSelector.FromAssemblyOf<Program>();//根据泛型反射获取所在的程序集

复制代码

1. typeSourceSelector.FromCallingAssembly();//获取开始发起调用方法的程序集

复制代码

1. typeSourceSelector.FromEntryAssembly();//获取应用程序入口点所在的程序集

复制代码

1. typeSourceSelector.FromApplicationDependencies();//获取应用程序及其依赖项的程序集

复制代码

1. typeSourceSelector.FromDependencyContext(DependencyContext.Default);//根据依赖关系上下文（DependencyContext）中的运行时库（Runtime Library）列表。它返回一个包含了所有运行时库信息的集合。

复制代码

1. typeSourceSelector.FromAssembliesOf(typeof(Program));//根据类型获取程序集的集合

复制代码

1. typeSourceSelector.FromAssemblies(Assembly.Load("dotNetParadise-Scrutor.dll"));//提供程序集支持Params或者IEnumerable

复制代码

第二步 从 Types 中选择 ImplementationType

简而言之就是从程序中获取的所有的 types 进行过滤，比如获取的 ImplementationType 必须是非抽象的，是类,是否只需要 Public等，还可以用 ImplementationTypeFilter 提供的扩展方法等

1. builder.Services.Scan(typeSourceSelector =>
2. {
3.     typeSourceSelector.FromEntryAssembly().AddClasses();
4. });

复制代码

AddClasses()方法默认获取所有公开非抽象的类
还可以通过 AddClasses 的委托参数来进行更多条件的过滤
比如定义一个 Attribute,忽略IgnoreInjectAttribute

1. namespace dotNetParadise_Scrutor;
3. [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
4. public class IgnoreInjectAttribute : Attribute
5. {
6. }

复制代码

1. builder.Services.Scan(typeSourceSelector =>
2. {
3.     typeSourceSelector.FromEntryAssembly().AddClasses(iImplementationTypeFilter =>
4.     {
5.         iImplementationTypeFilter.WithoutAttribute<IgnoreInjectAttribute>();
6.     });
7. });

复制代码

利用 iImplementationTypeFilter 的扩展方法很简单就可以实现
在比如 我只要想实现IApplicationService接口的类才可以被注入

1. namespace dotNetParadise_Scrutor;
3. /// <summary>
4. /// 依赖注入标记接口
5. /// </summary>
6. public interface IApplicationService
7. {
8. }

复制代码

1. builder.Services.Scan(typeSourceSelector =>
2. {
3.     typeSourceSelector.FromEntryAssembly().AddClasses(iImplementationTypeFilter =>
4.     {
5.         iImplementationTypeFilter.WithoutAttribute<IgnoreInjectAttribute>().AssignableTo<IApplicationService>();
6.     });
7. });

复制代码

类似功能还有很多，如可以根据命名空间也可以根据Type的属性用lambda表达式对ImplementationType进行过滤
上面的一波操作实际上就是为了构造一个IServiceTypeSelector对象，选出来的ImplementationType对象保存了到了ServiceTypeSelector的Types属性中供下一步选择。
除了提供程序集的方式外还可以直接提供类型的方式比如
创建接口和实现

1. public interface IForTypeService
2. {
3. }
4. public class ForTypeService : IForTypeService
5. {
6. }

复制代码

1. builder.Services.Scan(typeSourceSelector =>
2. {
3.     typeSourceSelector.FromTypes(typeof(ForTypeService));
4. });

复制代码

这种方式提供类型内部会调用AddClass()方法把符合条件的参数保存到ServiceTypeSelector
第三步确定注册策略

在AddClass之后可以调用UsingRegistrationStrategy()配置注册策略是 Append，Skip，Throw，Replace
下面是各个模式的详细解释

• RegistrationStrategy.Append :类似于builder.Services.Add
  
• RegistrationStrategy.Skip:类似于builder.Services.TryAdd
  
• RegistrationStrategy.Throw:ServiceDescriptor 重复则跑异常
  
• RegistrationStrategy.Replace: 替换原有服务
  

这样可以灵活地控制注册流程

1.     builder.Services.Scan(typeSourceSelector =>
2.     {
3.         typeSourceSelector.FromEntryAssembly().AddClasses().UsingRegistrationStrategy(RegistrationStrategy.Skip);
4.     });

复制代码

不指定则为默认的 Append 即 builder.Services.Add
第四步 配置注册的场景选择合适的ServiceType

ServiceTypeSelector提供了多种方法让我们从ImplementationType中匹配ServiceType

• AsSelf()
  
• As()
  
• As(params Type[] types)
  
• As(IEnumerable types)
  
• AsImplementedInterfaces()
  
• AsImplementedInterfaces(Func predicate)
  
• AsSelfWithInterfaces()
  
• AsSelfWithInterfaces(Func predicate)
  
• AsMatchingInterface()
  
• AsMatchingInterface(Action? action)
  
• As(Func selector)
  
• UsingAttributes()
  

AsSelf 注册自身

1. public class AsSelfService
2. {
3. }

复制代码

1. {
2.     builder.Services.Scan(typeSourceSelector =>
3.     {
4.         typeSourceSelector.FromEntryAssembly().AddClasses(iImplementationTypeFilter =>
5.         {
6.             iImplementationTypeFilter.InNamespaces("dotNetParadise_Scrutor.Application.AsSelf").WithoutAttribute<IgnoreInjectAttribute>();
7.         }).AsSelf();
8.     });
10.     Debug.Assert(builder.Services.Any(_ => _.ServiceType == typeof(AsSelfService)));
11. }

复制代码

等效于builder.Services.AddTransient();
As 批量为 ImplementationType 指定 ServiceType

1. public interface IAsService
2. {
3. }
4. public class AsOneService : IAsService
5. {
6. }
7. public class AsTwoService : IAsService
8. {
9. }

复制代码

1. {
2.     builder.Services.Scan(typeSourceSelector =>
3. {
4.     typeSourceSelector.FromEntryAssembly().AddClasses(iImplementationTypeFilter =>
5.     {
6.         iImplementationTypeFilter.InNamespaces("dotNetParadise_Scrutor.Application.As").WithoutAttribute<IgnoreInjectAttribute>();
7.     }).As<IAsService>();
8. });
9.     Debug.Assert(builder.Services.Any(_ => _.ServiceType == typeof(IAsService)));
10.     foreach (var asService in builder.Services.Where(_ => _.ServiceType == typeof(IAsService)))
11.     {
12.         Debug.WriteLine(asService.ImplementationType!.Name);
13.     }
14. }

复制代码

As(params Type[] types)和 As(IEnumerable types) 批量为ImplementationType指定多个 ServiceType，服务必须同时实现这里面的所有的接口
上面的实例再改进一下

1. public interface IAsOtherService
2. {
3. }
4. public interface IAsSomeService
5. {
6. }
8. public class AsOneMoreTypesService : IAsOtherService, IAsSomeService
9. {
10. }
11. public class AsTwoMoreTypesService : IAsSomeService, IAsOtherService
12. {
13. }

复制代码

1. {
2.     builder.Services.Scan(typeSourceSelector =>
3.     {
4.         typeSourceSelector.FromEntryAssembly().AddClasses(iImplementationTypeFilter =>
5.         {
6.             iImplementationTypeFilter.InNamespaces("dotNetParadise_Scrutor.Application.AsMoreTypes").WithoutAttribute<IgnoreInjectAttribute>();
7.         }).As(typeof(IAsSomeService), typeof(IAsOtherService));
8.     });
9.     List<Type> serviceTypes = [typeof(IAsSomeService), typeof(IAsOtherService)];
10.     Debug.Assert(serviceTypes.All(serviceType => builder.Services.Any(service => service.ServiceType == serviceType)));
11.     foreach (var asService in builder.Services.Where(_ => _.ServiceType == typeof(IAsSomeService) || _.ServiceType == typeof(IAsOtherService)))
12.     {
13.         Debug.WriteLine(asService.ImplementationType!.Name);
14.     }
15. }

复制代码

AsImplementedInterfaces 注册当前 ImplementationType 和实现的接口

1. public interface IAsImplementedInterfacesService
2. {
3. }
4. public class AsImplementedInterfacesService : IAsImplementedInterfacesService
5. {
6. }

复制代码

1. //AsImplementedInterfaces 注册当前ImplementationType和它实现的接口
2. {
3.     builder.Services.Scan(typeSourceSelector =>
4.     {
5.         typeSourceSelector.FromEntryAssembly().AddClasses(iImplementationTypeFilter =>
6.         {
7.             iImplementationTypeFilter.InNamespaces("dotNetParadise_Scrutor.Application.AsImplementedInterfaces").WithoutAttribute<IgnoreInjectAttribute>();
8.         }).AsImplementedInterfaces();
9.     });
11.     Debug.Assert(builder.Services.Any(service => service.ServiceType == typeof(IAsImplementedInterfacesService)));
12.     foreach (var asService in builder.Services.Where(_ => _.ServiceType == typeof(IAsImplementedInterfacesService)))
13.     {
14.         Debug.WriteLine(asService.ImplementationType!.Name);
15.     }
16. }

复制代码

AsSelfWithInterfaces 同时注册为自身类型和所有实现的接口

1. public interface IAsSelfWithInterfacesService
2. {
3. }
4. public class AsSelfWithInterfacesService : IAsSelfWithInterfacesService
5. {
6. }

复制代码

1. {
2.     builder.Services.Scan(typeSourceSelector =>
3.     {
4.         typeSourceSelector.FromEntryAssembly().AddClasses(iImplementationTypeFilter =>
5.         {
6.             iImplementationTypeFilter.InNamespaces("dotNetParadise_Scrutor.Application.AsSelfWithInterfaces").WithoutAttribute<IgnoreInjectAttribute>();
7.         }).AsSelfWithInterfaces();
8.     });
9.     //Self
10.     Debug.Assert(builder.Services.Any(service => service.ServiceType == typeof(AsSelfWithInterfacesService)));
11.     //Interfaces
12.     Debug.Assert(builder.Services.Any(service => service.ServiceType == typeof(IAsSelfWithInterfacesService)));
13.     foreach (var service in builder.Services.Where(_ => _.ServiceType == typeof(AsSelfWithInterfacesService) || _.ServiceType == typeof(IAsSelfWithInterfacesService)))
14.     {
15.         Debug.WriteLine(service.ServiceType!.Name);
16.     }
17. }

复制代码

AsMatchingInterface 将服务注册为与其命名相匹配的接口，可以理解为一定约定假如服务名称为 ClassName,会找 IClassName 的接口作为 ServiceType 注册

1. public interface IAsMatchingInterfaceService
2. {
3. }
4. public class AsMatchingInterfaceService : IAsMatchingInterfaceService
5. {
6. }

复制代码

1. //AsMatchingInterface 将服务注册为与其命名相匹配的接口，可以理解为一定约定假如服务名称为 ClassName,会找 IClassName 的接口作为 ServiceType 注册
2. {
3.     builder.Services.Scan(typeSourceSelector =>
4.     {
5.         typeSourceSelector.FromEntryAssembly().AddClasses(iImplementationTypeFilter =>
6.         {
7.             iImplementationTypeFilter.InNamespaces("dotNetParadise_Scrutor.Application.AsMatchingInterface").WithoutAttribute<IgnoreInjectAttribute>();
8.         }).AsMatchingInterface();
9.     });
10.     Debug.Assert(builder.Services.Any(service => service.ServiceType == typeof(IAsMatchingInterfaceService)));
11.     foreach (var service in builder.Services.Where(_ => _.ServiceType == typeof(IAsMatchingInterfaceService)))
12.     {
13.         Debug.WriteLine(service.ServiceType!.Name);
14.     }
15. }

复制代码

UsingAttributes 特性注入，这个还是很实用的在Scrutor提供了ServiceDescriptorAttribute来帮助我们方便的对Class进行标记方便注入

1. public interface IUsingAttributesService
2. {
3. }
5. [ServiceDescriptor<IUsingAttributesService>()]
6. public class UsingAttributesService : IUsingAttributesService
7. {
8. }

复制代码

1.     builder.Services.Scan(typeSourceSelector =>
2.     {
3.         typeSourceSelector.FromEntryAssembly().AddClasses(iImplementationTypeFilter =>
4.         {
5.             iImplementationTypeFilter.InNamespaces("dotNetParadise_Scrutor.Application.UsingAttributes").WithoutAttribute<IgnoreInjectAttribute>();
6.         }).UsingAttributes();
7.     });
8.     Debug.Assert(builder.Services.Any(service => service.ServiceType == typeof(IUsingAttributesService)));
9.     foreach (var service in builder.Services.Where(_ => _.ServiceType == typeof(IUsingAttributesService)))
10.     {
11.         Debug.WriteLine(service.ServiceType!.Name);
12.     }

复制代码

第五步 配置生命周期

通过链式调用WithLifetime函数来确定我们的生命周期，默认是 Transient

1. public interface IFullService
2. {
3. }
4. public class FullService : IFullService
5. {
6. }

复制代码

1. {
3.     builder.Services.Scan(typeSourceSelector =>
4.     {
5.         typeSourceSelector.FromEntryAssembly().AddClasses(iImplementationTypeFilter =>
6.         {
7.             iImplementationTypeFilter.InNamespaces("dotNetParadise_Scrutor.Application.Full");
8.         }).UsingRegistrationStrategy(RegistrationStrategy.Skip).AsImplementedInterfaces().WithLifetime(ServiceLifetime.Scoped);
9.     });
11.     Debug.Assert(builder.Services.Any(service => service.ServiceType == typeof(IFullService)));
12.     foreach (var service in builder.Services.Where(_ => _.ServiceType == typeof(IFullService)))
13.     {
14.         Debug.WriteLine($"serviceType：{service.ServiceType!.Name},LifeTime:{service.Lifetime}");
15.     }
16. }

复制代码

总结

到这儿基本的功能已经介绍完了，可以看出来扩展方法很多，基本可以满足开发过程批量依赖注入的大部分场景。
使用技巧总结：

• 根据程序集获取所有的类型 此时 Scrutor 会返回一个 IImplementationTypeSelector 对象里面包含了程序集的所有类型集合
  
• 调用 IImplementationTypeSelector 的 AddClasses 方法获取 IServiceTypeSelector 对象,AddClass 这里面可以根据条件选择 过滤一些不需要的类型
  
• 调用UsingRegistrationStrategy确定依赖注入的策略 是覆盖 还是跳过亦或是抛出异常 默认 Append 追加注入的方式
  
• 配置注册的场景 比如是 AsImplementedInterfaces 还是 AsSelf等
  
• 选择生命周期 默认 Transient
  

借助ServiceDescriptorAttribute更简单，生命周期和ServiceType都是在Attribute指定好的只需要确定选择程序集，调用UsingRegistrationStrategy配置依赖注入的策略然后UsingAttributes()即可
最后

本文从Scrutor的使用流程剖析了依赖注入批量注册的流程，更详细的教程可以参考Github 官方仓库。在开发过程中看到很多项目还有一个个手动注入的，也有自己写 Interface或者是Attribute反射注入的，支持的场景都十分有限，Scrutor的出现就是为了避免我们在项目中不停地造轮子,达到开箱即用的目的。
本文完整示例源代码

来源:https://www.cnblogs.com/ruipeng/p/18081965
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！