如何在不修改生成文件的情况下为EF自动生成的实体类添加自定义属性？

你遇到的核心问题在于：EF自动生成的实体类是部分类（partial class），直接编辑生成文件会被后续重新生成覆盖，而元数据类（Metadata Class）是正确的无侵入式解决方案，但自定义属性不会自动关联到原实体的属性上，需要通过特定方式读取。

一、正确的实现步骤 #

1. 创建元数据类

首先定义一个与目标实体结构一致的元数据类，在对应的属性上添加你的自定义特性：

// 自定义属性示例
public class MyCustomAttribute : Attribute
{
    public string Description { get; set; }
    public MyCustomAttribute(string description)
    {
        Description = description;
    }
}

// 元数据类，镜像实体类的属性结构
public class MyEntityMetadata
{
    [MyCustomAttribute("这是KeyOne的自定义描述")]
    public string KeyOne { get; set; }

    [MyCustomAttribute("这是KeyTwo的自定义描述")]
    public string KeyTwo { get; set; }
}

2. 关联元数据类到实体的部分类

创建一个与自动生成实体同名的部分类，使用[MetadataType]特性绑定元数据类：

// 注意：必须与自动生成的实体类处于同一命名空间
[MetadataType(typeof(MyEntityMetadata))]
public partial class MyEntity
{
    // 无需重复定义属性，仅需添加元数据绑定特性
}

3. 正确读取自定义属性

直接通过原实体类的PropertyInfo无法获取元数据类中的属性，需要先获取元数据类型，再从中读取属性：

public static IEnumerable<Attribute> GetCustomAttributesFromMetadata<TEntity>(string propertyName)
{
    // 获取实体类上的MetadataType特性
    var metadataAttr = typeof(TEntity).GetCustomAttribute<MetadataTypeAttribute>();
    if (metadataAttr == null)
        return Enumerable.Empty<Attribute>();

    // 从元数据类中获取对应属性
    var metadataProperty = metadataAttr.MetadataClassType.GetProperty(propertyName);
    return metadataProperty?.GetCustomAttributes() ?? Enumerable.Empty<Attribute>();
}

// 使用示例
var attributes = GetCustomAttributesFromMetadata<MyEntity>("KeyOne");
foreach (var attr in attributes)
{
    if (attr is MyCustomAttribute customAttr)
    {
        Console.WriteLine($"Found KeyOne，描述：{customAttr.Description}");
    }
}

二、关键说明 #

• 元数据类的作用：它是为了在不修改生成文件的前提下，给实体属性添加额外特性（包括数据注解和自定义属性），EF会自动识别元数据类中的数据注解，但自定义属性需要手动读取。
• 命名空间一致性：你的部分类必须和自动生成的实体类处于同一个命名空间，否则MetadataType特性无法生效。
• 属性匹配：元数据类中的属性名称、类型必须和实体类完全一致，否则无法关联。

三、排查你当前的问题 #

你提到测试输出Found KeyOne，可能是因为你只检查了属性是否存在，而没有正确从元数据类中读取自定义属性。按照上面的读取方法，就能获取到你添加的自定义特性了。

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