[譯]ASP.NET Core 2.0 依賴注入

三生石上(FineUI控制元件)發表於2017-10-24

問題

如何使用 ASP.NET Core 服務容器進行依賴注入？

答案

建立一個服務

public interface IGreetingService
{
    string Greet(string to);
}

public class GreetingService : IGreetingService
{
    public string Greet(string to)
    {
        return $"Hello {to}";
    }
}

然後可以在需要的時候注入，下面將此服務注入一箇中介軟體（Middleware）：

public class HelloWorldMiddleware
{
    private readonly RequestDelegate _next;

    public HelloWorldMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext context, IGreetingService greetingService)
    {
        var message = greetingService.Greet("World (via DI)");
        await context.Response.WriteAsync(message);
    }
}

使用此中介軟體的擴充套件方法（IApplicationBuilder）：

public static class UseMiddlewareExtensions
{
    public static IApplicationBuilder UseHelloWorld(this IApplicationBuilder app)
    {
        return app.UseMiddleware<HelloWorldMiddleware>();
    }
}

下面需要將此服務新增到ASP.NET Core的服務容器中，位於Startup.cs檔案的ConfigureServices()方法：

public void ConfigureServices(IServiceCollection services)
{
    services.AddScoped<IGreetingService, GreetingService>();
}

然後在請求管道中（request pipeline）使用此中介軟體，位於Startup.cs檔案的Configure()方法：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseHelloWorld();
}

執行，此時頁面輸出：

建立一個帶輸入引數的服務

如果你的服務需要更復雜的初始化引數，下面我們建立一個FlexibleGreetingService：

public class FlexibleGreetingService : IGreetingService
{
    private readonly string _sayWhat;

    public FlexibleGreetingService(string sayWhat)
    {
        _sayWhat = sayWhat;
    }

    public string Greet(string to)
    {
        return $"{_sayWhat} {to}";
    }
}

我們可以使用AddScoped的一個過載工廠方法來新增此服務到容器中：

public void ConfigureServices(IServiceCollection services)
{
    services.AddScoped<IGreetingService, FlexibleGreetingService>(factory =>
    {
        return new FlexibleGreetingService("Hi");
    });
}

執行，此時頁面輸出：

如果是單件生命週期，還有一個接受服務例項的過載方法：

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<IGreetingService>(new FlexibleGreetingService("Hi "));
}

討論

ASP.NET Core內建了一個輕量級的服務容器。我們可以在Startup.cs類的ConfigureServices()方法中配置需要的服務。這個方法在Configure()方法之前執行，所以我們可以在任意中介軟體使用之前配置的服務（包含MVC服務）。

依賴注入預設是透過公開建構函式來完成的，大多數情況下這是最佳實踐。

服務的生命週期

服務容器管理著新增到伺服器列表的生命週期。下面列出了新增服務的三種方法：

AddScoped()：服務會在一個請求內部只建立一次。
AddTransient()：服務會在每次需要時建立一次。
AddSingleton()：服務會在第一次需要時建立一次，並在隨後保持不變。

注：EF的生命週期應該是Scoped，我們可以透過IServiceCollection.AddDbContext來建立EF服務（內部也是作為Scoped實現）。

工廠方法

上面的方法都有一個過載方法來使用工廠方法來新增服務。對於需要複雜配置的服務這是很有用的。

這些方法的簽名看起來如下所示：

AddScoped(Func<IServiceProvider, TService>)

框架提供的服務

ConfigureServices()接受的IServiceCollection引數擁有很多內建的服務（由框架提供），可以參考ASP.NET Core文件。

IServiceCollection有很多有用的擴充套件方法來新增常用服務，比如AddDbContext，AddIdentity，AddOptions和AddMvc。

銷燬服務

服務容器會自動呼叫所有實現了IDisposable介面的服務型別，除了那些作為例項（而不是型別）新增的服務。

獲取服務（Request Services）

儘管透過建構函式來注入服務被認為是最佳實踐，我們依然可以透過IServiceProvider的GetService方法來獲取服務。在中介軟體中IServiceProvider物件可以透過HttpContext來獲取：

public async Task Invoke(HttpContext context)
{
    var greetingService = context.RequestServices.GetService<IGreetingService>();

    var message = greetingService.Greet("World (via GetService)");
    await context.Response.WriteAsync(message);
}

注：需要新增Microsoft.Extensions.DependencyInjection引用才能上述使用GetService的泛型過載方法。