如何使用不同的名称绑定视图模型属性

时间:2014-01-01 14:40:35

标签: asp.net-mvc razor data-annotations model-binding asp.net-mvc-5

有没有办法让视图模型属性作为html端具有不同名称和id值的元素进行反射。

这是我想要实现的主要问题。所以问题的基本介绍如下:

1-我有一个视图模型(作为示例),它是为视图侧的过滤操作创建的。

public class FilterViewModel
{
    public string FilterParameter { get; set; }
}

2-我有一个控制器动作,它是为GETting表格值创建的(这里是过滤器)

public ActionResult Index(FilterViewModel filter)
{
return View();
}

3-我认为用户可以过滤某些数据并通过查询字符串在表单提交上发送参数。

@using (Html.BeginForm("Index", "Demo", FormMethod.Get))
{    
    @Html.LabelFor(model => model.FilterParameter)
    @Html.EditorFor(model => model.FilterParameter)
    <input type="submit" value="Do Filter" />
}

4-我希望在渲染视图输出中看到的是

<form action="/Demo" method="get">
    <label for="fp">FilterParameter</label>
    <input id="fp" name="fp" type="text" />
    <input type="submit" value="Do Filter" />
</form>

5-作为解决方案,我想修改我的视图模型:

public class FilterViewModel
{
    [BindParameter("fp")]
    [BindParameter("filter")] // this one extra alias
    [BindParameter("param")] //this one extra alias
    public string FilterParameter { get; set; }
}

所以基本问题是关于BindAttribute但是使用复杂类型属性。但是,如果有一种内置的方式,这样做要好得多。 内置专业人士:

1-使用TextBoxFor,EditorFor,LabelFor和其他强类型视图模型助手可以更好地理解和沟通。

2- Url路由支持

3-没有问题的框架:

  

一般情况下,我们建议人们不要编写自定义模型绑定器   因为他们很难做对,他们很少需要。该   我在这篇文章中讨论的问题可能是其中一个案例   这是有道理的。

Link of quote

经过一些研究后,我发现了这些有用的作品:

Binding model property with different name

One step upgrade of first link

Here some informative guide

结果:但是他们都没有给我解决我的问题。我正在寻找一个针对这个问题的强类型解决方案。当然,如果您知道其他任何方式,请分享。


更新

我想要这样做的根本原因基本上是:

1-每次我想更改html控件名称,然后我必须在编译时更改PropertyName。 (在代码中更改字符串之间更改属性名称存在差异)

2-我想隐藏(伪装)最终用户的不动产名称。大多数情况下,View Model属性名称与映射的Entity Objects属性名称相同。 (出于开发人员的可读性原因)

3-我不想删除开发人员的可读性。想想很多具有2-3个字符长且具有mo含义的属性。

4-有很多视图模型被编写。所以改变他们的名字将比这个解决方案花费更多的时间。

5-到目前为止,这将是比其他问题中描述的其他问题更好的解决方案(在我的POV中)。

2 个答案:

答案 0 :(得分:8)

实际上,有一种方法可以做到。

TypeDescriptor收集的ASP.NET绑定元数据中,而不是直接反射。为了更加珍贵,我们使用了AssociatedMetadataTypeTypeDescriptionProvider,而我们只使用我们的模型类型作为参数调用TypeDescriptor.GetProvider

public AssociatedMetadataTypeTypeDescriptionProvider(Type type)
  : base(TypeDescriptor.GetProvider(type))
{
}

因此,我们需要的是为我们的模型设置自定义TypeDescriptionProvider

让我们实现自定义提供程序。首先,让我们定义自定义属性名称的属性:

[AttributeUsage(AttributeTargets.Property)]
public class CustomBindingNameAttribute : Attribute
{
    public CustomBindingNameAttribute(string propertyName)
    {
        this.PropertyName = propertyName;
    }

    public string PropertyName { get; private set; }
}

如果您已拥有所需名称的属性,则可以重复使用该属性。上面定义的属性只是一个例子。我更喜欢使用JsonPropertyAttribute,因为在大多数情况下我使用json和Newtonsoft的库并且只想定制一次自定义名称。

下一步是定义自定义类型描述符。我们不会实现整个类型描述符逻辑并使用默认实现。只会覆盖属性访问:

public class MyTypeDescription : CustomTypeDescriptor
{
    public MyTypeDescription(ICustomTypeDescriptor parent)
        : base(parent)
    {
    }

    public override PropertyDescriptorCollection GetProperties()
    {
        return Wrap(base.GetProperties());
    }

    public override PropertyDescriptorCollection GetProperties(Attribute[] attributes)
    {
        return Wrap(base.GetProperties(attributes));
    }

    private static PropertyDescriptorCollection Wrap(PropertyDescriptorCollection src)
    {
        var wrapped = src.Cast<PropertyDescriptor>()
                         .Select(pd => (PropertyDescriptor)new MyPropertyDescriptor(pd))
                         .ToArray();

        return new PropertyDescriptorCollection(wrapped);
    }
}

还需要实现自定义属性描述符。同样,除属性名称之外的所有内容都将由默认描述符处理。请注意,NameHashCode由于某种原因是一个单独的属性。随着名称的改变,它的哈希码也需要改变:

public class MyPropertyDescriptor : PropertyDescriptor
{
    private readonly PropertyDescriptor _descr;
    private readonly string _name;

    public MyPropertyDescriptor(PropertyDescriptor descr)
        : base(descr)
    {
        this._descr = descr;

        var customBindingName = this._descr.Attributes[typeof(CustomBindingNameAttribute)] as CustomBindingNameAttribute;
        this._name = customBindingName != null ? customBindingName.PropertyName : this._descr.Name;
    }

    public override string Name
    {
        get { return this._name; }
    }

    protected override int NameHashCode
    {
        get { return this.Name.GetHashCode(); }
    }

    public override bool CanResetValue(object component)
    {
        return this._descr.CanResetValue(component);
    }

    public override object GetValue(object component)
    {
        return this._descr.GetValue(component);
    }

    public override void ResetValue(object component)
    {
        this._descr.ResetValue(component);
    }

    public override void SetValue(object component, object value)
    {
        this._descr.SetValue(component, value);
    }

    public override bool ShouldSerializeValue(object component)
    {
        return this._descr.ShouldSerializeValue(component);
    }

    public override Type ComponentType
    {
        get { return this._descr.ComponentType; }
    }

    public override bool IsReadOnly
    {
        get { return this._descr.IsReadOnly; }
    }

    public override Type PropertyType
    {
        get { return this._descr.PropertyType; }
    }
}

最后,我们需要自定义TypeDescriptionProvider并将其绑定到我们的模型类型。默认情况下,TypeDescriptionProviderAttribute旨在执行该绑定。但在这种情况下,我们无法获得我们想要在内部使用的默认提供程序。在大多数情况下,默认提供程序将为ReflectTypeDescriptionProvider。但这并不能保证,并且由于它的保护级别而无法访问此提供程序 - 它是internal。但我们仍然希望回退到默认提供商。

TypeDescriptor还允许通过AddProvider方法为我们的类型显式添加提供程序。这就是我们将要使用的。但首先,让我们定义我们的自定义提供者本身:

public class MyTypeDescriptionProvider : TypeDescriptionProvider
{
    private readonly TypeDescriptionProvider _defaultProvider;

    public MyTypeDescriptionProvider(TypeDescriptionProvider defaultProvider)
    {
        this._defaultProvider = defaultProvider;
    }

    public override ICustomTypeDescriptor GetTypeDescriptor(Type objectType, object instance)
    {
        return new MyTypeDescription(this._defaultProvider.GetTypeDescriptor(objectType, instance));
    }
}

最后一步是将我们的提供程序绑定到我们的模型类型。我们可以以任何我们想要的方式实现它。例如,让我们定义一些简单的类,例如:

public static class TypeDescriptorsConfig
{
    public static void InitializeCustomTypeDescriptorProvider()
    {
        // Assume, this code and all models are in one assembly
        var types = Assembly.GetExecutingAssembly().GetTypes()
                            .Where(t => t.GetProperties().Any(p => p.IsDefined(typeof(CustomBindingNameAttribute))));

        foreach (var type in types)
        {
            var defaultProvider = TypeDescriptor.GetProvider(type);
            TypeDescriptor.AddProvider(new MyTypeDescriptionProvider(defaultProvider), type);
        }
    }
}

并通过网络激活调用该代码:

[assembly: PreApplicationStartMethod(typeof(TypeDescriptorsConfig), "InitializeCustomTypeDescriptorProvider")]

或者只需在Application_Start方法中调用它:

public class MvcApplication : HttpApplication
{
    protected void Application_Start()
    {
        TypeDescriptorsConfig.InitializeCustomTypeDescriptorProvider();

        // rest of init code ...
    }
}

但这不是故事的结局。 :(

考虑以下模型:

public class TestModel
{
    [CustomBindingName("actual_name")]
    [DisplayName("Yay!")]
    public string TestProperty { get; set; }
}

如果我们尝试在.cshtml中查看类似的内容:

@model Some.Namespace.TestModel
@Html.DisplayNameFor(x => x.TestProperty) @* fail *@

我们将获得ArgumentException

  

System.Web.Mvc.dll中发生了'System.ArgumentException'类型的异常,但未在用户代码中处理

     

其他信息:找不到属性Some.Namespace.TestModel.TestProperty。

因为所有帮助者很快或后来都会调用ModelMetadata.FromLambdaExpression方法。这个方法接受我们提供的表达式(x => x.TestProperty)并直接从成员信息中获取成员名称,并且不知道我们的任何属性,元数据(谁在乎,呵呵?)

internal static ModelMetadata FromLambdaExpression<TParameter, TValue>(/* ... */)
{
    // ...

        case ExpressionType.MemberAccess:
            MemberExpression memberExpression = (MemberExpression) expression.Body;
            propertyName = memberExpression.Member is PropertyInfo ? memberExpression.Member.Name : (string) null;
            //                                  I want to cry here - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

    // ...
}

对于x => x.TestProperty(其中xTestModel),此方法将返回TestProperty,而不是actual_name,但模型元数据包含actual_name属性,没有TestProperty。这就是抛出the property could not be found错误的原因。

这是设计失败

然而,尽管有这么一点不便,但仍有几种解决方法,例如:

  1. 最简单的方法是通过他们重新定义的名称访问我们的成员:

    @model Some.Namespace.TestModel
    @Html.DisplayName("actual_name") @* this will render "Yay!" *@
    

    这不好。根本没有intellisense,因为我们的模型更改,我们将没有任何编译错误。任何改变都可以打破,没有简单的方法来检测它。

  2. 另一种方式有点复杂 - 我们可以创建自己的助手版本,并禁止任何人调用默认助手或ModelMetadata.FromLambdaExpression用于具有重命名属性的模型类。

  3. 最后,首选两者的组合:编写自己的模拟以获取具有重定义支持的属性名称,然后将其传递给默认帮助程序。像这样:

    @model Some.Namespace.TestModel
    @Html.DisplayName(Html.For(x => x.TestProperty)) 
    

    编译时和智能感知支持,无需花费大量时间来完成整套帮助。利润!

  4. 上面描述的所有内容都像模型绑定的魅力。在模型绑定过程中,默认绑定器还使用由TypeDescriptor收集的元数据。

    但我认为绑定json数据是最好的用例。您知道,许多Web软件和标准都使用lowercase_separated_by_underscores命名约定。不幸的是,这不是C#的通常惯例。拥有以不同约定命名的成员的课程看起来很丑陋,最终可能会遇到麻烦。特别是当你有工具每次都在抱怨命名违规时。

    ASP.NET MVC默认模型绑定器不会像调用newtonsoft的JsonConverter.DeserializeObject方法时那样将json绑定到模型。相反,json解析为字典。例如:

    {
        complex: {
            text: "blabla",
            value: 12.34
        },
        num: 1
    }
    

    将被翻译成以下字典:

    { "complex.text", "blabla" }
    { "complex.value", "12.34" }
    { "num", "1" }
    

    稍后这些值以及由IValueProvider的不同实现收集的查询字符串,路由数据等中的其他值将被默认绑定器用于通过{收集的元数据来绑定模型{1}}。

    因此,我们从创建模型,渲染,绑定并使用它开始全面循环。

答案 1 :(得分:6)

简短的回答是否定的,长的答案仍然没有。没有内置的帮助器,属性,模型绑定器,无论它是什么(没有任何开箱即用)。

但我在回答之前所做的(我删除了它)是我昨天意识到的一个糟糕的解决方案。我打算把它放在github中,因为谁还想看(也许它解决了某些问题)(我也不建议它!)

现在我再次搜索它,我找不到任何有用的东西。如果您使用类似AutoMapper或ValueInjecter之类的工具来将ViewModel对象映射到Business对象,并且如果您想混淆View Model参数,那么可能您遇到了麻烦。当然你可以做到这一点,但强类型的html助手不会帮助你。我甚至不讨论其他开发人员是否正在分支并处理常见的视图模型。

幸运的是我的项目(4个人正在处理它,以及它的商业用途)现在还没那么大,所以我决定更改View Model属性名称! (还有很多工作要做。数以百计的视图模型来混淆他们的属性!!!)谢谢Asp.Net MVC!

在我提出的链接中有一些方法。但是如果您仍想使用BindAlias属性,我只建议您使用以下扩展方法。至少你不必编写你在BindAlias属性中编写的相同别名字符串。

这是:

public static string AliasNameFor<TModel, TProperty>(this HtmlHelper<TModel> htmlHelper,
    Expression<Func<TModel, TProperty>> expression)
{
    var memberExpression = ExpressionHelpers.GetMemberExpression(expression);
    if (memberExpression == null)
        throw new InvalidOperationException("Expression must be a member expression");
    var aliasAttr = memberExpression.Member.GetAttribute<BindAliasAttribute>();
    if (aliasAttr != null)
    {
        return MvcHtmlString.Create(aliasAttr.Alias).ToHtmlString();
    }
    return htmlHelper.NameFor(expression).ToHtmlString();
}

public static string AliasIdFor<TModel, TProperty>(this HtmlHelper<TModel> htmlHelper,
    Expression<Func<TModel, TProperty>> expression)
{
    var memberExpression = ExpressionHelpers.GetMemberExpression(expression);
    if (memberExpression == null)
        throw new InvalidOperationException("Expression must be a member expression");
    var aliasAttr = memberExpression.Member.GetAttribute<BindAliasAttribute>();
    if (aliasAttr != null)
    {
        return MvcHtmlString.Create(TagBuilder.CreateSanitizedId(aliasAttr.Alias)).ToHtmlString();
    }
    return htmlHelper.IdFor(expression).ToHtmlString();
}



public static T GetAttribute<T>(this ICustomAttributeProvider provider)
    where T : Attribute
{
    var attributes = provider.GetCustomAttributes(typeof(T), true);
    return attributes.Length > 0 ? attributes[0] as T : null;
}

public static MemberExpression GetMemberExpression<TModel, TProperty>(Expression<Func<TModel, TProperty>> expression)
{
    MemberExpression memberExpression;
    if (expression.Body is UnaryExpression)
    {
        var unaryExpression = (UnaryExpression)expression.Body;
        memberExpression = (MemberExpression)unaryExpression.Operand;
    }
    else
    {
        memberExpression = (MemberExpression)expression.Body;
    }
    return memberExpression;
}

当您想要使用它时:

[ModelBinder(typeof(AliasModelBinder))]
public class FilterViewModel
{
    [BindAlias("someText")]
    public string FilterParameter { get; set; }
}

在html中:

@* at least you dont write "someText" here again *@
@Html.Editor(Html.AliasNameFor(model => model.FilterParameter))
@Html.ValidationMessage(Html.AliasNameFor(model => model.FilterParameter))

所以我就像这样离开这个答案。这甚至不是答案(并且MVC 5没有答案)但是在谷歌搜索相同问题的人可能会发现这种体验很有用。

这是github回购:https://github.com/yusufuzun/so-view-model-bind-20869735