ASP.NET Core依賴注入系統學習教程：關於服務註冊使用到的方法

2022 年 8 月 11 日
筆記
Asp.Net Core

在.NET Core的依賴注入框架中，服務註冊的信息將會被封裝成ServiceDescriptor對象，而這些對象都會存儲在IServiceCollection接口類型表示的集合中，另外，IServiceCollection接口類型默認使用的實現類型為ServiceCollection。這樣來看，實際上服務註冊這回事，它就是一個將創建的ServiceDescriptor對象添加到IServiceCollection接口類型集合中的過程。

通常一個項目，都是由大量的對象相互協作而構建成的應用程序。所以對於使用依賴注入框架的應用程序而言，需要進行大量的服務註冊，並且其中會存在不同形式的註冊需求。.NET Core為此提供了大量不同形式的服務註冊方法，為了方便使用，它將這些方法都定義為了IServiceCollection接口的擴展方法，這些擴展方法主要分佈在

ServiceCollectionServiceExtensions和ServiceCollectionDescriptorExtensions這兩個類中。這兩個類型都可以實現服務的註冊，但是具有如下不同的側重點：

ServiceCollectionServiceExtensions：提供以生命周期模式命名，無需指定生命周期參數的註冊方法；
ServiceCollectionDescriptorExtensions：主要以ServiceDescriptor對作為參數進行服務註冊，並包含避免同一類型服務重複註冊的方法和維護IServiceCollection集合的方法；

個人覺得前者更加簡單易用，後者則配置靈活且功能豐富，下面將圍繞這兩個類型中的服務註冊方法進行介紹。

1.ServiceCollectionServiceExtensions

該類型中關於服務註冊方法的命名，通常是以固定字符「Add」作為前綴，「Add」後面則是會加上不同的生命周期模式名稱。該類型中的註冊方法也屬於實際開發場景中較為常用的一種，因為使用這種方式的好處是：無需在服務註冊時傳入一個具體的生命周期，而是根據服務對生命周期模式的需求，選擇與模式名稱相同的方法即可。

例如，需要創建生命周期模式為Singleton的服務，那麼與之對應的註冊方法就是AddSingleton。並且可以根據AddSingleton方法的重載選擇任意一種提供服務實例的方式。一般最常用的重載形式是，使用對應泛型方法傳入服務類型和實現類型，例如下面的使用方式：

1    var collection = new ServiceCollection();
2    collection.AddSingleton<IFooBar, FooBar>();

該類型的註冊方法主要都是根據3種生命周期模式而設計，並結合ServiceDescriptor類型中3種提供服務實例的方式進行擴展，從而延申出了很多重載形式，更加方便的為應用程序提供服務註冊。如果想要具體了解每個生命周期模式的不同重載可以參考官方說明：

//docs.microsoft.com/zh-cn/dotnet/api/microsoft.extensions.dependencyinjection.servicecollectionserviceextensions?view=dotnet-plat-ext-6.0

2.ServiceCollectionDescriptorExtensions

相比ServiceCollectionServiceExtensions類型中的方法而言，雖然ServiceCollectionDescriptorExtensions類型從名稱上只有一詞之差，但是它的方法涉及範圍更加豐富。該類型不僅具備服務的註冊，還具備了對服務註冊信息的「增刪改」，並且包含針對服務註冊重複性判斷的方法，接下來則針對該類型中的方法進行一個介紹。

2.1.Add

該方法需要我們將服務註冊的信息創建為一個ServiceDescriptor對象，並將該對象作為參數傳入Add方法，以此形式作為服務註冊。該方法有兩種重載形式，一種是添加單個ServiceDescriptor對象，另一種是可以添加多個ServiceDescriptor對象的集合，對於該方法的調用示例可以參考如下代碼：

 1             //服務註冊信息集合
 2             var serviceCollection = new ServiceCollection();
 3 
 4             //添加「單個」服務註冊信息對象
 5             ServiceDescriptor descriptor = new ServiceDescriptor(typeof(IFooBar),typeof(FooBar), ServiceLifetime.Singleton);
 6             serviceCollection.Add(descriptor);
 7 
 8             //添加「多個」服務註冊信息對象
 9             List<ServiceDescriptor> descriptorList = new List<ServiceDescriptor>()
10             {
11                     new ServiceDescriptor(typeof(IAnimal),typeof(Dog), ServiceLifetime.Singleton),
12                     new ServiceDescriptor(typeof(IEmployee),typeof(Programmer), ServiceLifetime.Singleton)
13             };
14             serviceCollection.Add(descriptorList);

2.2.服務重複註冊

.NET Core依賴注入框架中支持對同一服務類型進行多次註冊。因為後續介紹的某些方法會針對這種重複多次的註冊方式有相應的處理邏輯，所以在介紹那些方法之前，首先來介紹下服務重複註冊這個行為有哪些特點。

1.對於同一個服務類型進行多次註冊，使用GetService獲取實例時，只會獲取一個最近註冊的服務實例。例如下圖的代碼示例中，分別針對同一服務類型IAnimal進行了多次註冊，其中實現類型包含：Dog、Cat、Pig，但最後獲取的實例只有Pig一個。

2.對於同一個服務類型進行多次註冊，如果要獲取該服務類型註冊的所有服務實例，則可以使用GetServices方法來獲取。例如下圖的代碼示例中，分別針對同一服務類型Base進行了多次註冊，在通過調用GetServices方法後，將服務類型Base註冊的所有服務實例都存儲到了一個集合中。

2.3.TryAdd形式的方法

之所以在在此處介紹的標題為TryAdd形式的方法，是因為除了TryAdd方法本身之外，還有以TryAdd作為方法名稱前綴的方法，分別是：TryAdd{生命周期模式}和TryAddEnumerable，並且3個方法都是圍繞同一個主題，即避免服務重複註冊。它們在調用的時候都會去檢查服務類型是否已經註冊過，如果已經註冊了，則放棄當前方法的註冊。TryAdd方法本身和TryAdd{生命周期模式}處理的邏輯基本是一致的，TryAddEnumerable處理會略有不同，下面針對這3類TryAdd形式的方法進行逐一介紹。

TryAdd

該方法需要我們將服務註冊的信息創建為一個ServiceDescriptor對象，類似於Add方法，只不過在Add的基礎上加了服務重複註冊的判斷邏輯，使用方式如下圖示例：

該示例執行的結果：最終只會獲取到第一次註冊的服務示例，因為當第二次調用TryAdd時就發現了已經存在相同服務類型的註冊，此時它會放棄註冊行為。

TryAdd{生命周期模式}

TryAdd{生命周期模式}類型的方法可以看作是TryAdd方法的一種延申形式，處理邏輯和TryAdd方法一致。但是使用起來更加的便捷，因為它是根據3種生命周期模式擴展而來的版本，使用該類型方法註冊時無需指定生命周期模式參數，而是根據生命周期需求選擇對應的方法名來決定生命周期模式。

以上是TryAdd{生命周期模式}類方法的使用示例，可以看出相比TryAdd方法而言，該方法更加方便，我們無需創建ServiceDescriptor對象和指定生命周期模式。該示例以Singleton模式為例，其他兩種模式的調用與此一致，此處就不一一演示了。

TryAddEnumerable

對於TryAddEnumerable方法判斷服務重複性的邏輯而言，不在是和前兩者的方法一樣：僅僅使用服務類型這一個條件來判斷重複性。TryAddEnumerable方法在檢查重複性時會同時考慮「服務類型」和「實現類型」。如果發現某個服務註冊信息對象的「服務類型」和「實現類型」，與當前即將要註冊服務信息的「服務類型」和「實現類型」相同時，TryAddEnumerable方法會放棄當前的註冊，以避免出現對於這種情況的重複註冊。下面基於這個邏輯通過代碼示例來證明這一點。

對於上面的示例而言，都是針對同一服務類型使用TryAddEnumerable方法的註冊。其中對於第三次進行的Dog的註冊而言，此時的ServiceCollection服務註冊集合中已經存在了一個相同服務類型的註冊，並且已存在的這個服務註冊的實現類型也與之相同，所以第三次進行的註冊被TryAddEnumerable方法認定為一個重複性的註冊，故沒有添加到ServiceCollection集合中。而Cat註冊時雖然已經存在了相同服務類型的IAnimal，但是沒有服務類型和實現類型同時相同的Cat註冊，即不滿足TryAddEnumerable的重複性判斷條件，所以該服務註冊會被添加到ServiceCollection服務註冊集合中。

3.維護性方法

.NET Core依賴注入框架對於服務註冊的行為，實際上就是將ServiceDescriptor(服務註冊信息描述對象)添加到IServiceCollection集合中的過程。所以對於一個集合而言除了用於服務註冊的添加方法之外，還有一些維護性的方法，用於對IServiceCollection中的服務註冊進行：刪除、替換、清空等操作，這些方法的來源主要來自兩點：

由IList<ServiceDescriptor>接口繼承而來；
ServiceCollectionDescriptorExtensions類定義的擴展方法；

下面通過代碼示例對一些常用的方法進行演示，並通過注釋對方法使用的細節進行強調：

 1            var serviceCollection = new ServiceCollection();
 2             serviceCollection.AddSingleton<IAnimal, Dog>();
 3             serviceCollection.AddSingleton<Base, Pig>();
 4 
 5             //替換：將舊的ServiceDescriptor對象刪除，在新增一個新的ServiceDescriptor對象
 6             var catDescriptor = ServiceDescriptor.Scoped<IAnimal, Cat>();
 7             serviceCollection.Replace(catDescriptor);
 8 
 9             //刪除：刪除指定服務類型的註冊
10             serviceCollection.RemoveAll<Base>();
11 
12             //清空ServiceCollection集合中所有的服務註冊信息對象
13             serviceCollection.Clear();

4.自動註冊

.NET Core依賴注入框架雖然為我們提供了豐富的服務註冊方法，但是對於大型的項目而言，服務註冊將成為一種高頻次且重複性的枯燥工作，那麼對於這樣的一種情形而言，有沒有一種自動化的註冊方式呢？答案是有的，就是藉助使用一個第三方開源的NetCore.AutoRegisterDi組件來實現服務的自動註冊。下面將通過一個示例來演示如何使用NetCore.AutoRegisterDi組件。

1.從NuGet下載NetCore.AutoRegisterDi

通過NuGet下載組件的方式有很多，你可以用不同的下載，本示例通過利用VS中可視化的NuGet界面進行下載。

2.建立特徵

NetCore.AutoRegisterDi組件自動化註冊的前提是，要求服務註冊的實現類型具有某一種特徵，該組件會基於這種特徵查找出與該特徵匹配的所有類型，然後對這些符合特徵的類型進行服務註冊，最終注入到依賴它的類型中。本示例中服務註冊的實現類型所採用的特徵是：所有服務實現類型名稱都是以「Service」結尾。

 1 using System;
 2 
 3 namespace DependencyInjectionDemo
 4 {
 5     //服務類型
 6     public interface IComputer 
 7     {
 8         string SayHi(); //打招呼
 9     }
10 
11     //服務實現類型
12     public class ComputerService : IComputer
13     {
14         public string SayHi()
15         {
16             return "你好，我是戴爾電腦。";
17         }
18     }
19 
20 }

3.定義注入形式

本示例中是將註冊的服務提供給MVC中的控制器對象，控制器對象對依賴的服務提供以構造函數形式的注入方式，如下代碼所示。

 1  public class HomeController : Controller
 2     {
 3         private IComputer _computer;
 4 
 5         public HomeController(IComputer computer)
 6         {
 7             _computer = computer;
 8         }
 9 
10         public IActionResult Index()
11         {
12             ViewBag.Msg = _computer.SayHi();
13             return View();
14         }
15 
16     }

4.配置自動註冊

以ASP.NET Core的項目為例，我們需要在Startup類的ConfigureServices方法中添加如下的代碼：

1            //獲取服務實現類型所在的程序集，一般都在實體層
2            var modelAssembly = Assembly.Load("DependencyInjectionDemo");
3 
4             //服務自動註冊
5             services.RegisterAssemblyPublicNonGenericClasses(modelAssembly)
6                         .Where(c => c.Name.EndsWith("Service"))  
7                         .AsPublicImplementedInterfaces(ServiceLifetime.Scoped);

其中RegisterAssemblyPublicNonGenericClasses方法用於獲取某個程序集中的所有類型（在實際的項目中我們的服務實現類型一般都定義在實體層），在RegisterAssemblyPublicNonGenericClasses方法調用之後，根據為「服務實現類型」定義的特徵來獲取相應的類型，此處我們使用Where方法結合特徵(以Service結尾的類)篩選出相應的類型。AsPublicImplementedInterfaces方法表示，將針對前面兩個方法篩選出的所有公共實現類型，使用指定的生命周期模式結合服務類型進行服務註冊。

在完成以上的步驟後，後續對於應用程序的服務註冊，都將由NetCore.AutoRegisterDi組件自動完成，那麼這樣一來，對於後續使用依賴注入框架而言，我們僅僅只需要為依賴的服務定義構造函數的注入形式即可。

學習感悟：學習就像是燒開水，燒到30度、60度、90度，燒的次數在多，沒有燒到100度沸點則都是白費。

Tags: Asp.Net Core