ASP.NET Custom ErrorMessage для поля Enum модели - PullRequest
Новая
       45

ASP.NET Custom ErrorMessage для поля Enum модели

0 голосов
/ 01 ноября 2018

Я занимаюсь разработкой веб-сайта на основе EntityFrameworkCore и ориентирован на ASP.NET Core 2.1. Я хочу указать сообщение об ошибке для поля enum в моей модели следующим образом: 

[Required(ErrorMessage = "Select an item from the list.")]
public MyEnum MyEnum { get; set; }

Однако сообщение о наличии товара все еще генерируется: The value '0' is invalid. Кажется, проблема в том, что тип Enum проверяется до того, как будет проверен любой мой код. Два подхода, представленные здесь (https://www.codeproject.com/Articles/1204077/ASP-NET-Core-MVC-Model-Validation),, либо создание класса, который наследуется от ValidationAttribute, либо наличие модели, наследующей от IValidatableObject, оба страдают от этого.

Я нашел обходной путь: объявите поле как int, а затем используйте пользовательский атрибут проверки: 

[EnumCheck(typeof(MyEnum), ErrorMessage = "Select an item form the list.")]
public int MyEnum { get; set; }

... а затем подкласс от ValidationAttribute: 

sealed public class EnumCheck : ValidationAttribute
{
    readonly Type t_;

    public EnumCheck(Type t)
    {
        t_ = t;
    }

    public override bool IsValid(object value)
    {
        return Enum.IsDefined(t_, value);
    }
}

У этого подхода есть некоторые недостатки, так как теперь мне нужно привести поле к типу Enum во многих местах, где оно используется.

Есть ли способ предоставить ErrorMessage для типов полей Enum?

UPDATE

Ниже приведен минимальный пример (больше не используется подкласс EnumCheck из ValidationAttribute, а скорее EnumDataType, упомянутый @ PéterCsajtai):

Модель 

namespace web.Models
{
    public enum Day
    {
        Sunday = 1,
        Monday,
        Tuesday,
        Wednesday,
        Thursday,
        Friday,
        Saturday
    }

    public class Form
    {
        [EnumDataType(typeof(Day), ErrorMessage = "Select an item from the list.")]
        public Day Day { get; set; }
    }
}

Контроллер 

namespace web.Controllers
{
    public class HomeController : Controller
    {
        public IActionResult Index()
        {
            return View();
        }

        public IActionResult Save(Form model)
        {
            if(!ModelState.IsValid)
            {
                return View("Index");
            }

            return View("Index", model);
        }
    }
}

Посмотреть 

<form asp-controller="Home">
    <div asp-validation-summary="All" class="text-danger"></div>
    <fieldset>
        <label asp-for="@Model.Day"></label>
        <select asp-for="@Model.Day" asp-items="Html.GetEnumSelectList<Day>()">
            <option value="">Select...</option>
        </select>
        @Html.ValidationMessageFor(m => m.Day)
        <span asp-validation-for="@Model.Day" class="text-danger"></span>
    </fieldset>
    <fieldset>
        <input type="submit" asp-action="Save" />
    </fieldset>
</form>

И вывод после формы сообщения:

form output

Ответы [ 2 ]

0 голосов
/ 24 ноября 2018

  • В исходном случае [Required(ErrorMessage = "Select an item from the list.")] вы устанавливаете сообщение, которое будет отображаться, если отсутствует MyEnum. Но, как и все ValueTypes, он может никогда отсутствовать, поэтому он никогда не вызовет эту проверку. Решением для этого является обнуляемый ValueType.

  • Ваше второе усилие все еще не работает, потому что ошибка привязки модели - «Может ли пустое значение быть преобразовано в Day? Нет, это может» т «. запускается до того, как ваша проверка может начать работу.

Проверка для Type предполагает, что у вас есть instance из этого Type для проверки. Способ, которым Aspnetcore превращает сообщение формы в это типизированное значение, является привязкой к модели. Если опубликованное значение не может быть привязано к модели - например, если вы отправляете «boo» в свойство, объявленное как int, или пустую строку в Enum - тогда validation никогда даже не начинается. Вместо этого отображается ошибка modelbinding .

Простое решение

  • Используйте nullable enum , Day?, чтобы связывание модели пробел успешно (пробел разрешается в null).
  • Используйте [Required()], чтобы значение null не прошло проверку.

Вывод: измените свою форму на: 

public class Form
{
    [Required(ErrorMessage = "Select an item from the list.")]
    public Day? Day { get; set; }
}

И тогда все будет работать так, как вы ожидаете.

Ссылка: Проверка модели в AspNet Core MVC

Примечание: в отличие от других ValidationAttributes, документация для EnumDataType, хотя она наследуется от ValidationAttribute, не дает пример использования ее для проверки. Вместо этого пример использования его для метаданных.

0 голосов
/ 01 ноября 2018

Я думаю, что вы ищете EnumDataTypeAttribute: 

[EnumDataType(typeof(MyEnum), ErrorMessage = "Select an item form the list.")]
public MyEnum MyEnum { get; set; }
...