EF Core能否在数据库迁移时识别MetadataType特性的注解？

EF Core默认不会自动读取MetadataType特性里的数据注解，你需要通过自定义模型构建器扩展来手动应用这些元数据配置，以下是具体实现步骤：

1. 定义实体类和元数据类 #

假设你的Person类及对应元数据类结构如下：

using System.ComponentModel.DataAnnotations;

public class Person
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
}

[MetadataType(typeof(PersonMetadata))]
public partial class Person { }

public class PersonMetadata
{
    [MaxLength(50)]
    public string Name { get; set; }

    [MaxLength(100)]
    [EmailAddress]
    public string Email { get; set; }
}

2. 创建模型构建器扩展方法 #

添加静态类，用于扫描并应用元数据类中的注解配置：

using Microsoft.EntityFrameworkCore;
using System.ComponentModel.DataAnnotations;
using System.Reflection;

public static class ModelBuilderExtensions
{
    public static void ApplyMetadataTypeConfigurations(this ModelBuilder modelBuilder)
    {
        // 遍历所有实体类型
        foreach (var entityType in modelBuilder.Model.GetEntityTypes())
        {
            var entityClrType = entityType.ClrType;
            // 获取实体类上的MetadataType特性
            var metadataTypeAttribute = entityClrType.GetCustomAttribute<MetadataTypeAttribute>();
            if (metadataTypeAttribute == null) continue;

            var metadataClrType = metadataTypeAttribute.MetadataClassType;
            // 遍历元数据类的属性，匹配实体类属性并应用注解
            foreach (var property in metadataClrType.GetProperties())
            {
                var entityProperty = entityType.FindProperty(property.Name);
                if (entityProperty == null) continue;

                // 获取属性上的所有验证注解
                var attributes = property.GetCustomAttributes(true).OfType<ValidationAttribute>();
                foreach (var attribute in attributes)
                {
                    // 根据注解类型配置EF Core模型
                    switch (attribute)
                    {
                        case MaxLengthAttribute maxLengthAttr:
                            entityProperty.SetMaxLength(maxLengthAttr.Length);
                            break;
                        case MinLengthAttribute minLengthAttr:
                            entityProperty.SetMinLength(minLengthAttr.Length);
                            break;
                        case RequiredAttribute _:
                            entityProperty.IsRequired = true;
                            break;
                        case EmailAddressAttribute _:
                            entityProperty.SetColumnType("varchar(100)");
                            break;
                        // 可根据需求扩展更多注解类型的处理逻辑
                    }
                }
            }
        }
    }
}

3. 在DbContext中调用扩展方法 #

在你的DbContext的OnModelCreating方法里引入该扩展：

public class AppDbContext : DbContext
{
    public DbSet<Person> Persons { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        // 配置数据库连接字符串
        optionsBuilder.UseSqlServer("YourConnectionString");
    }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);
        // 应用元数据类的注解配置
        modelBuilder.ApplyMetadataTypeConfigurations();
    }
}

4. 生成并执行迁移 #

现在执行迁移命令，EF Core就能识别MetadataType中定义的MaxLength等注解：

Add-Migration ApplyPersonMetadata
Update-Database

注意事项 #

• 元数据类的属性名称必须和实体类完全一致，否则无法匹配生效
• 若同时使用Fluent API配置，Fluent API的优先级会高于元数据类的注解
• 可根据业务需求，在扩展方法中增加更多注解类型的处理逻辑

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