如何创建可被EF Code First迁移识别的组合式C#特性

你碰到的这个重复定义特性的问题太常见了——多个实体类里的CustomerNo属性要反复写相同的Column、MaxLength和Display特性，不仅麻烦还容易写错。EF Code First确实只认编译时直接挂在属性上的特性，所以你之前试的那种在自定义特性里实例化其他特性的思路走不通，EF根本不会去解析自定义特性内部的内容。下面给你几个靠谱的解决方案，按实用性排序：

方案1：元数据类+继承（推荐） #

这个方案完美兼顾EF迁移识别和UI特性需求，还能避开C#单继承的限制，是最稳妥的选择。

步骤： #

1. 创建一个元数据类，把CustomerNo的所有特性集中定义：

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

public class CustomerNoMetadata
{
    [Column(TypeName = "varchar")]
    [MaxLength(15)]
    [Display(Name = "Customer Identifier")]
    public string CustomerNo { get; set; }
}

2. 创建一个空的抽象基类，关联上面的元数据：

[MetadataType(typeof(CustomerNoMetadata))]
public abstract class HasCustomerNo
{
    public string CustomerNo { get; set; }
}

3. 让你的实体类继承这个基类即可：

[Table("foo")]
public class foo : HasCustomerNo
{
    // 其他自定义属性...
}

[Table("bar")]
public class bar : HasCustomerNo
{
    // 其他自定义属性...
}

这样所有继承HasCustomerNo的实体类，CustomerNo属性都会自动应用元数据里的特性，EF迁移能正常识别，UI端的Display特性也能生效，而且不会生成额外的数据库表，完全满足你直接查询CustomerNo的需求。

方案2：自定义EF Code First约定 #

如果你不想用继承，可以通过EF的自定义约定批量配置属性，适合只需要处理EF数据库映射规则的场景。

步骤： #

1. 创建自定义约定类，匹配所有CustomerNo属性并配置规则：

using System.Data.Entity.ModelConfiguration.Conventions;
using System.Reflection;

public class CustomerNoConvention : IConfigurationConvention<PropertyInfo, PrimitivePropertyConfiguration>
{
    public void Apply(PropertyInfo propertyInfo, PrimitivePropertyConfiguration configuration)
    {
        // 匹配所有名为CustomerNo的string类型属性
        if (propertyInfo.Name == "CustomerNo" && propertyInfo.PropertyType == typeof(string))
        {
            configuration.MaxLength(15);
            configuration.HasColumnType("varchar");
        }
    }
}

2. 在DbContext中注册这个约定：

protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
    modelBuilder.Conventions.Add(new CustomerNoConvention());
    // 其他数据库配置...
}

注意：这个方案只处理EF的数据库映射规则，UI端的Display特性需要单独处理，比如可以在启动时通过反射批量给CustomerNo属性添加DisplayAttribute（属于小hack，但能生效）。

方案3：直接继承基类 #

如果你的实体类没有其他基类需要继承，这个方案最直接：

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

public abstract class BaseEntityWithCustomerNo
{
    [Column(TypeName = "varchar")]
    [MaxLength(15)]
    [Display(Name = "Customer Identifier")]
    public string CustomerNo { get; set; }
}

[Table("foo")]
public class foo : BaseEntityWithCustomerNo
{
    // 其他自定义属性...
}

[Table("bar")]
public class bar : BaseEntityWithCustomerNo
{
    // 其他自定义属性...
}

缺点是受限于C#单继承规则，如果实体类已经有基类就没法用了。

方案4：T4模板生成重复代码 #

如果你有大量实体类需要添加CustomerNo属性，可以用T4模板自动生成属性和特性，避免手动重复编写：

示例T4模板片段：

<#@ template language="C#" #>
<#@ assembly name="System.Core" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Reflection" #>

<# 
// 替换为你的实体类所在命名空间
var entityTypes = Assembly.GetExecutingAssembly().GetTypes()
    .Where(t => t.Namespace == "YourProject.Entities"); 
#>

<# foreach (var type in entityTypes) { #>
[Table("<#= type.Name.ToLower() #>")]
public class <#= type.Name #>
{
    // 自动生成CustomerNo属性及特性
    [Column(TypeName="varchar")]
    [MaxLength(15)]
    [Display(Name="Customer Identifier")]
    public string CustomerNo {get; set;}
    
    // 手动添加其他属性...
}
<# } #>

这个方案适合批量生成场景，但需要维护模板，灵活性稍差。

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