abp依賴注入的原理剖析
請先移步參考 [Abp vNext 原始碼分析] - 3. 依賴注入與攔截器 本文此篇文章的補充和完善，
abp的依賴注入最后是通過IConventionalRegister介面的AddType方法實作的，先看下該介面：
public interface IConventionalRegistrar
{
void AddAssembly(IServiceCollection services, Assembly assembly);
void AddTypes(IServiceCollection services, params Type[] types);
void AddType(IServiceCollection services, Type type);
}
該介面定義了三個方法，支持傳入程式集、型別陣列、具體型別，其實作在一個抽象類ConventionalRegistrarBase中：
public abstract class ConventionalRegistrarBase : IConventionalRegistrar
{
public virtual void AddAssembly(IServiceCollection services, Assembly assembly)
{
var types = AssemblyHelper
.GetAllTypes(assembly)
.Where(
type => type != null &&
type.IsClass &&
!type.IsAbstract &&
!type.IsGenericType
).ToArray();
AddTypes(services, types);
}
public virtual void AddTypes(IServiceCollection services, params Type[] types)
{
foreach (var type in types)
{
AddType(services, type);
}
}
public abstract void AddType(IServiceCollection services, Type type);
}
不管是程式集，還是型別陣列最后都是呼叫AddType方法，AddType的實作在這個抽象類的派生類中，abp有一個默認的實作類DefaultConventionalRegistrar，該類實作了AddType方法，abp的依賴注入就是通過該類的AddType方法注入的，原始碼：
public class DefaultConventionalRegistrar : ConventionalRegistrarBase
{
public override void AddType(IServiceCollection services, Type type)
{
if (IsConventionalRegistrationDisabled(type))
{
return;
}
var dependencyAttribute = GetDependencyAttributeOrNull(type);
var lifeTime = GetLifeTimeOrNull(type, dependencyAttribute);
if (lifeTime == null)
{
return;
}
var serviceTypes = ExposedServiceExplorer.GetExposedServices(type);
TriggerServiceExposing(services, type, serviceTypes);
foreach (var serviceType in serviceTypes)
{
var serviceDescriptor = ServiceDescriptor.Describe(serviceType, type, lifeTime.Value);
if (dependencyAttribute?.ReplaceServices == true)
{
services.Replace(serviceDescriptor);
}
else if (dependencyAttribute?.TryRegister == true)
{
services.TryAdd(serviceDescriptor);
}
else
{
services.Add(serviceDescriptor);
}
}
}
// 其他方法實作
}
從這個類中可以看出abp依賴注入的實作思路：根據GetExposedServices方法回傳的服務型別串列去構造服務描述符(服務描述符的第一個引數就是服務型別，第二個引數就是實作型別)，而實作型別就是我們要注入的型別，再將此服務描述符注入到DI容器中，
GetDependencyAttributeOrNull方法和GetLifeTimeOrNull方法是獲取使用了Dependency特性注入的類及其生命周期，如果沒有則使用默認的生命周期，因此如果Dependency特性的注入優先級更高，GetExposedServices是在靜態類ExposedServiceExplorer中，該靜態類是用來獲取注入型別的定義及實作的，原始碼實作：
public static List<Type> GetExposedServices(Type type)
{
return type
.GetCustomAttributes()
.OfType<IExposedServiceTypesProvider>()
.DefaultIfEmpty(DefaultExposeServicesAttribute)
.SelectMany(p => p.GetExposedServiceTypes(type))
.ToList();
}
IExposedServicveTypeProvider介面定義及實作：
//定義：
public interface IExposedServiceTypesProvider
{
Type[] GetExposedServiceTypes(Type targetType);
}
//實作：
public class ExposeServicesAttribute : Attribute, IExposedServiceTypesProvider
{
public ExposeServicesAttribute(params Type[] serviceTypes)
{
ServiceTypes = serviceTypes ?? new Type[0];
}
public Type[] GetExposedServiceTypes(Type targetType)
{
var serviceList = ServiceTypes.ToList();
if (IncludeDefaults == true)
{
foreach (var type in GetDefaultServices(targetType))
{
serviceList.AddIfNotContains(type);
}
if (IncludeSelf != false)
{
serviceList.AddIfNotContains(targetType);
}
}
else if (IncludeSelf == true)
{
serviceList.AddIfNotContains(targetType);
}
return serviceList.ToArray();
}
private static List<Type> GetDefaultServices(Type type)
{
var serviceTypes = new List<Type>();
foreach (var interfaceType in type.GetTypeInfo().GetInterfaces())
{
var interfaceName = interfaceType.Name;
if (interfaceName.StartsWith("I"))
{
interfaceName = interfaceName.Right(interfaceName.Length - 1);
}
if (type.Name.EndsWith(interfaceName))
{
serviceTypes.Add(interfaceType);
}
}
return serviceTypes;
}
}
該接口的實作是在ExposeServices特性的實作類中，這是個特性類，是abp三種注入服務的第一種——ExposeServices特性注入，該類的建構式會直接保存要注入型別的服務串列，其次就是GetDefaultService方法，該方法會回傳默認的服務型別，通過反射獲取類繼承的介面，并截取介面的名稱(除去I之后的介面名)，只有實作類與介面名稱相同的條件下才會注入到服務型別串列中，這點要注意！對于該方法回傳的型別會被添加到服務型別串列中(ServiceTypes)，默認情況下，實作類本身會注入到服務型別串列中，從原始碼中可以分析到：
if (IncludeSelf != false)
{
serviceList.AddIfNotContains(targetType);
}
targetType就是我們當前注入的型別，在此便注入了型別本身，如此的好處是，可以獲取到類的實體，減少了直接實體化而帶來依賴，
如此便回傳了注入型別的定義及實作串列(serviceTypes)，而后遍歷這個串列，服務描述符(ServiceDescriptor)的引數ServiceType就是這個串列的項，這個服務描述符便注入到了DI容器中，對于Dependency特性注入的方式，如果引數是ReplaceServices，那么將會替換；如果引數是Register，那么將會直接注入，否則的話，直接添加進DI容器中，
三種注入方式的實作：
- ExposeServices特性的注入分析
// 介面
public interface IMessageWriter
{
void Write();
}
// 實作 1
[ExposeServices(typeof(IMessageWriter))]
public class TestMessageTwo : IMessageWriter, ITransientDependency
{
public void Write()
{
Console.WriteLine("TestMessageTwo");
}
}
// 實作 2
[ExposeServices(typeof(IMessageWriter), typeof(TestMessageOne))]
public class TestMessageOne : IMessageWriter, ITransientDependency
{
public void Write()
{
Console.WriteLine("TestMessageOne");
}
}
// 注入
_services = new ServiceCollection();
_services.AddType<TestMessageOne>();
_services.AddType<TestMessageTwo>();
// 底層呼叫：
var serviceTypes = ExposedServiceExplorer.GetExposedServices(type);
abp底層通過ExposedServiceExplorer靜態類的GetExposedServices方法確定需要注冊型別的定義和實作，這個靜態類最后實際上是呼叫了ExposeServicesAttribute類的建構式和GetExposedServiceTypes方法確定了服務型別串列，
public ExposeServicesAttribute(params Type[] serviceTypes)
{
ServiceTypes = serviceTypes ?? new Type[0];
}
public Type[] GetExposedServiceTypes(Type targetType)
{
}
- Dependency特性注入
//介面
public interface IMyService : ITransientDependency
{
}
//實作
[Dependency(TryRegister = true)]
public class TryRegisterImplOfMyService : IMyService
{
}
//注入
_services = new ServiceCollection();
_services.AddTypes(typeof(TryRegisterImplOfMyService));
//底層呼叫
ExposeServicesAttribute.GetDefaultServices(typeof(TryRegisterImplOfMyService));
Dependency特性注入在呼叫GetDefaultServices方法回傳服務型別串列，而后在DefaultConventionalRegistrar類的AddType方法中構造服務描述符，注入到DI中，
var serviceDescriptor = ServiceDescriptor.Describe(serviceType, type, lifeTime.Value);
if (dependencyAttribute?.ReplaceServices == true)
{
services.Replace(serviceDescriptor);
}
else if (dependencyAttribute?.TryRegister == true)
{
services.TryAdd(serviceDescriptor);
}
備注：
對于Dependency注入和介面方式注入，實作類的類名必須以介面名結尾，否則將不能注入到DI中，
- 介面注入
//介面
public interface IMyService : ITransientDependency
{
}
//實作 1
public class FirstImplOfMyService : IMyService
{
}
//實作 2
public class SecondImplOfMyService : IMyService
{
}
// 注入
_services = new ServiceCollection();
_services.AddTypes(typeof(FirstImplOfMyService),typeof(SecondImplOfMyService));
//底層呼叫
ExposeServicesAttribute.GetDefaultServices(typeof(TryRegisterImplOfMyService));
介面方式的注入，也是呼叫GetDefaultServices回傳一個型別串列，然后遍歷，保存到服務型別串列中，最后注入到DI容器中，
- ReplaceServices替換
如果介面方式注入與Dependency特性注入同時使用且介面相同那么就是另外一種情況，示例：
// 介面
public interface IMyService : ITransientDependency
{
}
// 介面方式實作
public class FirstImplOfMyService : IMyService
{
}
// Dependency特性注入 -- 替換掉 介面方式注入的實作
[Dependency(ReplaceServices = true)]
public class MyServiceReplacesIMyService : IMyService
{
}
// 注入
_services = new ServiceCollection();
_services.AddTypes(typeof(FirstImplOfMyService),typeof(MyServiceReplacesIMyService));
使用ReplaceServices將會使Dependency特性注入替換介面方式的注入，因此只有Dependency特性的注入會被添加到DI容器中，
代碼示例：
#region ExposeServices 屬性注入
public interface ICalculator { }
public interface ITaxCalculator { }
[ExposeServices(typeof(IService))]
public class TaxCalculator : ICalculator, ITaxCalculator, ITransientDependency
{
}
#endregion
#region 介面約定 模式注入
public interface IService : ITransientDependency { }
public class MyService : IService
{
}
#endregion
#region Dependency特性注入
public interface IMyDependencyTest { }
[Dependency(lifetime: ServiceLifetime.Transient, TryRegister = true)]
public class MyDependencyTest : IMyDependencyTest { }
#endregion
class Program
{
static void Main(string[] args)
{
var services = new ServiceCollection();
services.AddType(typeof(MyDependencyTest));
services.AddType(typeof(MyService));
services.AddType<TaxCalculator>();
foreach(var service in services)
{
Console.WriteLine($"{service.ServiceType} --- {service.ImplementationType} --- {service.Lifetime}");
}
Console.Read();
}
}
除去ExposeServices屬性注入外，其余的兩種模式必須介面與類名相對應，否則，就只能注入類本身，但是，ExposeServics屬性注入不會截取介面名與類名比較，
輸出：
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/94878.html
標籤：C#
下一篇：在 C# 中使用變數