将新属性添加到MVC ModelMetadata

时间:2014-04-03 09:59:53

标签: asp.net-mvc asp.net-mvc-4 modelmetadata modelmetadataprovider

我正在寻找替代方法,例如AdditionalValues,但我想知道是否可以在可以向ModelMetadata对象中添加新属性的情况下结束模板视图。

例如,您可以:

@ViewData.ModelMetadata.MvvmBound

我想在编辑器和显示模板中使用它来将MVVM属性添加到正在呈现的HTML元素中。

我完全迷失了,但到目前为止我的努力是:

public class MyModelMetaDataProvider : DataAnnotationsModelMetadataProvider
{
    protected new MyModelMetaData CreateMetadata(IEnumerable<Attribute> attributes, Type containerType, Func<object> modelAccessor, Type modelType, string propertyName)
    {
        ModelMetadata modelMetaData = base.CreateMetadata(attributes, containerType, modelAccessor, modelType, propertyName);
        MyModelMetaData myMetaData = (MyModelMetaData)modelMetaData;

        return myMetaData;
    }
}

public class MyModelMetaData: ModelMetadata
{
    public MyModelMetaData(ModelMetadataProvider provider, Type containerType, Func<object> modelAccessor, Type modelType, string propertyName)
        : base(provider, containerType, modelAccessor, modelType, propertyName)
    {

    }

    public int MyProperty { get; set; }
}  

然后在全球的asax中我使用:

ModelMetadataProviders.Current =new MyModelMetaDataProvider();

问题是如果我尝试在视图中使用MyProperty它不被识别,我预计这是因为VS不了解自定义的ModelMetadata类。

我甚至不确定这是可能的吗?

1 个答案:

答案 0 :(得分:11)

AdditionalValues课程中有一个字典ModelMetadataRef here

您可以使用AdditionalMetadata属性向该词典添加值,如:

public class DummyModel
{
    [AdditionalMetadata("MvvmBound", true)]
    public string PropertyA{ get; set; }

    public string PropertyB{ get; set; }
}

您可以在string编辑器模板中查看这些内容,例如:

@{
    bool isBound = false;
    if(ViewData.ModelMetadata.AdditionalValues.ContainsKey("MvvmBound"))
    {
        isBound = (bool)ViewData.ModelMetadata.AdditionalValues["MvvmBound"];    
    }
}

//use isBound to set some attributes in the html element

您可能还想在DummyModel的编辑器模板中检查这些属性,您可以在其中检索各个属性的元数据,如下所示:

@ModelMetadata.FromLambdaExpression(x => x.PropertyA, ViewData).AdditionalValues["MvvmBound"] 

这段代码有一些缺点。该方法需要将键名传递给AdditionalValues字典,您还需要将值从object转换为正确的类型。您可以创建自己的扩展方法,以便从元数据中检索该值,而无需手动提供密钥名称并手动执行转换:

public static class ModelMetadataExtensions
{
    public static bool IsMvvmBound(this ModelMetadata metadata)
    {
        if (!metadata.AdditionalValues.ContainsKey("MvvmBound")) return false;
        return (bool)metadata.AdditionalValues["MvvmBound"];
    }
}

这将允许您在编辑器模板中使用更干净的代码。例如,在上面DummyModel的编辑器模板中,你可以做类似的事情(记得将扩展方法的命名空间添加到/ Views文件夹中的Web.config文件中):

<h3>WholeModel Is MvvmBound?: @ViewData.ModelMetadata.IsMvvmBound()</h3>
<h3>PropertyA Is MvvmBound?: @ModelMetadata.FromLambdaExpression(x => x.PropertyA, ViewData).IsMvvmBound()</h3>
<h3>PropertyB Is MvvmBound?: @ModelMetadata.FromLambdaExpression(x => x.PropertyB, ViewData).IsMvvmBound()</h3>

您可以将该扩展方法与扩展IMetadataAware的自定义属性配对,这样您就不必每次在属性上使用时都需要对元数据值的密钥名称进行硬编码:

public class IsMvvmBoundAttribute : Attribute, IMetadataAware 
{
    public IsMvvmBoundAttribute()
    {
        this.IsMvvmBound = true;
    }

    public bool IsMvvmBound { get; set; }

    //This is the single method of IMetadataAware, and what allows us to add the values into the AdditionalValues dictionary
    public void OnMetadataCreated(ModelMetadata metadata)
    {
        metadata.AdditionalValues.Add("MvvmBound", this.IsMvvmBound);
    }
}

public class DummyModel
{
    //[AdditionalMetadata("MvvmBound", true)] <- replaced with the new attribute
    [IsMvvmBoundAttribute]
    public string PropertyA{ get; set; }

    public string PropertyB{ get; set; }
}

由于ModelMetadata.AdditionalValuesDictionary<string,object>,因此您不仅限于为每个键存储一个简单的值。您可以按照上面的代码创建自己的类,其中包含您需要的所有属性,可用于设置每个值的属性,并将该类的实例保存到AdditionalValues字典以及提取实例的扩展方法从字典中的那个类。

正如您所看到的,您可以在不需要自己的ModelMetadata课程或扩展ModelMetadataProvider的情况下走得很远。

希望它有所帮助!