ASP.NET Core 中文文件第四章 MVC（3.8）檢視中的依賴注入

阿新 • • 發佈：2019-01-18

ASP.NET Core 支援在檢視中使用依賴注入。這將有助於提供檢視專用的服務，比如本地化或者僅用於填充檢視元素的資料。你應該儘量保持控制器和檢視間的關注點分離（separation of concerns）。你的檢視所顯示的大部分資料應該從控制器傳入。

章節：

一個簡單的示例

你可以使用 @inject 指令將服務注入到檢視中。可以把 @inject 看作是給你的檢視增加一個屬性，然後利用依賴注入給這個屬性賦值。

@inject 的語法：
@inject <type> <name>

一個使用 @inject 的例子：

@using System.Threading.Tasks
@using ViewInjectSample.Model
@using ViewInjectSample.Model.Services
@model IEnumerable<ToDoItem>
@inject StatisticsService StatsService
<!DOCTYPE html>
<html>
<head>
    <title>To Do Items</title>
</head>
<body>
    <div>
        <h1>To Do Items</h1>
        <ul>
            <li>Total Items: @StatsService.GetCount()</li>
            <li>Completed: @StatsService.GetCompletedCount()</li>
            <li>Avg. Priority: @StatsService.GetAveragePriority()</li>
        </ul>
        <table>
            <tr>
                <th>Name</th>
                <th>Priority</th>
                <th>Is Done?</th>
            </tr>
            @foreach (var item in Model)
            {
                <tr>
                    <td>@item.Name</td>
                    <td>@item.Priority</td>
                    <td>@item.IsDone</td>
                </tr>
            }
        </table>
    </div>
</body>
</html>

這個檢視顯示了一個 ToDoItem 例項的列表和統計概覽。概覽資訊是由注入的服務 StatisticsService 填入的。這個服務是在 Startup.cs 裡的 ConfigureServices 方法中被註冊到依賴注入項的。

// For more information on how to configure your application, visit http://go.microsoft.com/fwlink/?LinkID=398940
public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();

    services.AddTransient<IToDoItemRepository, ToDoItemRepository>();
    services.AddTransient<StatisticsService>();
    services.AddTransient<ProfileOptionsService>();

StatisticsService 對通過倉儲讀取到的 ToDoItem 資料集執行一些計算。

using System.Linq;
using ViewInjectSample.Interfaces;

namespace ViewInjectSample.Model.Services
{
    public class StatisticsService
    {
        private readonly IToDoItemRepository _toDoItemRepository;

        public StatisticsService(IToDoItemRepository toDoItemRepository)
        {
            _toDoItemRepository = toDoItemRepository;
        }

        public int GetCount()
        {
            return _toDoItemRepository.List().Count();
        }

        public int GetCompletedCount()
        {
            return _toDoItemRepository.List().Count(x => x.IsDone);
        }

        public double GetAveragePriority()
        {
            if (_toDoItemRepository.List().Count() == 0)
            {
                return 0.0;
            }

            return _toDoItemRepository.List().Average(x => x.Priority);
        }
    }
}

示例中的倉儲使用的是 in-memory 集合。上面的實現方法（所有對記憶體資料的操作）不推薦用於大型、遠端儲存的資料集。

這個示例通過繫結到檢視的模型以及注入到檢視的服務來顯示資料：

填充查詢資料

檢視注入有助於填充 UI 元素中的選項資料，例如下拉列表。設想一個包括性別、州以及其他選項的使用者資料表單。如果通過標準的 MVC 方式渲染這樣一個表單，需要控制器為每一組選項都請求資料訪問服務，然後將每一組待繫結的選項填充到模型或 ViewBag 中。

另一種方法則直接將服務注入到檢視中以獲取這些選項資料。這種方法將控制器需要的程式碼量減到了最少，把構造檢視元素的邏輯移到檢視本身中去。用來顯示資料編輯表單的控制器 Action 只需要把使用者資料例項傳給表格就可以了（而不需要傳各種選項資料，譯註）：

using Microsoft.AspNetCore.Mvc;
using ViewInjectSample.Model;

namespace ViewInjectSample.Controllers
{
    public class ProfileController : Controller
    {
        [Route("Profile")]
        public IActionResult Index()
        {
            // TODO: look up profile based on logged-in user
            var profile = new Profile()
            {
                Name = "Steve",
                FavColor = "Blue",
                Gender = "Male",
                State = new State("Ohio","OH")
            };
            return View(profile);
        }
    }
}

用來編輯這些選項的 HTML 表單包含選項中的三個下拉列表：

這些列表是由注入到檢視的一個服務填充的：

@using System.Threading.Tasks
@using ViewInjectSample.Model.Services
@model ViewInjectSample.Model.Profile
@inject ProfileOptionsService Options
<!DOCTYPE html>
<html>
<head>
    <title>Update Profile</title>
</head>
<body>
<div>
    <h1>Update Profile</h1>
    Name: @Html.TextBoxFor(m => m.Name)
    <br/>
    Gender: @Html.DropDownList("Gender",
           Options.ListGenders().Select(g => 
                new SelectListItem() { Text = g, Value = g }))
    <br/>

    State: @Html.DropDownListFor(m => m.State.Code,
           Options.ListStates().Select(s => 
                new SelectListItem() { Text = s.Name, Value = s.Code}))
    <br />

    Fav. Color: @Html.DropDownList("FavColor",
           Options.ListColors().Select(c => 
                new SelectListItem() { Text = c, Value = c }))
    </div>
</body>
</html>

ProfileOptionsService 是一個 UI 層的服務,旨在為這個表單提供所需資料：

using System.Collections.Generic;

namespace ViewInjectSample.Model.Services
{
    public class ProfileOptionsService
    {
        public List<string> ListGenders()
        {
            // keeping this simple
            return new List<string>() {"Female", "Male"};
        }

        public List<State> ListStates()
        {
            // a few states from USA
            return new List<State>()
            {
                new State("Alabama", "AL"),
                new State("Alaska", "AK"),
                new State("Ohio", "OH")
            };
        }

        public List<string> ListColors()
        {
            return new List<string>() { "Blue","Green","Red","Yellow" };
        }
    }
}

提示
不要忘記在 Startup.cs 的 ConfigureServices 方法中把你想要通過依賴注入請求的型別註冊一下。

重寫服務

除了注入新服務之外，這種技術也可以用來重寫之前已經在頁面上注入的服務。下圖顯示了在第一個例子的頁面上可用的所有欄位：

如你所見，預設的欄位有 Html ， Component 和 Url （同樣還有我們注入的 StatsService）。假如你想要把預設的 HTML Helpers 替換成你自己的，你可以利用 @inject 輕鬆實現：

@using System.Threading.Tasks
@using ViewInjectSample.Helpers
@inject MyHtmlHelper Html
<!DOCTYPE html>
<html>
<head>
    <title>My Helper</title>
</head>
<body>
    <div>
        Test: @Html.Value
    </div>
</body>
</html>

如果你想要擴充套件已有服務，你只需要在使用這種替換技術的同時，讓你自己的服務繼承或封裝已有實現。

參考

返回目錄

ASP.NET Core 中文文件第四章 MVC（3.8）檢視中的依賴注入

一個簡單的示例

填充查詢資料

重寫服務

參考

ASP.NET Core 中文文件第四章 MVC（3.8）檢視中的依賴注入

ASP.NET Core 中文文件第四章 MVC（3.9）檢視元件

ASP.NET Core 中文文件第四章 MVC（3.7 ）區域性檢視（partial）

ASP.NET Core 中文文件第四章 MVC（4.6）Areas（區域）

ASP.NET Core 中文文件第四章 MVC（4.2）控制器操作的路由

ASP.NET Core 中文文件第四章 MVC（4.1）Controllers, Actions 和 Action Results

ASP.NET Core 中文文件第四章 MVC（4.4）依賴注入和控制器

ASP.NET Core 中文文件第四章 MVC（4.5）測試控制器邏輯

ASP.NET Core 中文文件第四章 MVC（2.3）格式化響應資料

ASP.NET Core 中文文件第四章 MVC（01）ASP.NET Core MVC 概覽

ASP.NET Core 中文文件第四章 MVC（4.3）過濾器

ASP.NET Core 中文文件第五章測試（5.2）整合測試

ASP.NET Core 中文文件第三章原理（2）中介軟體

ASP.NET Core 中文文件第三章原理（6）全球化與本地化

ASP.NET Core 中文文件第三章原理（11）在多個環境中工作

ASP.NET Core 中文文件第三章原理（4）路由

ASP.NET Core 中文文件第三章原理（13）管理應用程式狀態

ASP.NET Core 中文文件第三章原理（1）應用程式啟動

ASP.NET Core 中文文件第三章原理（16）.NET開放Web介面（OWIN）

ASP.NET Core 中文文件第三章原理（17）為你的伺服器選擇合適版本的.NET框架

ASP.NET Core 中文文件 第四章 MVC（3.8）檢視中的依賴注入

一個簡單的示例

填充查詢資料

重寫服務

參考

相關推薦

ASP.NET Core 中文文件第四章 MVC（3.8）檢視中的依賴注入