CN105278961A - 生成数据库表结构文档的方法及系统 - Google Patents

Abstract

本发明涉及一种生成数据库表结构文档的方法和系统。所述方法包括：读取数据库脚本，将所述数据库脚本解析为对应的java实体类；获取预设的样式配置信息；根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档。通过本发明，能够自动生成多种样式的数据库表结构文档，有利于节省开发、维护成本。

Description

生成数据库表结构文档的方法及系统

技术领域

本发明涉及数据处理技术领域，特别是涉及一种生成数据库表结构文档的方法及系统。

背景技术

数据库表结构文档指的是：描述程序数据库详细设计的文档。数据库表结构文档是产品交付时重要的文档之一，但该文档的书写工作技术含量低但工作量非常大，并且容易出现漏写、错写等书写错误。

并且现有的生成数据库表结构文档的方式，还存在文档样式受限、维护成本高、无法扩展到其他重复类型的文档、重复操作成本高等问题。

发明内容

基于此，本发明提供生成数据库表结构文档的方法及系统，能够自动生成多种样式的数据库表结构文档，有利于节省开发、维护成本。

本发明采用以下技术方案：

本发明一方面提供生成数据库表结构文档的方法，包括：

读取数据库脚本，将所述数据库脚本解析为对应的java实体类；

获取预设的样式配置信息；

根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档。

优选的，所述读取数据库脚本，包括，

通过设定的CASE工具导出对应的数据库脚本文件；

或者，根据接收到的数据库命令导出对应的数据库脚本文件。

优选的，所述将所述数据库脚本解析为对应的java实体类包括，

识别数据库脚本包含的若干数据库表，将每个数据库表包含的数据信息解析封装为一对应的java实体类；

所述根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档包括，

根据所述样式配置信息、所述数据库脚本对应的若干java实体类生成对应的数据库表结构文档，所述数据库表结构文档中包含对应的若干个数据表结构。

优选的，所述数据库脚本为SQL脚本；

所述数据信息包括：表名、字段名、字段类型、字段长度、字段是否为null以及字段说明。

优选的，所述根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档包括，

通过预设的第三方word生成插件加载所述java实体类以及所述样式配置信息，生成对应的数据库表结构word文档。

优选的，所述获取预设的样式配置信息之前还包括，

设置若干样式配置信息并存储，所述样式配置信息包括标题样式信息和表格样式信息。

本发明另一方面还提供一种生成数据库表结构文档的系统，包括：

脚本解析模块，用于读取数据库脚本，将所述数据库脚本解析为对应的java实体类；

样式获取模块，用于获取预设的样式配置信息；

文档生成模块，用于根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档。

优选的，所述脚本解析模块包括，

导出子模块，用于通过设定的CASE工具导出对应的数据库脚本文件；或者，用于根据接收到的数据库命令导出对应的数据库脚本文件。

优选的，所述脚本解析模块包括，

解析子模块，用于识别数据库脚本包含的若干数据库表，将每个数据库表包含的数据信息解析封装为一对应的java实体类；

所述文档生成模块，具体用于根据所述样式配置信息、所述数据库脚本对应的若干java实体类生成对应的数据库表结构文档，所述数据库表结构文档中包含若干个数据表结构。

优选的，所述数据库脚本为SQL脚本；

所述数据信息包括：表名、字段名、字段类型、字段长度、字段是否为null以及字段说明。

优选的，所述文档生成模块，具体用于通过预设的第三方word生成插件加载所述java实体类以及所述样式配置信息，生成对应的数据库表结构word文档。

优选的，还包括，

样式配置模块，用于设置若干样式配置信息并存储，所述样式配置信息包括标题样式信息和表格样式信息。

实施本发明的上述技术方案的有益效果包括：通过将数据库脚本解析封装为对应的java实体类；根据预设的样式配置信息、所述java实体类可自动生成对应数据内容、对应数据表样式的数据库表结构文档；相对于手动建立数据库表结构文档，节省了大量时间，且消除了人为误差；并且，通过本发明方案生成数据库表结构文档的方法，用户可根据实际需要灵活调整数据库表结构文档的样式，便于扩展到其他重复类型的文档生成。

附图说明

图1为本发明实施例的生成数据库表结构文档的方法的示意性流程图；

图2为根据本发明实施例生成的数据库表结构文档的示意图；

图3为本发明实施例的生成数据库表结构文档的系统的示意性结构图。

具体实施方式

为使得本发明的发明目的、特征、优点能够更加的明显和易懂，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而非全部实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

本发明提供的实施例包括生成数据库表结构文档的方法实施例；还包括相应的生成数据库表结构文档的系统实施例。以下分别进行详细说明。

图1为本发明实施例的生成数据库表结构文档的方法的示意性流程图。如图1中所示，所述方法包含以下步骤S101至步骤S103，详细说明如下:

S101，读取数据库脚本，将所述数据库脚本解析为对应的java实体类；

需要说明的是，java实体类是在JAVA软件开发中广泛使用的概念。java实体类就是一个拥有Set和Get方法的类，通常可和数据库联系在一起，这种联系可借由框架(如Hibernate)来建立的。

本实施例中，在一个数据库脚本中可能包含若干个数据表。对应的，本实施例中，将所述数据库脚本解析封装为对应的java实体类具体可为，识别数据库脚本包含的若干数据库表，将每个数据库表包含的数据信息解析封装为一对应的java实体类；即一个java实体类对应数据库脚本中的一个数据表，解析一个数据库脚本可能得到对应的多个java实体类。

S102，获取预设的样式配置信息；

本实施例中，用户可根据实际情况配置需要的样式配置信息并存储，例如配置若干数据表标题的样式(包括字体、显示位置等样式信息)，以及配置若干表格结构的样式(包括表格尺寸、填充色、数据显示格式等样式信息)。

S103，根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档。

需要说明的是，可通过预设的第三方word生成插件直接加载所述java实体类以及所述样式配置信息，生成对应的数据库表结构文档(所述数据库表结构文档为word文档)。其中，所述第三方word生成插件为类似JDK的Java软件开发工具包，本发明对此不做限定。

本实施例中，若当前解析的数据库脚本中包含多个数据表，即可得到对应数量的多个java实体类。因此，可根据所述样式配置信息、所述数据库脚本对应的若干java实体类生成对应的数据库表结构文档中，也包含若干个数据表结构。

作为一优选实施方式，本实施例中所述数据库脚本可为SQL脚本。下面以具体示例对本发明的生成数据库表结构文档的方法进行说明。

例如获取的数据库脚本中包含下面这段数据表信息：

表名称--日志表

使用数据库：DB2

字段前缀：LOG

最后修改人：xxx

最后修改日期：2014.02.21

DROPTABLEPB_LOG

CREATETABLEPB_LOG

(LOG_REGIDVARCHAR(6)default‘000000’NOTNULL,--机构号

LOG_LOGNOCHAR(12)NOTNULL,--日志编号

LOG_DATATIMECHAR(14)NOTNULL,--操作时间，格式为YYYYMMDDHHMISS

LOG_CSTINOVARCHAR(32)NOTNULL,--交易代码

LOG_BSNCODECHAR(7)NOTNULL,--日志编号

LOG_TIMESTAMPTIMESTAMPDEFAULTCURRENTTIMESTAMP,

PRIMARYKEY(LOG_LOGNO)

)；

需要说明的是，本实施例中，可通过设定的CASE工具(例如PowerDesigner)直接导出对应的数据库脚本文件；或者，根据接收到的数据库命令导出对应的数据库脚本文件。

解析数据库脚本文件中的该数据表信息。如上示例的数据库表中包含的数据信息有表名、字段名、字段类型、字段长度、字段是否为null以及字段说明等。通过上述步骤S101得到的该数据表对应的java实体类中包含的属性有：表名(中文)、表名(英文)、前缀、字段名、字段类型、字段长度(没有为空)、是否为null以及说明，还应该预留相关字段。最终可生成的数据库表结构文档如图2所示。

根据本发明的上述实施例，通过将数据库脚本解析封装为对应的java实体类；根据预设的样式配置信息、所述java实体类可自动生成对应数据内容、对应数据表样式的数据库表结构文档；相对于手动建立数据库表结构文档，节省了大量时间，且消除了人为误差；并且，通过本发明方案生成数据库表结构文档的方法，用户可根据实际需要灵活调整数据库表结构文档的样式，便于扩展到其他重复类型的文档生成。

需要说明的是，对于前述的方法实施例，为了简便描述，将其都表述为一系列的动作组合，但是本领域技术人员应该知悉，本发明并不受所描述的动作顺序的限制，因为依据本发明，某些步骤可以采用其它顺序或者同时进行。其次，本领域技术人员也应该知悉，说明书中所描述的实施例均属于优选实施例，所涉及的动作和模块并不一定都是本发明所必须的。

以下对可用于执行上述生成数据库表结构文档方法的本发明实施例的生成数据库表结构文档的系统进行说明。图3为本发明实施例的生成数据库表结构文档的系统的示意性结构图，为了便于说明，图中仅仅示出了与本发明实施例相关的部分，本领域技术人员可以理解，图中示出的系统结构并不构成对系统的限定，可以包括比图示更多或更少的部件，或者组合某些部件，或者不同的部件布置。

图3示例的生成数据库表结构文档的系统包含脚本解析模块201、样式获取模块202和文档生成模块203，其中：

所述脚本解析模块201，用于读取数据库脚本，将所述数据库脚本解析为对应的java实体类；

优选地，所述脚本解析模块201可包括，

导出子模块，用于通过设定的CASE工具导出对应的数据库脚本文件；或者，用于根据接收到的数据库命令导出对应的数据库脚本文件；

需要说明的是，java实体类是在JAVA软件开发中广泛使用的概念。java实体类就是一个拥有Set和Get方法的类，通常可和数据库联系在一起，这种联系可借由框架(如Hibernate)来建立的。

通常在一个数据库脚本中可能包含若干个数据表。因此，所述脚本解析模块201还可包括，解析子模块，用于识别数据库脚本包含的若干数据库表，将每个数据库表包含的数据信息解析封装为一对应的java实体类；即一个java实体类对应数据库脚本中的一个数据表。

样式获取模块202，用于获取预设的样式配置信息；

通过本实施例的生成数据库表结构文档的系统，用户可根据实际情况配置需要的样式配置信息并存储，例如配置若干数据表标题的样式(包括字体、显示位置等样式信息)，以及配置若干表格结构的样式(包括表格尺寸、填充色、数据显示格式等样式信息)。

文档生成模块203，用于根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档。

需要说明的是，可通过预设的第三方word生成插件加载所述java实体类以及所述样式配置信息，生成对应的数据库表结构文档(所述数据库表结构文档为word文档)。其中，所述第三方word生成插件可采用现有的常规插件，本发明对此不做限定。

作为一优选实施方式，所述数据库脚本可为SQL脚本，若当前解析的数据库脚本中包含多个数据表，即可得到对应数量的多个java实体类。因此，所述文档生成模块203可根据所述样式配置信息、所述数据库脚本对应的若干java实体类生成对应的数据库表结构文档，所述数据库表结构文档中包含若干个对应的数据表结构。

本实施例中，所述生成数据库表结构文档的系统还可包括，样式配置模块，用于设置若干样式配置信息并存储，所述样式配置信息包括标题样式信息和表格样式信息。

根据在上述示例的生成数据库表结构文档的系统实施例，通过将数据库脚本解析封装为对应的java实体类；根据预设的样式配置信息、所述java实体类可自动生成对应数据内容、对应数据表样式的数据库表结构文档；相对于手动建立数据库表结构文档，节省了大量时间，且消除了人为误差；并且，通过本发明方案生成数据库表结构文档的方法，用户可根据实际需要灵活调整数据库表结构文档的样式，便于扩展到其他重复类型的文档生成。

需要说明的是，上述实施例中各模块/单元之间的信息交互、执行过程等内容，由于与本发明前述方法实施例基于同一构思，其带来的技术效果与本发明前述方法实施例相同，具体内容可参见本发明方法实施例中的叙述，此处不再赘述。

此外，上述示例的生成数据库表结构文档的系统实施例中，各功能模块的逻辑划分仅是举例说明，实际应用中可以根据需要，例如出于相应硬件的配置要求或者软件的实现的便利考虑，将上述功能分配由不同的功能模块完成，即将所述生成数据库表结构文档的系统的内部结构划分成不同的功能模块，以完成以上描述的全部或者部分功能。

在上述实施例中，对各个实施例的描述都各有侧重，某个实施例中没有详述的部分，可以参见其它实施例的相关描述。

以上为对本发明所提供的生成数据库表结构文档的方法及系统的描述，对于本领域的一般技术人员，依据本发明实施例的思想，在具体实施方式及应用范围上均会有改变之处，综上，本说明书内容不应理解为对本发明的限制。

Claims (12)

1.生成数据库表结构文档的方法，其特征在于，包括，

读取数据库脚本，将所述数据库脚本解析为对应的java实体类；

获取预设的样式配置信息；

根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档。

2.如权利要求1所述生成数据库表结构文档的方法，其特征在于，所述读取数据库脚本包括，

通过设定的CASE工具导出对应的数据库脚本文件；

或者，根据接收到的数据库命令导出对应的数据库脚本文件。

3.如权利要求1所述生成数据库表结构文档的方法，其特征在于，所述将所述数据库脚本解析为对应的java实体类包括，

识别数据库脚本包含的若干数据库表，将每个数据库表包含的数据信息解析封装为一对应的java实体类；

所述根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档包括，

根据所述样式配置信息、所述数据库脚本对应的若干java实体类生成对应的数据库表结构文档，所述数据库表结构文档中包含对应的若干个数据表结构。

4.如权利要求3所述生成数据库表结构文档的方法，其特征在于，所述数据库脚本为SQL脚本；

所述数据信息包括：表名、字段名、字段类型、字段长度、字段是否为null以及字段说明。

5.如权利要求1所述生成数据库表结构文档的方法，其特征在于，所述根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档包括，

通过预设的第三方word生成插件加载所述java实体类以及所述样式配置信息，生成对应的数据库表结构word文档。

6.如权利要求1所述生成数据库表结构文档的方法，其特征在于，所述获取预设的样式配置信息之前还包括，

设置若干样式配置信息并存储，所述样式配置信息包括标题样式信息和表格样式信息。

7.生成数据库表结构文档的系统，其特征在于，包括，

脚本解析模块，用于读取数据库脚本，将所述数据库脚本解析为对应的java实体类；

样式获取模块，用于获取预设的样式配置信息；

文档生成模块，用于根据所述样式配置信息、所述java实体类生成对应的数据库表结构文档。

8.如权利要求7所述生成数据库表结构文档的系统，其特征在于，所述脚本解析模块包括，

导出子模块，用于通过设定的CASE工具导出对应的数据库脚本文件；或者，用于根据接收到的数据库命令导出对应的数据库脚本文件。

9.如权利要求7所述生成数据库表结构文档的系统，其特征在于，所述脚本解析模块包括，

解析子模块，用于识别数据库脚本包含的若干数据库表，将每个数据库表包含的数据信息解析封装为一对应的java实体类；

所述文档生成模块，具体用于根据所述样式配置信息、所述数据库脚本对应的若干java实体类生成对应的数据库表结构文档，所述数据库表结构文档中包含若干个数据表结构。

10.如权利要求9所述生成数据库表结构文档的系统，其特征在于，所述数据库脚本为SQL脚本；

所述数据信息包括：表名、字段名、字段类型、字段长度、字段是否为null以及字段说明。

11.如权利要求7所述生成数据库表结构文档的系统，其特征在于，所述文档生成模块，具体用于通过预设的第三方word生成插件加载所述java实体类以及所述样式配置信息，生成对应的数据库表结构word文档。

12.如权利要求7所述生成数据库表结构文档的系统，其特征在于，还包括，

样式配置模块，用于设置若干样式配置信息并存储，所述样式配置信息包括标题样式信息和表格样式信息。