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

落伟同学_1070

落伟同学_1070

2026-01-03

771人浏览

原创

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

ef core如何实现自定义约定 ef core conventions配置教程

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<iconventionentitytypebuilder> 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();
        }
    }
}</iconventionentitytypebuilder>

注册方式(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;但只要规则清晰、跨实体复用度高,用约定就能让模型配置更干净、更可维护。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

2023.10.12

5083

8

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.27

1031

4

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

2024.02.23

1329

5

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2024.03.06

7161

10

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

2024.03.06

3783

4

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

2024.04.07

7140

11

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

2024.04.29

10021

6

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

1370

5

sql中删除一列的命令是什么
sql中删除一列的命令是什么

在sql中,使用alter table语句可以删除一列,语法为:alter table table_name drop column column_name。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

1192

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.3万人学习