CN105760370A - 一种插件式报表框架技术 - Google Patents

Abstract

本发明公开一种插件式报表框架技术，包括以下步骤：通过数据选择接口挑选报表数据源中的数据点，形成参数后供统一数据接口调用；统一数据接口屏蔽各报表数据源之间取数差异，形成格式化的数据，向报表制作引擎返回数据描述，向报表渲染引擎返回最终数据。报表制作引擎制作报表模板，定义报表数据的展现形式。报表模板只需报表数据描述，无需了解具体数据。报表数据描述被应用到表格中，其字体、颜色等式样被具体定义。报表渲染引擎获取统一数据接口中报表的具体数据，结合模板中定义的数据展现形式进行报表计算、渲染及最终展示。本发明提供报表基础框架，并以插件的方式扩展所支持的报表种类，以此来满足企业报表多样性、多变性的扩展需求。

Description

一种插件式报表框架技术

技术领域

本发明属于企业级报表工具技术领域，特别涉及一种插件式报表框架技术，用于满足企业多样的报表需求。

背景技术

随着企业规模扩大，企业报表类型也日益繁多，既有涉及企业生产、运行的报表，也有涉及决策、分析的报表。然而不同种类报表的数据来源、制作方式、展现格式各不相同。企业运行数据可能来源于各运行系统，决策数据可能来源于关系型数据库；运行报表可能只需要表格展现，而决策报表可能还要辅以图表展示。如何屏蔽报表数据源差异、统一制作方式、丰富展示效果成为企业报表工具面临的主要难点。现有的一些报表技术，主要存在以下问题：

(1)数据源支持单一，且缺乏有效的扩展手段。现有报表工具主要支持特定数据源，或是提供基于sql的关系库访问方式，或是提供系统私有数据的程序访问方式，缺乏数据集层面的统一考虑。这导致报表工具扩展性较差，难以接入固有数据源以外的数据。

(2)制作方式与数据源高度耦合。由于缺乏统一数据接口层，数据源中数据都是以私有格式接入报表，这导致报表的制作与数据源高度耦合。当报表扩展其它数据源时，报表制作工具的程序须随之修改，这极大的增加了报表扩展的难度。

本案涉及的名词定义如下：

数据源：报表数据的存储介质，可以是数据库、文件或第三方系统。

数据集：各种数据源实现统一数据接口的实例。统一数据接口要求将数据源抽象成类似二维数组的数据块，具有确定的行数与列数，每一行便是一条数据记录，且每列都有相应的列名。

数据描述：对数据集数据的抽象，用于报表模板的制作，具体为数据列名。

插件：一种程序扩展技术，本案中的报表插件指用于满足不同类型报表之间的扩展程序。插件之间各自独立，互不影响。

发明内容

为满足企业多变的报表需求，提供一种插件式报表框架技术，以便捷的支持不同类型报表的扩展，给企业提供统一的报表解决方案。

为了达成上述目的，本发明的方案是：

提供一种插件式报表框架技术，其特征在于包括统一数据接口、数据选择接口、报表制作引擎及报表渲染引擎，其中统一数据接口获取来自多种数据源的数据并将数据组织成固定格式供报表调用；数据选择接口定义报表数据查询的条件，形成的结果供统一数据接口获查询报表数据时调用；报表制作引擎利用统一数据接口返回的数据描述制作报表模板，编辑报表格式；报表渲染引擎将报表数据应用到报表模板中，最终渲染形成报表展示。

上述方案中所述统一数据接口将各数据源的数据组织成报表调用所需格式，数据可来源于多种数据源，包括关系型数据库、文件系统及其它，报表展现无需了解数据存储介质，只需从统一数据接口中获取所需格式的数据，以此实现报表展示与数据源解耦，报表插件须根据应用需求实现统一数据接口。

上述方案中所述报表数据选择接口定义报表数据查询参数，参数最终将传递给统一数据接口调用，数据选择接口由应用需求导向，不同类型报表数据定义方式各异，报表插件须根据应用需求实现数据选择接口。

上述方案中所述报表制作引擎制作报表模板，定义报表数据的展现形式，报表模板只需报表数据描述，无需了解具体数据，数据描述由统一数据接口以数据列形式返回，报表数据列被应用到表格中，其字体、颜色等式样被具体定义，报表制作引擎由报表框架提供，报表插件无须关注。

上述方案中所述报表渲染引擎获取统一数据接口中报表的具体数据，结合模板中定义的数据展现形式进行报表计算、渲染及最终展示，渲染引擎由报表框架提供，报表插件无须关注。

本发明具有以下优点：

(1)对多数据源提供了良好的扩展支持。框架提供了统一数据接口，插件针对不同的数据源只需提供相应的数据集。

(2)对多类型报表制作提供了良好的扩展支持。框架提供的数据选择接口，用来选择不同数据源中的数据。而选择的结果，只是作为数据集查询的条件，并不影响报表的制作方式。

(3)报表制作与报表数据源实现解耦。报表模板制作时，只需调用数据接口中的数据描述，而报表制作引擎程序无需再作调整。报表插件按报表类型需求实现报表取数接口与数据选择接口，报表制作引擎、渲染引擎负责完成报表的制作与展示。

附图说明

图1是本发明报表框架的整体架构图；

图2是本发明数据流图；

图3是本发明中数据快照加载的流程图；

具体实施方式

以下将结合附图，对本发明的技术方案进行详细说明。

本发明提供一种插件式报表框架技术，该技术能灵活的应对企业报表需求的扩展。报表框架包括统一数据接口、数据选择接口、报表制作引擎、报表渲染引擎这四部分。整体架构如图1系所示。

统一数据接口屏蔽不同数据源数据格式、取数方式的差异，为报表制作、渲染引擎提供格式化数据。插件实现统一数据接口的实例称为数据集。数据集查询数据时需要用到数据选择接口返回的查询条件。

数据选择接口用于挑选报表制作所需要的数据源中的数据。数据选择接口支持可视化的数据选择，插接实现数据选择接口的实例为数据选择界面。选择界面须根据数据源特点定制。例如数据源为关系数据库，数据界面就应支持数据库表的检索及sql语句的输入。数据选择界面的结果将作为数据集查询数据的条件(例如sql语句将作为商用库数据集的查询条件)。

报表制作引擎与报表渲染引擎是框架提供的两个基础引擎，独立于报表插件，扩展报表插件时，这两个引擎无需改动。报表制作引擎利用数据集返回的数据信息描述(数据列名)制作报表模板，编辑格式；报表渲染引擎调用数据集查询数据，并将其应用到报表模板中，最终计算、渲染出报表。

本发明提供一种报表框架技术，通过实现报表插件来应对企业报表的多样需求。整个方案包括实现报表数据集、数据选择界面、数据回写与数据快照这四部分内容。

一、实现报表数据集

数据集是报表插件实现统一数据接口的实例。数据集接受来自数据选择接口的查询参数，向报表制作引擎提供数据描述(数据列名)，向报表渲染引擎提供最终数据。报表渲染引擎最终结合数据集提供的数据与制作引擎提供的报表模板计算出报表。四者之间的数据流如图2所示。

数据集向报表制作引擎、报表渲染引擎提供格式化的数据，从而屏蔽了各数据源之间的差异。数据集提供的数据类似关系数据库中的一张表，其具有固定的行数与列数，每一列具由相应的列名描述。数据集返回给报表制作引擎的数据相当于列名的数组，返回给报表渲染引起的数据相当于二维数据表的内容。

实现报表数据集是实现报表插件的一个必要步骤，具体为继承统一数据接口，实现相应的方法。统一数据接口提供以下两个方法：

方法名	参数	返回
			getColumns	params:String	ArrayList<String>
getDataSet	params:String	ArrayList<ArrayList<String>>

getColumns方法返回格式化数据的每列名称，其输入参数为数据选择接口返回的结果。注意到这里的参数数据类型为String，其格式满足JSON规范。JSON(JavaScriptObjectNotation)是一种轻量级的数据交换格式，JSON采用完全独立于语言的文本格式，可以方便的描述多个键值对以及其嵌套对象。这里之所以采用JSON格式的String类型，是因为每种类型报表数据选择接口返回的参数个数、类型都不一样，很难采用固定类型来规范接口。故采用JSON格式，对于同一类型报表，其报表插件中包含对数据选择接口与统一数据接口的实现。插件在数据选择接口实现时返回的JSON字符串，在统一数据接口中“了解”其含义，可以将JSON中封装的参数一一取出。

getDataSet方法返回二维数据表，其输入参数亦为JSON格式的String类型。该参数除了数据选择接口返回的参数外，还包括另一种参数。一般应用中，在查询数据前都要通过控件选定一些参数。例如通过时间选择控件选择需浏览报表的时间。这些参数都跟应用紧密关联，需要通过控件展现给用户并且让用户选择、确认后，才传递给数据查询程序以查询最终展示数据，该类参数称为动态参数。而通过数据选择接口返回的参数称为静态参数，在不引起混淆的情况下，静态参数被简称为参数。动态参数有两个特点，一是最终查询前需要展现给用户让用户选择，二是其影响最终的查询结果，即选择了不同的参数，会得到不同的查询结果。静态参数在用户制作某张报表时已经固定，而动态参数在用户查询时会发生改变。动态参数与静态参数共同构成了数据查询参数，getDataSet方法利用这些查询参数返回给报表渲染引擎最终查询数据。

二、实现数据选择界面

数据选择界面是报表插件对数据选择接口的实现。数据选择界主要面用来选择特定数据源的数据，形成参数后，供数据集调用。例如数据源为关系数据库，数据界面就应支持数据库表的检索及sql语句的输入。数据选择界面的结果将作为数据集查询数据的条件(例如sql语句将作为商用库数据集的查询条件)。除了数据选择外，报表插件还可以在数据选择界面中定义报表特有的一些参数，这些都要视具体的报表应用而定。

数据选择界面并不是实现报表插件的必要步骤，对于没有数据选择、配置过程的报表应用，无需实现该接口。实现数据选择界面时，只需继承数据选择接口，实现相应的方法。数据选择接口实质上是一个panel类，插件需要在该panel上组织控件、布局，同时实现以下三个方法：

方法名	参数	返回
			getDialogTitle	无	String
getParams	无	String
			applyParams	params:String	boolean

getDialogTitle接口返回选择界面的窗口标题，用来标识是哪个报表插件的数据选择接口，输入参数为空，返回类型为String。

getParams接口用于返回用户选择的查询参数(静态参数)，其输入参数为空，返回值为String类型。如前所述，此处的String为JSON格式，通过JSON格式可以在String中传递多个参数。这样既保证了接口的通用性，又满足了应用多参数的扩展。

applyParams将上次选择的参数应用到配置窗口中，用于重新选择数据。其输入参数为JSON格式的String类型(上次选择的参数)，返回结果为是否成功。三、数据回写

数据回写是指报表展示时，可以修改报表数据并将其回写至数据源的功能。如何屏蔽不同数据源回写方式的差异，是数据回写的关键点。报表框架提供的回写支持是：在回写模式下，数据集返回最终数据时，须附带该单元格数据回写所需参数的信息；报表渲染引擎展示时隐藏掉这些信息；回写时将这些信息与回写的值一起返回后台，供相应的回写接口调用。

由于不是所有类型的报表都需要数据回填，故数据回写不是实现报表插件的必要步骤。实现数据回写，只需继承数据回写基类，实现相应的方法。数据回写基类提供以下两个方法：

writeBackSingle方法用于单条记录的写回，其中参数key为回写的参数，类型为String，格式为JSON；参数value为回写的值。方法的返回值标识回写是否成功。

writeBackBatch方法用于多条记录的批量写回，params为写回参数，类型为String，格式为JSON，其中包含了每条回写记录的参数与值。方法的返回值标识回写是否成功。

四、数据快照

数据快照是为了加速数据集数据查询而缓存的数据的备份。快照以文件形式存储。报表框架提供了数据快照定时生成机制，数据快照要求数据集满足以下几个条件：

1)该数据集包含一个时间属性的动态参数。如果动态参数中没有时间属性，也就无快照之说。时间动态参数的名称一定要为date，且前台传递的参数数据格式为yyyy-MM-dd。

2)如果数据集中还包含其它动态参数，数据集查询数据时一定要考虑到这些参数的默认值。应为定时框架中为报表生成数据集参数时，只会给date动态参数赋值。

3)数据选择界面返回的结果中，须包含报表周期参数。在返回的JSON格式字符串中须包含dataType域与uuid域。

快照以文件形式存储，其存储结构依赖于静态参数中包含的uuid与dataType。uuid是每一个数据集对象唯一的标识。各数据集的数据快照就是以此uuid来进行检索区分的。数据集的数据快照是以.dat文件形式存储在文件系统中。数据快照目录中包含众多子目录，每个子目录都是以uuid命名，说明该目录下存放的就是对应数据集的数据快照以供程序读取。而在具体的uuid目录中，存放着众多以时标命名的文件，如2013-4-17.dat，这便是该数据集date动态参数为2013-4-17时的数据快照。

dateType为数据集的数据周期，控制uuid目录下具体快照文件名称。例如dataType为day，则每一日都有一个快照文件，文件名为****-**-**.dat；如果dataType为month，则每一月才有一个快照文件，文件名称为****-**_01.data(默认以本月第一日为报表文件名称)；周报以本每周第一日(周日)为报表名，季度报表以季度第一日为报表名称，年报以本年第一日作为报表名称。

满足了以上3个条件后，只需对数据集最终数据查询稍作改造即可，具体流程如图3所示。大致步骤为：

1)最终数据查询时，首先根据动态参数date的值与静态参数中的dataType确定是否快照已经存在。例如dataType为day(日报)，如果date的值为当天以前，则说明快照“应该”已经生成，则优先去查询数据快照；否则就直接查询并返回数据。

2)如果优先查询数据快照，则要判断数据快照是否实际存在。如果实际数据快照并没有存在，则继续调用查询接口查询数据并生成数据快照，生成完快照后需要调用文件服务器更新文件接口将快照保存至文件服务器中；如果数据快照已经存在，则直接从数据快照中读取数据并返回。

3)如果数据集支持回填，则要考虑回填模式标识wview的取值。如果wview为true，则不能从快照中加载数据(因为快照中一般不存储填报信息)。此时不作任何判断，直接去查数据集填报信息并返回。

剩下的问题便是如何查询快照以及如何生成快照。查询数据快照时，可以根据uuid与dataType参数，结合数据快照文件的存储规则，找到该数据快照文件并读取；生成快照亦需按照快照文件规则生成。具体快照文件的内容，框架不作限制，开发者可以根据应用自定义。

以上实施例仅为说明本发明的技术思想，不能以此限定本发明的保护范围，凡是按照本发明提出的技术思想，在技术方案基础上所做的任何改动，均落入本发明保护范围之内。

Claims (5)

1.一种插件式报表框架技术，其特征在于包括统一数据接口、数据选择接口、报表制作引擎及报表渲染引擎，其中统一数据接口获取来自多种数据源的数据并将数据组织成固定格式供报表调用；数据选择接口定义报表数据查询的条件，形成的结果供统一数据接口获取查询报表数据时调用；报表制作引擎利用统一数据接口返回的数据描述制作报表模板，编辑报表格式；报表渲染引擎将报表数据应用到报表模板中，最终渲染形成报表展示。

2.如权利要求1所述的一种插件式报表框架技术，其特征在于：所述统一数据接口将各数据源的数据组织成报表调用所需格式，数据可来源于多种数据源，包括关系型数据库、文件系统及其它，报表展现无需了解数据存储介质，只需从统一数据接口中获取所需格式的数据，以此实现报表展示与数据源解耦，报表插件须根据应用需求实现统一数据接口。

3.如权利要求1所述的一种插件式报表框架技术，其特征在于：所述报表数据选择接口定义报表数据查询参数，参数最终将传递给统一数据接口调用，数据选择接口由应用需求导向，不同类型报表数据定义方式各异，报表插件须根据应用需求实现数据选择接口。

4.如权利要求1所述的一种插件式报表框架技术，其特征在于：所述报表制作引擎制作报表模板，定义报表数据的展现形式，报表模板只需报表数据描述，无需了解具体数据，数据描述由统一数据接口以数据列形式返回，报表数据列被应用到表格中，其字体、颜色等式样被具体定义，报表制作引擎由报表框架提供，报表插件无须关注。

5.如权利要求1所述的一种插件式报表框架技术，其特征在于：所述报表渲染引擎获取统一数据接口中报表的具体数据，结合模板中定义的数据展现形式进行报表计算、渲染及最终展示，渲染引擎由报表框架提供，报表插件无须关注。