Язык программирования C#9 и платформа .NET5

Троелсен Эндрю

namespace AutoLot.Mvc.ViewComponents

{

public class MenuViewComponent : ViewComponent

{

private readonly IMakeRepo _makeRepo;

public MenuViewComponent(IMakeRepo makeRepo)

{

_makeRepo = makeRepo;

}

}

Компонентам представлений доступны два метода,

Invoke

и

InvokeAsync

.

Один из них должен быть реализован и поскольку

MakeRepo

делает только синхронные вызовы, добавьте метод

Invoke

:

public async IViewComponentResult Invoke

{

}

Когда компонент представления визуализируется из представления, вызывается открытый метод

Invoke/InvokeAsync

. Этот метод возвращает экземпляр реализации интерфейса

IViewComponentResult

, который концептуально подобен

PartialViewResult

, но сильно упрощен. В методе

Invoke

получается список производителей из хранилища и в случае успеха возвращается экземпляр

ViewViewComponentResult

(в его имени нет опечатки), где в качестве модели представления применяется список производителей. Если вызов для получения записей

Make

завершается неудачей, тогда производится возврат экземпляра

ContentViewComponentResult

с сообщением об ошибке. Модифицируйте код метода, как показано ниже:

public IViewComponentResult Invoke

{

var makes = _makeRepo.GetAll.ToList;

if (!makes.Any)

{

return new ContentViewComponentResult("Unable to get the makes");

}

return View("MenuView", makes);

}

Вспомогательный метод

View

из базового класса

ViewComponent

похож на вспомогательный метод с тем же именем из класса

Controller

, но с парой ключевых отличий. Первое отличие заключается в том, что стандартным именем файла представления является

Default.cshtml

, а не имя метода. Однако подобно вспомогательному методу

View

из класса

Controller

имя представления может быть любым, когда оно передается вызову метода (без расширения

.cshtml

). Второе отличие связано с тем, что представление обязано находиться в одном из следующих трех каталогов:

Views/< controller>/Components/<имя_компонента_представления>/<view_name>

Views/Shared/Components/<имя_компонента_представления>/<view_name>

Pages/Shared/Components/<имя_компонента_представления>/<view_name>

На заметку! В версии ASP.NET Core 2.x появился еще один механизм для создания веб-приложений, который называется Razor Pages, но в этой книге он не рассматривается.

Класс C# может находиться где угодно (даже в другой сборке), но файл

<имя_представления>.cshtml

должен храниться в одном из ранее перечисленных каталогов.

Построение

частичного представления

Частичное представление, визуализируемое классом

MenuViewComponent

, будет проходить по записям

Make

, добавляя каждую в виде элемента списка, который предназначен для отображения в меню Bootstrap. Элемент меню All (Все) добавляется первым как жестко закодированное значение.

Создайте внутри каталога

Views\Shared

новый каталог по имени

Components

, а в нем — еще один каталог под названием

Menu

. Имя каталога должно совпадать с именем созданного ранее класса компонента представления минус суффикс

ViewComponent

. Добавьте в каталог

Menu

файл частичного представления по имени

MenuView.cshtml

.

Удалите существующий код и поместите в файл показанную ниже разметку:

@model IEnumerable<Make>

<div class="dropdown-menu">

<a class="dropdown-item text-dark" asp-area="" asp-controller="Cars" asp-

action="Index">All</a>

@foreach (var item in Model)

{

<a class="dropdown-item text-dark" asp-controller="Cars"

asp-action="ByMake"

asp-route-

makeId="@item.Id"

asp-route-makeName="@item.Name">@item.Name</a>

}

</div>

Вызов компонентов представлений

Компоненты представлений обычно визуализируются из представления (хотя их можно визуализировать также из метода действия контроллера). Синтаксис довольно прямолинеен:

Component.Invoke(<имя_компонента_представления>)

или

@await Component.InvokeAsync(<имя_компонента_представления>)

. Как и в случае с контроллерами, при вызове компонента представления суффикс

ViewComponent

не должен указываться:

@await Component.InvokeAsync("Menu") // асинхронная версия

@Component.Invoke("Menu") // синхронная версия

Вызов компонентов представлений как специальных вспомогательных функций дескрипторов

Появившиеся в ASP.NET 1.1 компоненты представлений можно вызывать с использованием синтаксиса вспомогательных функций дескрипторов. Вместо применения

Component.InvokeAsync/Component.Invoke

просто вызывайте компонент представления следующим образом:

<vc:menu></vc:menu>

В приложении потребуется разрешить использование такого способа вызова компонентов представлений, что делается добавлением команды

@addTagHelper

с именем сборки, которая содержит нужный компонент представления. В файл

_ViewImports.cshtml

необходимо добавить показанную ниже строку, которая уже была добавлена для специальных вспомогательных функций дескрипторов:

@addTagHelper *, AutoLot.Mvc