1. 概述
1.1 应用场景
FineReport 已经提供了大量的自带函数,在正常情况下足够满足用户的报表制作需求,但是在一些特殊领域,可能需要一些特殊的函数,在这种情况下,FineReport 提供了自定义函数机制,可以由用户根据业务需要自己来定义一些函数,但这些函数必须满足FineReport函数定义规则。
1.2 函数定义规则
FineReport 函数定义规则:Functionname(Para,Para,...),其中Functionname为函数名,Para 为参数。
在 FineReport中,每一个函数都被定义成一个类,这个类必须要实现 Function 这个接口,在运算的时候首先通过函数名反射取得这个类,然后调用它的 run(Object[] agrs)方法。下面以 SUM 这个函数为例。
由程序可以看到,SUM 类用来运算 SUM 函数,他继承了 AbstractFunction 类,而 AbstractFunction 实现了 Function 这个接口。
当函数运算的时候,先根据函数名取得运算该函数的类,如 SUM(2,4,true) 这个函数先根据函数名取得 SUM 这个类,然后调用 SUM 类的run(Object[] args) 方法,args 中存放的是 SUM 函数的参数,运算的时候可以从 args 中取得参数进行运算。如执行结果为SUM(2,4,true)=2+4+1=7。
1.3 编译环境准备
详情参见:编译Java程序
2. 示例
下面以一个简单的自定义函数例子来说明使用自定义函数。我们定义一个函数 StringCat,它的作用是把所有的参数以字符串的形式连接起来。
StringCat 函数使用规则为StringCat(Para,Para,Para…….);
其中 Para 为该函数的参数,个数不限。
由概述可知 AbstractFunction 实现了 Function 这个接口,因此 StringCat 可以直接继承 AbstractFunction 类。
2.1 编写 Java 文件
编写StringCat.java,
说明: 使用函数 StringCat(Para,Para,Para…..)时,根据函数名取得运算该函数的类 StringCat,并将参数传入类中的 args 对象数组中,执行该类的run 函数。
而在 run 函数中即实现了将传入的参数以字符串的形式连接起来。并返回最终形成的字符串。
2.2 编译 class 文件
2.2.1 编译环境准备
详情参见:编译Java程序
2.2.2 生成 class 文件
编译 StringCat.java,生成类 StringCat.class 。
2.3 导入 class 文件
将编译后的StringCat.class放到 FineReport 的安装目录%FR_HOME%\webapps\webroot\WEB-INF\classes\com\fr\function目录下。
2.4 注册自定义函数
重启设计器后便可直接使用,使用方法与内置的函数是相同的。
生成该函数的类后需要在设计器中进行注册,才可以使用该函数。打开「服务器>函数管理器」,选择刚刚定义好的 StringCat 类,如下图所示:
修改函数名称和函数描述,如下图所示:
2.5 使用自定义函数
注册好自定义函数后,制作报表时便可直接使用了,使用方法与内置的函数是相同的。
1)模板设计
新建报表,定义两个报表参数 para1、para2,类型分别为字符串型与整形,默认值分别为空字符串与 0,如下图所示:
添加参数到参数面板,在空白报表的任意单元格里写入公式:=StringCat($para1,$para2),如下图所示:
注:写入公式的时候在参数名前加 $,表明这是使用的参数。
2)模板预览
点击分页预览在参数控件中,写入参数值如 para1 为:FineReport,para2 为:123。
点击查询可以看到结果:
3. 索引
4. 自定义函数配置信息
函数管理器中配置的自定义函数信息都会存储在 FineDB 的 fine_conf_entity 表中,字段都是以 FunctionConfig.functionDefList 开头。
每个自定义函数会被随机分配一个 8 位的 UUID
在数据库中存储格式为:
字段 | 含义 | 值 |
---|---|---|
FunctionConfig.functionDefList.hm480sJe.className | 类名 | com.fr.test.gauthority |
FunctionConfig.functionDefList.hm480sJe.description | __EMPTY__ | |
FunctionConfig.functionDefList.hm480sJe.name | 函数名 | gauthority |
注:在进行项目集成时,若报表应用使用了自定义函数,要将该配置文件拷贝到服务器应用中。重启后生效。