ASP.NET Core元数据加载：MVC项目非修改脚手架类添加数据注解问题

我目前正在用ASP.NET Core的MVC模板开发项目，已经通过Entity Framework对现有数据库完成了脚手架生成操作。现在需要给实体类添加Data Annotations验证规则，但又不想直接修改脚手架自动生成的类——毕竟后续如果重新生成脚手架，手动加的注解肯定会被覆盖，所以打算通过元数据类配合重写SaveChanges方法来实现这个需求。

先贴一下脚手架自动生成的Users.cs代码片段：

public partial class Users 
{ 
    public int UserId { get; set; } 
    // 其他实体属性...
    // 如果直接在这里加[MaxLength(5, ErrorMessage = "Too short")]这类注解，后续重新脚手架会丢失
}

下面是具体的实现步骤：

1. 创建独立的元数据类 #

首先给Users类创建对应的元数据类，把所有需要的Data Annotations规则都写在这里，完全和自动生成的实体类解耦：

public class UsersMetadata
{
    [MaxLength(5, ErrorMessage = "用户名长度不能超过5个字符")]
    [Required(ErrorMessage = "用户名不能为空")]
    public string UserName { get; set; } // 示例：给UserName属性加验证

    // 其他需要添加验证规则的属性，一一对应实体类的属性名即可
}

2. 通过Partial类关联元数据 #

因为脚手架生成的Users是partial类，我们可以新建一个独立的partial类文件，用[MetadataType]特性把元数据类和实体类关联起来：

[MetadataType(typeof(UsersMetadata))]
public partial class Users
{
    // 这里不需要写任何额外逻辑，只是作为元数据和自动生成类的关联桥梁
}

这样后续哪怕重新生成脚手架，这个自定义的partial类也不会被覆盖，元数据里的验证规则依然有效。

3. 重写SaveChanges实现服务器端统一验证（可选但推荐） #

如果想在数据保存到数据库前强制触发验证，可以在你的DbContext里重写SaveChanges和SaveChangesAsync方法，确保所有待保存的实体都经过验证：

public class YourDbContext : DbContext
{
    // 构造函数、DbSet定义等原有代码...

    public override int SaveChanges()
    {
        ValidatePendingEntities();
        return base.SaveChanges();
    }

    public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
    {
        ValidatePendingEntities();
        return await base.SaveChangesAsync(cancellationToken);
    }

    private void ValidatePendingEntities()
    {
        // 获取所有新增或修改的实体
        var pendingEntities = ChangeTracker.Entries()
            .Where(e => e.State == EntityState.Added || e.State == EntityState.Modified)
            .Select(e => e.Entity);

        var validationContext = new ValidationContext(this);
        var validationErrors = new List<ValidationResult>();

        foreach (var entity in pendingEntities)
        {
            if (!Validator.TryValidateObject(entity, validationContext, validationErrors, validateAllProperties: true))
            {
                // 验证不通过时抛出异常，阻止数据保存
                throw new ValidationException(string.Join("\n", validationErrors.Select(r => r.ErrorMessage)));
            }
        }
    }
}

这样不管是通过MVC控制器还是其他方式操作数据，只要调用SaveChanges，就会自动触发元数据里的验证规则，避免无效数据进入数据库。

额外提示 #

• 元数据类的属性名称必须和实体类的属性完全一致，否则注解不会生效。
• 如果是MVC视图的客户端验证，只要元数据关联正确，ModelState会自动识别这些规则，前端的验证提示也能正常工作。

内容的提问来源于stack exchange，提问作者Jolly