ASP_NET_MVC_4_Framework_s_primerami_na_C_dlya_p

public DateTime BirthDate { get; set; }

public Address HomeAddress { get; set; }

[Display(Name = "Approved")]

public bool IsApproved { get; set; }

public Role Role { get; set; }

}

Атрибут DataType принимает в качестве параметра значение из перечисления DataType. В данном примере мы указали значение DataType.Date, которое сообщает шаблонным вспомогательным методам, что необходимо визуализировать значение свойства BirthDate в формате даты без времени, как показано на рисунке 20-9.

Подсказка

Изменения будут более заметны, если вы просмотрите приложение в браузере с лучшей поддержкой типов элементов input HTML5.

Рисунок 20-9: Изменяем способ отображения значения DateTime с помощью атрибута DataType

В таблице 20-3 описаны наиболее полезные значения из перечисления DataType.

Таблица 20-3: Значения из перечисления DataType

Значение

DateTime

Date

Time

Text

PhoneNumber

MultilineText Визуализирует значение в элементе textarea

Password

Url

EmailAddress

Результат применения этих значений зависит от типа свойства, с которым они связаны, и вспомогательного метода, который мы используем. Например, значение MultilineText сообщит вспомогательному методу, который создает элементы editor для свойств, сгенерировать элемент

521

Шаблон Object является особым случаем. Он используется шаблонными вспомогательными методами, чтобы создать HTML для объекта модели представления. Этот шаблон проверяет каждое свойство объекта и выбирает наиболее подходящий шаблон для типа каждого свойства. Шаблон Object учитывает метаданные, такие как атрибуты UIHint и DataType.

Применяем метаданные в дополняющем классе (buddy class)

Не всегда можно применить метаданные к классу сущности модели. Так обычно происходит, когда классы моделей генерируются автоматически, например, с помощью инструментов ORM, таких как Entity Framework (хотя и не таким образом, как мы использовали Entity Framework в приложении SportsStore). Любые изменения, которые мы вносим в автоматически сгенерированные классы (такие как применение атрибутов), будут потеряны при следующем обновлении или регенерации классов.

Чтобы решить эту проблему, нужно определить класс модели как частичный и создать еще один частичный класс, который содержит метаданные. Многие инструменты для автоматической генерации классов создают частичные классы по умолчанию, в том числе и Entity Framework. В листинге 20-16 показан измененный класс Person, который мог бы быть сгенерированным автоматически: в нем нет метаданных, и он определен как частичный.

Листинг 20-16: Частичный класс модели

using System;

using System.ComponentModel.DataAnnotations;

namespace HelperMethods.Models

{

[MetadataType(typeof (PersonMetaData))] public partial class Person

{

public int PersonId { get; set; } public string FirstName { get; set; } public string LastName { get; set; } public DateTime BirthDate { get; set; } public Address HomeAddress { get; set; } public bool IsApproved { get; set; } public Role Role { get; set; }

}

// ...other types omitted from listing for brevity...

}

Мы сообщаем MVC Framework о дополняющем классе с помощью атрибута MetadataType, который принимает тип дополняющего класса в качестве аргумента. Дополняющий класс должен быть определен в том же пространстве имен и также должен быть частичным. Чтобы продемонстрировать, как это работает, мы добавили в проект новую папку под названием Models/Metadata. В этой папке мы создали новый класс под названием PersonMetadata.cs, содержание которого показано в листинге 20-17.

Листинг 20-17: Определяем дополняющий класс метаданных

using System;

using System.ComponentModel;

using System.ComponentModel.DataAnnotations; using System.Web.Mvc;

namespace HelperMethods.Models

{

[DisplayName("New Person")]

public partial class PersonMetaData

524

{

[HiddenInput(DisplayValue = false)] public int PersonId { get; set; }

[Display(Name = "First")]

public string FirstName { get; set; }

[Display(Name = "Last")]

public string LastName { get; set; }

[Display(Name = "Birth Date")] [DataType(DataType.Date)]

public DateTime BirthDate { get; set; }

[Display(Name = "Approved")]

public bool IsApproved { get; set; }

}

}

Дополняющий класс должен содержать только те свойства, к которым мы хотим применить метаданные – нет необходимости воспроизводить все свойства класса Person, например.

Подсказка

Обязательно измените пространство имен, в которое Visual Studio добавляет новый класс - дополняющий класс должен быть в том же пространстве имен, что и класс модели (в данном примере - HelperMethods.Models).

Работаем со сложными типами свойств

Процесс формирования шаблонов полагается на шаблон Object, который мы описали в предыдущем разделе. Каждое свойство проверяется, и для него выбирается шаблон для создания кода HTML, который будет визуализировать это свойство и его значения данных.

Возможно, вы заметили, что свойство HomeAddress не отображалось как часть класса Person, когда мы использовали EditorForModel. Так происходит потому, что шаблон Object работает только с простыми типами, то есть типами, которые могут быть получены из значения string с помощью метода GetConverter класса System.ComponentModel.TypeDescriptor. Поддерживаемые типы включают внутренние типы C#, такие как int, bool и double, а также многие общие типы MVC Framework, такие как Guid и DateTime.

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

Возможно, это и неудобно, но это разумная политика; MVC Framework не знает, как были созданы наши объекты моделей, и если бы шаблон Object был рекурсивным, то он бы задействовал медленно загружающиеся функции ORM, а затем читал и отображал бы каждый объект в нижележащей базе данных. Если мы хотим создать HTML для сложного свойства, то это нужно сделать явно, используя отдельный вызов к шаблонному вспомогательному методу. Чтобы показать, как это делается, мы внесли изменения в представление CreatePerson.cshtml, которые показаны в листинге 20-18.

Листинг 20-18: Работаем со сложным типом

@model HelperMethods.Models.Person

525

@{

ViewBag.Title = "CreatePerson"; Html.EnableClientValidation(false);

}

<h2>CreatePerson: @Html.LabelForModel()</h2>

@using (Html.BeginRouteForm("FormRoute", new {}, FormMethod.Post, new {@class = "personClass", data_formType = "person"}))

{

<div class="column"> @Html.EditorForModel()

</div>

<div class="column">

@Html.EditorFor(m => m.HomeAddress)

</div>

<input type="submit" value="Submit" />

}

Чтобы отобразить свойство HomeAddress, мы добавили вызов к строго типизированному вспомогательному методу EditorFor.(Мы также добавили некоторые элементы div, чтобы к генерируемому HTML применялись стили CSS, которые мы определили для класса column в листинге 20-10). Результат показан на рисунке 20-10.

Рисунок 20-10: Отображаем сложное свойство

Подсказка

Свойство HomeAddress возвращает объект Address, и мы можем применить к классу Address те же метаданные, которые применили к классу Person. Когда мы используем вспомогательный метод EditorFor в свойстве HomeAddress, шаблон Object вызывается явно, так что все соглашения, относящиеся к метаданным,

соблюдены.

526

Настройка системы шаблонных вспомогательных методов

Мы научились с помощью метаданных влиять на то, как шаблонные вспомогательные методы отображают элементы. Однако, как и для всех функций MVC Framework, для шаблонных вспомогательных методов есть дополнительные опции, которые позволяют полностью настроить их работу. В следующих разделах мы продемонстрируем, как можно дополнить или заменить встроенную поддержку для реализации конкретных решений.

Создаем пользовательский шаблон Editor

Самый простой способ изменить поведение шаблонного вспомогательного метода – создать пользовательский шаблон. Это позволит нам сгенерировать для свойства модели именно такой HTML, какой мы хотим.

Чтобы продемонстрировать, как работает этот подход, мы создадим пользовательский шаблон для свойства Role класса Person. Тип этого свойства - значение из перечисления Role, и нам не нравится то, как оно визуализируется. Шаблонный вспомогательный метод создает обычный элемент input, который позволяет пользователю ввести любое значение, не ограничивая их теми, которые указаны в перечислении.

MVC Framework будет искать пользовательские шаблоны для элементов editor в папке /Views/Shared/EditorTemplates, поэтому мы добавили эту папку в проект и создали в ней новое строго типизированное частичное представление под названием Role.cshtml. Вы можете увидеть содержимое этого файла в листинге 20-19.

Листинг 20-19: Содержимое файла Role.cshtml

@model HelperMethods.Models.Role

@Html.DropDownListFor(m => m,

new SelectList(Enum.GetNames(Model.GetType()), Model.ToString()))

Тип модели для данного представления – это перечисление Role, и мы используем вспомогательный метод Html.DropDownListFor, чтобы создать элемент select с элементами option для значений в перечислении. Мы передаем дополнительное значение в конструктор SelectList; оно указывает выбранное значение, которое мы получаем от объект модели представления. Метод DropDownListFor и объект SelectList работают со строковыми значениями, поэтому мы должны преобразовать значения в перечислении и модели представления.

Когда мы будем использовать шаблонный вспомогательный метод, чтобы создать элемент editor

для типа Role, будет использоваться файл /Views/Shared/EditorTemplates/Role.cshtml. Таким образом, мы получаем последовательное и полезное представление для типа данных. Эффект применения пользовательского шаблона показан на рисунке 20-11.

Рисунок 20-11: Эффект применения пользовательского шаблона для перечисления Role

527

Порядок поиска шаблонов

Шаблон Role.cshtml работает потому, что платформа MVC сначала выполняет поиск пользовательских шаблонов для данного типа C#, и только потом использует один из встроенных шаблонов. Поиск подходящего шаблона MVC Framework проводит в следующем порядке:

1. Шаблон, переданный во вспомогательный метод - например, вспомогательный метод

Html.EditorFor(m => m.SomeProperty, "MyTemplate") нашел бы шаблон

MyTemplate.

2.Шаблон, который указан в атрибутах метаданных, таких как UIHint.

3.Шаблон, который связан с типом данных, указанным в метаданных, например в атрибуте DataType.

4.Шаблон, который соответствует имени класса .NET обрабатываемого типа данных.

5.Встроенный шаблон String, если обрабатываемый тип данных является простым.

6.Шаблон, который соответствует базовому классу типа данных.

7.Если тип данных реализует IEnumerable, то будет использоваться встроенный шаблон Collection. Если ничего не подходит, то будет использоваться шаблон Object, на который распространяется правило, что формирование шаблонов не является рекурсивным.

Внекоторых пунктах используются встроенные шаблоны, которые описаны в таблице 20-4. На каждом этапе процесса поиска шаблона MVC Framework ищет шаблон под названием EditorTemplates/<name> для вспомогательных методов для элементов editor и DisplayTemplates/<name> для вспомогательных методов для элементов display. Для нашего

шаблона Role поиск остановится на пункте 4; мы создали шаблон под названием Role.cshtml и

поместили его в папку /Views/Shared/EditorTemplates.

Поиск пользовательских шаблонов проводится по той же схеме, что и поиск обычных представлений, а следовательно, мы можем создать пользовательский шаблон для конкретного контроллера и поместить его в папку ~/Views/<controller>/EditorTemplates, чтобы переопределить шаблоны из папки ~/Views/Shared. Подробная информация о поиске представлений дана в главе 18.

Создаем общий (generic) шаблон

Можно создавать шаблоны не только для конкретного типа. Мы можем, например, создать шаблон для всех перечислений, а затем выбрать его с помощью атрибута UIHint. Если вы посмотрите блок «Порядок поиска шаблонов», то увидите, что шаблоны, заданные с помощью атрибута UIHint, имеют приоритет над шаблонами для конкретного типа.

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

Enum.cshtml в папке /Views/Shared/EditorTemplates. Содержимое этого файла показано в листинге 20-20.

Листинг 20-20: Представление Enum.cshtml

@model Enum

@Html.DropDownListFor(m => m, Enum.GetValues(Model.GetType())

.Cast<enum>()

.Select(m =>

{

string enumVal = Enum.GetName(Model.GetType(), m); return new SelectListItem()

{

Selected = (Model.ToString() == enumVal),

528

Text = enumVal, Value = enumVal

};

})

Типом модели для этого шаблона является Enum, что позволяет нам работать с любым перечислением. Для разнообразия мы создали с помощью LINQ строки, которые необходимы для создания элементов select и option. Далее мы можем затем применить атрибут UIHint. В нашем проекте есть дополняющий класс метаданных, так что мы применили этот атрибут к классу PersonMetadata, как показано в листинге 20-21. (Напомним, что этот класс находится по адресу

/Models/Metadata/PersonMetadata.cs).

Листинг 20-21: Используем атрибут UIHint, чтобы указать пользовательский шаблон

using System;

using System.ComponentModel;

using System.ComponentModel.DataAnnotations; using System.Web.Mvc;

namespace HelperMethods.Models

{

[DisplayName("New Person")]

public partial class PersonMetaData

{

[HiddenInput(DisplayValue = false)] public int PersonId { get; set; }

[Display(Name = "First")]

public string FirstName { get; set; }

[Display(Name = "Last")]

public string LastName { get; set; }

[Display(Name = "Birth Date")] [DataType(DataType.Date)]

public DateTime BirthDate { get; set; }

[Display(Name = "Approved")]

public bool IsApproved { get; set; }

[UIHint("Enum")]

public Role Role { get; set; }

}

}

Такой подход позволяет получить более общее решение, которое можно применять во всем приложении и гарантировать, что все свойства Enum отображаются с помощью элемента select. Мы предпочитаем создавать пользовательские шаблоны для конкретных типов моделей, но иногда удобнее иметь шаблон, который можно применять более широко.

Заменяем встроенные шаблоны

Если мы создадим пользовательский шаблон с таким же именем, как и один из встроенных шаблонов, MVC Framework будет использовать пользовательскую версию в предпочтение встроенной. В листинге 20-22 показано содержимое файла Boolean.cshtml, который мы создали в папке /Views/Shared/EditorTemplates. Это представление заменяет встроенный шаблон Boolean, который используется для отображения значений bool и bool?.

529

Листинг 20-22: Заменяем встроенный шаблон

@model bool?

@if (ViewData.ModelMetadata.IsNullableValueType && Model == null) { @:(True) (False) <b>(Not Set)</b>

}else if (Model.Value) { @:<b>(True)</b> (False) (Not Set)

}else {

@:(True) <b>(False)</b> (Not Set)

}

В данном представлении мы отображаем все возможные значения и выделяем то, которое соответствует объекту модели. Результат применения этого шаблона показан на рисунке 20-12.

Рисунок 20-12: Результат переопределения встроенного шаблона для элементов editor

Обратите внимание на гибкость пользовательских шаблонов, хотя в этом примере мы используем их не самым полезным образом и даже не позволяем пользователю изменять значение свойства. Как видите, существует много способов контролировать, как должны отображаться и редактироваться свойства модели, и вы можете выбрать подход, который лучше всего соответствует вашему стилю программирования и конкретному приложению.

Резюме

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

530