ASP.NET Core如何註入多個服務實現類

前言:

依賴註入在 ASP.NET Core 中起中很重要的作用,也是一種高大上的編程思想,它的總體原則就是:俺要啥,你就給俺送啥過來。服務類型的實例轉由容器自動管理,無需我們在代碼中顯式處理。

因此,有瞭依賴註入後,你的編程思維就得變一變瞭。在過去,許多功能性的類型(比如一個加密解密的類),我們都喜歡將其定義為靜態(static),而有瞭依賴註入,你就要避免使用靜態類型,應該交由服務容器幫你管理,隻要你用好瞭,你會發現依賴註入是很方便的。

依賴註入的初級玩法,也是比較標準的玩法,此種玩法有兩種模式:

  1. 十代單傳模式:一個接口對應一個類,比如先定義接口 IA、IB,隨後,類A實現 IA,類B 實現 IB。一對一。也可以是抽象類(或基類)E,然後 F 繼承 E 類。
  2. 斷子絕孫模式:直接就寫一個類,不考慮派生,直接就添加到服務容器中。

來,看個例子。

1、定義個接口

    public interface IPlayGame
    {
        void Play();
    }


然後,寫一個類來實現它。

    public class NBPlayGame : IPlayGame
    {
        public void Play()
        {
            Console.WriteLine("全民打麻藥。");
        }
    }

我們知道,所謂服務類,其實就是普通類,這些類一般用於完成某些功能,比如計算 MD5 值。接著呢,還記得 Startup 類有個 ConfigureServices 方法吧,對,就在這廝裡面把我們剛剛那個服務進行註冊(就是添加到 ServiceCollection 集合中)。

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddTransient<IPlayGame, NBPlayGame>();
        }


添加的時候很簡單,類型一對一,IPlayGame 接口與 NBPlayGame 類對應。添加時有三種方法你可以調用,實際上對應著,服務類在容器中的生命周期。

  • AddSingleton:單個實例,這是壽命最長的,與天同壽。整個應用程序中僅用一個實例。
  • AddTransient:這個是最短命的,可能是天天晚上加班熬夜,死得很快。此種情況下,服務類的實例是用的時候創建,用完後直接銷毀。
  • AddScoped:這個比較難理解。它的生命周期在單個請求內,包括客戶端與服務器之間隨後產生的子請求,反正隻要請求的會話結束瞭,就會清理。

2、註入服務

比如在中間件,在控制器,或者在其他服務類的構造函數上(中間件是在 Invoke / InvokeAsync 方法上)進行實例接收。

現在來用一下,寫一個中間件。

    public class TestMiddleware
    {
        public TestMiddleware(RequestDelegate next) { }

        public Task InvokeAsync(HttpContext context, IPlayGame game)
        {
            game.Play();
            return Task.CompletedTask;
        }
    }

已註冊的服務會註入到 InvokeAsync 方法的參數中。註意第一個參數是 HttpContext,這是必須參數,後面的是註入的參數。

最後,在 Startup 類的 Configure 方法中就可以 use 這個中間件瞭。

        public void Configure(IApplicationBuilder app)
        {
            app.UseMiddleware<TestMiddleware>();
        }
 

運行後,Play 方法調用,在控制臺中輸出以下結果

 3、功能類

 也稱“斷子絕孫”模式,不使用接口規范,直接寫功能類。

    public class DoSomething
    {
        public string GetMessage() => "你好,剛才 Boss 找你。";
    }

註冊服務時更簡單。

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddScoped<DoSomething>();
        }

在 Configure 方法中進行註入。

        public void Configure(IApplicationBuilder app, DoSomething thing)
        {
            Console.WriteLine(thing.GetMessage());
        }


運行後,輸出結果如下

 

 在容器中,使用 ServiceDescriptor 類來存儲服務類型相關的信息。其中,ServiceType 表示的是服務的類型,如果服務是有接口與實現類的,那麼這個屬性指的是接口的類型,實現類的類型信息由 ImplementationType 屬性存儲。如果沒有接口,直接隻定義類型,那麼這個類型的信息就存到 ServiceType 屬性上,ImplementationType 屬性不使用。

上面這些例子中,ServiceType 是 IPlayGame 接口相關信息,ImplementationType 是 NBPlayGame 類的信息。如果像上面 DoSomething 類的情況,則 ServiceType 為 DoSomething 相關的信息,ImplementationType 為空。

 4、高級類

接下來,咱們看高級玩法。

定義一個接口。

    public interface IDemoService
    {
        string Version { get; }
        void Run();
    }


然後,有兩個類實現這個接口。

    public class DemoService1 : IDemoService
    {
        public string Version => "v1";

        public void Run()
        {
            Console.WriteLine("第一個服務實現類。");
        }
    }

    public class DemoService2 : IDemoService
    {
        public string Version => "v2";

        public void Run()
        {
            Console.WriteLine("第二個服務實現類。");
        }
    }

然後,我們註冊服務。

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddTransient<IDemoService, DemoService1>();
            services.AddTransient<IDemoService, DemoService2>();
        }


然後我們照例,接收註入,咱們依舊使用中間件的方法參數接收。

    public class DemoMiddleware
    {
        public DemoMiddleware(RequestDelegate next)
        {
            // 由於程序約定,此構造函數必須提供。
        }

        public async Task InvokeAsync(HttpContext context, IDemoService sv)
        {
            await context.Response.WriteAsync(sv.Version);
        }
    }

然後,在 Startup.Configure 方法中使用該中間件。

        public void Configure(IApplicationBuilder app, DoSomething thing)
        {
            app.UseMiddleware<DemoMiddleware>();
        }


運行之後,你發現問題瞭,看看輸出。

 

 出事瞭,參數僅能接收到最後註冊的實現類型實例,也就是 DemoService2 類。所以就看到網上有不少朋友發貼問瞭,.NET Core 是不是不支持多個服務實現類的註入?這難倒瞭很多人。

實話告訴你,Core Core 兄是支持註入多個實現類的實例的。

下面,老周介紹兩種解決方法(其實有三種,還有一種不太好弄,尤其是你對 Core 兄不熟的時候,所以我說兩種,基本夠用)。

方法一、接收 IServiceProvider 類型的註入。

        public async Task InvokeAsync(HttpContext context, IServiceProvider provider)
        {
            StringBuilder sb = new StringBuilder();
            foreach (var sv in provider.GetServices<IDemoService>())
            {
                sb.Append($"{sv.Version}<br/>");
            }
            await context.Response.WriteAsync(sb.ToString());
        }

隻要能接收到 IServiceProvider 所引用的實例,就能通過 GetServices 方法獲取多個服務實例。

方法二,這種方法老周很推薦,更簡單,直接註入 IEnumerable<T> 類型,本例中就是 IEnumerable<IDemoService>。

        public async Task InvokeAsync(HttpContext context, IEnumerable<IDemoService> svs)
        {
            StringBuilder sb = new StringBuilder();
            foreach (var sv in svs)
            {
                sb.Append($"{sv.Version}<br/>");
            }
            await context.Response.WriteAsync(sb.ToString());
        }

IEnumerable<T> 的妙處就是可以 foreach ,這樣你也能訪問多個實例,而且必要時還可以聯合 LINQ 一起耍。

運行結果如下。

 

到此這篇關於ASP.NET Core如何註入多個服務實現類的文章就介紹到這瞭,更多相關ASP.NET Core何註多個服務實現類內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: