本示例使用 .net core 5 rc-1 實現。
1. 添加 Nuget 包引用
使用 Autofac 當然要添加 Autofac 的 Nuget 包,主要涉及到兩個:
- Autofac.Extensions.DependencyInjection 核心支持包
- Autofac.Extras.DynamicProxy2 AOP 動態代理支持
如果不需要動態代理的話,只需要添加第一個即可。
dotnet add package Autofac.Extensions.DependencyInjection
2. 配置 Autofac
首先需要需要配置 Autofac 的容器工廠。
IHostBuilder 定義了擴展依賴注入容器的擴展點:
- UseServiceProviderFactory(),提供創建 Service Provider 的對象。
- ConfigureContainer(),配置依賴注入容器
這里我們不再使用默認的依賴注入容器,需要使用 AutofacServiceProviderFactory 來提供 Autofac 的 Service Provider。
由於需要使用 Autofac 的容器,所以在構建應用程序的時候,需要使用 Autofac 的服務工廠。主程序 Program 中的 CreateHostBuilder() 方法需要增加一行,修改之后如下所示:
public static IHostBuilder CreateHostBuilder (string[] args) =>
Host.CreateDefaultBuilder (args)
.UseServiceProviderFactory (new AutofacServiceProviderFactory ())
.ConfigureWebHostDefaults (webBuilder => {
webBuilder.UseStartup<Startup> ();
});
}
然后,需要在 Startup() 中配置服務注冊。
Autofac 的服務工廠會在調用 ConfigureServices() 之后,自動調用名為 ConfigureContainer() 的方法,一般情況下,我們會在這個方法里面使用 Autofac 來注冊服務。
在 Startup 文件中,添加如下的 ConfigureContainer() 方法。ContainerBuilder 是定義在命名空間 Autofac 中的,注意添加對該命名空間的引用。
using Autofac;
public void ConfigureContainer (ContainerBuilder builder) {
......
}
Autofac 提供了各種注冊服務的方法,不是微軟的 Addxxx() 方式,而是 Registerxxx() 方式。
例如,如果我們已經定義了一個 IDbService 接口,而它的實現類型是 DbService。那么,注冊服務的形式如下所示:
// register type, and enable interceptor injection
builder.RegisterType<DbService> ().As<IDbService> ()
.InstancePerLifetimeScope ();
DbService 是注冊在容器中的實現類型,而 As<IDbService> 是在容器中注冊的類型。注入的時候需要使用這個接口類型。InstancePerLifetimeScope() 則是說明它的生命周期是 Scope 類型的。
可以看到,在 Autofac 中,使用鏈式調用的方式來完成服務注冊。
3. 使用 Autofac Module 進行注冊
Autofac 提供了一個名為 Module 的概念,它支持將一組相關的服務注冊過程進行打包,以簡化配置和部署。
Autofac 提供了名為 Autofac.IModule 接口,以及一個它的抽象實現類型 Autofac.Module。它的核心是 Load() 方法,用來完成服務的注冊。我們可以重載它以實現自定義的服務注冊,該方法的簽名如下:
protected virtual void Load(
ContainerBuilder builder
)
可以看到該方法提供同樣的 ContainerBuilder 參數來提供服務注冊的支持。
這樣的話,前面的服務注冊可以轉移到一個 Autofac 的 Module 中來。
我們可以定義一個服務注冊類,如下所示:
using Autofac;
using Microsoft.AspNetCore.Mvc;
public class ServiceAutofacModule : Autofac.Module {
protected override void Load (ContainerBuilder builder) {
// register type, and enable interceptor injection
builder.RegisterType<DbService> ().As<IDbService> ()
.InstancePerLifetimeScope ();
}
}
然后,將 Startup() 中的 ConfigureContainer() 調整為如下形式,使用 Module 的方式完成服務注冊。
public void ConfigureContainer (ContainerBuilder builder) {
// use autofac module
builder.RegisterModule<ServiceAutofacModule>();
}
Module 的使用詳見:https://autofaccn.readthedocs.io/en/latest/configuration/modules.html
4. 常見的注冊方式
1. 按照類型進行注冊
// register type, and enable interceptor injection
builder.RegisterType<DbService> ().As<IDbService> ()
.InstancePerLifetimeScope ();
2. 按已經引用的程序集注冊
var assembly = assembly.Load ("Domain.Services");
builder.registerAssemblyType (assembly)
.AsImplementedInterfaces ()
.InstancePerLifetimeScope ();
3. 注冊程序集中的某些服務
下面的代碼中,先取得了 ControllerBase 的類型,然后在當前程序集中查找所有派生自 ControllerBase 的 Api 控制器
builder.RegisterAssemblyTypes(typeof(Program).Assembly)
.Where(t => t.Name.EndsWith("Service"))
.AsImplementedInterfaces()
.InstancePerLifetimeScope();
5. 使用屬性注入
Autofac 除了支持構造函數注入,還支持屬性注入,屬性注入會在構造函數注入之后進行。
必須要注意的是,必須在使用屬性注入的服務上進行聲明,
例如,如果 DbService 需要支持屬性注入,那么需要在注冊該服務的時候進行聲明。
builder.RegisterType<DbService> ().As<IDbService> ()
.PropertiesAutowired()
.InstancePerLifetimeScope ();
ASP.NET Core 中,對控制器進行屬性注入的特殊處理
默認情況下,ASP.NET Core 對於控制器並不是從容器中創建的,所以如果你檢查容器中的注冊,是看不到控制器的注冊的。
為了支持屬性注入,需要讓 ASP.NET Core 將控制器也注冊到容器中。這可以在 AddControllers() 方法之后,調用 AddControllersAsServices() 來實現。
public void ConfigureServices (IServiceCollection services) {
services.AddControllers()
.AddControllersAsServices();
}
然后,我們需要對控制器添加支持屬性注入的聲明。
既可以針對單個的控制器類
// make property autowire at one controller
builder.RegisterType<WeatherForecastController>()
.PropertiesAutowired();
也可以針對所有的控制器。
// make property autowire at all api controller
var controllerBaseType = typeof (ControllerBase);
builder.RegisterAssemblyTypes (typeof (Program).Assembly)
.Where (t => controllerBaseType.IsAssignableFrom (t) &&
t != controllerBaseType)
.PropertiesAutowired ();
6. 使用 AOP 動態代理
使用 AOP 需要如下的 4 個步驟。
1. 定義攔截器
攔截器的接口 IInterceptor 定義在命名空間 Castle.DynamicProxy 中,需要注意的是,它需要添加對 NuGet 包 Autofac.Extras.DynamicProxy 的引用。
dotnet add package Autofac.Extras.DynamicProxy
實現 IInterceptor 接口。
using Castle.DynamicProxy;
using System;
public class DbServiceInterceptor:IInterceptor
{
public virtual void Intercept(IInvocation invocation)
{
Console.WriteLine($"{DateTime.Now}: Before method execting. ");
invocation.Proceed();
Console.WriteLine($"{DateTime.Now}: After method exected.");
}
}
2. 注冊攔截器
攔截器也同樣需要注冊到容器中。
// register interceptor
builder.RegisterType<DbServiceInterceptor> ();
3. 啟用攔截器
需要支持攔截器的服務需要啟用攔截器,然后才能使用攔截器。
// register type, and enable interceptor injection
builder.RegisterType<DbService> ().As<IDbService> ()
.EnableInterfaceInterceptors ()
.InstancePerLifetimeScope ();
可以使用 EnableInterfaceInterceptors() 或者 EnableClassInterceptors() 擴展方法來啟用攔截器。
EnableInterfaceInterceptors() 創建接口代理來執行攔截,而 EnableClassInterceptors() 則創建目標組件的子類來執行攔截。
4. 使用攔截器
第一種方式是在使用攔截器的服務上,通過特性來聲明使用的攔截器。
using Autofac.Extras.DynamicProxy;
using Castle.DynamicProxy;
[Intercept (typeof (DbServiceInterceptor))]
public class DbService : IDbService {
public string Say () {
return "Hello";
}
}
當使用特性來關聯攔截器的時候,不需要在注冊服務的時候指定攔截器。你只需要啟用,實際的攔截器將被自動發現。
第二種方式是在注冊服務的時候指定,使用 InterceptedBy() 擴展方法。
builder.RegisterType<SomeType>()
.EnableClassInterceptors()
.InterceptedBy(typeof(CallLogger));
注意:
- 使用公共接口
- 類攔截要求被攔截的方法是虛方法,因為使用了子類代理技術。
- 通過表達式創建的服務,或者使用實例注冊的服務,不能使用子類方式代理,此時,要使用接口代理。
- 要使用接口代理,服務必須僅僅通過接口提供服務,為了最佳的性能,所有此類服務接口必須是注冊的一部分,例如使用 .As
子句。 - 如果通過 EnableClassInterceptors() 使用了類攔截,則避免使用構造函數選擇器 UsingConstructor()。在使用類攔截的時候,會為代理類生成新的構造函數以獲取你希望使用的攔截器。如果你使用了 UsingConstructor(),就會跳過此邏輯。導致攔截器不能被使用。
已知問題:
- 同步方法攔截。Castle 攔截器僅僅支持同步方法攔截。不支持顯式的 async/await 方法。但是,async/await 是 Task 的語法糖,你可以在攔截器中使用 Task 和 ContinueWith() 之類的方法。 This issue 展示了用法。另外,這些助手類 也使得 async 工作更容易一點。
- Castle.Core 版本問題。