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

初識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”接口，代碼如下：

using System;
using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Linq.Expressions;
using System.Text;
using System.Threading.Tasks;

namespace Lezhima.Data.Interface
{
    public interface IRepository<T> where T : class
    {
        /// <summary>
        /// 從指定的表中獲取符合條件的一條實體數據
        /// </summary>
        /// <param name="predicate"></param>
        /// <returns></returns>
        Task<T> GetAsync(Expression<Func<T, bool>> predicate);
    }
}

 

3、在Lezhima.Data層再增加一個名為“Repository”類，實現“IRepository”接口，代碼如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Data;
using System.Linq.Expressions;
using Microsoft.EntityFrameworkCore;
using System.Data.SqlClient;
using Lezhima.Data.Interface;

namespace Lezhima.Data
{
    /// <summary>
    /// 數據層
    /// 實現IRepository接口
    /// </summary>
    /// <typeparam name="T"></typeparam>
    public class Repository<T> : IRepository<T> where T : class
    {

        /// <summary>
        /// 從指定的表中獲取符合條件的一條實體數據
        /// </summary>
        /// <param name="predicate"></param>
        /// <returns></returns>
        public async Task<T> GetAsync(Expression<Func<T, bool>> predicate)
        {
            using (var db = new LezhimaContext())
            {
                if (predicate == null)
                    return null;

                return await db.Set<T>().Where(predicate).FirstOrDefaultAsync<T>();
            }
        }
    }
}

 

4、在Lezhima.Core層再定義一個名為“IUserCore”接口，代碼如下：

using System;
using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;

namespace Lezhima.Core.Interface
{
    public interface IUserCore
    {
        /// <summary>
        /// 根據賬號密碼判斷用戶是否擁有合法登錄權限
        /// </summary>
        /// <param name="email"></param>
        /// <returns>100成功，101賬號錯誤，102密碼錯誤，103參數不合法</returns>
        Task<MobiResult> Login(string email,string pwd);
    }
}

 

5、在Lezhima.Core層再增加一個名為“UserCore”類，實現“IUserCore”接口，代碼如下：

using Lezhima.Core.Interface;
using Lezhima.Data.Interface;
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;

namespace Lezhima.Core
{
    public class UserCore : IUserCore
    {
        //定義一個依賴屬性
        private readonly IRepository<EB_User> _Repository;

        /// <summary>
        /// 通過構造涵數方式注入Data層的Repository實例
        /// </summary>
        /// <param name="repository"></param>
        public UserCore(IRepository<EB_User> repository)
        {
            _Repository = repository;
        }


        /// <summary>
        /// 根據賬號密碼判斷用戶是否擁有合法登錄權限
        /// </summary>
        /// <returns>100成功，101賬號錯誤，102密碼錯誤，103參數不合法</returns>
        public async Task<MobiResult> Login(string email, string pwd)
        {
            if (string.IsNullOrEmpty(email) || string.IsNullOrEmpty(pwd))
                return new MobiResult(103);

            //到Data層去取指定用戶的數據
            var model= await _Repository.GetAsync(p => p.Email.Equals(email)&&p.IsDelete!=99);
            if(model ==null)
                return new MobiResult(101);

            if(!model.Pwd.Equals(pwd))
                return new MobiResult(102);

            return new MobiResult(100);
        }

    }
}

 

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

using System;
using System.Collections.Generic;
using System.Linq;
using System.Security.Claims;
using System.Threading.Tasks;
using Lezhima.Core.Interface;
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Authentication.Cookies;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace Lezhima.Web.Controllers
{
    [Authorize]
    [AutoValidateAntiforgeryToken]
    public class AccountController : Controller
    {

        //定義一個依賴屬性
        private readonly IUserCore _UserCore;

        /// <summary>
        /// 通過構造涵數方式注入Core層的UserCore實例
        /// </summary>
        /// <param name="__UserCore"></param>
        public AccountController(IUserCore __UserCore)
        {
            _UserCore = __UserCore;
        }


        // GET: Account
        public ActionResult Index()
        {
            return View();
        }




        /// <summary>
        /// 實現客戶端的登錄操作
        /// </summary>
        /// <param name="loginRequest"></param>
        /// <returns></returns>
        [HttpPost]
        [AllowAnonymous]
        public async Task<IActionResult> Login(LoginRequest loginRequest)
        {
            var result = await _UserCore.Login(loginRequest.Email, loginRequest.Pwd);

            if (result.Code != 100)
            {
                ViewBag.ResultModel = result;
                return View();
            }

            //向客戶端寫入用戶的身份cookie
            var _user = new ClaimsPrincipal(new ClaimsIdentity(new Claim[]
            {
                    new Claim("UserId", user_model.UserId.ToString()),
            }, CookieAuthenticationDefaults.AuthenticationScheme));
            await HttpContext.SignInAsync(CookieAuthenticationDefaults.AuthenticationScheme, _user);

            if (string.IsNullOrWhiteSpace(loginRequest.ReturnUrl))
            {
                return RedirectToAction("Index", "Home");
            }
            return Redirect(loginRequest.ReturnUrl);
        }

    }
}

 

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

using Autofac;
using Lezhima.Core;
using Lezhima.Data;
using Lezhima.Data.Interface;
using System;

namespace Lezhima.Web.Injection
{
    /// <summary>
    /// 重寫依賴注入的業務
    /// </summary>
    public class Evolution : Module
    {
        protected override void Load(ContainerBuilder builder)
        {
            //注入Data層的Repository類
            builder.RegisterGeneric(typeof(Repository<>)).As(typeof(IRepository<>)).InstancePerDependency();
            //批量注入Core層的類
            builder.RegisterAssemblyTypes(typeof(UserCore).Assembly)
                    .Where(t => t.Name.EndsWith("Core"))
                    .AsImplementedInterfaces();
        }
    }
}

 

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

public IConfiguration Configuration { get; }

public IServiceProvider ConfigureServices(IServiceCollection services)
{
	services.AddMvc();

	//將Evolution注冊到項目中來，實現依賴注入
	var builder = new ContainerBuilder();
	builder.RegisterModule(new Evolution());
	builder.Populate(services);
	var container = builder.Build();
	return container.Resolve<IServiceProvider>();
}

  

總結

1、每層在調用時，通過在該類內聲明一個接口類型的屬性（變量），再通過Autofac構造涵數注入方式實現依賴注入並獲取到相應的類實例。

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

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

4、最后再通過在ASP.NET Core項目內的“Startup”類內將注入代碼類注冊到項目中就可正常使用了。

 

聲明

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