ASP.NET Core 中介軟體的使用（二）：依賴注入的使用

學習中的苦與樂發表於2020-12-19
ASP.NET依賴注入

寫在前面

上一篇大家已經粗略接觸瞭解到.NET Core中介軟體的使用：ASP .Net Core 中介軟體的使用（一）：搭建靜態檔案伺服器/訪問指定檔案，

.NET Core框架中很多核心物件都是通過依賴注入的方式提供的，那什麼是依賴注入？

這也是個老生常談的問題，到底依賴注入是什麼？ 為什麼要用它？ 初學者特別容易對控制反轉IOC(Iversion of Control)，DI等概念搞暈。

 

 什麼是依賴注入？

提到依賴注入，大家一定會想到控制反轉，怎麼了解，控制反轉是一種設計原則（Inversion of Control，縮寫為IoC），而依賴注入(（Dependency Injection，簡稱DI）)是它的一種實現方式。

當一個類需要另一個類協作來完成工作的時候就產生了依賴。比如我們在AccountController這個控制器需要完成和使用者相關的註冊、登入 等事情。

這裡有一個設計原則：依賴於抽象，而不是具體的實現，當一個類依賴於具體依賴時，它被認為與該類緊密耦合。

 

依賴注入的目的是為了什麼？

控制反轉用於解耦，將介面和實現的耦合降低，有一個好處就是，一個介面，可以進行不同的實現，這樣提高擴充套件性，確保程式碼的可維護性和擴充套件性。

通俗的講，就是物件在被使用前，我們需要New一下物件，建立一個例項物件，然後在進行其他操作。

 

怎麼使用依賴注入？

.NET Core 自帶了依賴注入的框架，我們可以歸納為這幾個使用方式，當然還有很多使用方法（常規，泛型，工廠），就不一一舉例了：

  • 建構函式注入；

  • 方法注入；

  • 屬性注入；

這麼歸納是不是感覺不太好理解？沒關係，我們進一步細化為如下使用方式：

  1. 在Startup型別的建構函式中注入；

  2. 在Startup型別的Configure方法中注入；

  3. 在中介軟體型別建構函式中注入；

  4. 在中介軟體型別的Invoke/InvokeAsync方法中注入；

  5. 在Controller型別的建構函式中注入；

  6. 在Controller的Action方法中注入；

 

 

一、在Startup型別的建構函式中注入

配置的IConfiguration物件和表示承載環境的IHostEnvironment物件可以直接注入Startup建構函式中。

當然也可以通過注入IWebHostEnvironment物件的方式得到當前承載環境相關的資訊，

這是因為ASP.NET Core應用中的承載環境通過IWebHostEnvironment介面表示，IWebHostEnvironment介面派生於IHostEnvironment介面）。

 

我們可以通過一個簡單的例項來驗證針對Startup的建構函式注入。

如下面的程式碼片段所示，我們在呼叫IWebHostBuilder介面的Startup<TStartup>方法時註冊了自定義的Startup型別。

在定義Startup型別時，我們在其建構函式中注入上述3個物件，提供的除錯斷言不僅證明了3個物件不為Null，還表明採用IHostEnvironment介面和IWebHostEnvironment介面得到的其實是同一個例項。

 

class Program
{
    static void Main()
    {
        Host.CreateDefaultBuilder().ConfigureWebHostDefaults(builder => builder.UseStartup<Startup>())
        .Build()
        .Run();
    }
}

public class Startup
{
    public Startup(IConfiguration configuration, IHostEnvironment hostingEnvironment,IWebHostEnvironment webHostEnvironment)
    {
        Debug.Assert(configuration != null);
        Debug.Assert(hostingEnvironment != null);
        Debug.Assert(webHostEnvironment != null);
        Debug.Assert(ReferenceEquals(hostingEnvironment, webHostEnvironment));
    }
    public void Configure(IApplicationBuilder app) { }
}

 

 

二、在Startup型別的Configure方法中注入

 

這種注入方式也叫管道注入，這種是使用比較多的一種注入方式，因為.NET Core建立專案的時候已經在Startup.cs類裡面生成框架了（管道注入）,

如果建構函式注入還可以對注入的服務有所選擇，那麼對於Configure方法來說，通過任意方式註冊的服務都可以注入其中，包括通過呼叫

IHostBuilder、IWebHostBuilder和Startup自身的ConfigureServices方法註冊的服務，還包括框架自行註冊的所有服務。

如下面的程式碼程式碼片段所示，我們分別呼叫IWebHostBuilder和Startup的ConfigureServices方法註冊了針對IStudent介面和ISchool介面的服務，這兩個服務直接注入Startup的Configure方法中。另外，Configure方法要求提供一個用來註冊中介軟體的IApplicationBuilder物件作為引數，但是對該引數出現的位置並未做任何限制。

class Program
{
    static void Main()
    {
        Host.CreateDefaultBuilder().ConfigureWebHostDefaults(builder => builder
            .UseStartup<Startup>()
            .ConfigureServices(svcs => svcs.AddSingleton<IStudent, Student>()))
        .Build()
        .Run();
    }
}

public class Startup
{
    public void ConfigureServices(IServiceCollection services) => services.AddSingleton<ISchool, School>();
    public void Configure(IApplicationBuilder app, IStudent student, ISchool school)
    {
        Debug.Assert(student != null);
        Debug.Assert(school!= null);
    }
}

 

 

三、在中介軟體型別建構函式中注入

 

ASP.NET Core請求處理管道最重要的物件是用來真正處理請求的中介軟體。

由於ASP.NET Core在建立中介軟體物件並利用它們構建整個請求處理管道時，所有的服務都已經註冊完畢，所以任何一個註冊的服務都可以注入中介軟體型別的建構函式中。

如下所示的程式碼片段體現了針對中介軟體型別的建構函式注入。

class Program
{
    static void Main()
    {
        Host.CreateDefaultBuilder().ConfigureWebHostDefaults(builder => builder
            .ConfigureServices(svcs => svcs
                .AddSingleton<studentschoolMiddleware>()
                .AddSingleton<IStudent, student>()
                .AddSingleton<ISchool, school>())
            .Configure(app => app.UseMiddleware<studentschoolMiddleware>()))
        .Build()
        .Run();
    }
}

public class studentschoolMiddleware : IMiddleware
{
    public studentschoolMiddleware(IStudent student, ISchool school)
    {
        Debug.Assert(student != null);
        Debug.Assert(school != null);
    }

    public Task InvokeAsync(HttpContext context, RequestDelegate next)
    {
        Debug.Assert(next != null);
        return Task.CompletedTask;
    }
}

 

四、在中介軟體型別的Invoke/InvokeAsync方法中注入

如果採用基於約定的中介軟體型別定義方式，註冊的服務還可以直接注入真正用於處理請求的InvokeAsync方法或者Invoke方法中。

另外，將方法命名為InvokeAsync更符合TAP（Task-based Asynchronous Pattern）程式設計模式，之所以保留Invoke方法命名，主要是出於版本相容的目的。

如下所示的程式碼片段展示了針對InvokeAsync方法的服務注入。

class Program
{
    static void Main()
    {
        Host.CreateDefaultBuilder().ConfigureWebHostDefaults(builder => builder
            .ConfigureServices(svcs => svcs
                .AddSingleton<IStudent, student>()
                .AddSingleton<ISchool, school>())
            .Configure(app => app.UseMiddleware<studentschoolMiddleware>()))
        .Build()
        .Run();
    }
}

public class studentschoolMiddleware
{
    private readonly RequestDelegate _next;

    public studentschoolMiddleware(RequestDelegate next) => _next = next;
    public Task InvokeAsync(HttpContext context, IStudent student, ISchool school)
    {
        Debug.Assert(context != null);
        Debug.Assert(student != null);
        Debug.Assert(school != null);
        return _next(context);
    }
}

對於基於約定的中介軟體，建構函式注入與方法注入存在一個本質區別。

由於中介軟體被註冊為一個Singleton物件，所以我們不應該在它的建構函式中注入Scoped服務。

Scoped服務只能注入中介軟體型別的InvokeAsync方法中，因為依賴服務是在針對當前請求的服務範圍中提供的，所以能夠確保Scoped服務在當前請求處理結束之後被釋放。

五、在Controller型別的建構函式中注入

在一個ASP.NET Core MVC應用中，我們可以在定義的Controller中以建構函式注入的方式注入所需的服務。

在如下所示的程式碼片段中，我們將IStudentschool服務注入到HomeController的建構函式中。

class Program
{
    static void Main()
    {
        Host.CreateDefaultBuilder().ConfigureWebHostDefaults(builder => builder
            .ConfigureServices(svcs => svcs
                .AddSingleton<IStudentschool, studentschool>()
                .AddSingleton<ISchool, school>()
                .AddControllersWithViews())
            .Configure(app => app
                .UseRouting()
                .UseEndpoints(endpoints => endpoints.MapControllers())))
        .Build()
        .Run();
    }
}

public class HomeController : Controller
{
    public HomeController(IStudentschool studentschool) => Debug.Assert(studentschool!= null);

}

 

六、在Controller的Action方法中注入

藉助於ASP.NET Core MVC基於模型繫結的引數繫結機制，我們可以將註冊的服務繫結到目標Action方法的引數上，進而實現針對Action方法的依賴注入。

在採用這種型別的注入方式時，我們需要在注入引數上按照如下的方式標註FromServicesAttribute特性，用以確定引數繫結的來源是註冊的服務。

在如下所示的程式碼片段

class Program
{
    static void Main()
    {
        Host.CreateDefaultBuilder().ConfigureWebHostDefaults(builder => builder
            .ConfigureServices(svcs => svcs
                .AddSingleton<IStudentschool, Studentschool>()
                .AddControllersWithViews())
            .Configure(app => app
                .UseRouting()
                .UseEndpoints(endpoints => endpoints.MapControllers())))
        .Build()
        .Run();
    }
}

public class HomeController: Controller
{
    [HttpGet("/")]
    public void Index([FromServices]IStudentschool studentschool)
    {
        Debug.Assert(Studentschool!= null);
    }
}

 

七、在檢視中注入

在ASP.NET Core MVC應用中，我們還可以將服務註冊到現的View中。

假設我們定義瞭如下這個簡單的MVC程式，並定義了一個簡單的HomeController。

如下程式碼片段

class Program
{
    static void Main()
    {
        Host.CreateDefaultBuilder().ConfigureWebHostDefaults(builder => builder
            .ConfigureServices(svcs => svcs
                .AddSingleton<IStudentschool, Studentschool>()
                .AddControllersWithViews())
            .Configure(app => app
                .UseRouting()
                .UseEndpoints(endpoints => endpoints.MapControllers())))
        .Build()
        .Run();
    }
}

public class HomeController: Controller
{
        [HttpGet("/")]
        public IActionResult Index() => View();
}

我們為HomeController定義了一個路由指向根路徑（“/”）的Action方法Index，該方法在呼叫View方法呈現預設的View之前，

將注入的IStudentschool服務以ViewBag的形式傳遞到View中。

如下所示的程式碼片段是這個Action方法對應View（/Views/Home/Index.cshtml）的定義，我們通過@inject指令注入了IStudentschool服務，並

將屬性名設定為Studentschool，這意味著當前View物件將新增一個Studentschool屬性來引用注入的服務。

@inject IStudentschool Studentschool
@
{
    Debug.Assert(Studentschool!= null);
}

 

 寫在後面

到這裡就簡單介紹了.NET Core依賴注入的使用方式，更多的使用方式還有待探索，一些使用過程當中的注意事項也需要探索，如：

  • 有效地設計服務及其依賴關係；
  • 防止多執行緒問題；
  • 防止記憶體洩漏；
  • 防止潛在的錯誤；
  • 如果使用了服務注入，還要考慮服務生命週期（服務不能依賴於生命週期小於其自身的服務。）；

 

參考： https://www.cnblogs.com/artech/p/di-in-asp-net-core-3.html

 

歡迎關注訂閱我的微信公眾平臺【熊澤有話說】，更多好玩易學知識等你來取
作者：熊澤-學習中的苦與樂
公眾號：熊澤有話說
出處： https://www.cnblogs.com/xiongze520/p/14155858.html
創作不易，版權歸作者和部落格園共有，轉載或者部分轉載、摘錄，請在文章明顯位置註明作者和原文連結。  

 

相關文章