极速报表：模板及插件

变更记录

1 简介

    使用极速报表开发业务报表时，必须继承元数据模板才能实现相关的功能，同时框架对相关的功能进行了封装，开发了一些供业务使用的插件。在实现相关功能时，需要实现相应的方法。下面分元数据模板和插件接口两部分来介绍。

1.2 元数据模板

    报表元数据模板：scmc_report_tpl，元数据模板对过滤区域进行了划分，通用过滤、显示设置、合计列有木人的设置，同时配置了模板插件。如下图：

    在目标页面添加的任何字段标识，需要注意不能与报表列表控件中动态生成的字段同名，报表列表中字段是动态生成，可能导致冲突。比如：通用过滤加了字段叫org，报表列表显示一列也叫org，可能出现数据显示异常，也可能报错。

    关键区域和字段

1.2 插件及接口

    即时报表插件有3类：

    1）报表页面控制插件（与平台原生报表一致），用于控制页面交互逻辑，可以有多个，需继承kd.bos.report.plugin.AbstractReportFormPlugin（领域模型插件）；

    2）列表查询插件，用于实现数据查询的逻辑，只能配置一个，需继承kd.bplat.scmc.report.core.tpl.AbstractReportQuery （极速报表插件），该插件对查询逻辑进行业务了封装，用于接通配置。子类几乎不用实现任何逻辑。

     3）报表计算插件，用于业务控制具体的计算逻辑，实现一定的扩展，可以有多个，需实现kd.bplat.scmc.report.core.tpl.IReportDataHandle（极速报表插件），在对应的报表数据源插件列表中配置，业务大部分逻辑，都在这个插件里实现；

    报表的总体思路，可以这样理解：计算报表分为输入层、计算层、输出层，输入层需要的是一些报表的参数，及过滤条件，也可以分为框架的参数，和业务的参数，框架的参数就是通用过滤设置的条件，显示设置的参数等，业务的参数就是自定义的一些常用过滤和自定义的一些特殊参数，都是在输入层完成，即在AbstractReportFormPlugin 实现类控制。输出层则是定义的一些流式计算框架，开放了很多的切口，运行业务将自定义的一些参数在计算前设置好，如自定义的过滤条件。以及业务可以在相应的方式中设置算子达到计算的要求。输出层则无需关注，都是输出到报表页面。

    因此在实现相关功能前，应该先思考清楚，自己要加的逻辑是在哪一层控制。而不是以达功能为目的。不合理的设计可能导致业务报表的无法再扩展。

2 开发技巧

    2）列表查询插件。

     3）报表计算插件。

2.3 接口方法

    页面控制插件是领域模型（即平台）的插件，开发人员需先对平台Form插件有所了解。列表查询插件只需要继承出一个子类，几乎不需要修改任何逻辑，因此，这两种插件这里不做介绍。下面重点介绍报表计算插件。

2.3.1 接口：kd.bplat.scmc.report.core.tpl.IReportDataHandle。

• setupCtx

    设置上下文，通过ctx.get方法获取信息，然后ctx.set相关信息，比如：将Form界面传过来的自定义条件，设置到报表过滤条件中。

• handleBlockDataSelectCols

    这里只对某个数据块来定义，中间表需要哪些字段，默认逻辑字段是不会自动加载的，根据不同的逻辑需要，添加不同的字段需求。尽量避免全部字段加载。一般是数据源到数据库中间MR算子有需求是才会添加。计算完后，不会影响中间表字段。

• handleBigtableCols

    这里收集的是中间表需要哪些字段，默认逻辑字段是不会自动加载的，根据不同的逻辑需要，添加不同的字段需求。尽量避免全部字段加载。这里添加后，所有映射的数据库都会识别需要字段，自动加载数据。

     注意：这里方法加的字段，默认会传递到handleBlockDataSelectCols中。反之，则没有传递关系。

• modifyBlocks

    针对实体数据源进行一些设置。ctx是上下文信息，blockCollector是数据源信息集合。比如：代码自定义一个数据块，添加到blockCollector，或通过遍历数据块，在特点的数据块信息中添加过滤条件、添加数据转换器，修改字段映射等。

• modifyJoinBlocks

    针对关联实体数据源进行一些设置。和modifyBlocks 用法相同。在V5.0.024版本添加的。

• transFormAfterUnion

    定义在数据块Union完之后，需要执行哪些数据转换器，transCollector.add即可，比如：需要对数量进行拆分为收入、发出等列，在改方法比较合适，因为下一节点就是分组汇总。

• beforeGroupData

    在分组汇总添加自定义算子前，可以再次对ctx进行信息修改，比如：不想使用标准的分组合计逻辑，可以修改后删除GroupPlan，也可以在setUpdate位置除了。

• transFormAfterGroup

    定义在数据块分组汇总完之后，需要执行哪些数据转换器，transCollector.add即可。

• beforeAddSumRow

在添加汇总行算子前，可以再次对ctx进行信息修改，比如：不想使用标准的分组合计逻辑，可以修改后删除RowSumPlan。

• transFormAfterAddSumRow

    定义在数据块添加汇总行之后，需要执行哪些数据转换器，transCollector.add即可。

• transformResult

    定义在AlgoX计算完结果，输出DataSet数据包后，需要执行哪些数据转换器，transCollector.add即可。注意这里要添加的是IDataTransform实现类了。

• buildShowColumn

    定义报表字段如何显示，比如：增加字段、调整字段的一些定义。Cols是经过框架自动处理完的字段集合。插件修改后再返回。

2.3.2 数据转换接口：kd.bplat.scmc.report.core.tpl.IDataXTransform

• d