自定义函数

编辑
  • 文档创建者:doreen0813
  • 浏览次数:1723次
  • 编辑次数:6次
  • 最近更新:doreen0813 于 2019-06-26
  • 1、描述

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

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

    在FineBI中,每一个函数都被定义成一个类,这个类必须要实现Function这个接口,在运算的时候首先通过函数名反射取得这个类,然后调用它的run(Object[] agrs)方法。下面以SUM这个函数为例。

    2、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;
    }
    }

    下面以一个简单的自定义函数例子来说明使用自定义函数。我们定义一个函数StringCat,他的作用是把所有的参数以字符串的形式连接起来。

    StringCat函数使用规则为StringCat(Para,Para,Para…….);

    其中Para为该函数的参数,个数不限。

    由概述可知AbstractFunction实现了Function这个接口,因此StringCat可以直接继承AbstractFunction类,完整代码如下:

    package com.fr.function;
    import com.fr.script.AbstractFunction;
    public class StringCat extends AbstractFunction {
    public Object run(Object[] args) {
    String result = "";
    Object para;
    for (int i = 0; i < args.length; i++) {
    para = args[i];
    result += para.toString();
    }
    return result;
    }
    }

    说明: 使用函数StringCat(Para,Para,Para…..)时,根据函数名取得运算该函数的类StringCat,并将参数传入类中的args对象数组中,执行该类的run函数。 而在run函数中即实现了将传入的参数以字符串的形式连接起来。并返回最终形成的字符串。

    3、实现步骤

    3.1 编译自定义函数

    将编译后的StringCat.class放到FineBI的安装目录WEB-INF下面的classes目录下,因为StringCat.java属于包com.fr.function,所以StringCat.class需要放到%FineBI%\webapps\webroot\WEB-INF\classes\com\fr\function目录下。如下图:

    注:若WEB-INF下没有对应目录则新建即可。  

    222

    3.2 注册自定义函数

    生成该函数的类后需要在设计器中进行注册,才可以使用该函数。参考设计器远程连接方法及步骤使用设计器远程连接FineBI工程,打开服务器>函数管理器,选择刚刚定义好了StringCat类,如下图:

    222

    函数名称可以自定义,如这边定义为StringCat;

    同时可以添加该函数的使用说明,如上图所示的描述。

    3.3 使用自定义函数

    注册好自定义函数后,重启FineBI后便可直接使用了,使用方法与内置的函数是相同的。

    比如我们在添加计算指标中,其他函数下面可以看到之前自定义的函数Stringcat,点击该函数可添加到公式中使用,如下图:

    222

    根据函数自定义用法编辑公式使用即可。

    注:在BI中使用自定义公式的时候,需要对公式中的字段进行类型转换。因为自定义函数在获取参数时,默认处理为sting类型,对于其他类型的字段就需要使用类型转换函数进行转换。

    比如我们使用判断是否为节假日的自定义函数IsHoliday,在函数使用时直接添加字段IsHoliday(注册时间),会提示公式不合法,如下图:

    222

    需要在注册时间字段前加上字段类型转换函数todate,将其转换为时间字段,该公式即合法,如下图:

    222

    附件列表


    主题: 专题总结
    标签: 暂无标签
    如果您认为本文档还有待完善,请编辑

    文档内容仅供参考,如果你需要获取更多帮助,付费/准付费客户请咨询帆软技术支持
    关于技术问题,您还可以前往帆软社区,点击顶部搜索框旁边的提问按钮
    若您还有其他非技术类问题,可以联系帆软传说哥(qq:1745114201

    此页面有帮助吗?只是浏览 [ 去社区提问 ]