将多个接口与 MVC DataAnnotations 和 MetaDataType 结合使用

Question

我正在使用 DataAnnotations 将验证应用于 MVC ViewModel，它是多个实体框架对象和一些自定义逻辑的组合。接口中的实体对象已经定义了验证，但是如何将此验证应用于 ViewModel？

我最初的想法是将这些接口合并为一个，并将合并后的接口应用到 ViewModel，但这不起作用。下面是一些示例代码，演示了我的意思：

// interfaces containing DataAnnotations implemented by entity framework classes
public interface IPerson
{
    [Required]
    [Display(Name = "First Name")]
    string FirstName { get; set; }

    [Required]
    [Display(Name = "Last Name")]
    string LastName { get; set; }

    [Required]
    int Age { get; set; }
}
public interface IAddress
{
    [Required]
    [Display(Name = "Street")]
    string Street1 { get; set; }

    [Display(Name = "")]
    string Street2 { get; set; }

    [Required]
    string City { get; set; }

    [Required]
    string State { get; set; }

    [Required]
    string Country { get; set; }
}

// partial entity framework classes to specify interfaces
public partial class Person : IPerson {}
public partial class Address : IAddress {}

// combined interface
public interface IPersonViewModel : IPerson, IAddress {}

// ViewModel flattening a Person with Address for use in View
[MetadataType(typeof(IPersonViewModel))] // <--- This does not work. 
public class PersonViewModel : IPersonViewModel
{
    public string FirstName { get; set; }

    public string LastName { get; set; }

    public int Age { get; set; }

    public string Street1 { get; set; }

    public string Street2 { get; set; }

    public string City { get; set; }

    public string State { get; set; }

    public string Country { get; set; }
}

我的实际问题涉及 ViewModel 上的大约 150 个属性，因此它并不像示例那么简单，并且重新输入所有属性似乎严重违反了 DRY。

关于如何实现这一目标有什么想法吗？

Answer 1

为了使其工作，您需要手动将接口关联为具体类的元数据。

我希望能够添加多个 MetadataType 属性，但这是不允许的。

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)] // Notice AllowMultiple
public sealed class MetadataTypeAttribute : Attribute

因此，这会产生编译错误：

[MetadataType(typeof(IPerson))] 
[MetadataType(typeof(IAddress))] // <--- Duplicate 'MetadataType' attribute 
public class PersonViewModel : IPersonViewModel

但是，如果您只有一个接口，它就可以工作。因此，我的解决方案是简单地使用 AssociatedMetadataTypeTypeDescriptionProvider 关联接口，并将其包装在另一个属性中。

[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
public class MetadataTypeBuddyAttribute : Attribute
{
    public MetadataTypeBuddyAttribute(Type modelType, Type buddyType)
    {
        TypeDescriptor.AddProviderTransparent(
           new AssociatedMetadataTypeTypeDescriptionProvider(
               modelType,
               buddyType
           ),
           modelType);
    }
}

在我的情况（MVC4）中，我的接口上的数据注释属性已经起作用了。这是因为我的模型直接实现接口而不是具有多级继承。但是，在接口级别实现的自定义验证属性不起作用。

仅当手动关联接口时，所有自定义验证才会相应地起作用。如果我正确理解你的情况，这也是你问题的解决方案。

[MetadataTypeBuddy(typeof(PersonViewModel), typeof(IPerson))] 
[MetadataTypeBuddy(typeof(PersonViewModel), typeof(IAddress))]
public class PersonViewModel : IPersonViewModel

Answer 2

根据此处的答案，我无法以某种方式使 MetadataTypeBuddy 属性起作用。我确信我们必须在某个地方设置 MVC 应该调用该属性。当我像这样在 Application_Start() 中手动运行该属性时，我设法让它工作

new MetadataTypeBuddyAttribute(typeof(PersonViewModel), typeof(IPerson));
new MetadataTypeBuddyAttribute(typeof(PersonViewModel), typeof(IAddress));

Answer 3

MetadataTypeBuddy 属性对我不起作用。
但是在“启动”中添加“新”MetadataTypeBuddyAttribute 确实有效但是它可能会导致复杂的代码，开发人员不知道在任何新类的“启动”中添加它。

注意：您只需在每个类的应用程序启动时调用一次 AddProviderTransparent 即可。

这是为类添加多个元数据类型的线程安全方法。

    [AttributeUsage(AttributeTargets.Class)]
    public class MetadataTypeMultiAttribute : Attribute
    {
        private static bool _added = false;
        private static readonly object padlock = new object();

        public MetadataTypeMultiAttribute(Type modelType, params Type[] metaDataTypes)
        {
            lock (padlock)
            {
                if (_added == false)
                {
                    foreach (Type metaDataType in metaDataTypes)
                    {
                        System.ComponentModel.TypeDescriptor.AddProviderTransparent(
                            new AssociatedMetadataTypeTypeDescriptionProvider(
                                modelType,
                                metaDataType
                            ),
                            modelType);
                    }

                    _added = true;
                }
            }
        }
    }