EF Core如何实现自定义约定 EF Core Conventions配置教程

EF Core自定义约定是统一控制模型构建行为的高效方式，通过IModelConvention等接口在模型构建早期修改元数据，适用于批量配置命名规范、主键规则等场景，比OnModelCreating更简洁灵活。

EF Core 的自定义约定（Conventions）是统一控制模型构建行为的高效方式，适合批量处理命名规范、默认配置、关系规则等场景。它比在每个实体上写 OnModelCreating 更简洁，也比全局配置更灵活。

什么是模型约定（Model Convention）

模型约定是在 EF Core 构建 IMutableModel 过程中自动执行的规则，运行时机早于 OnModelCreating，可修改实体、属性、关系、索引等元数据。它不依赖具体实体类型，而是基于模型结构动态生效。

• 适用于所有实体，无需重复配置
• 可覆盖默认行为（如主键命名、表名复数化）
• 不能访问实体实例或运行时数据，只操作元数据

实现自定义约定的两种方式

EF Core 提供了接口级和泛型类级两种扩展点，推荐使用泛型基类，更安全且易测试。

• IModelConvention：最基础接口，接收整个 IMutableModel，适合全局调整（如统一禁用复数表名）
• IEntityTypeConvention：按实体类型精准作用，例如对所有继承自 IAuditable 的实体自动添加 CreatedAt 属性配置
• PropertyAttributeConvention：配合自定义特性（如 [IsRowVersion]）自动设为并发令牌

实战：自动将 Id 属性设为主键并启用自增

不用在每个实体里写 HasKey(x => x.Id)，用约定统一处理：

public class IdAsKeyConvention : IEntityTypeConvention {     public void ProcessEntityTypeAdded(IConventionEntityTypeBuilder entityTypeBuilder,          IConventionContext context)     {         var idProperty = entityTypeBuilder.Metadata.FindProperty("Id");         if (idProperty != null && idProperty.ClrType == typeof(int) || idProperty.ClrType == typeof(long))         {             entityTypeBuilder.HasKey("Id");             entityTypeBuilder.Property("Id").ValueGeneratedOnAdd();         }     } }

注册方式（OnConfiguring 或 AddDbContext）：

protected override void ConfigureConventions(ModelConfigurationBuilder configurationBuilder) {     configurationBuilder.Conventions.Add(_ => new IdAsKeyConvention()); }

常见约定场景与建议

实际项目中高频使用的约定逻辑：

• 表名自动转为小写下划线格式（BlogPost → blog_post）
• 所有字符串属性默认设最大长度 256，避免 sql Server 默认 nvarchar(max)
• 标记 [DeletedAt] 的 DateTime? 属性自动设为软删除查询过滤器
• 外键属性自动忽略导航属性命名冲突（如 AuthorId + Author 不报错）

注意：约定执行顺序会影响结果，EF Core 内置约定优先级固定，自定义约定默认追加在末尾；如需前置，可用 Conventions.AddBefore/After 调整。

基本上就这些。自定义约定不是万能的，复杂逻辑仍建议保留在 OnModelCreating；但只要规则清晰、跨实体复用度高，用约定就能让模型配置更干净、更可维护。