读取数据库信息构建视图字段的备注信息,方便程序代码生成

【读取数据库信息构建视图字段的备注信息,方便程序代码生成】在很多情况下,我们开发都需要有一个快速的代码生成工具用来提高开发效率,代码生成工具很多信息都是读取数据库的表、视图等元数据进行对象表信息的完善,有了这些信息,我们就可以在普通的实体类代码里面添加属性字段的中文注释,或者在Winform或者Web界面的快速生成的时候,可以在查询框或者界面编辑的时候,充当标签提示等处理信息。但是,一般情况下视图的备注信息是没有的,但是视图和表之间是存在一定的关系的,虽然不同数据库系统对于它们的信息对应不一定一致,但是我们可以把它们的对应关系寻找出来就可以给视图字段增加备注了,这个就是本文介绍的思路和做法了,本篇结合介绍代码生成工具Databae2Sharp的处理实现进行讲解如何获取视图中字段对应的备注信息。
1、SQLServer数据库的视图信息处理
我们为了演示视图的处理,我们需要创建两个表,以及视图的信息,首先我们创建一个客户信息表,如下所示。

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

我们希望这个T_Customer表中的Creator字段和用户表进行关联,然后我们添加一个视图,其中的视图代码如下所示。

SELECTdbo.T_Customer.ID, dbo.T_Customer.Name, dbo.T_Customer.Age, dbo.T_Customer.Creator, dbo.T_Customer.CreateTime, dbo.Users.UserName FROMdbo.T_Customer INNER JOIN dbo.Users ON dbo.T_Customer.Creator = dbo.Users.ID

也就是列出T_Customer的字段,以及一个Users表中的Username字段,相当于关联了两个表的视图,获取这个表的数据如下所示。

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

好了,到这里我们基本就准备好前提条件了,剩下的就是如何获取这些视图的信息了。
在SQLServer里面,我们如果需要获取用户视图的信息,那么通过系统的视图就可以获取到了,如下所示。

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

这个就是视图的名称和视图SQL代码了,我们如果需要详细获取视图的字段信息,这些还不够,我们可以根据视图信息进一步列出用户视图和具体表的关系,如下所示。
读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

从上图我们就可以看出这个视图字段和表的字段的一一对应关系了,也就是可以通过具体表的字段信息,包括我们这里非常关注的备注信息了。
例如根据这些原理,我们视图就直接从数据库表字段中提取备注信息了,从而实现视图备注字段的自动提取,减少人工设置的繁琐和不便。

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片
2、Oracle数据库视图信息的处理
在Oracle里面的视图字段信息处理,和SQLServer有所不同,因为我们很难找到视图字段和表字段的一一对应关系的视图信息,因此有点困难。
在Oracle里面我们先准备好一个T_Customer表,以及视图等基础信息先。

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

同时创建一个视图和用户表发生关联,和在SQLServer一样的做法,SQL如下所示。
create or replace view view_customer as select u.fullname, t.id, t.name, t.age, t.creator, t.createtime from t_customer t inner join t_acl_user u on t.creator = u.id;

我们通过Oracle的系统视图ALL_TAB_COLUMNS或者DBA_TAB_COLUMNS可以获得视图的字段信息,如下所示。

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

不过很不幸,这个视图的信息没有和视图关联表发生任何的交集,无法获取到对应的表信息,那么如何获取视图对应表的信息呢,答案是可以通过ALL_DEPENDENCIES这个视图进行获取,如下图所示。

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

但是这里也只是获取到对应的表,没有和字段关联,不过这样基本上也差不多了,因为我们可以获得视图字段,以及这个视图里面包含的关联表,那么基本上它的字段信息也大致锁定了,除非两个表之间很多字段名称相同,难以处理。
结合下面的SQL,我们可以获得表和字段的信息了,如下所示。
select distinct table_name, column_name from all_tab_columns where table_name in (select referenced_name from all_dependencies where name='VIEW_CUSTOMER' and type = 'VIEW' and referenced_type = 'TABLE') and column_name in (select column_name from all_tab_columns where table_name='VIEW_CUSTOMER') order by table_name;

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

这样我们根据视图对应表的字段信息,匹配它的备注信息就差不多了,最后我们来看看基于Oracle的实现效果。

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

读取数据库信息构建视图字段的备注信息,方便程序代码生成
文章图片

从上图我们可以看到,代码工具Database2Sharp,根据上述介绍的逻辑关系,自动从表对应的字段里面去匹配对应的备注信息,从而减少手工设置视图字段备注信息的繁琐工作,为视图代码生成和界面生成提高了速度和效率。
以上的视图备注信息的提取逻辑,我们可以把它应用在自己的业务处理里面,实现更加广泛的应用。
以上视图备注信息的提取需求,来自一个客户的建议,非常不错,在此感谢他为这个细节做出的贡献。

    推荐阅读