ASP.NET Core MVC 控制器創建與依賴註入

来源:http://www.cnblogs.com/tdfblog/archive/2017/07/10/controller-activation-and-dependency-injection-in-asp-net-core-mvc.html
-Advertisement-
Play Games

在這篇文章中,我將介紹在ASP.NET Core MVC中 IControllerActivator 是如何創建控制器的,以及通過依賴註入創建控制器存在的差異。 ...


本文翻譯自《Controller activation and dependency injection in ASP.NET Core MVC》,由於水平有限,故無法保證翻譯完全準確,歡迎指出錯誤。謝謝!

在我最後一篇關於 ASP.NET Core 釋放IDsiposable對象的文章(中文英文原文)中,Mark Rendle 指出,MVC 控制器在請求結束時也會釋放資源。乍一看,此範圍內的資源在請求結束時會釋放似乎是顯而易見的,但是 MVC 控制器的處理方式實際上與大多數服務略有不同。

在這篇文章中,我將介紹在ASP.NET Core MVC中IControllerActivator是如何創建控制器的,以及通過依賴註入創建控制器存在的差異。

預設的IControllerActivator

在 ASP.NET Core 中,當 MVC 中間件接收到請求時,通過路由選擇要執行的控制器和操作方法。為了實際的執行操作, MVC 中間件必須創建所選控制器的實例。

創建控制器的過程依賴眾多不同的提供者和工廠類,但最終是由實現IControllerActivator介面的實例來決定的。實現類只需要實現兩個方法:

public interface IControllerActivator  
{
    object Create(ControllerContext context);
    void Release(ControllerContext context, object controller);
}

如您所見,該IControllerActivator.Create方法傳遞了用於創建控制器的ControllerContext實例。控制器的創建方式取決於具體的實現。

眾所周知,ASP.NET Core 使用的是DefaultControllerActivator,它通過TypeActivatorCache來創建控制器。TypeActivatorCache通過調用類的構造函數,並試圖從 DI 容器中解析構造函數所需參數的實例。

有一點很重要,DefaultControllerActivator 不會試圖從 DI 容器中解析控制器的實例,只會解析控制器的依賴項。


DefaultControllerActivator 示例

為了演示這個行為,我創建了一個簡單的 MVC 應用程式,包括一個單一的服務和一個控制器。服務實例有一個name屬性,它通過構造函數來設置。預設情況下,它使用"default"作為預設值。

public class TestService  
{
    public TestService(string name = "default")
    {
        Name = name;
    }

    public string Name { get; }
}

在應用程式中HomeController依賴於TestService,並返回Name屬性的值:

public class HomeController : Controller  
{
    private readonly TestService _testService;
    public HomeController(TestService testService)
    {
        _testService = testService;
    }

    public string Index()
    {
        return "TestService.Name: " + _testService.Name;
    }
}

還有一塊代碼在Startup文件中。在這裡我將TestService註冊在 DI 容器中作為範圍內服務,並設置 MVC 中間件和服務:

public class Startup  
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc();

        services.AddScoped<TestService>();
        services.AddTransient(ctx =>
            new HomeController(new TestService("Non-default value")));
    }

    public void Configure(IApplicationBuilder app)
    {
        app.UseMvcWithDefaultRoute();
    }
}

您會註意到,我定義了一個工廠方法用於創建HomeController的實例。將HomeController類型註冊到 DI 容器中,並且在TestService實例中傳遞自定義Name屬性。

如果您運行應用程式,您會看到什麼結果?

您可以看到,該TestService.Name屬性使用的是預設值,表示TestService實例是直接從 DI 容器中獲取的,直接忽略了創建HomeController的工廠方法。

這很容易理解,當您通過DefaultControllerActivator創建控制器時,它不會從DI容器中創建HomeController實例,只會解析構造函數的依賴項。

大多數情況下,使用DefaultControllerActivator是一個不錯的選擇,但有時您可能希望直接通過 DI 容器來創建控制器,比如您希望使用具有攔截器或裝飾器等功能的第三方容器。

幸運的是,MVC 框架包含了一個這樣的IControllerActivator實現,並提供了一種非常方便的擴展方法來啟用它。


ServiceBasedControllerActivator

如您所見,DefaultControllerActivator使用TypeActivatorCache來創建控制器,MVC還包括另一個實現,稱為ServiceBasedControllerActivator,它是直接從 DI 容器中獲取控制器。它的實現非常簡單:

public class ServiceBasedControllerActivator : IControllerActivator  
{
    public object Create(ControllerContext actionContext)
    {
        var controllerType = actionContext.ActionDescriptor.ControllerTypeInfo.AsType();

        return actionContext.HttpContext.RequestServices.GetRequiredService(controllerType);
    }

    public virtual void Release(ControllerContext context, object controller)
    {
    }
}

當您將 MVC 服務添加到應用程式時,可以使用AddControllersAsServices()擴展方法配置基於 DI 的激活器:

public class Startup  
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc()
                .AddControllersAsServices();

        services.AddScoped<TestService>();
        services.AddTransient(ctx =>
            new HomeController(new TestService("Non-default value")));
    }

    public void Configure(IApplicationBuilder app)
    {
        app.UseMvcWithDefaultRoute();
    }
}

通過上面的代碼,點擊主頁將通過 DI 容器來創建一個控制器。由於我們已經註冊了一個創建HomeController的工廠方法,我們自定義TestService配置將被保留,使用替換後的Name屬性:

AddControllersAsServices方法實現了兩件事情 - 它將您應用程式中的所有控制器註冊到 DI 容器(如果尚未註冊),並將IControllerActivator註冊為ServiceBasedControllerActivator

public static IMvcBuilder AddControllersAsServices(this IMvcBuilder builder)  
{
    var feature = new ControllerFeature();
    builder.PartManager.PopulateFeature(feature);

    foreach (var controller in feature.Controllers.Select(c => c.AsType()))
    {
        builder.Services.TryAddTransient(controller, controller);
    }

    builder.Services.Replace(ServiceDescriptor.Transient<IControllerActivator, ServiceBasedControllerActivator>());

    return builder;
}

如果需要做一些更複雜的事情,您可以隨時實現自己IControllerActivator;不過我找不到任何理由,這兩點實現還不能滿足您的需求!


總結

  • 預設情況下,在ASP.NET Core MVC 中IControllerActivator配置為DefaultControllerActivator
  • DefaultControllerActivator使用TypeActivatorCache來創建控制器。它從 DI 容器載入構造函數所需參數來創建控制器的實例。
  • 您也可以使用ServiceBasedControllerActivator作替代方法,它直接從 DI 容器載入控制器。您可以在Startup.ConfigureServices方法中使用MvcBuilderAddControllersAsServices()擴展方法來配置此激活方式。


轉載請註明出處,原文鏈接:http://www.cnblogs.com/tdfblog/p/controller-activation-and-dependency-injection-in-asp-net-core-mvc.html


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 1. 準備工作: 準備一臺ubuntu機器,將boot.img複製到該機器上,下載必要的工具sudo apt-get install abootimggit clone https://github.com/anestisb/android-simg2img.gitcd android-simg2i ...
  • 本文所選的例子來自於《Advanced Bash-scripting Gudie》一書,譯者 楊春敏 黃毅 腳本運行結果 ...
  • Linux系統中文語言亂碼,是很多小伙伴在開始接觸Linux時經常遇到的問題,而且當我們將已在Wndows部署好的項目搬到Linux上運行時,Tomcat的輸出日誌中文全為亂碼(在Windows上正常),看著非常心塞,那麼我們應該怎麼解決呢? 系統中文亂碼 Tomcat輸出日誌中文亂碼 系統環境 C ...
  • 進程的啟動和終止 內核執行c程式時,利用exec函數調用一個特殊的啟動常式,該啟動常式叢內核中獲取命令行參數和環境變數值。 進程終止的情況 5種正常終止的情況: 3種異常終止情況 進程啟動和終止圖 atexit函數 一個進程最多可以登記32和函數(例如:signal函數),這些函數由exit函數自動 ...
  • 1.win+R,然後輸入gpedit.msc打開本地組策略編輯器。 2.打開window設置--安全設置--本地策略--安全選項--找到 用戶帳戶控制: 以管理員批准模式運行所有管理員 和 用戶帳戶控制: 用內置管理員帳戶的管理員批准模式 選擇禁用。 3.然後重啟。 註:本人從網路上http://j ...
  • 把編譯安裝的httpd 實現服務腳本,通過service和chkconfig 進行管理 1 編譯安裝httpd 把httpd編譯安裝在/app/httpd/目錄下。 2 在/etc/rc.d/init.d/目錄下新建一個文件httpd 這個文件的目的在於讓service 命令可以管理編譯安裝的htt ...
  • 概述Docker已經熱了有一兩年了,而且我相信這不是一個曇花一現的技術,而是一個將深遠影響我們日後開發和部署、運營應用系統的一種創新(很多人將其作為devops的一種非常重要的基石)。學習docker的最好方式,莫過於它的官方文檔 ,有興趣 的同學請參考 https://www.docker.com... ...
  • 上一篇博客我講解了TagHelper的基本用法和自定義標簽的生成,那麼我就趁熱打鐵,和大家分享一下TagHelper的高級用法~~,大家也可以在我的博客下隨意留言。 對於初步接觸asp.net core的騷年可以看看我對TagHelper的瞭解和看法: 《asp.net core新特性(1):Tag ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...