ASP.NET Core 中文文檔 第四章 MVC(4.4)依賴註入和控制器

来源:http://www.cnblogs.com/dotNETCoreSG/archive/2016/10/08/aspnetcore-4_4_4-dependency-injection.html
-Advertisement-
Play Games

ASP.NET Core MVC 控制器應通過它們的構造器明確的請求它們的依賴關係。在某些情況下,單個控制器的操作可能需要一個服務,在控制器級別上的請求可能沒有意義。在這種情況下,你也可以選擇將服務作為 action 方法的參數。 ...


原文: Dependency Injection and Controllers
作者: Steve Smith
翻譯: 劉浩楊
校對: 孟帥洋(書緣)

ASP.NET Core MVC 控制器應通過它們的構造器明確的請求它們的依賴關係。在某些情況下,單個控制器的操作可能需要一個服務,在控制器級別上的請求可能沒有意義。在這種情況下,你也可以選擇將服務作為 action 方法的參數。

章節:

查看或下載示例代碼

依賴註入

依賴註入(Dependency injection,DI)是一種如 Dependency Inversion Principle 所示的技術,允許應用程式由鬆散耦合的模塊組成。ASP.NET Core 內置了 dependency injection,這使得應用程式更容易測試和維護。

構造器註入

ASP.NET Core 內置的基於構造器的依賴註入支持擴展到 MVC 控制器。通過只添加一個服務類型作為構造器參數到你的控制器中,ASP.NET Core 將會嘗試使用內置的服務容器解析這個類型。服務通常是,但不總是使用介面來定義。例如,如果你的應用程式存在取決於當前時間的業務邏輯,你可以註入一個檢索時間的服務(而不是對它硬編碼),這將允許你的測試通過一個使用設置時間的實現。

using System;

namespace ControllerDI.Interfaces
{
    public interface IDateTime
    {
        DateTime Now { get; }
    }
}

實現這樣一個介面,它在運行時使用的系統時鐘是微不足道的:

using System;
using ControllerDI.Interfaces;

namespace ControllerDI.Services
{
    public class SystemDateTime : IDateTime
    {
        public DateTime Now
        {
            get { return DateTime.Now; }
        }
    }
}

有了這些代碼,我們可以在我們的控制器中使用這個服務。在這個例子中,我們在 HomeControllerIndex 方法中加入一些根據一天中的時間向用戶顯示問候的邏輯。

using ControllerDI.Interfaces;
using Microsoft.AspNetCore.Mvc;

namespace ControllerDI.Controllers
{
    public class HomeController : Controller
    {
        private readonly IDateTime _dateTime;   //手動高亮

        public HomeController(IDateTime dateTime)   //手動高亮
        {
            _dateTime = dateTime;   //手動高亮
        }

        public IActionResult Index()
        {
            var serverTime = _dateTime.Now; //手動高亮
            if (serverTime.Hour < 12)       //手動高亮
            {
                ViewData["Message"] = "It's morning here - Good Morning!";  //手動高亮
            }
            else if (serverTime.Hour < 17)  //手動高亮
            {
                ViewData["Message"] = "It's afternoon here - Good Afternoon!";  //手動高亮
            }
            else    //手動高亮
            {
                ViewData["Message"] = "It's evening here - Good Evening!";  //手動高亮
            }
            return View();  //手動高亮
        }
    }
}

如果我們現在運行應用程式,我們將可能遇到一個異常:

An unhandled exception occurred while processing the request.

InvalidOperationException: Unable to resolve service for type 'ControllerDI.Interfaces.IDateTime' while attempting to activate 'ControllerDI.Controllers.HomeController'.
Microsoft.Extensions.DependencyInjection.ActivatorUtilities.GetService(IServiceProvider sp, Type type, Type requiredBy, Boolean isDefaultParameterRequired)

這個錯誤發生時,我們沒有在我們的 Startup 類的 ConfigureServices 方法中配置服務。要指定請求 IDateTime 時使用 SystemDateTime 的實例來解析,添加下麵的清單中高亮的行到你的 ConfigureServices 方法中:

public void ConfigureServices(IServiceCollection services)
{
    // Add application services.
    services.AddTransient<IDateTime, SystemDateTime>();     //手動高亮
}

註意
這個特殊的服務可以使用任何不同的生命周期選項來實現(TransientScopedSingleton)。參考 dependency injection 來瞭解每一個作用域選項將如何影響你的服務的行為。

一旦服務被配置,運行應用程式並且導航到首頁應該顯示預期的基於時間的消息:

提示
參考 Testing Controller Logic 學習如何在控制器中顯示請求依賴關係 http://deviq.com/explicit-dependencies-principle 讓代碼更容易測試。

ASP.NET Core 內置的依賴註入支持用於請求服務的類型只有一個構造器。如果你有多於一個構造器,你可能會得到一個異常描述:

An unhandled exception occurred while processing the request.

InvalidOperationException: Multiple constructors accepting all given argument types have been found in type 'ControllerDI.Controllers.HomeController'. There should only be one applicable constructor.
Microsoft.Extensions.DependencyInjection.ActivatorUtilities.FindApplicableConstructor(Type instanceType, Type[] argumentTypes, ConstructorInfo& matchingConstructor, Nullable`1[]& parameterMap)

作為錯誤消息狀態,你可以糾正只有一個構造器的問題。你也可以參考 replace the default dependency injection support with a third party implementation 支持多個構造器。

Action 註入和 FromServices

有時候在你的控制器中你不需要為超過一個 Action 使用的服務。在這種情況下,將服務作為 Action 方法的一個參數是有意義的。這是通過使用特性 [FromServices] 標記參數實現,如下所示:

public IActionResult About([FromServices] IDateTime dateTime)   //手動高亮
{
    ViewData["Message"] = "Currently on the server the time is " + dateTime.Now;

    return View();
}

從控制器訪問設置

在控制器中訪問應用程式設置或配置設置是一個常見的模式。此訪問應當使用在 configuration 所描述的訪問模式。你通常不應該從你的控制器中使用依賴註入直接請求設置。更好的方式是請求 IOptions<T> 實例, T 是你需要的配置類型。

要使用選項模式,你需要創建一個表示選項的類型,如:

namespace ControllerDI.Model
{
    public class SampleWebSettings
    {
        public string Title { get; set; }
        public int Updates { get; set; }
    }
}

然後你需要配置應用程式使用選項模型,在 ConfigureServices 中添加你的配置類到服務集合中:

public Startup(IHostingEnvironment env)
{
    var builder = new ConfigurationBuilder()    //手動高亮
        .SetBasePath(env.ContentRootPath)       //手動高亮
        .AddJsonFile("samplewebsettings.json"); //手動高亮
    Configuration = builder.Build();            //手動高亮
}

public IConfigurationRoot Configuration { get; set; }   //手動高亮

// This method gets called by the runtime. Use this method to add services to the container.
// For more information on how to configure your application, visit http://go.microsoft.com/fwlink/?LinkID=398940
public void ConfigureServices(IServiceCollection services)
{
    // Required to use the Options<T> pattern
    services.AddOptions();      //手動高亮

    // Add settings from configuration
    services.Configure<SampleWebSettings>(Configuration);   //手動高亮

    // Uncomment to add settings from code
    //services.Configure<SampleWebSettings>(settings =>
    //{
    //    settings.Updates = 17;
    //});

    services.AddMvc();

    // Add application services.
    services.AddTransient<IDateTime, SystemDateTime>();
}

註意
在上面的清單中,我們配置應用程式程式從一個 JSON 格式的文件中讀取設置。你也可以完全在代碼中配置設置,像上面的代碼中所顯示的。參考 configuration 更多的配置選項。

一旦你指定了一個強類型的配置對象(在這個例子中,SampleWebSettings),並且添加到服務集合中,你可以從任何控制器或 Action 方法中請求 IOptions<T> 的實例(在這個例子中, IOptions<SampleWebSettings>)。下麵的代碼演示瞭如何從控制器中請求設置。

    public class SettingsController : Controller
    {
        private readonly SampleWebSettings _settings;   //手動高亮

        public SettingsController(IOptions<SampleWebSettings> settingsOptions)  //手動高亮
        {
            _settings = settingsOptions.Value;  //手動高亮
        }

        public IActionResult Index()
        {
            ViewData["Title"] = _settings.Title;
            ViewData["Updates"] = _settings.Updates;
            return View();
        }
    }

遵循選項模式允許設置和配置互相分離,確保控制器遵循 separation of concerns ,因為它不需要知道如何或者在哪裡找到設置信息。由於沒有 static cling 或在控制器中直接實例化設置類,這也使得控制器更容易單元測試

返回目錄


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

-Advertisement-
Play Games
更多相關文章
  • 一直想弄清楚onTouchEvent,onInterceptTouchEvent,dispatchTouchEvent的執行順序,以及內部使用switch (event.getAction())中的執行順序。趁這次機會趕緊弄清楚。 重寫上面幾個方法後。我們在LogCat中看看列印的結果。 一.isO ...
  • 說明 JSBridge實現原理 目錄 前言 參考來源 前置技術要求 楔子 原理概述 簡介 url scheme介紹 實現流程 實現思路 第一步:設計出一個Native與JS交互的全局橋對象 第二步:JS如何調用Native 第三步:Native如何得知api被調用 第四步:分析url-參數和回調的格 ...
  • 基於OpenSLL的RSA加密應用(非演算法) === iOS開發中的小伙伴應該是經常用der和p12進行加密解密,而且在通常加密不止一種加密演算法,還可以加點兒鹽吧~本文章主要闡述的是在iOS中基於openSLL的RSA加密。一共有兩種方式,一種是基於p12加密解密的,還有一種是博客園官方提供的公鑰字 ...
  • 說明 Hybrid模式原生和H5交互原理 目錄 前言 參考來源 前置技術要求 楔子 Android、iOS原生和H5的基本通信機制 Android端 iOS端 原生和H5的另一種通訊方式:JSBridge 什麼是JSBridge 為什麼要用JSBridge JSBridge原理以及實現 前言 參考來 ...
  • 大家或許有遇到這個神坑,在Fragment中使用startActivityForResult能夠成功,可是在Fragment中的onActivityResult卻無法被調用。一不註意就讓人一夜愁白了頭。苦經探索(當然包括親愛的百度和谷歌),終於總結出了一些規律。 在Fragment中使用startA ...
  • 此文,將嘗試動態從某個不確定的文件夾中載入資源文件.文章,會繼續完善自定義的 imageNamed 函數,併為下一篇文章鋪墊. ...
  • Android的UI訪問是沒有加鎖的,這樣在多個線程訪問UI是不安全的。所以Android中規定只能在UI線程中訪問UI。 但是有沒有極端的情況?使得我們在子線程中訪問UI也可以使程式跑起來呢?接下來我們用一個例子去證實一下。 新建一個工程,activity_main.xml佈局如下所示: 很簡單, ...
  • 最前面的話:Smobiler是一個在VS環境中使用.Net語言來開發APP的開發平臺,也許比Xamarin更方便 一、目標樣式 我們要實現上圖中的效果,需要如下的操作: 1.從工具欄上的“Smobiler Components”拖動一個GaugeView控制項到窗體界面上 2.修改GaugeView控 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...