作為一個沒有系統學習過依賴註入的開發者而言,如果直接在一個使用依賴註入的框架下進行開發,往往對於依賴註入的存在是沒有明顯的察覺,通過代碼追根溯源你都會看不出對象是從哪裡創建的。但這並不影響你進行開發的工作,你可以參照現有代碼的使用形式,將需要使用的對象加入到構造函數的參數列表上,你就可以使用對象,調 ...
作為一個沒有系統學習過依賴註入的開發者而言,如果直接在一個使用依賴註入的框架下進行開發,往往對於依賴註入的存在是沒有明顯的察覺,通過代碼追根溯源你都會看不出對象是從哪裡創建的。但這並不影響你進行開發的工作,你可以參照現有代碼的使用形式,將需要使用的對象加入到構造函數的參數列表上,你就可以使用對象,調用相應的功能了。
ASP.NET Core中利用容器提供對象的方式有兩種:依賴註入形式和Service Locator形式(服務定位器)。但是對於依賴註入而言,往往都是由框架主動的為應用程式提供對象,我們僅提供服務註冊和註入的構造函數即可,所以依托於框架的自動化機制,在應用層面依賴註入往往是“無感”的。
為了更好的體驗容器的服務註冊和消費,並屏蔽這種“無感”,本篇的代碼示例將採用Service Locator形式,因為該模式獲取對象的主動權還在應用程式上,所以可以讓服務的註冊和消費形式更加直觀的展示,有助於示例展示更多細節特征。但是在實際的應用開發時,我們應該避免使用Service Locator,因為它是官方認定的一種反模式。
1.創建演示項目
下麵我們從0到1基於一個控制台應用程式來演示容器的服務註冊和消費。由於需要使用依賴註入框架,我們則需在創建項目之後引入依賴註入框架依賴的包,其中包含:
- “Microsoft.Extensions.DependencyInjection”
- “Microsoft.Extensions.DependencyInjection.Abstrations”
如果開發的是ASP.NET Core應用程式,依賴註入的包會作為框架基礎自動引入。由於示例是控制台應用沒有自動引入,我們可以在NuGet中下載安裝。
.NET Core提供的很多基礎框架或組件在設計時,都會考慮“抽象和實現”的分離,對於依賴註入框架也不例外,其中抽象的介面等類型會定義在尾碼名為Abstrations的抽象包中,對於具體的實現類型則定義在DependencyInjection包中。
2.介面和實現
在使用依賴註入容器提供對象的場景中,某個類型依賴的對象通常定義為介面類型,這促使類型的依賴面向的是介面而不是具體的類型,這有助於應用程式的解耦並遵循依賴倒置原則。我個人認為這種面向介面的編程方式,並非特定於依賴註入的範疇,而是面向對象編程的基本原則。
本示例涉及的介面類型和實現類型的代碼如下:
1 public interface IFoo{}
2 public interface IBar{}
3 public interface IFoobar<T1,T2>{}
4
5 public class Foo:IFoo{}
6 public class Bar:IBar{}
7 public class Foobar<T1,T2>:IFoobar<T1,T2>
8 {
9 public T1 Para1 {get;}
10 public T2 Para2 {get;}
11
12 public Foobar(T1 para1,T2 para2)
13 {
14 Para1=para1;
15 Para2=para2;
16 }
17 }
上面的代碼分別定義3個介面類型:IFoo、IBar、IFoobar<T1,T2>,並且為每個介面定義了對於的實現類型:Foo、Bar、Foobar<T1,T2>,基於實例代碼的內容可以表明:容器不光可以提供普通類型的實例,還可以提供泛型類型的實例。
3.服務註冊
術語
在依賴註入的介紹中會大量提到“服務”一詞,該稱謂是依賴註入中的術語,服務通常代表的是:容器為某個類型提供的依賴對象,與Web領域中的服務並不是一個意思。
為了讓容器能夠提供某個類型依賴的服務,則必須進行相應服務的註冊,服務註冊是容器提供服務實例的依據,只有進行了服務註冊,容器才能知道需要提供哪些類型的服務。
服務在註冊時需要指定相應的服務類型和生命周期模式。服務類型通常為一個介面類型,這以便於我們的服務進行抽象化,在後期可以更好的進行擴展。生命周期模式主要通過ServiceLifetime枚舉類表示其中包括:Singleton(單例)、Scoped(作用域)、Transient(暫時)。
註冊方法
下麵結合本示例的服務類型完成相應的服務註冊,代碼如下:
1 var provider = new ServiceCollection()
2 .AddTransient<IFoo, Foo>()
3 .AddScoped<IBar, Bar>()
4 .AddTransient(typeof(IFoobar<,>), typeof(Foobar<,>))
5 .BuildServiceProvider();
上面的代碼中首先實例化了一個ServiceCollection對象,該對象主要用於存放服務註冊信息。ServiceCollection對象分別使用了AddTransient、AddScoped、AddSingleton擴展方法對IFoo、IBar、IFoobar服務類型進行了服務註冊,用於服務註冊的擴展方法不僅指定了不同的生命周期,還為服務類型指定了具體的實現類型。在對所有服務註冊後,還調用了BuildServiceProvider方法,該方法可以創建並獲取依賴註入的容器對象,該容器對象為IServiceProvider類型。
註冊形式
依賴註入的服務註冊形式並不局限於上面代碼示例中的方式,其中很多方式用於服務的註冊,如果想深入瞭解可以查閱官方文檔,但主要的註冊形式可以歸納為4種類型:
- 指定服務類型和服務實現類型:AddScoped<IBar, Bar>();
- 直接指定具體的服務實現類型:AddTransient(typeof(Foo));
- 根據服務類型直接提供一個實例:AddSingleton<IFoo>(new Foo());
- 指定一個創建服務實例的工廠方法:AddSingleton<IFoo>(_=> { Foo foo = new Foo(); return foo; });
4.服務消費
在完成了服務註冊的工作後,接下來我們可以對服務進行消費。首先通過BuildServiceProvider方法返回的容器對象,在調用GetService方法即可獲取指定服務的實例。本實例測試獲取服務實例的代碼如下:
1 var provider = new ServiceCollection()
2 .AddTransient<IFoo, Foo>()
3 .AddScoped<IBar, Bar>()
4 .AddTransient(typeof(IFoobar<,>), typeof(Foobar<,>))
5 .BuildServiceProvider();
6
7 Console.WriteLine(provider.GetService<IFoo>() is Foo);
8 Console.WriteLine(provider.GetService<IBar>() is Bar);
9 var foobar = (Foobar<IFoo, IBar>)provider.GetService<IFoobar<IFoo, IBar>>();
10 Console.WriteLine(foobar.Para1 is Foo);
11 Console.WriteLine(foobar.Para2 is Bar);
運行上面的代碼後輸出的結果均為True,則表示我們成功的獲取到服務實例。再次重申下,以上的服務消費方式是Service Locator形式,為了方便演示才採用的,在實際開發中應當使用依賴註入的形式,關於依賴註入形式的使用方式可以查閱:《ASP.NET Core依賴註入之旅:2.理論概念》文章中的“依賴註入初體驗”部分。
5.結語
本篇沒有過多的深入依賴註入中的每個細節,而是通過Service Locator(服務定位器)的形式結合代碼示例,來體驗容器進行服務註冊和消費的方式,後續會對其中的服務註冊和消費的細節進行詳細的介紹,還包括非常重要的生命周期模式。
其實在應用層面使用.NET的依賴註入還是比較簡單的,因為其中很多複雜的運行機制都是交給了框架,但是這種簡單易用的形式並不能成為我們可以淺表學習依賴註入的藉口。毫不誇張的說,整個ASP.NET Core就是建立在依賴註入框架之上的,所以我們必須要對依賴註入有一個系統學習的過程。
知識改變命運