web-dev-qa-db-ja.com

プロパティのカスタムモデルバインダー

次のコントローラーアクションがあります。

[HttpPost]
public ViewResult DoSomething(MyModel model)
{
    // do something
    return View();
}

MyModelは次のようになります。

public class MyModel
{
    public string PropertyA {get; set;}
    public IList<int> PropertyB {get; set;}
}

したがって、DefaultModelBinderはこれを問題なくバインドする必要があります。唯一のことは、PropertyBをバインドするために特別な/カスタムバインダーを使用したいということです。また、このバインダーを再利用したいです。したがって、解決策は、もちろん機能しないPropertyBの前にModelBinder属性を配置することだと思いました（ModelBinder属性はプロパティでは許可されていません）。私は2つの解決策を見ます：

  1. 次のように、モデル全体（モデルには多くのプロパティがあるため、私はこれを好みません）ではなく、すべての単一のプロパティでアクションパラメータを使用します。

    public ViewResult DoSomething(string propertyA, [ModelBinder(typeof(MyModelBinder))] propertyB)

  2. 新しいタイプを作成するには、MyCustomType: List<int>と言って、このタイプのモデルバインダーを登録します（これはオプションです）

  3. MyModelのバインダーを作成するには、BindPropertyをオーバーライドし、プロパティが"PropertyB"の場合は、カスタムバインダーでプロパティをバインドします。これは可能ですか？

他の解決策はありますか？

c#asp.net-mvcmodel-bindingcustom-model-binder
32
rrejc

bindPropertyをオーバーライドし、プロパティが「PropertyB」の場合は、カスタムバインダーでプロパティをバインドします

これは良い解決策ですが、「is PropertyB」をチェックする代わりに、プロパティレベルのバインダーを定義する独自のカスタム属性をチェックする方がよいでしょう。

[PropertyBinder(typeof(PropertyBBinder))]
public IList<int> PropertyB {get; set;}

BindPropertyオーバーライドの例 here を確認できます。

19
queen3

私は実際には3番目のソリューションが好きですが、DefaultModelBinderから継承し、MVCアプリケーションのデフォルトのモデルバインダーとして構成されているカスタムバインダーに配置することで、すべてのModelBinderの汎用ソリューションにします。

次に、この新しいDefaultModelBinderを、パラメータで指定されたタイプを使用して、PropertyBinder属性で装飾されたすべてのプロパティを自動的にバインドします。

私はこの素晴らしい記事からアイデアを得ました： http://aboutcode.net/2011/03/12/mvc-property-binder.html 。

また、解決策についての私の見解も示します。

私のDefaultModelBinder：

namespace MyApp.Web.Mvc
{
    public class DefaultModelBinder : System.Web.Mvc.DefaultModelBinder
    {
        protected override void BindProperty(
            ControllerContext controllerContext, 
            ModelBindingContext bindingContext, 
            PropertyDescriptor propertyDescriptor)
        {
            var propertyBinderAttribute = TryFindPropertyBinderAttribute(propertyDescriptor);
            if (propertyBinderAttribute != null)
            {
                var binder = CreateBinder(propertyBinderAttribute);
                var value = binder.BindModel(controllerContext, bindingContext, propertyDescriptor);
                propertyDescriptor.SetValue(bindingContext.Model, value);
            }
            else // revert to the default behavior.
            {
                base.BindProperty(controllerContext, bindingContext, propertyDescriptor);
            }
        }

        IPropertyBinder CreateBinder(PropertyBinderAttribute propertyBinderAttribute)
        {
            return (IPropertyBinder)DependencyResolver.Current.GetService(propertyBinderAttribute.BinderType);
        }

        PropertyBinderAttribute TryFindPropertyBinderAttribute(PropertyDescriptor propertyDescriptor)
        {
            return propertyDescriptor.Attributes
              .OfType<PropertyBinderAttribute>()
              .FirstOrDefault();
        }
    }
}

My IPropertyBinderインターフェース：

namespace MyApp.Web.Mvc
{
    interface IPropertyBinder
    {
        object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext, MemberDescriptor memberDescriptor);
    }
}

私のPropertyBinderAttribute：

namespace MyApp.Web.Mvc
{
    public class PropertyBinderAttribute : Attribute
    {
        public PropertyBinderAttribute(Type binderType)
        {
            BinderType = binderType;
        }

        public Type BinderType { get; private set; }
    }
}

プロパティバインダーの例：

namespace MyApp.Web.Mvc.PropertyBinders
{
    public class TimeSpanBinder : IPropertyBinder
    {
        readonly HttpContextBase _httpContext;

        public TimeSpanBinder(HttpContextBase httpContext)
        {
            _httpContext = httpContext;
        }

        public object BindModel(
            ControllerContext controllerContext,
            ModelBindingContext bindingContext,
            MemberDescriptor memberDescriptor)
        {
            var timeString = _httpContext.Request.Form[memberDescriptor.Name].ToLower();
            var timeParts = timeString.Replace("am", "").Replace("pm", "").Trim().Split(':');
            return
                new TimeSpan(
                    int.Parse(timeParts[0]) + (timeString.Contains("pm") ? 12 : 0),
                    int.Parse(timeParts[1]),
                    0);
        }
    }
}

上記のプロパティバインダーの使用例：

namespace MyApp.Web.Models
{
    public class MyModel
    {
        [PropertyBinder(typeof(TimeSpanBinder))]
        public TimeSpan InspectionDate { get; set; }
    }
}
17
Jonathan

@jonathanconwayの答えは素晴らしいですが、ちょっとした詳細を追加したいと思います。

GetPropertyValueの検証メカニズムが機能する機会を与えるために、BindPropertyの代わりにDefaultBinderメソッドをオーバーライドする方がおそらく良いでしょう。

protected override object GetPropertyValue(
    ControllerContext controllerContext,
    ModelBindingContext bindingContext,
    PropertyDescriptor propertyDescriptor,
    IModelBinder propertyBinder)
{
    PropertyBinderAttribute propertyBinderAttribute =
        TryFindPropertyBinderAttribute(propertyDescriptor);
    if (propertyBinderAttribute != null)
    {
        propertyBinder = CreateBinder(propertyBinderAttribute);
    }

    return base.GetPropertyValue(
        controllerContext,
        bindingContext,
        propertyDescriptor,
        propertyBinder);
}
5
Gebb

この質問が出されてから6年が経ちましたが、まったく新しいソリューションを提供するのではなく、このスペースを使って更新を要約したいと思います。これを書いている時点では、MVC 5はかなり前から存在しており、ASP.NETCoreがリリースされたばかりです。

私はVijaya Anandによって書かれた投稿で検討されたアプローチに従いました（ところで、Vijayaのおかげです） http://www.prideparrot.com/blog/archive/2012/6/customizing_property_binding_through_attributes 。また、注目に値するのは、データバインディングロジックがカスタム属性クラスに配置されていることです。これは、VijayaAnandの例のStringArrayPropertyBindAttributeクラスのBindPropertyメソッドです。

ただし、私が読んだこのトピックに関する他のすべての記事（@jonathanconwayのソリューションを含む）では、カスタム属性クラスは、フレームワークが適切なカスタムモデルバインダーを見つけて適用するための第一歩にすぎません。バインディングロジックは、通常はIModelBinderオブジェクトであるカスタムモデルバインダーに配置されます。

最初のアプローチは私にとってより簡単です。 1つ目のアプローチには、まだ知られていない欠点があるかもしれませんが、現時点では、MVCフレームワークはかなり新しいものです。

さらに、MVC 5ではVijaya Anandの例のExtendedModelBinderクラスは不要であることがわかりました。MVC5に付属するDefaultModelBinderクラスは、カスタムモデルバインディング属性と連携するのに十分スマートであるようです。

1
VincentZHANG