EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

上一节我们针对最开始抛出的异常只是进行了浅尝辄止的解析,是不是有点意犹未尽的感觉,是的,我也有这种感觉,看到这里相信您和我会有一些疑惑,要是我们接下来通过注解、Fluent APi、DbSet分别对表名进行如下设置,那么其优先级到底是怎样的呢?内置具体是如何实现的呢?让我们从头开始揭开其神秘的面纱。

既然涉及到表名解析优先级,那么接下来我们进行如下配置,模型请参考上一节内容

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

在还未进入原理解析之前,让我们大胆猜测通过如上配置后优先级将是怎样的呢?是Fluent Api > 注解 > DbSet > 约定吗?假设是这样的话,EntityFramework Core内置是怎样实现的呢?是采用覆盖的机制吗?

一堆疑问浮现在我们眼前,来,让我们进入探究枯燥源码的世界,为您一一解惑。首先我们需要明确的是,在我们实例化上下文进行操作之前,EntityFramework Core具体做了些什么?故事就要从我们派生自DbContext上下文说起,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

在EntityFramework Core中我们利用上下文进行操作之前就是按照上述代码由上至下整体上做了如下三步准备工作:

【1】实例化上下文时,查找DbSet属性并缓存到内存中。

【2】以上下文作为缓存的键,获取缓存在内存中的模型数据。

【3】若未缓存,则创建上下文中所有模型有关数据。

查找DbSet属性并缓存

接下来我们步步分析,步步逼近以上三步操作实现,无论是主动实例化还是在Web中添加上下文中间件时,都必须经过将我们需要用到所有接口进行依赖注入

当然EntityFramework Core引用的是.NET Core中依赖注入库,至于注册了哪些,这些细节我们并不关心,我们只关注所需要用到的且会一一说明,获取接口IDbSetInitializer的具体实现DbSetInitializer,调用该类中的如下方法:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

接下来获取接口IDbSetFinder的具体实现DbSetFinder去过滤查找存在Setter属性的DbSet(这点就不用我解释),查找细节我们不关心,每个DbSet都有其DbSetProperty属性,所以查找到后添加到该属性并缓存到IDbSetCache中,到此对于DbSet的查找和缓存就已完事,接下来去创建上下文中的所有模型数据。

创建上下文模型

首先是去获取上下文中所有模型数据,以上下文为键去查找缓存的模型数据,若没有则创建,否则创建缓存,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

接下来到了缓存不存在创建模型的环节,创建模型主要做了以下三件事。

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

当实例化ModelBuilder通过约定分发机制处理各个约定,具体做了哪些操作呢?主要做了以下三件事

【1】各个约定进行初始化做一些准备工作,并将其添加到对应约定集合中去。

【2】遍历自定义约定插件集合,修改对应默认约定并返回最新约定集合。

【3】通过约定分发机制,处理获取得到的最新约定集合。 

上述第【1】和【2】步通过如下代码实现:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

EntityFramework Core内置提供了三个创建默认约定集合提供者接口IProviderConventionSetBuilder的具体实现,三者属于继承关系。

【1】ProviderConventionSetBuilder:构建针对数据库使用的默认约定集合的提供者

【2】RelationalConventionSetBuilder:构建模型与数据库映射的默认约定集合的提供者

【3】SqlServerConventionSetBuilder:针对SQL Server数据库构建默认约定集合的提供者

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

我们用不到的约定已经剔除,上述向实体类型添加约定集合中先后添加了RelationalTableAttributeConvention和TableNameFromDbSetConvention对于表名的约定,对于TableNameFromDbSetConvention约定在构造实例化时做了如下操作:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

我们继续看上述通过上下文是如何获取对应模型的DbSet属性的呢?

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

因为在初始化上下文时我们就已经对上下文中的所有DbSet属性进行了缓存,所以通过如上方法就是获取模型与对应上下文缓存的DbSet属性的映射,还是很好理解,如下也给出调试源码时所显示Blog对应的DbSet属性信息。

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

现在我们已经获取到了所有默认约定集合,接下来实例化ModelBuilder,将默认约定集合作为参数传进去,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

接下来继续实例化Model,传入默认约定集合,开始实例化约定分配类并通过约定分发机制对模型进行处理,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

上述ConventionDispatcher类就是对模型的各个阶段进行分发处理,关于分发处理机制后续再单独通过一篇文章来详细分析,因为上述我们将表名的两个约定放在EntityTypeAddedConventions集合中,接下来我们来到约定分发机制对该约定集合中12个默认约定遍历处理,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

因为首先添加的RelationalTableAttributeConvention约定,所以当遍历到RelationalTableAttributeConvention约定时,就去到处理该约定的具体实现,说白了该约定就是获取表名的注解即遍历特性,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

方法ProcessEntityTypeAdded的最终具体实现就是设置对应具体模型的表名,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

有童鞋就问了,我们在表特性上只定义架构名称,那么上述不就产生bug了吗,用过注解的都知道既然在表特性上提供了架构名称,那么表名必须提供,但是表名提供,架构名称可不提供,所以上述处理逻辑并没任何毛病。  

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

我们继续看上述在RelationalEntityTypeBuilderExtensions类中对于ToTable方法的实现,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

我们看到该方法主要目的是判断该表名是否可设置,若不可设置则返回空,否则将设置该注解的名称作为模型的表名,我们看看上述CanSetTable又是如何判断是否可设置呢?

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

注:RelationalAnnotationNames.TableName是专为通过注解获取表名而定义的常量其值为Relational:TableName

真是一层套一层,此时在注解字典中不存在该键,最终当然也就将模型的表特性名称作为模型的表名,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

上述就是ToTable方法中调用第一个方法CanSetTable是否可设置表名的过程,主要就是在注解字典中查找注解名称为Relational:TableName是否已存在的过程,我们可以看到注解字典中不存在表名的注解名称,接下来调用第二个方法SetTableName方法去设置表名

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

接下来将是向注解字典中添加名为Relational:TableName,值为Blog2的注解,通过如下图监视可以清楚看到:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

到目前为止,对于模型Blog已经通过注解即表特性设置了表名,接下来处理约定TableNameFromDbSetConvention,到底是覆盖还是跳过呢?我们还是一探其实现,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

首先获取模型Blog的元数据,接下来判断其基类是否为空,该类型的原始类型不能为空,同时在其暴露的DbSet属性中包含该类型,很显然都满足条件,最后将我们上述对模型和DbSet属性进行了映射,所以设置其表名为Blog1,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

如上只是满足了条件进行设置,我们还要看看方法ToTable的具体实现才能最终下结论,此时依然会和注解判断逻辑一样,但是此时在注解字典中已存在键Relational:TableName,所以将跳过,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

好了,到此为止针对注解和DbSet对表名的设置已经讨论完毕,接下来我们进行到执行OnModelCreating方法即我们自定义的设置即如下代码:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

此时将执行到我们对Blog自定义设置的表名Blog3,我们看看最终其ToTable方法直接跳过了CanSetTable方法,直接将参数名称赋值作为模型表名。

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱
EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

到此为止对模型的初始化准备工作已经完成,接下来开始利用上下文进行操作,此时我们回到上一节利用上下文获取表名的方法,如下:

EntityFramework Core表名原理解析,让我来,揭开你神秘的面纱

通过分析可知,无论是根据DbSet配置表名还是通过注解配置表名又或者是通过在OnModelCreating方法中自定义配置表名,最终在落地设置时,都统一以Relational:TableName为键设置表名值,所以上述若基类不存在就获取该表名常量的值,否则都未配置表名的话,才去以模型名称作为表名。

通过此篇和上一篇我们才算对EntityFramework Core中表名的详细解析才算明朗,我们下一个结论:EntityFramework Core对于表名的配置优先级是自定义(OnModelCreating方法)> 注解(表特性)> DbSet属性名称 > 模型名称,可能我们会想何不先注册DbSet约定,然后再注册表特性约定,采取覆盖的机制呢?但是事实并非如此,这里我们仅仅只是研究源码的冰山一角或许是为了考虑其他吧。若暴露DbSet属性,根据注册的默认约定表名为DbSet属性名称,否则表名为模型名称,若通过注解设置表名,此时上下文中暴露的DbSet属性将会被忽略,若通过OnModelCreating方法自定义配置表名,则最终以其自定义表名为准。那么问题随之又来了,对于属性是否可依此而类推呢?这个问题,只能您亲自去看源码一探究竟了。

原文出处:微信公众号【JeffckyShare】,作者【Jeffcky】

原文链接:https://mp.weixin.qq.com/s?__biz=MzIzMTczNjIxOQ==&mid=2247484593&idx=1&sn=93c9bf6b7f9da0d2014f28076c803626&chksm=e89ed245dfe95b538d517a71036e0eb50f9663b435c7a4aa7553aa08bdfc7acf8b3cd109cb0a&mpshare=1&scene=1&srcid=&sharer_sharetime=1578964613225&sharer_shareid=cc609ea2d56165426b8c4ccd3a28d316&key=ff1b1d089c15295c3c7c1545d7243d49d113166c03ed07a7c7ad9b30a2e87787ff120211bdb13f48e9d1dbebae0e1b2192754b80a860938ce9d42c685877f961b8758258d1b5127e74d54ba8eead39e4&ascene=1&uin=Mjk4MzIyNjQxOQ%3D%3D&devicetype=Windows+10&version=62070158&lang=zh_CN&exportkey=Az5LrOZeycN1JoFRepN48RI%3D&pass_ticket=aLfCeLYx1WPbtAzMPZ%2FB5zxJ5W%2BIgN08o2%2FZTtNz3xy9LchDif5J2ybXlgVLDPhC

本文观点不代表Dotnet9立场,转载请联系原作者。

发表评论

登录后才能评论