ASP.NET Core2使用Autofac實現IOC依賴注入竟然能如此的優雅簡便

Andre-Hub發表於2018-09-10
ASP.NET依賴注入

初識ASP.NET Core的小夥伴一定會發現，其幾乎所有的專案依賴都是通過依賴注入方式進行鏈式串通的。這是因為其使用了依賴注入 (DI) 的軟體設計模式，程式碼的設計是遵循著“高內聚、低耦合”的原則，使得各個類與類之間的關係依賴於介面，這樣做的目的是能更有利於專案程式碼的維護與擴充套件。

 

Autofac

在進入主題之前我們們還是先來簡單的認識下鼎鼎大名的“Autofac”吧。那麼何為Autofac呢，通俗的講就是一個開源的，且基於.NET Core、ASP.NET Core、.NET 4.5.1+等框架實現的控制反轉（IOC）類庫。通過Autofac可以在.NET Core、ASP.NET Core、.NET 4.5.1+等專案上很容易的實現依賴注入，程式碼很容易就能達到“高內聚、低耦合”的原則。另外，Autofac的中文資料也很多，需要詳細瞭解的也可在網上自行檢視。

Autofac官方網站：https://autofac.org/

Autofac官方的中文文件網站：https://autofaccn.readthedocs.io/zh/latest/

 

背景

在我們大部分的專案中都會將程式碼抽成多層，每層之間通過相互依賴串聯工作。在這裡，我們將ASP.NET Core專案程式碼抽成三層結構，分別為輸入輸出層（MVC專案）、業務層（類庫）、資料層（類庫），每層的功能描述如下：

1、Lezhima.Web：接受來自客戶端的請求，及服務端響應的出入口。由一個基於ASP.NET Core的MVC專案組成。

2、Lezhima.Core：根據請求做出相應的業務判斷，及排程上下游資料並計算，輸出相應的業務結果給呼叫者。由一個基於.NET Core的類庫組成。

3、Lezhima.Data：直接跟DB進行通訊互動，實現對DB的增、刪、改、查等操作。由一個基於.NET Core的類庫組成。

依賴關係：

基於上述中的三層程式碼結構，我們可以清晰的看出Lezhima.Web做為專案出入口，在其需要時會呼叫Lezhima.Core類庫，並將業務交由Lezhima.Core庫處理，而Lezhima.Core類庫在其需要時會呼叫Lezhima.Data類庫操作DB。那麼，它們之間的依懶關係應該是這樣子的：

1、Lezhima.Web同時依賴於Lezhima.Core與Lezhima.Data類庫。

2、Lezhima.Core依賴於Lezhima.Data類庫。

 

實現程式碼

通過上面的介紹，我們清楚了三個分層之間的功能與依賴關係，那麼接下來我們就分別來看看它們具體程式碼及使用Autofac如何優雅的實現依賴注入吧。

1、首先在Lezhima.Web專案中通過NuGet管理器引用：Autofac、Autofac.Extensions.DependencyInjection兩個類庫。

2、我們先來看看Lezhima.Data層的程式碼，首先定義一個名為“IRepository”介面，程式碼如下：

  1 using System;
  2 using System.Collections.Generic;
  3 using System.Data;
  4 using System.Linq;
  5 using System.Linq.Expressions;
  6 using System.Text;
  7 using System.Threading.Tasks;
  8 
  9 namespace Lezhima.Data.Interface
 10 {
 11     public interface IRepository<T> where T : class
 12     {
 13         /// <summary>
 14         /// 從指定的表中獲取符合條件的一條實體資料
 15         /// </summary>
 16         /// <param name="predicate"></param>
 17         /// <returns></returns>
 18         Task<T> GetAsync(Expression<Func<T, bool>> predicate);
 19     }
 20 }

 

3、在Lezhima.Data層再增加一個名為“Repository”類，實現“IRepository”介面，程式碼如下：

  1 using System;
  2 using System.Collections.Generic;
  3 using System.Linq;
  4 using System.Text;
  5 using System.Threading.Tasks;
  6 using System.Data;
  7 using System.Linq.Expressions;
  8 using Microsoft.EntityFrameworkCore;
  9 using System.Data.SqlClient;
 10 using Lezhima.Data.Interface;
 11 
 12 namespace Lezhima.Data
 13 {
 14     /// <summary>
 15     /// 資料層
 16     /// 實現IRepository介面
 17     /// </summary>
 18     /// <typeparam name="T"></typeparam>
 19     public class Repository<T> : IRepository<T> where T : class
 20     {
 21 
 22         /// <summary>
 23         /// 從指定的表中獲取符合條件的一條實體資料
 24         /// </summary>
 25         /// <param name="predicate"></param>
 26         /// <returns></returns>
 27         public async Task<T> GetAsync(Expression<Func<T, bool>> predicate)
 28         {
 29             using (var db = new LezhimaContext())
 30             {
 31                 if (predicate == null)
 32                     return null;
 33 
 34                 return await db.Set<T>().Where(predicate).FirstOrDefaultAsync<T>();
 35             }
 36         }
 37     }
 38 }
 39

 

4、在Lezhima.Core層再定義一個名為“IUserCore”介面，程式碼如下：

  1 using System;
  2 using System.Collections.Generic;
  3 using System.Text;
  4 using System.Threading.Tasks;
  5 
  6 namespace Lezhima.Core.Interface
  7 {
  8     public interface IUserCore
  9     {
 10         /// <summary>
 11         /// 根據賬號密碼判斷使用者是否擁有合法登入許可權
 12         /// </summary>
 13         /// <param name="email"></param>
 14         /// <returns>100成功，101賬號錯誤，102密碼錯誤，103引數不合法</returns>
 15         Task<MobiResult> Login(string email,string pwd);
 16     }
 17 }
 18

 

5、在Lezhima.Core層再增加一個名為“UserCore”類，實現“IUserCore”介面，程式碼如下：

  1 using Lezhima.Core.Interface;
  2 using Lezhima.Data.Interface;
  3 using System;
  4 using System.Collections.Generic;
  5 using System.Text;
  6 using System.Threading.Tasks;
  7 
  8 namespace Lezhima.Core
  9 {
 10     public class UserCore : IUserCore
 11     {
 12         //定義一個依賴屬性
 13         private readonly IRepository<EB_User> _Repository;
 14 
 15         /// <summary>
 16         /// 通過構造涵數方式注入Data層的Repository例項
 17         /// </summary>
 18         /// <param name="repository"></param>
 19         public UserCore(IRepository<EB_User> repository)
 20         {
 21             _Repository = repository;
 22         }
 23 
 24 
 25         /// <summary>
 26         /// 根據賬號密碼判斷使用者是否擁有合法登入許可權
 27         /// </summary>
 28         /// <returns>100成功，101賬號錯誤，102密碼錯誤，103引數不合法</returns>
 29         public async Task<MobiResult> Login(string email, string pwd)
 30         {
 31             if (string.IsNullOrEmpty(email) || string.IsNullOrEmpty(pwd))
 32                 return new MobiResult(103);
 33 
 34             //到Data層去取指定使用者的資料
 35             var model= await _Repository.GetAsync(p => p.Email.Equals(email)&&p.IsDelete!=99);
 36             if(model ==null)
 37                 return new MobiResult(101);
 38 
 39             if(!model.Pwd.Equals(pwd))
 40                 return new MobiResult(102);
 41 
 42             return new MobiResult(100);
 43         }
 44 
 45     }
 46 }
 47

 

6、在Lezhima.Web層增加一個名為“AccountController ”的控制器，程式碼如下：

  1 using System;
  2 using System.Collections.Generic;
  3 using System.Linq;
  4 using System.Security.Claims;
  5 using System.Threading.Tasks;
  6 using Lezhima.Core.Interface;
  7 using Microsoft.AspNetCore.Authentication;
  8 using Microsoft.AspNetCore.Authentication.Cookies;
  9 using Microsoft.AspNetCore.Authorization;
 10 using Microsoft.AspNetCore.Http;
 11 using Microsoft.AspNetCore.Mvc;
 12 
 13 namespace Lezhima.Web.Controllers
 14 {
 15     [Authorize]
 16     [AutoValidateAntiforgeryToken]
 17     public class AccountController : Controller
 18     {
 19 
 20         //定義一個依賴屬性
 21         private readonly IUserCore _UserCore;
 22 
 23         /// <summary>
 24         /// 通過構造涵數方式注入Core層的UserCore例項
 25         /// </summary>
 26         /// <param name="__UserCore"></param>
 27         public AccountController(IUserCore __UserCore)
 28         {
 29             _UserCore = __UserCore;
 30         }
 31 
 32 
 33         // GET: Account
 34         public ActionResult Index()
 35         {
 36             return View();
 37         }
 38 
 39 
 40 
 41 
 42         /// <summary>
 43         /// 實現客戶端的登入操作
 44         /// </summary>
 45         /// <param name="loginRequest"></param>
 46         /// <returns></returns>
 47         [HttpPost]
 48         [AllowAnonymous]
 49         public async Task<IActionResult> Login(LoginRequest loginRequest)
 50         {
 51             var result = await _UserCore.Login(loginRequest.Email, loginRequest.Pwd);
 52 
 53             if (result.Code != 100)
 54             {
 55                 ViewBag.ResultModel = result;
 56                 return View();
 57             }
 58 
 59             //向客戶端寫入使用者的身份cookie
 60             var _user = new ClaimsPrincipal(new ClaimsIdentity(new Claim[]
 61             {
 62                     new Claim("UserId", user_model.UserId.ToString()),
 63             }, CookieAuthenticationDefaults.AuthenticationScheme));
 64             await HttpContext.SignInAsync(CookieAuthenticationDefaults.AuthenticationScheme, _user);
 65 
 66             if (string.IsNullOrWhiteSpace(loginRequest.ReturnUrl))
 67             {
 68                 return RedirectToAction("Index", "Home");
 69             }
 70             return Redirect(loginRequest.ReturnUrl);
 71         }
 72 
 73     }
 74 }

 

7、在Lezhima.Web層增加一個名為“Evolution”的類，用於繼承Autofac的Module類，實現上述三層之間的依賴關係注入，程式碼如下：

  1 using Autofac;
  2 using Lezhima.Core;
  3 using Lezhima.Data;
  4 using Lezhima.Data.Interface;
  5 using System;
  6 
  7 namespace Lezhima.Web.Injection
  8 {
  9     /// <summary>
 10     /// 重寫依賴注入的業務
 11     /// </summary>
 12     public class Evolution : Module
 13     {
 14         protected override void Load(ContainerBuilder builder)
 15         {
 16             //注入Data層的Repository類
 17             builder.RegisterGeneric(typeof(Repository<>)).As(typeof(IRepository<>)).InstancePerDependency();
 18             //批量注入Core層的類
 19             builder.RegisterAssemblyTypes(typeof(UserCore).Assembly)
 20                     .Where(t => t.Name.EndsWith("Core"))
 21                     .AsImplementedInterfaces();
 22         }
 23     }
 24 }
 25

 

8、在Lezhima.Web層的“Startup”類的“ConfigureServices”方法內注入即可，程式碼如下：

  1 public IConfiguration Configuration { get; }
  2 
  3 public IServiceProvider ConfigureServices(IServiceCollection services)
  4 {
  5 	services.AddMvc();
  6 
  7 	//將Evolution註冊到專案中來，實現依賴注入
  8 	var builder = new ContainerBuilder();
  9 	builder.RegisterModule(new Evolution());
 10 	builder.Populate(services);
 11 	var container = builder.Build();
 12 	return container.Resolve<IServiceProvider>();
 13 }

  

總結

1、每層在呼叫時，通過在該類內宣告一個介面型別的屬性（變數），再通過Autofac構造涵數注入方式實現依賴注入並獲取到相應的類例項。

2、通過繼承Autofac的Module類，並在Load方法內重寫自已專案的類關係來實現注入業務。

3、Autofac注入有多種不同的生命週期型別，分別為InstancePerLifetimeScope、SingleInstance、InstancePerDependency等，各位在專案中按需選擇即可。

4、最後再通過在ASP.NET Core專案內的“Startup”類內將注入程式碼類註冊到專案中就可正常使用了。

 

宣告

本文為作者原創，轉載請備註出處與保留原文地址，謝謝。如文章能給您帶來幫助，請點下推薦或關注，感謝您的支援！

 

相關文章