讲师中心 微信公众号
AI工具推荐 视频效率加速

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

落伟同学_1070

落伟同学_1070

发布时间:2026-01-03 09:53:02

|

771人浏览过

|

来源于php中文网

原创

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

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

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

什么是模型约定(Model Convention)

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

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

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

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

  • IModelConvention:最基础接口,接收整个 IMutableModel,适合全局调整(如统一禁用复数表名)
  • IEntityTypeConvention<TEntity>:按实体类型精准作用,例如对所有继承自 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();
        }
    }
}

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

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

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

相关专题

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

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

4363

2023.10.12

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

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

911

2023.10.27

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

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

1149

2024.02.23

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

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

6301

2024.03.06

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

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

3123

2024.03.06

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

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

6280

2024.04.07

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

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

8521

2024.04.29

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

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

1150

2024.04.29

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

60

2026.10.16

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn