dotNET Core 3.X 使用 Autofac 来增强依赖注入
在上一篇《dotNET Core 3.X 依賴注入》中簡單介紹了 dotNET Core 框架本身的依賴注入功能,大部分情況下使用框架的依賴注入功能就可以滿足了,在一些特殊場景下,我們就需要引入第三方的注入框架。
為什么要使用 Autofac?
如果您在之前的 dotNET Framwork 時代使用過依賴注入,那么對 Autofac 一定不會陌生,在 dotNET Core 中也可以很方便的使用 Autofac,之所以使用第三方注入框架,是因為能提供更多的功能:
屬性注入
批量注入
動態代理的 AOP 功能
在 dotNET Core 中使用 Autofac
在 dotNET Core 2.x 和 3.x 中使用 Autofac 是有區別的,所以下面分別介紹在兩個版本中的簡單使用。
2.x
1、創建 dotNET Core 2.1 版本的 WebAPI 項目
2、創建 IUserService 接口和 UserService 類:
3、創建 UserController,在構造函數中添加依賴注入:
[Route("api/[controller]/[action]")] [ApiController] public?class?UserController:?ControllerBase {private?readonly?IUserService?_userService;public?UserController(IUserService?userService){_userService?=?userService;}public?string?GetUserName(){return?_userService.GetUserName();} }4、添加 Autofac.Extensions.DependencyInjection 的 NuGet 引用
5、修改 Startup 類的 ConfigureServices 方法:
public?IServiceProvider?ConfigureServices(IServiceCollection?services) {services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);//創建?Autofac?容器var?containerBuilder?=?new?ContainerBuilder();containerBuilder.Populate(services);//將?UserService?類作為?IUserService?的實現進行注冊containerBuilder.RegisterType<UserService>().As<IUserService>().InstancePerLifetimeScope();var?container?=?containerBuilder.Build();//接管內置的容器return?new?AutofacServiceProvider(container); }3.x
1、創建 dotNET Core 3.x 的項目和相關類,參考上面的一到四步
2、修改 Program 類,使用 AutofacServiceProviderFactory 來替代創建服務提供程序的工廠:
public?static?IHostBuilder?CreateHostBuilder(string[]?args)?=>Host.CreateDefaultBuilder(args).UseServiceProviderFactory(new?AutofacServiceProviderFactory()).ConfigureWebHostDefaults(webBuilder?=>?{?webBuilder.UseStartup<Startup>();?});3、修改 Startup 類,在該類中添加 ConfigureContainer 方法,和ConfigureServices 方法一樣,框架也是通過命名約束來進行執行的:
public?void?ConfigureContainer(ContainerBuilder?builder) {builder.RegisterType<UserService>().As<IUserService>().InstancePerLifetimeScope(); }Autofac 的增強功能
下面的所有示例全部在 dotNET Core 3.1 版本中完成。
屬性注入
dotNET Core 框架本身的依賴注入只支持構造函數和 FromSerice 的方式,Autofac 可以支持屬性的注入。
使用屬性注入很簡單,在注冊類型時調用 PropertiesAutowired 方法即可,具體步驟如下:
1、調整 UserController ,以屬性的方式來定義 IUserService:
public?class?UserController:?ControllerBase {public?IUserService?UserService?{?get;?set;?}public?string?GetUserName(){return?UserService.GetUserName();} }2、修改 Startup 類的 ConfigureServices 方法,添加 AddControllersAsServices 方法的調用:
public?void?ConfigureServices(IServiceCollection?services) {services.AddControllers().AddControllersAsServices(); }3、修改 Startup 類的 ConfigureContainer :
public?void?ConfigureContainer(ContainerBuilder?builder) {builder.RegisterType<UserService>().As<IUserService>().InstancePerLifetimeScope();var?controllerBaseType?=?typeof(ControllerBase);?builder.RegisterAssemblyTypes(typeof(Program).Assembly).Where(t?=>?controllerBaseType.IsAssignableFrom(t)?&&?t?!=?controllerBaseType).PropertiesAutowired(); }只要在 Controller 中需要做屬性注入的時候,才需要在 ConfigureServices 方法中添加對 AddControllersAsServices 方法的調用;
PropertiesAutowired 方法添加在使用屬性的注入類型中,比如上面代碼是在 Controller 中使用屬性,所以 PropertiesAutowired 添加對所有 Controller注冊的后面;
如果在 UserService 類以屬性的方式對 IDeptService 引用,注冊的方式如下:
批量注冊
其實上面的代碼中已經涉及到了批量注冊,就是對所有的 Controller 進行注冊:
var?controllerBaseType?=?typeof(ControllerBase);? builder.RegisterAssemblyTypes(typeof(Program).Assembly).Where(t?=>?controllerBaseType.IsAssignableFrom(t)?&&?t?!=?controllerBaseType).PropertiesAutowired();所有的 Controller 都是繼承自基類 ControllerBase,先獲取基類的類型;
找到 Program 類所在的程序集中所有實現了 ControllerBase 的類型進行注冊。
再來看另一種情況,上面例子中創建 UserServicce 服務,現在再創建 DeptService 服務類:
public?interface?IDeptService {string?GetDeptName(); } public?class?DeptService:IDeptService {public?string?GetDeptName(){return?"產品部";} }修改 Startup 類的 ConfigureContainer 方法來實現批量注冊:
public?void?ConfigureContainer(ContainerBuilder?builder) {builder.RegisterAssemblyTypes(typeof(Program).Assembly).Where(t?=>?t.Name.EndsWith("Service")).AsImplementedInterfaces().InstancePerLifetimeScope(); }找到 Program 類所在的程序集中所有以 Service 命名的類型進行注冊。更多的情況就根據實際場景舉一反三了。
動態代理的 AOP 功能
使用動態代理的功能,需要引用 NuGet 包:Autofac.Extras.DynamicProxy,如下圖:
AOP 的概念這里就不在贅述,和 dotNET Core 內置的攔截器(Filter、中間件)的區別是 Autofac 的 AOP 針對具體業務方法而不是 HTTP 請求。
1、創建 UserServiceInterceptor 攔截類,繼承自 IInterceptor:
public?class?UserServiceInterceptor:IInterceptor {public?virtual?void?Intercept(IInvocation?invocation){Console.WriteLine($"{DateTime.Now}:?方法執行前");invocation.Proceed();Console.WriteLine($"{DateTime.Now}:?方法執行后");} }2、修改 Startup 類中的 ConfigureContainer 方法,進行 AOP 的注冊:
public?void?ConfigureContainer(ContainerBuilder?builder) {builder.RegisterType<UserServiceInterceptor>();builder.RegisterType<UserService>().As<IUserService>().EnableInterfaceInterceptors().InstancePerLifetimeScope(); }注冊 UserServiceInterceptor 攔截器
注冊 UserService 服務的時候調用 EnableInterfaceInterceptors 啟用攔截器
3、修改 UserService 類,添加 AOP 特性標記:
[Intercept(typeof(UserServiceInterceptor))] public?class?UserService:?IUserService {//public?IDeptService?DeptService?{?get;?set;?}public?string?GetUserName(){Console.WriteLine($"{DateTime.Now}:?方法執行中");return?"oec2003";//return?$"oec2003({DeptService.GetDeptName()})";} }4、調用結果如下:
總結
本文算是拋磚引入,Autofac 還有許多的功能由于目前沒有使用到,也就沒有放到本文中,比如子容器等。具體使用 dotNET Core 框架自身的依賴注入,還是使用 Autofac,要看具體的場景了,當然兩者也是可以并存的。
示例代碼:https://github.com/oec2003/DotNetCoreThreeAPIDemo/tree/master/AutofacNetCore3.1Demo
總結
以上是生活随笔為你收集整理的dotNET Core 3.X 使用 Autofac 来增强依赖注入的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 记一次EF Core连接MySql、Or
- 下一篇: 使用请求头认证来测试需要授权的 API