EF .NET 6数据库优先模式下数据注解无法生效的求助

问题背景 #

通过Scaffold-DbContext生成Product模型类后，为避免重新生成模型丢失数据注解，创建了ProductMetadata元数据类并通过[MetadataType]特性关联到Product分部类，但设置的Display名称不显示、Required验证也未生效。直接在原模型类添加注解则一切正常，已尝试清理重建、清除浏览器缓存、重启VS2022、核对命名空间和类可访问性等操作。

相关代码 #

生成的原模型类

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;

namespace EFDBFirst.Models
{
    public partial class Product
    {
        public Product()
        {
            OrderDetails = new HashSet<OrderDetail>();
        }

        public int ProductId { get; set; }
        public string ProductName { get; set; } = null!;
        public int? SupplierId { get; set; }
        public int? CategoryId { get; set; }        
        public string? QuantityPerUnit { get; set; }
        public decimal? UnitPrice { get; set; }
        public short? UnitsInStock { get; set; }
        public short? UnitsOnOrder { get; set; }
        public short? ReorderLevel { get; set; }
        public bool Discontinued { get; set; }

        public virtual Category? Category { get; set; }
        public virtual ICollection<OrderDetail> OrderDetails { get; set; }
    }
}

原错误元数据类

using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.Diagnostics;

namespace EFDBFirst.Models
{    
    public partial class ProductMetadata
    {
        [Required(ErrorMessage = @"Qty/Unit is required")]
        [Display(Name ="QPU")]
        public string? QuantityPerUnit { get; set; }
    }
}

关联的分部类

using System.ComponentModel;
using System.ComponentModel.DataAnnotations;

namespace EFDBFirst.Models
{
    [MetadataType(typeof(ProductMetadata))]
    public partial class Product
    {
    }
}

问题排查与修复步骤 #

1. 移除元数据类的partial修饰符 #

元数据类是独立的辅助类，不需要标记为partial（它不是Product类的分部实现）。修改后的元数据类：

using System.ComponentModel.DataAnnotations;

namespace EFDBFirst.Models
{    
    public class ProductMetadata // 移除partial修饰符
    {
        [Required(ErrorMessage = "Qty/Unit is required")]
        [Display(Name = "QPU")]
        public string? QuantityPerUnit { get; set; }
    }
}

2. 确保视图正确使用强类型辅助方法 #

验证视图中必须使用Html.LabelFor、Html.EditorFor、Html.ValidationMessageFor等强类型辅助方法，这些方法会自动读取元数据中的注解配置。示例：

@model EFDBFirst.Models.Product

<div class="form-group">
    @Html.LabelFor(m => m.QuantityPerUnit)
    @Html.EditorFor(m => m.QuantityPerUnit, new { htmlAttributes = new { @class = "form-control" } })
    @Html.ValidationMessageFor(m => m.QuantityPerUnit, "", new { @class = "text-danger" })
</div>

如果直接使用硬编码HTML标签（如<label>QuantityPerUnit</label>），不会读取元数据的Display名称。

3. 确认元数据提供器已正确注册 #

• ASP.NET Core项目：在Program.cs中确保添加数据注解服务（默认已注册，显式声明可避免潜在问题）：

builder.Services.AddControllersWithViews()
    .AddDataAnnotationsLocalization();

• ASP.NET MVC项目：在Global.asax的Application_Start方法中添加：

protected void Application_Start()
{
    // 其他配置...
    ModelMetadataProviders.Current = new DataAnnotationsModelMetadataProvider();
}

4. 检查分部类与原模型的一致性 #

• 确保[MetadataType]标记的分部类和原Product类在同一命名空间、同一程序集中。
• 确认分部类文件未被排除在项目编译外（右键文件→属性→生成操作设置为"编译"）。

5. 重新编译验证 #

执行清理解决方案→重建解决方案操作，确保所有代码变更被编译到程序集中。

内容的提问来源于stack exchange，提问作者J. Barrett