1. 概述
1.1 应用场景
实际应用中,用户可能需要通过程序来获取数据。FineReport 支持程序数据集,用户自定义程序数据源后,可在数据集处添加「程序」数据集使用。
本文将会通过一个简单示例,讲解如何定义和使用程序数据集。示例将通过 Java 程序,自定义一个简单数据表,用来制作报表。
1.2 实现原理
FineReport 是通过 AbstractTableData 抽象类来读取数据源的,所有的数据来源都继承实现其抽象方法。因此用户只要实现了 AbstractTableData 抽象类,就可以用自定义类型的数据源,FineReport 报表引擎就能够读取定义的数据源作为报表数据源使用。
自定义 Java 代码思路为:
1) 定义数据表结构
2)实现构建函数,在构建函数中准备数据
3)实现 AbstractTableData 抽象类
2. 示例
下面实现一个简单自定义数据源,作为程序数据集使用。数据如下表所示:
Name | Score |
---|---|
Alex | 15 |
Helly | 22 |
Bobby | 99 |
2.1 准备编译环境
编译程序前,需先创建一个 Java 工程环境,并且需要一个 Java 编辑器,如 Eclipse 或 idea 。
在编辑器工程中导入 FineReport 工程 JAR 包。包括安装的报表工程
%FR_HOME%/lib下的所有的包,
%FR_HOME%/server/lib 下的所有包,
%FR_HOME%/webapps/webroot/WEB-INF/lib下的所有包,
还要引入 JDK 下的的 tools.jar。详细操作可参考:编译Java程序
2.2 定义程序数据源
2.2.1 编写 Java 程序
在编辑器中编写 Java 程序 ArrayTableDataDemo.java,即定义一个类,继承 AbstractTableData,并实现里面的方法。
完整代码可参见:
注1:建议文件的包名路径和如下代码中一致,若不一致,要保证在 2.3 节 %FR_HOME%\webapps\webroot\WEB-INF\classes工程路径下有对应的文件夹。
注2:若包名路径和如下代码中不一致,需要手动引入 AbstractTableData,即代码中加入 import com.fr.data.AbstractTableData;
注3:远程设计时情况下,自定义程序数据集中定义的数据字段必须是可序列化的,不然数据集预览会报错。
10.0.16 之前的版本:
https://code.fanruan.com/demo/example/src/release/10.0/src/main/java/com/fr/data/ArrayTableDataDemo.java
10.0.16 及之后的版本:https://code.fanruan.com/demo/example/src/branch/release/10.0/src/main/java/com/fr/data/SimpleArrayTableDataDemo.java
2.2.2 编译 Java 文件
Java 程序编写完成后,在编译器中编译 ArrayTableDataDemo.java ,编译通过后,将会在对应工程下生成ArrayTableDataDemo.class 类文件。
2.2.3 导入 class 文件
将编译后生成的 ArrayTableDataDemo.class 类文件文件复制到 %FR_HOME%\webapps\ \webroot\WEB-INF\classes\com\fr\data 工程目录下,此时该程序数据源便定义好了。如下图所示:
注2:远程设计时,本地设计器和远程服务器的工程下都需要放置程序数据集对应的 class 文件。
点击下载 class 文件:ArrayTableDataDemo.rar
2.3 创建程序数据集
点击模板数据集下面的加号,选择「程序」数据集,在弹出的程序数据集对话框中,选择对应的 class 文件,如下图所示:
选定 class 文件后,点击保存后即完成了程序数据源配置。
2.4 使用程序数据集
配置好程序数据源后便可以使用自定义的程序数据集,与其他类型的数据集使用方法相同,可以通过拖拽方法实现单元格数据列绑定。如下图所示:
注:如果预览不出数据,请确认代码段里面定义数据库连接时 URL 的地址是否正确、数据连接名称是否正确。