列挙型フラグのモデルバインドリスト
私は、各レコードがそのレコードのフラグ値を決定するためのチェックボックスの行である列挙フラグのグリッドを持っています。これは、システムが提供する通知のリストであり、ユーザーは（それぞれについて）通知の配信方法を選択できます。
[Flag]
public enum NotificationDeliveryType
{
InSystem = 1,
Email = 2,
Text = 4
}
私はこれを見つけました article ですが、彼は単一のフラグ値を取得しており、これを次のようにコントローラーにバインドしています（曜日の概念を使用）。
[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モデルバインダーがフラグを処理できる場所はどこにもありません。ありがとう！
ビューモデルを設計するときは、列挙型を使用しないようにします。ビューモデルは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>
エディターテンプレートでそのようなコードを書くソフトウェア開発者（この場合は私）が彼の仕事にそれほど誇りに思うべきではないことは明らかです。ほら見て！ 5分前のようにこのRazorテンプレートを作成した私でも、それが何をするのか理解できなくなっています。
そこで、このスパゲッティコードを再利用可能なカスタム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());
}
これにより、より良い結果が得られます。
Darinのコードは素晴らしかったが、MVC4で使用するときに問題が発生しました。
ボックスを作成するためのHtmlHelper拡張機能で、モデルが列挙型ではない（具体的にはSystem.Objectと言っている）ランタイムエラーが発生し続けました。 Lambda式を使用するようにコードを作り直し、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());
https://github.com/Bitmapped/MvcEnumFlags のGithubにコードを投稿しました。
MVC Enum Flags パッケージを試すことができます（ nuget から入手できます）。ゼロ値の列挙型の選択を自動的にスキップします。これはいい感じです。
[以下は Documentation とそのコメントからのものです。これが適切にバインドされていないかどうかを確認してください]
インストール後、以下をGlobal.asax.cs\Application_Startに追加します。
ModelBinders.Binders.Add(typeof(MyEnumType), new EnumFlagsModelBinder());
次に、ビューで_@using MvcEnumFlags_ up topと@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));
Darinとビットマップコードを使用して、答えを書きましたが、うまくいきませんでした。最初に、null許容の問題を修正しました。それでも、biningの問題があり、htmlに問題があることがわかりました。この答えを信じません。 、別のものを検索し、私の国のフォーラムでここと同じコードを使用しているものを見つけましたが、変更はほとんどありません。そのため、コードとマージし、すべてうまくいきました。プロジェクトではnullを使用できます。他の場所でどのように機能するかわからないので、少し修正が必要かもしれませんが、null可能で、モデル自体が列挙型であることを考えてみました。
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()
);
ビットマップ、あなたは重要な質問をしました、そして私は次の解決策を提案できます：ModelBinderのBindPropertyメソッドをオーバーライドし、次にモデルプロパティ値をオーバーライドする必要があります：
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);
}