帆软自定义函数

1.描述

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

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

在FineReport中，每一个函数都被定义成一个类，这个类必须要实现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函数所使用代码：

<span style="color:#334356"><span style="color:#1bc1a1"><img data-cke-saved-src="http://help.finereport.com/js/clipboard/clippy.png" src="http://help.finereport.com/js/clipboard/clippy.png" alt="Copy to clipboard" class="clippy" /><code>package com.fr.report.script;

<span style="color:teal">import</span> com.fr.general.FArray;

<span style="color:teal">import</span> com.fr.script.AbstractFunction;

public <span style="color:teal">class</span> <span style="color:#445588"><strong>CSUM</strong></span> <span style="color:teal">extends</span> <span style="color:#445588"><strong>AbstractFunction</strong></span> {
	public <span style="color:#0086b3">Object</span> run(<span style="color:#0086b3">Object</span>[] args) {
		double result = <span style="color:teal">0</span>;
		<span style="color:teal">for</span> (int i = <span style="color:teal">0</span>; i < args.length; i++) {
			<span style="color:teal">if</span> (args[i] == null) {
				<span style="color:teal">continue</span>;
			}
			result += parseObject(args[i]);
		}
		<span style="color:teal">return</span> result;
	}
	private double parseObject(<span style="color:#0086b3">Object</span> obj) {
		<span style="color:teal">if</span> (obj <span style="color:teal">instanceof</span> <span style="color:#0086b3">Number</span>) {
			<span style="color:teal">return</span> ((<span style="color:#0086b3">Number</span>) obj).doubleValue();
		} <span style="color:teal">else</span> <span style="color:teal">if</span> (obj <span style="color:teal">instanceof</span> <span style="color:#0086b3">Boolean</span>) {
			<span style="color:teal">return</span> ((<span style="color:#0086b3">Boolean</span>) obj).booleanValue() ? <span style="color:teal">1</span> : <span style="color:teal">0</span>;
		} <span style="color:teal">else</span> <span style="color:teal">if</span> (obj <span style="color:teal">instanceof</span> FArray) {
			FArray array = (FArray) obj;
			double sum = <span style="color:teal">0</span>;
			<span style="color:teal">for</span> (int i = <span style="color:teal">0</span>; i < array.length(); i++) {
				sum += parseObject(array.elementAt(i));
			}
			<span style="color:teal">return</span> sum;
		} <span style="color:teal">else</span> <span style="color:teal">if</span> (obj != null) {
			<span style="color:teal">try</span> {
				<span style="color:teal">return</span> Double.parseDouble(obj.toString());
			} <span style="color:teal">catch</span> (NumberFormatException exp) {
				<span style="color:teal">return</span> <span style="color:teal">0</span>;
			}
		}
		<span style="color:teal">return</span> <span style="color:teal">0</span>;
	}
}</code></span></span>

3. 示例

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

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

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

由概述可知AbstractFunction实现了Function这个接口，因此StringCat可以直接继承AbstractFunction类

3.1 完整代码如下

<span style="color:#334356"><span style="color:#1bc1a1"><img data-cke-saved-src="http://help.finereport.com/js/clipboard/clippy.png" src="http://help.finereport.com/js/clipboard/clippy.png" alt="Copy to clipboard" class="clippy" /><code>package com.fr.function;

<span style="color:teal">import</span> com.fr.script.AbstractFunction;

public <span style="color:teal">class</span> <span style="color:#445588"><strong>StringCat</strong></span> <span style="color:teal">extends</span> <span style="color:#445588"><strong>AbstractFunction</strong></span> {
    public <span style="color:#0086b3">Object</span> run(<span style="color:#0086b3">Object</span>[] args) {
        <span style="color:#0086b3">String</span> result = <span style="color:#dd1144">""</span>;
        <span style="color:#0086b3">Object</span> para;
        <span style="color:teal">for</span> (int i = <span style="color:teal">0</span>; i < args.length; i++) {
            para = args[i];
            result += para.toString();
        }
        <span style="color:teal">return</span> result;
    }
}</code></span></span>

说明：使用函数StringCat(Para,Para,Para…..)时，根据函数名取得运算该函数的类StringCat，并将参数传入类中的args对象数组中，执行该类的run函数。

而在run函数中即实现了将传入的参数以字符串的形式连接起来。并返回最终形成的字符串。

3.2 编译自定义函数

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

3.3 注册自定义函数

生成该函数的类后需要在设计器中进行注册，才可以使用该函数。打开服务器>函数管理器，选择刚刚定义好了StringCat类，如下图