自定义函数简介

1.1 应用场景

FineBI 已经提供了大量的自带函数，在正常情况下足够满足用户的模板制作需求，但是在一些特殊领域，可能需要一些特殊的函数，在这种情况下，FineBI 提供了自定义函数，可以由用户根据业务需要自己来定义一些函数，但这些函数必须满足 FineBI 函数定义规则。

注：仅支持抽取数据。

1.2 使用范围

• 仅支持抽取数据版本。

• 不支持自定义聚合类函数，例如：聚合函数、快速计算函数 。

1.3 定义规则

FineBI函数定义规则：Functionname(Para,Para,...)，其中 Functionname 为函数名，Para 为参数。

在 FineBI 中，每一个函数都被定义成一个类，这个类必须要实现 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。

SUM函数所使用代码：

package com.fr.report.script;
import com.fr.general.FArray;
import com.fr.script.AbstractFunction;
public class CSUM extends AbstractFunction {
public Object run(Object[] args) {
double result = 0;
for (int i = 0; i < args.length; i++) {
if (args[i] == null) {
continue;
}
result += parseObject(args[i]);
}
return result;
}
private double parseObject(Object obj) {
if (obj instanceof Number) {
return ((Number) obj).doubleValue();
} else if (obj instanceof Boolean) {
return ((Boolean) obj).booleanValue() ? 1 : 0;
} else if (obj instanceof FArray) {
FArray array = (FArray) obj;
double sum = 0;
for (int i = 0; i < array.length(); i++) {
sum += parseObject(array.elementAt(i));
}
return sum;
} else if (obj != null) {
try {
return Double.parseDouble(obj.toString());
} catch (NumberFormatException exp) {
return 0;
}
}
return 0;
}
}

1.4 编译环境准备

详情参见：编译Java程序

以一个简单的自定义函数例子来说明使用自定义函数。

定义一个函数 StringCat ，作用是把所有的参数以字符串的形式连接起来。

详情参见：自定义函数实现字符串拼接

1）自定义函数名以 class 文件名为准。

2）自定义函数文件名仅支持英文，包括纯大写、纯小写、大小写混合输入。

3）添加的函数在「其他函数」中展示。

4）当前不支持大小写混合输入。