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

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

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

Специальные вспомогательные функции дескрипторов могут помочь избавиться от повторяющегося кода. В проекте

AutoLot.Mvc

специальные вспомогательные функции дескрипторов заменят HTML-разметку, используемую для навигации между экранами CRUD для

Car

.

Подготовительные шаги

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

UrlHelperFactory

и

IActionContextAccessor

для ссылок на основе маршрутизации. Кроме того, будет добавлен

расширяющий метод для типа string, чтобы удалять суффикс

Controller

из имен контроллеров.

Обновление Startup.cs

Для создания экземпляра

UrlFactory

класса, производного не от класса

Controller

, в коллекцию служб потребуется добавить

IActionContextAccessor

. Начните с добавления в файл

Startup.cs

следующих пространств имен:

using Microsoft.AspNetCore.Mvc.Infrastructure;

using Microsoft.Extensions.DependencyInjection.Extensions;

Затем добавьте в метод

ConfigureServices

такую строку:

services.TryAddSingleton<IActionContextAccessor, ActionContextAccessor>;

Создание расширяющего метода для типа string

При обращении к именам контроллеров в коде инфраструктуре ASP.NET Core довольно часто требуется низкоуровневое строковое значение, не содержащее суффикс

Controller

, что препятствует использованию метода

nameof

без последующего вызова

string.Replace

. Со временем задача становится утомительной, поэтому для ее решения будет создан расширяющий метод для типа

string

.

Создайте в проекте

AutoLot.Services

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

Utilities

и добавьте в него файл

StringExtensions.cs

со статическим классом

StringExtensions

. Модифицируйте код, добавив расширяющий метод

RemoveController

:

using System;

namespace AutoLot.Mvc.Extensions

{

public static class StringExtensions

{

public static string RemoveController(this string original)

=> original.Replace("Controller", "", StringComparison.OrdinalIgnoreCase);

}

}

Создание базового класса

Создайте в проекте

AutoLot.Mvc

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

TagHelpers

и внутри него каталог

Base

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

Base

файл класса

ItemLinkTagHelperBase.cs

, сделайте класс

ItemLinkTagHelperBase

открытым и абстрактным, а также унаследованным от класса

TagHelper

. Приведите код класса к следующему виду:

using AutoLot.Mvc.Controllers;

using AutoLot.Services.Utilities;

using Microsoft.AspNetCore.Mvc;

using Microsoft.AspNetCore.Mvc.Infrastructure;

using Microsoft.AspNetCore.Mvc.Routing;

using Microsoft.AspNetCore.Razor.TagHelpers;

namespace AutoLot.Mvc.TagHelpers.Base

{

public abstract class ItemLinkTagHelperBase : TagHelper

{

}

}

Добавьте

конструктор, который принимает экземпляры реализаций

IActionContextAccessor

и

IUrlHelperFactory

. Используйте

UrlHelperFactory

с

ActionContextAccessor

, чтобы создать экземпляр реализации

IUrlHelper

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

protected readonly IUrlHelper UrlHelper;

protected ItemLinkTagHelperBase(IActionContextAccessor contextAccessor,

IUrlHelperFactory

urlHelperFactory)

{

UrlHelper = urlHelperFactory.GetUrlHelper(contextAccessor.ActionContext);

}

Добавьте открытое свойство для хранения

Id

элемента:

public int? ItemId { get; set; }

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

Process

, принимающий два параметра,

TagHelperContext

и

TagHelperOutput

. Параметр

TagHelperContext

применяется для получения остальных атрибутов дескриптора и словаря объектов, которые используются с целью взаимодействия с другими вспомогательными функциями дескрипторов, нацеленными на дочерние элементы. Параметр

TagHelperOutput

применяется для создания визуализированного вывода. Поскольку это базовый класс, создайте метод по имени

BuildContent

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

Process

. Добавьте следующий код:

protected void BuildContent(TagHelperOutput output,

string actionName, string className, string displayText, string fontAwesomeName)

{

output.TagName = "a"; // Заменить <item-list> дескриптором <a>.

var target = (ItemId.HasValue)

? UrlHelper.Action(actionName,

nameof(CarsController).RemoveController,

new {id = ItemId})

: UrlHelper.Action(actionName, nameof(CarsController).RemoveController);

output.Attributes.SetAttribute("href", target);

output.Attributes.Add("class",className);

output.Content.AppendHtml($@"{displayText}

<i class=""fas fa-{fontAwesomeName}""></i>");

}

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