使用数据库元数据为Entity Framwork实体生成注释

心已赠人 2021-11-22 04:06 281阅读 0赞

众所周知Entity Framwork自动生成的实体上没有注释。

img1![SouthEast][]

没错，我使用的是Entity Framwork的各种应用模式中的数据库先行模式。本文不讨论Entity Framwork的哪种应用模式更好的问题而是讨论Entity Framwork提供的T4模板没有生成实体注释的问题。

通常架构数据库的时候会书写描述架构的元数据。如

img2![SouthEast 1][]

SqlServer把这些元数据存储在哪里我不关心。但是从下图可以发现貌似这种元数据是个键值对结构。并且该类元数据被称作Extended Properties

img3![SouthEast 2][]

通常数据库会以数据库爱好的方式提供操作数据的接口。操作这里的Extended Properties类别的元数据的接口是什么呢？是下面一个系统元数据函数和三个系统存储过程：

img4![SouthEast 3][]

img5![SouthEast 4][]

img6![SouthEast 5][]

img7![SouthEast 6][]

这四个接口刚好完成我们所需要的对Extended Properties类别元数据的CRUD操作。可惜，Entity Framwork的实体数据模型中并不包含这类属性。虽然这类元数据与ORM无关但是它们对我们的代码有利，如果能把这类元数据以注释的形式加到实体类代码上的话。

为了确认Entity Framwork的实体数据模型上不包含这类元数据，现在然我们以数据库优先的方式创建一个Entity Framwork项目，随便找一个数据库建好了后从数据库更新元数据

img8![SouthEast 7][]

在点击“Update Model From Database”之前开启SqlServer Profiler程序

img9![SouthEast 8][]

通过监视Entity Framwork更新元数据的sql代码可以发现Entity Framwork并没有查询Extended Properties类别的元数据。上面说了这类元数据与ORM这件事情无关，所以干正经事的Entity Framwork根本不需要查询这类元数据。但是我们想要利用数据库中的Extended Properties元数据为实体代码自动添加注释，这件事对于我们来说是正经事。想要利用实体数据模型上的元数据为实体代码添加注释的道路是难以走通了因为Ef都根本没去查这类元数据。

那么，我们自建模型。通过监视Entity Framwrok从数据库更新元数据的Sql代码我们领会到了SqlServer元数据数据访问方面的知识。研究发现为生成实体数据模型元数据Entity Framwork查询下如下结构的四种数据：

img10![SouthEast 9][]

上图四种元数据分别对应SqlServer的表、视图、表列和视图列。当然这四类元数据现在表现为四张数据库视图这是经过我封装好了的。我们将这四张视图作为提供元数据的“接口”。没错就是“接口”，谁规定过接口必须是C\#中的interface关键字定义的结构？接口是契约，这四张视图就是我们的数据库契约，现在我建的每个数据库都实现了这个接口，它们都具有这四张视图。这四张视图是通过参考Entity Framwork获取元数据的Sql语句建立的。这些Sql查询太过复杂，尤其查询表列和视图列的元数据的查询语句复杂的让人难以入眼，下面只贴一个表视图吧：

img11![SouthEast 10][]

有了上面四张视图，再加上三个系统存储过程sys.sp\_addextendedproperty、sys.sp\_updateextendedproperty、sys.sp\_dropextendedproperty和一个系统元数据函数::fn\_Listentendedproperty，如果这些知识都是我们熟悉的或者留意过的则大部分人可以在头脑中有一个大致的解决方案了。但作为善终，本文还得继续。废话少说，下面开始架构和编码。

讨论到现在发现一直都是在围绕着数据库说事，可见数据库这个概念很重要，所以我想把它抽象一下先，建个Db类：

img12![SouthEast 11][]

Db类很简单基本没有什么可说的，唯有它的GetConnection方法值得一说，我们将上面的类图换个视角看一看：

img13![SouthEast 12][]

Db类的GetConnection方法构建数据库连接的任务是通过委托ADO.NET的DbProviderFactory类型的对象完成的，而dbProviderFactory作为DbProviderFactory类型的实例是通过ADO.NET的DbProviderFactories.GetFactory(this.ProviderName)静态方法传入ProviderName字符串构建的

img14![SouthEast 13][]

当然除了Db类外，我们也需要为表、表列、视图、视图列类别的元数据建模，不过它们四个并没有出彩的地方：

img15![SouthEast 14][]

还记得前文提到的数据库上的那四个视图接口么？上图的这四个对象模型映射的就是数据库中的那四个视图（关系模型）。Db类型的对象不需要持久化吗？当然需要，它持久化到数据库中的Database表：

img16![SouthEast 15][]

同样Database表也没有什么出彩的地方，前文有一张图上提到数据库连接“引导库”，Database表所在的库就是这个引导库。

模型建好的，为了简化问题，就把上面的Db模型、DbTable模型、DbView模型、DbTableColumn模型和DbViewColumn模型当数据访问模型。现在基于这四个模型定义一套元数据访问接口：

img17![SouthEast 16][]

目前来说有意义的是图上红色矩形圈住的几个方法。这几个方法就是用以实现对Extended Properties类别的数据库元数据的增删改操作的，它们都是通过调用一个很臭的私有方法实现的：

img18![SouthEast 17][]

至此，终于我们实现了对数据库的Extended Properties类别的元数据的管理。元数据填好了就可以供我们所用了。现在让我们把元数据读成下图所示的形式。这张图完整的记录的数据库、表、表列、视图、视图列的元数据以及Extended Properties类别的元数据。

img19![SouthEast 18][]

好了，现在我们可以修改Entity Framwork的T4实体类代码生成模板了。

img20![SouthEast 19][]

首先构建数据库元数据提供程序，然后调用它的GetDbDoc方法传入数据库名查询出给定的数据库的文档。该文档是一张对象图，其对象间的关系参见上面贴过的图。

沿着Entity Framwork的T4模板代码往下找，下面是生成类的代码，我们在上面添加类注释：

img21![SouthEast 20][]

下面是生成普通属性的代码，我们在上面添加属性注释：

img22![SouthEast 21][]

好了，现在运行自定义过Entity Framwork的T4代码模板，看一下效果：

img23![SouthEast 22][]

如愿的生成了注释。

后话：

其实设计这个数据库元数据管理模块本来的目的不是生成实体代码注释，而是为了生成数据库文档。之所以要在查看文档时自动生成是因为众所周知的一个问题，文档很容易过期，没人维护。数据库文档模块做好后发现数据库文档上的信息对实体代码同样有意义，为Entity Framwork的实体代码生成注释只是数据库元数据管理模块的意外惊喜。生成的文档效果如下：

img24![SouthEast 23][]

img25![SouthEast 24][]

img26![SouthEast 25][]

（完）

[SouthEast]: /images/20211122/8603fcad608742d98b25e401c3b68f09.png
[SouthEast 1]: /images/20211122/abe649070cdb4ea288bb18b990e61b69.png
[SouthEast 2]: /images/20211122/b64607fb13bc4242850cca7b6dedab92.png
[SouthEast 3]: /images/20211122/b68029a9c85b4041971bef718d412b9e.png
[SouthEast 4]: /images/20211122/38189bd739144cee9c61c0a4e0ff5324.png
[SouthEast 5]: /images/20211122/b79ae56b2ec241e88565ae0606c50d4d.png
[SouthEast 6]: /images/20211122/3fae17758cdc446d8aeac274b431c975.png
[SouthEast 7]: /images/20211122/75f0ba2673af47f582bba581e0338978.png
[SouthEast 8]: /images/20211122/3fde78fd3c3c47fda245dfe2473eec46.png
[SouthEast 9]: /images/20211122/861ee58dc9404048904969ee765fb6e8.png
[SouthEast 10]: /images/20211122/0a006912f7504d8dbc8e12f5b70d62e8.png
[SouthEast 11]: /images/20211122/8af732372982451b9e033a9829a55dd2.png
[SouthEast 12]: /images/20211122/802da7a3c54045c7bdcdce5f76d92a9b.png
[SouthEast 13]: /images/20211122/055026b09256472ead0bcf33d47eca00.png
[SouthEast 14]: /images/20211122/4312b4248d0145ecb0d6ceaed9e77b4d.png
[SouthEast 15]: /images/20211122/41727bf13db04f9581291481d51c938b.png
[SouthEast 16]: /images/20211122/b1e0161965084a7f8bcb44eefd13b6b3.png
[SouthEast 17]: /images/20211122/b5e741b827c34be19ca34601b36d578a.png
[SouthEast 18]: /images/20211122/1d4ef47cfaca477da49d59ad0ca49f04.png
[SouthEast 19]: /images/20211122/476741c0854c4136a0fcce94d1ae954d.png
[SouthEast 20]: /images/20211122/1c68483dabbe45f3af5fb098b1d5c30c.png
[SouthEast 21]: /images/20211122/a715efee850d498b8d565b6c83fc8638.png
[SouthEast 22]: /images/20211122/202abeca8c6241b0944b7c2a199ceff1.png
[SouthEast 23]: /images/20211122/669d103cf6914c7389c63e193ea76af1.png
[SouthEast 24]: /images/20211122/85d326d1772c4952a34f2232b9bff1a5.png
[SouthEast 25]: /images/20211122/2bda81aeefe247318d2a3c5ef82ddf3b.png