介紹
ABP的依賴注入系統是基於Microsoft的依賴注入擴充套件庫（Microsoft.Extensions.DependencyInjection nuget包）開發的。所以我們採用dotnet自帶的注入方式也是支援的。
- 由於ABP是一個模組化框架,因此每個模組都定義它自己的服務並在它自己的單獨模組類中透過依賴注入進行註冊.例:
public class BlogModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
//在此處注入依賴項
// dotnet自帶依賴注入方式也是支援的
context.services.AddTransient
context.services.AddScoped
context.services.AddSingleton
}
}
Autofac
Autofac 是.Net世界中最常用的依賴注入框架之一. 相比.Net Core標準的依賴注入庫, 它提供了更多高階特性, 比如動態代理和屬性注入.
整合
1.安裝 Volo.Abp.Autofac nuget 包到你的專案 (對於一個多專案應用程式, 建議安裝到可執行專案或者Web專案中.)
2.模組新增 AbpAutofacModule 依賴:
[DependsOn(typeof(AbpAutofacModule))]
public class MyModule : AbpModule
{
//...
}
}
3.配置 AbpApplicationCreationOptions 用 Autofac 替換預設的依賴注入服務. 根據應用程式型別, 情況有所不同
- ASP.NET Core 應用程式
public class Program
{
public static int Main(string[] args)
{
CreateHostBuilder(args).Build().Run();
}
internal static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup<Startup>();
})
.UseAutofac(); //Integrate Autofac!
}
- 控制檯應用程式
namespace AbpConsoleDemo
{
class Program
{
static void Main(string[] args)
{
using (var application = AbpApplicationFactory.Create<AppModule>(options =>
{
options.UseAutofac(); //Autofac integration
}))
{
//...
}
}
}
}
依照約定的註冊
如果實現這些介面,則會自動將類註冊到依賴注入:
- ITransientDependency 註冊為transient生命週期.
- ISingletonDependency 註冊為singleton生命週期.
- IScopedDependency 註冊為scoped生命週期.
預設特定型別
一些特定型別會預設註冊到依賴注入.例子:
- 模組類註冊為singleton.
- MVC控制器（繼承Controller或AbpController）被註冊為transient.
- MVC頁面模型（繼承PageModel或AbpPageModel）被註冊為transient.
- MVC檢視元件（繼承ViewComponent或AbpViewComponent）被註冊為transient.
- 應用程式服務（實現IApplicationService介面或繼承ApplicationService類）註冊為transient.
- 儲存庫（實現IRepository介面）註冊為transient.
- 域服務（實現IDomainService介面）註冊為transient.
手動註冊
在某些情況下,你可能需要向IServiceCollection手動註冊服務,尤其是在需要使用自定義工廠方法或singleton例項時.在這種情況下,你可以像Microsoft文件描述的那樣直接新增服務.
public class BlogModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.services.AddTransient<ITestMicrosoftManager, TestMicrosoftManager>();
}
}
如何使用
建構函式注入
- 構造方法注入是將依賴項注入類的首選方式
屬性注入
- Microsoft依賴注入庫不支援屬性注入.但是,ABP可以與第三方DI提供商（例如Autofac）整合,以實現屬性注入。
- 屬性注入依賴項通常被視為可選依賴項.這意味著沒有它們,服務也可以正常工作.Logger就是這樣的依賴項,MyService可以繼續工作而無需日誌記錄.
public class MyService : ITransientDependency
{
public ILogger<MyService> Logger { get; set; }
public MyService()
{
Logger = NullLogger<MyService>.Instance;
}
public void DoSomething()
{
//...使用 Logger 寫日誌...
}
}
IServiceProvider
直接從IServiceProvider解析服務.在這種情況下,你可以將IServiceProvider注入到你的類並使用
public class MyService : ITransientDependency
{
private readonly IServiceProvider _serviceProvider;
public MyService(IServiceProvider serviceProvider)
{
_serviceProvider = serviceProvider;
}
public void DoSomething()
{
var taxCalculator = _serviceProvider.GetService<ITaxCalculator>();
//...
}
}
服務替換
在某些情況下，需要替換某些介面的實現.
- ITestManager有一個預設實現DefaultManager,但是我現在想替換成TestReplaceManager,該如何操作呢?
原生dotnet方式替換
services.Replace(ServiceDescriptor.Transient<ITestManager, TestReplaceManager>());
Abp支援
- 加上Dependency特性標籤
- 加上ExposeServices特性標籤
[Dependency(ReplaceServices = true)]
[ExposeServices(typeof(ITestManager))]
public class TestReplaceManager : ITestManager, ITransientDependency
{
public void Print()
{
Console.WriteLine("TestReplaceManager");
}
}
問題
- 有時候我們實現了ITransientDependency,ISingletonDependency,IScopedDependency但是再執行是還是提示依賴注入失敗?
- 實現類的名稱拼寫錯誤
- 比如介面名稱為ITestAppService,但是實現類為DefaultTessAppService,這個時候編譯不會報錯，但是執行報錯,下面會基於原始碼分析。
public class DefaultTessAppService : ApplicationService, ITestAppService
{
// ....
}
- 我透過[Dependency(ReplaceServices = true)]替換服務沒有生效?
- 請新增[ExposeServices(typeof(ITestManager))]顯示暴露服務,下面會基於原始碼分析。
原始碼分析
- 進入到Startup.AddApplication原始碼
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddApplication<xxxManagementHttpApiHostModule>();
}
}
- 進入到await app.ConfigureServicesAsync()原始碼
public async static Task<IAbpApplicationWithExternalServiceProvider> CreateAsync(
[NotNull] Type startupModuleType,
[NotNull] IServiceCollection services,
Action<AbpApplicationCreationOptions>? optionsAction = null)
{
var app = new AbpApplicationWithExternalServiceProvider(startupModuleType, services, options =>
{
options.SkipConfigureServices = true;
optionsAction?.Invoke(options);
});
await app.ConfigureServicesAsync();
return app;
}
- 主要檢視ConfigureServices下的Services.AddAssembly(assembly)方法。
public virtual async Task ConfigureServicesAsync()
{
// 省略...
var assemblies = new HashSet<Assembly>();
//ConfigureServices
foreach (var module in Modules)
{
if (module.Instance is AbpModule abpModule)
{
if (!abpModule.SkipAutoServiceRegistration)
{
var assembly = module.Type.Assembly;
if (!assemblies.Contains(assembly))
{
Services.AddAssembly(assembly);
assemblies.Add(assembly);
}
}
}
try
{
await module.Instance.ConfigureServicesAsync(context);
}
catch (Exception ex)
{
throw new AbpInitializationException($"An error occurred during {nameof(IAbpModule.ConfigureServicesAsync)} phase of the module {module.Type.AssemblyQualifiedName}. See the inner exception for details.", ex);
}
}
// 省略...
}
4.進入下面AddAssembly下AddType的邏輯
public class DefaultConventionalRegistrar : ConventionalRegistrarBase
{
public override void AddType(IServiceCollection services, Type type)
{
if (IsConventionalRegistrationDisabled(type))
{
return;
}
// 檢視是否有DependencyAttribute特性標籤
var dependencyAttribute = GetDependencyAttributeOrNull(type);
// 判斷是否有實現介面，注入對於的型別。
var lifeTime = GetLifeTimeOrNull(type, dependencyAttribute);
if (lifeTime == null)
{
return;
}
var exposedServiceTypes = GetExposedServiceTypes(type);
TriggerServiceExposing(services, type, exposedServiceTypes);
foreach (var exposedServiceType in exposedServiceTypes)
{
var serviceDescriptor = CreateServiceDescriptor(
type,
exposedServiceType,
exposedServiceTypes,
lifeTime.Value
);
if (dependencyAttribute?.ReplaceServices == true)
{
services.Replace(serviceDescriptor);
}
else if (dependencyAttribute?.TryRegister == true)
{
services.TryAdd(serviceDescriptor);
}
else
{
services.Add(serviceDescriptor);
}
}
}
}
// GetLifeTimeOrNull
protected virtual ServiceLifetime? GetLifeTimeOrNull(Type type, DependencyAttribute? dependencyAttribute)
{
return dependencyAttribute?.Lifetime ?? GetServiceLifetimeFromClassHierarchy(type) ?? GetDefaultLifeTimeOrNull(type);
}
// abp 三個生命週期
protected virtual ServiceLifetime? GetServiceLifetimeFromClassHierarchy(Type type)
{
if (typeof(ITransientDependency).GetTypeInfo().IsAssignableFrom(type))
{
return ServiceLifetime.Transient;
}
if (typeof(ISingletonDependency).GetTypeInfo().IsAssignableFrom(type))
{
return ServiceLifetime.Singleton;
}
if (typeof(IScopedDependency).GetTypeInfo().IsAssignableFrom(type))
{
return ServiceLifetime.Scoped;
}
return null;
}
5.重點到了,看下為什麼名稱錯誤為什麼導致注入失敗。
- 透過介面的名稱去獲取實現。
- 也能解釋有時候不顯示指定ExposeServices可能替換失敗的問題
public class ExposeServicesAttribute : Attribute, IExposedServiceTypesProvider
{
// 省略...
private static List<Type> GetDefaultServices(Type type)
{
var serviceTypes = new List<Type>();
foreach (var interfaceType in type.GetTypeInfo().GetInterfaces())
{
var interfaceName = interfaceType.Name;
if (interfaceType.IsGenericType)
{
interfaceName = interfaceType.Name.Left(interfaceType.Name.IndexOf('`'));
}
// 查詢到實現類的名稱是否是移除I
if (interfaceName.StartsWith("I"))
{
interfaceName = interfaceName.Right(interfaceName.Length - 1);
}
// 查詢到實現類的名稱是否以介面名結尾
if (type.Name.EndsWith(interfaceName))
{
serviceTypes.Add(interfaceType);
}
}
return serviceTypes;
}
}
Abp vNext Pro
- Abp Vnext Pro Github地址 的 Vue3 實現版本 開箱即用的中後臺前端/設計解決方案.
- 文件地址
- 演示地址:使用者名稱admin 密碼1q2w3E*
- Abp Vnext Pro Suite Github地址 程式碼生成器。
- 演示地址:使用者名稱admin 密碼1q2w3E*
- 影片教程