Список привязок к моделям Enum Flags
У меня есть сетка Enum Flags, в которой каждая запись представляет собой ряд флажков для определения значений флага этой записи. Это список уведомлений, которые предлагает система, и пользователь может выбрать (для каждого), как он хочет, чтобы они доставлялись:
[Flag]
public enum NotificationDeliveryType
{
InSystem = 1,
Email = 2,
Text = 4
}
Я нашел эту статью, но он возвращает одно значение флага и привязывает его в контроллере следующим образом (с концепцией дней недели):
[HttpPost]
public ActionResult MyPostedPage(MyModel model)
{
//I moved the logic for setting this into a helper
//because this could be re-used elsewhere.
model.WeekDays = Enum<DayOfWeek>.ParseToEnumFlag(Request.Form, "WeekDays[]");
...
}
Я не могу найти где-нибудь, что связыватель модели MVC 3 может обрабатывать флаги. Спасибо!
6 ответов
В целом, я избегаю использования перечислений при разработке моих моделей представлений, потому что они не работают с помощниками ASP.NET MVC и из связующего устройства из коробки. Они прекрасно подходят для моделей вашего домена, но для моделей просмотра вы можете использовать другие типы. Поэтому я оставляю свой слой отображения, который отвечает за преобразование между моими доменными моделями и просмотр моделей, чтобы беспокоиться об этих преобразованиях.
Это, как говорится, если по какой-то причине вы решили использовать перечисления в этой ситуации, вы можете свернуть привязку пользовательской модели:
public class NotificationDeliveryTypeModelBinder : DefaultModelBinder
{
public override object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
{
var value = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
if (value != null )
{
var rawValues = value.RawValue as string[];
if (rawValues != null)
{
NotificationDeliveryType result;
if (Enum.TryParse<NotificationDeliveryType>(string.Join(",", rawValues), out result))
{
return result;
}
}
}
return base.BindModel(controllerContext, bindingContext);
}
}
который будет зарегистрирован в Application_Start:
ModelBinders.Binders.Add(
typeof(NotificationDeliveryType),
new NotificationDeliveryTypeModelBinder()
);
Все идет нормально. Теперь стандартные вещи:
Посмотреть модель:
[Flags]
public enum NotificationDeliveryType
{
InSystem = 1,
Email = 2,
Text = 4
}
public class MyViewModel
{
public IEnumerable<NotificationDeliveryType> Notifications { get; set; }
}
контроллер:
public class HomeController : Controller
{
public ActionResult Index()
{
var model = new MyViewModel
{
Notifications = new[]
{
NotificationDeliveryType.Email,
NotificationDeliveryType.InSystem | NotificationDeliveryType.Text
}
};
return View(model);
}
[HttpPost]
public ActionResult Index(MyViewModel model)
{
return View(model);
}
}
Посмотреть (~/Views/Home/Index.cshtml):
@model MyViewModel
@using (Html.BeginForm())
{
<table>
<thead>
<tr>
<th>Notification</th>
</tr>
</thead>
<tbody>
@Html.EditorFor(x => x.Notifications)
</tbody>
</table>
<button type="submit">OK</button>
}
пользовательский шаблон редактора для NotificationDeliveryType (~/Views/Shared/EditorTemplates/NotificationDeliveryType.cshtml):
@model NotificationDeliveryType
<tr>
<td>
@foreach (NotificationDeliveryType item in Enum.GetValues(typeof(NotificationDeliveryType)))
{
<label for="@ViewData.TemplateInfo.GetFullHtmlFieldId(item.ToString())">@item</label>
<input type="checkbox" id="@ViewData.TemplateInfo.GetFullHtmlFieldId(item.ToString())" name="@(ViewData.TemplateInfo.GetFullHtmlFieldName(""))" value="@item" @Html.Raw((Model & item) == item ? "checked=\"checked\"" : "") />
}
</td>
</tr>
Очевидно, что разработчик программного обеспечения (я в данном случае), пишущий такой код в шаблоне редактора, не должен гордиться своей работой. Я имею в виду, посмотри! Даже я, который написал этот шаблон Razor, как 5 минут назад, уже не может понять, что он делает.
Таким образом, мы реорганизовали этот код спагетти в многократно используемый пользовательский помощник HTML:
public static class HtmlExtensions
{
public static IHtmlString CheckBoxesForEnumModel<TModel>(this HtmlHelper<TModel> htmlHelper)
{
if (!typeof(TModel).IsEnum)
{
throw new ArgumentException("this helper can only be used with enums");
}
var sb = new StringBuilder();
foreach (Enum item in Enum.GetValues(typeof(TModel)))
{
var ti = htmlHelper.ViewData.TemplateInfo;
var id = ti.GetFullHtmlFieldId(item.ToString());
var name = ti.GetFullHtmlFieldName(string.Empty);
var label = new TagBuilder("label");
label.Attributes["for"] = id;
label.SetInnerText(item.ToString());
sb.AppendLine(label.ToString());
var checkbox = new TagBuilder("input");
checkbox.Attributes["id"] = id;
checkbox.Attributes["name"] = name;
checkbox.Attributes["type"] = "checkbox";
checkbox.Attributes["value"] = item.ToString();
var model = htmlHelper.ViewData.Model as Enum;
if (model.HasFlag(item))
{
checkbox.Attributes["checked"] = "checked";
}
sb.AppendLine(checkbox.ToString());
}
return new HtmlString(sb.ToString());
}
}
и мы убираем беспорядок в нашем шаблоне редактора:
@model NotificationDeliveryType
<tr>
<td>
@Html.CheckBoxesForEnumModel()
</td>
</tr>
который дает таблицу:
Теперь, очевидно, было бы неплохо, если бы мы могли предоставить более удобные ярлыки для этих флажков. Как например:
[Flags]
public enum NotificationDeliveryType
{
[Display(Name = "in da system")]
InSystem = 1,
[Display(Name = "@")]
Email = 2,
[Display(Name = "txt")]
Text = 4
}
Все, что нам нужно сделать, это адаптировать помощника HTML, который мы написали ранее:
var field = item.GetType().GetField(item.ToString());
var display = field
.GetCustomAttributes(typeof(DisplayAttribute), true)
.FirstOrDefault() as DisplayAttribute;
if (display != null)
{
label.SetInnerText(display.Name);
}
else
{
label.SetInnerText(item.ToString());
}
что дает нам лучший результат:
Код Дарина был великолепен, но я столкнулся с некоторыми проблемами при использовании его с MVC4.
В расширении HtmlHelper для создания блоков я продолжал получать ошибки времени выполнения, что модель не была перечислением (в частности, говоря System.Object). Я переработал код для получения лямбда-выражения и исправил эту проблему с помощью класса ModelMetadata:
public static IHtmlString CheckBoxesForEnumFlagsFor<TModel, TEnum>(this HtmlHelper<TModel> htmlHelper, Expression<Func<TModel, TEnum>> expression)
{
ModelMetadata metadata = ModelMetadata.FromLambdaExpression(expression, htmlHelper.ViewData);
Type enumModelType = metadata.ModelType;
// Check to make sure this is an enum.
if (!enumModelType.IsEnum)
{
throw new ArgumentException("This helper can only be used with enums. Type used was: " + enumModelType.FullName.ToString() + ".");
}
// Create string for Element.
var sb = new StringBuilder();
foreach (Enum item in Enum.GetValues(enumModelType))
{
if (Convert.ToInt32(item) != 0)
{
var ti = htmlHelper.ViewData.TemplateInfo;
var id = ti.GetFullHtmlFieldId(item.ToString());
var name = ti.GetFullHtmlFieldName(string.Empty);
var label = new TagBuilder("label");
label.Attributes["for"] = id;
var field = item.GetType().GetField(item.ToString());
// Add checkbox.
var checkbox = new TagBuilder("input");
checkbox.Attributes["id"] = id;
checkbox.Attributes["name"] = name;
checkbox.Attributes["type"] = "checkbox";
checkbox.Attributes["value"] = item.ToString();
var model = htmlHelper.ViewData.Model as Enum;
if (model.HasFlag(item))
{
checkbox.Attributes["checked"] = "checked";
}
sb.AppendLine(checkbox.ToString());
// Check to see if DisplayName attribute has been set for item.
var displayName = field.GetCustomAttributes(typeof(DisplayNameAttribute), true)
.FirstOrDefault() as DisplayNameAttribute;
if (displayName != null)
{
// Display name specified. Use it.
label.SetInnerText(displayName.DisplayName);
}
else
{
// Check to see if Display attribute has been set for item.
var display = field.GetCustomAttributes(typeof(DisplayAttribute), true)
.FirstOrDefault() as DisplayAttribute;
if (display != null)
{
label.SetInnerText(display.Name);
}
else
{
label.SetInnerText(item.ToString());
}
}
sb.AppendLine(label.ToString());
// Add line break.
sb.AppendLine("<br />");
}
}
return new HtmlString(sb.ToString());
}
Я также расширил связыватель модели, чтобы он работал с любым типом перечисления.
public override object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
{
// Fetch value to bind.
var value = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
if (value != null)
{
// Get type of value.
Type valueType = bindingContext.ModelType;
var rawValues = value.RawValue as string[];
if (rawValues != null)
{
// Create instance of result object.
var result = (Enum)Activator.CreateInstance(valueType);
try
{
// Parse.
result = (Enum)Enum.Parse(valueType, string.Join(",", rawValues));
return result;
}
catch
{
return base.BindModel(controllerContext, bindingContext);
}
}
}
return base.BindModel(controllerContext, bindingContext);
}
Вам все еще нужно зарегистрировать каждый тип перечисления в Application_Start, но, по крайней мере, это устраняет необходимость в отдельных классах связующих. Вы можете зарегистрировать его, используя:
ModelBinders.Binders.Add(typeof(MyEnumType), new EnumFlagsModelBinder());
Я разместил свой код на Github по адресу https://github.com/Bitmapped/MvcEnumFlags.
Вы можете попробовать пакет Enum Flags MVC (доступен через nuget). Он автоматически пропускает нулевые значения перечисления, что приятно.
[Ниже приводится документация и ее комментарии; посмотрите, если это не является обязательным для вас]
После установки добавьте следующее в Global.asax.cs\Application_Start:
ModelBinders.Binders.Add(typeof(MyEnumType), new EnumFlagsModelBinder());
Затем в представлении поставить @using MvcEnumFlags наверх и @Html.CheckBoxesForEnumFlagsFor(model => model.MyEnumTypeProperty) для фактического кода.
Я использую подход, описанный в MVVM Framework.
enum ActiveFlags
{
None = 0,
Active = 1,
Inactive = 2,
}
class ActiveFlagInfo : EnumInfo<ActiveFlags>
{
public ActiveFlagInfo(ActiveFlags value)
: base(value)
{
// here you can localize or set user friendly name of the enum value
if (value == ActiveFlags.Active)
this.Name = "Active";
else if (value == ActiveFlags.Inactive)
this.Name = "Inactive";
else if (value == ActiveFlags.None)
this.Name = "(not set)";
}
}
// Usage of ActiveFlagInfo class:
// you can use collection of ActiveFlagInfo for binding in your own view models
// also you can use this ActiveFlagInfo as property for your classes to wrap enum properties
IEnumerable<ActiveFlagInfo> activeFlags = ActiveFlagInfo.GetEnumInfos(e =>
e == ActiveFlags.None ? null : new ActiveFlagInfo(e));
Используя Дарин и растровый код, я пишу ответ, но у меня ничего не вышло, поэтому сначала я исправил обнуляемые вещи, а потом все еще имел проблему с бинингом, обнаружил, что что-то не так с HTML, поэтому я не верю в этот ответ, найдите другое, что я нашел что-то на форуме моей страны, который использовал тот же код, что и здесь, но с очень небольшими изменениями, так что я сливаю это с моим кодом, и все прошло хорошо, мой проект использует nullable, поэтому я не знаю, как это сработает в других местах, возможно, потребуется немного исправить, но я пытался думать о nullable и модели как о самом enum.
public static class Extensions
{
public static IHtmlString CheckBoxesForEnumFlagsFor<TModel, TEnum>(this HtmlHelper<TModel> htmlHelper, Expression<Func<TModel, TEnum>> expression)
{
ModelMetadata metadata = ModelMetadata.FromLambdaExpression(expression, htmlHelper.ViewData);
Type enumModelType = metadata.ModelType;
var isEnum = enumModelType.IsEnum;
var isNullableEnum = enumModelType.IsGenericType &&
enumModelType.GetGenericTypeDefinition() == typeof (Nullable<>) &&
enumModelType.GenericTypeArguments[0].IsEnum;
// Check to make sure this is an enum.
if (!isEnum && !isNullableEnum)
{
throw new ArgumentException("This helper can only be used with enums. Type used was: " + enumModelType.FullName.ToString() + ".");
}
// Create string for Element.
var sb = new StringBuilder();
Type enumType = null;
if (isEnum)
{
enumType = enumModelType;
}
else if (isNullableEnum)
{
enumType = enumModelType.GenericTypeArguments[0];
}
foreach (Enum item in Enum.GetValues(enumType))
{
if (Convert.ToInt32(item) != 0)
{
var ti = htmlHelper.ViewData.TemplateInfo;
var id = ti.GetFullHtmlFieldId(item.ToString());
//Derive property name for checkbox name
var body = expression.Body as MemberExpression;
var propertyName = body.Member.Name;
var name = ti.GetFullHtmlFieldName(propertyName);
//Get currently select values from the ViewData model
//TEnum selectedValues = expression.Compile().Invoke(htmlHelper.ViewData.Model);
var label = new TagBuilder("label");
label.Attributes["for"] = id;
label.Attributes["style"] = "display: inline-block;";
var field = item.GetType().GetField(item.ToString());
// Add checkbox.
var checkbox = new TagBuilder("input");
checkbox.Attributes["id"] = id;
checkbox.Attributes["name"] = name;
checkbox.Attributes["type"] = "checkbox";
checkbox.Attributes["value"] = item.ToString();
var model = (metadata.Model as Enum);
//var model = htmlHelper.ViewData.Model as Enum; //Old Code
if (model != null && model.HasFlag(item))
{
checkbox.Attributes["checked"] = "checked";
}
sb.AppendLine(checkbox.ToString());
// Check to see if DisplayName attribute has been set for item.
var displayName = field.GetCustomAttributes(typeof(DisplayNameAttribute), true)
.FirstOrDefault() as DisplayNameAttribute;
if (displayName != null)
{
// Display name specified. Use it.
label.SetInnerText(displayName.DisplayName);
}
else
{
// Check to see if Display attribute has been set for item.
var display = field.GetCustomAttributes(typeof(DisplayAttribute), true)
.FirstOrDefault() as DisplayAttribute;
if (display != null)
{
label.SetInnerText(display.Name);
}
else
{
label.SetInnerText(item.ToString());
}
}
sb.AppendLine(label.ToString());
// Add line break.
sb.AppendLine("<br />");
}
}
return new HtmlString(sb.ToString());
}
}
public class FlagEnumerationModelBinder : DefaultModelBinder
{
public override object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
{
if (bindingContext == null) throw new ArgumentNullException("bindingContext");
if (bindingContext.ValueProvider.ContainsPrefix(bindingContext.ModelName))
{
var values = GetValue<string[]>(bindingContext, bindingContext.ModelName);
if (values.Length > 1 && (bindingContext.ModelType.IsEnum && bindingContext.ModelType.IsDefined(typeof(FlagsAttribute), false)))
{
long byteValue = 0;
foreach (var value in values.Where(v => Enum.IsDefined(bindingContext.ModelType, v)))
{
byteValue |= (int)Enum.Parse(bindingContext.ModelType, value);
}
return Enum.Parse(bindingContext.ModelType, byteValue.ToString());
}
else
{
return base.BindModel(controllerContext, bindingContext);
}
}
return base.BindModel(controllerContext, bindingContext);
}
private static T GetValue<T>(ModelBindingContext bindingContext, string key)
{
if (bindingContext.ValueProvider.ContainsPrefix(key))
{
ValueProviderResult valueResult = bindingContext.ValueProvider.GetValue(key);
if (valueResult != null)
{
bindingContext.ModelState.SetModelValue(key, valueResult);
return (T)valueResult.ConvertTo(typeof(T));
}
}
return default(T);
}
}
ModelBinders.Binders.Add(
typeof (SellTypes),
new FlagEnumerationModelBinder()
);
ModelBinders.Binders.Add(
typeof(SellTypes?),
new FlagEnumerationModelBinder()
);
Bitmapped, вы задали важные вопросы, и я могу предложить следующее решение: вы должны переопределить метод BindProperty вашего ModelBinder и затем нужно переопределить значение свойства модели:
protected override void BindProperty(ControllerContext controllerContext, ModelBindingContext bindingContext, System.ComponentModel.PropertyDescriptor propertyDescriptor)
{
if (propertyDescriptor.PropertyType.IsEnum && propertyDescriptor.PropertyType.GetCustomAttributes(typeof(FlagsAttribute), false).Any())
{
var value = bindingContext.ValueProvider.GetValue(propertyDescriptor.Name);
if (value != null)
{
// Get type of value.
var rawValues = value.RawValue as string[];
if (rawValues != null)
{
// Create instance of result object.
var result = (Enum)Activator.CreateInstance(propertyDescriptor.PropertyType);
try
{
// Try parse enum
result = (Enum)Enum.Parse(propertyDescriptor.PropertyType, string.Join(",", rawValues));
// Override property with flags value
propertyDescriptor.SetValue(bindingContext.Model, result);
return;
}
catch
{
}
}
}
base.BindProperty(controllerContext, bindingContext, propertyDescriptor);
}
else
base.BindProperty(controllerContext, bindingContext, propertyDescriptor);
}