用powerdesigner设计数据流图(PowerDesigner数据库表设计最佳实践)
用powerdesigner设计数据流图(PowerDesigner数据库表设计最佳实践)对于以上方法,PowerDesigner是图形界面的表设计工具,并且具有脚本开发能力,在编写脚本的情况下,能够生成标准的DDL与文档,接下来让我们看看如何利用PowerDesigner设计与生成标准文档。如何定义大型项目的数据库表管理?通常多模块的、表数量超过30张、由多位工程师分别设计的,我们认为已经上了一定规模,需要一个标准流程进行表结构管理。基于笔者在工程实践中的经验,推荐大家在没有自研数据库管理平台的情况下,使用如下方法管理数据库Schema:管理数据库以及相关数据时,通常有以下几种做法:为什么数据库Schema的管理非常重要?因为软件开发过程并不是1次完成,特别是互联网项目,密集的发布频率通常伴随着密集的数据库表结构变更,有可能添加表、添加字段、修改字段、添加预制数据等等。如果单纯依靠人去管理这些数据库脚本,非常容易出错。于是我们需要用版本管理工具,比如Git对这些脚本进行管理,
很多朋友都使用过PowerDesigner这个企业建模工具,PowerDesigner是Sybase的企业建模和设计解决方案,最初由Xiao-Yun Wang(王晓昀)在SDP Technologies公司开发完成。PowerDesigner除了能够用来画ER图、UML图、数据库设计图等,是一个全能型的企业建模工具。
PowerDesigner
本文仅讨论使用PowerDesigner管理数据库设计图以及对于数据库设计的一种管理流程,并使用PowerDesinger平台开发一个VBS脚本生成所需的数据库DDL和文档。
管理数据库Schema的方法软件系统的开发,涉及到数据库的时候,需要管理的内容有:
- 数据库的DDL,如建表语句、索引创建;
- 预制数据,比如系统运行所必需的权限数据、存储在数据库的表单数据、业务类型数据;
- 初始化数据,比如超级管理员账号;
管理数据库以及相关数据时,通常有以下几种做法:
- 通过一个基准Database管理Schema,并使用如mysqldump的工具导出DDL;
- 手动维护DDL的SQL文件,并使用版本管理工具,如Git对脚本进行管理;
- 团队自行开发数据库设计系统,包含图形化的设计界面、DDL生成、变更管理;
为什么数据库Schema的管理非常重要?因为软件开发过程并不是1次完成,特别是互联网项目,密集的发布频率通常伴随着密集的数据库表结构变更,有可能添加表、添加字段、修改字段、添加预制数据等等。如果单纯依靠人去管理这些数据库脚本,非常容易出错。于是我们需要用版本管理工具,比如Git对这些脚本进行管理,配合Diff工具或者Beyond Compare/Meld这样的GUI工具进行版本差异对比来编写升级脚本。对于超大型系统,笔者曾经所在的团队甚至基于Eclipse开发了一个“预制数据管理工具”来管理系统数据,由一组称为“实例化工程师”的团队管理。
通过Meld对比文件差异
如何定义大型项目的数据库表管理?通常多模块的、表数量超过30张、由多位工程师分别设计的,我们认为已经上了一定规模,需要一个标准流程进行表结构管理。基于笔者在工程实践中的经验,推荐大家在没有自研数据库管理平台的情况下,使用如下方法管理数据库Schema:
- 使用版本管理工具,如Git管理ddl、预制数据、初始化数据;
- 使用图形工具设计表结构(便于团队理解,新人更容易上手);
- 定义数据库表结构设计、预制数据变更流程规范;
- 维护、定期更新标准的表结构文档以及字段注释;
对于以上方法,PowerDesigner是图形界面的表设计工具,并且具有脚本开发能力,在编写脚本的情况下,能够生成标准的DDL与文档,接下来让我们看看如何利用PowerDesigner设计与生成标准文档。
PowerDesigner的表设计很多工程师可能认为,使用一个SQL文件管理数据库的ddl就很方便了,团队内的其他同事也应该很容易通过表结构了解系统。但对于复杂系统,表的数量达到一定规模,并且还需要多人协作设计的情况下,情况会变得很复杂。一款好用的图形工具,能够使大家在交流沟通的时候事半功倍。
接下来让我们使用PowerDesigner设计两张表。首先我们创建一个Physical Diagram开始绘制简单的表:
Physical Diagram
在设计表的时候,一个Tips是,不要使用PowerDesigner中的主外键关联功能。在软件中维持关联关系,不使用外键已经成为互联网应用设计的一个共识,使用外键不便于数据库的水平扩容。那么如何表示表之间的关系呢?可以使用“Link/Traceability Link”功能:
Link/Traceability Link
设计表的时候,注意设置表的Owner,之后我们将把Owner的名称作为生成脚本的文件名,这里通常可以写成你的数据库名:
设置Owner
填写表的字段,以及字段的注释:
Comment/注释
再添加一张user_logs表,并将它们用“Link”关联,现在图长成这样:
User/Logs
接下来看看怎么生成表结构以及文档。我准备了一份脚本,通过菜单Tools#Excute Commands#Edit Run/Script运行脚本:
运行脚本
查看脚本中定义的输出目录,我们得到了一份Html doc与SQL脚本:
生成的文档与脚本
通过如上流程,数据库设计的时候,我们只需要关注数据库模型、表之间的关系、字段的类型,文档与SQL通过Script生成,多人协作的时候,这样的设计流程将大大简化我们的工作。对于设计人员,只需要关注设计本身,配合版本管理工具与CI/CD,能够方便的将设计部署到系统中。我们甚至可以在脚本中对目标数据库的字段类型等做检查、同时生成多种目标数据库的建表语句,包括PowerDesigner本身不支持的数据库,因为使用脚本生成,使得我们拥有了极大的灵活性。
PowerDesigner Run Script那么如何开始了解并开发一个PowerDesigner脚本呢?首先,PowerDesigner提供了VBS脚本开发的能力,通过VBS脚本可以读取设计模型的几乎所有元数据。打开PowerDesigner的帮助文档,找到“Customizing and Extending PowerDesigner”章节,在这里,可以获得最丰富的扩展能力资料。
帮助文档
笔者会展示脚本编写的基本思路,沿着这个思路,你可以在文档中获得更丰富的API来扩展你的脚本。首先我们需要遍历Workspace,并通过ListModel方法(自定义方法)遍历模型:
Dim workspace fileStream
Set workspace = ActiveWorkspace 'ActiveWorkspace是内置对象
Set fileStream = createobject("Scripting.FileSystemObject")
set commandShell = createobject("WScript.Shell")
If (workspace Is Nothing) Then
MsgBox "There is no Active Diagram!"
Else
Dim children folder
Set children = workspace.Children
For Each folder In children
If(folder.ModelObject.IsKindOf(PdPDM.Cls_Model)) Then
ListModel folder.ModelObject
End If
Next
End If
ListModel方法定义如下,我们分别遍历模型中的表,并传递给ProcessTable方法处理:
Function ListModel(model)
if(model Is Nothing) Then
MsgBox 'Nothing Model'
Else
Dim curTable
For Each curTable In model.Tables : ProcessTable(curTable) : Next
End If
End Function
ProcessTable定义如下,读取表的元数据后我们开始SQL拼接,这里笔者写了ProccessPk、ProccessUnion、ProccessIndex三个方法分别处理主键、Union、Index的语句生成,基于篇幅原因就不展示了:
Function ProcessTable(argTable)
Dim curTabSql eachColumn
curTabSql = curTabSql "DROP TABLE IF EXISTS " argTable.Code ";" VBCRLF
curTabSql = curTabSql "CREATE TABLE " argTable.Code VBCRLF
curTabSql = curTabSql "(" VBCRLF
'loop Columns
For Each eachColumn In argTable.Columns
curTabSql = curTabSql Left(Space(3) UCase(eachColumn.Code) Space(30) 30) Space(4) UCase(eachColumn.DataType)
' Is Not Null
If((eachColumn.NullStatus = "not null") And (Not eachColumn.Primary)) Then
curTabSql = curTabSql " NOT NULL " VBCRLF
Else
' Is Default
If(eachColumn.DefaultValueDisplayed = "") Then
curTabSql = curTabSql " " VBCRLF
Else
curTabSql = curTabSql " DEFAULT '" eachColumn.DefaultValueDisplayed "' " VBCRLF
End If
End If
Next
curTabSql = Left(curTabSql InStrRev(curTabSql " ") - 1) VBCRLF
curTabSql = curTabSql ") ENGINE=INNODB DEFAULT CHARSET " TABLE_ENCODE ";" VBCRLF
curTabSql = curTabSql ProccessPk(argTable) VBCRLF
curTabSql = curTabSql ProccessUnion(argTable) VBCRLF
curTabSql = curTabSql ProccessIndex(argTable) VBCRLF VBCRLF
' TODO 写入文件
End Function
既然可以读取元数据,那么生成Html doc就很简单了,你可以定义一个Html模版去拼接生成Html文档。如果你有更高级的生成要求,在API文档中你可以找到答案。
更近一步,有的团队需要设置表的表空间等参数,那么如何在PowerDesigner中扩展呢?我们可以使用PowerDesinger中的扩展属性功能,并在脚本中读取扩展属性做相应的处理:
New Attribute
可能的困难在于你需要使用VBS编写脚本,不过掌握了Java、C、TypeScript这类编程语言的同学了解VBS应该非常容易,这需要大概1天的时间学习,相较于生产力的提升,这个投入还是值得的。
本文总结以上就是本文的全部内容,让我们简单总结一下:
- GUI Doc 版本管理工具管理表结构复杂的大型项目,便于多人协作;
- PowerDesinger的脚本编程能力能够产生自定义SQL/文档;
- 使用PowerDesinger表属性扩展能力,创建个性化属性满足特殊需求;
你还知道其他更好用的工具吗?或者在使用PowerDesinger过程中有什么疑问?欢迎留言讨论。