1. 概述编辑
1.1 版本
报表服务器版本 | JAR 包 |
---|---|
10.0 | 2018-12-27 |
1.2 应用场景
大批量数据导出的时候,会对服务器、网络传输、数据库造成一定的压力。为了防止这样的风险,FineReport 10.0 新增了「大数据集导出」的功能,可直接根据数据集结果进行导出。
1.3 功能描述
「大数据集导出」功能主要是针对明细表,用户通过自定义 JavaScrpit 代码调用接口,实现跳过报表计算直接取数导出。
实现原理如下:
1)使用 SXSSFWorkbook 流式行导出,速度快。
2)使用生产者消费者模式,一个线程用于取数,把数据行存在队列中,另一线程读取行导出。
1.4 接口简介
大数据集导出接口:directExportToExcel: function (dsName, fileName, params, colNames)
Key | Value | 举例 |
---|---|---|
sessionID | 具体 sessionID | - |
dsName | 数据集名称 | ds1 |
params | 数据集参数 JSON,参数名:参数值 | { id: '9527', name:'Stephen' } |
columns | 列名称用逗号分割,不指定使用数据集所有字段 | col1,col2,... |
fileName | 导出文件名称,不指定使用默认的「模板名-数据集名称.xlsx」 |
注1:此功能只支持关系型数据库,且 SQL Server 数据库需要把游标设置为服务器游标。
注2:MySQL 数据库,不能在 where 子句中使用列别名,否则无法成功导出。当 MySQL 评估求值 where 子句时,SELECT 子句中指定的列的值可能尚未确定。
接口示例如下:
//接口为directExportToExcel: function (dsName, fileName, params, colNames)
//注意参数中的特殊字符需要进行url编码,比如大括号,冒号等。
var paramStr = encodeURIComponent("{param1:1,param2:\"21','22\",param3:\"text\",...}")
//数据集传参,字符串参数建议写成格式\"text\"
var colNames = encodeURIComponent("col1, col2, col3,...")
//指定导出的数据列,导出字段按此顺序排列,为空默认导出所有
_g().directExportToExcel("数据集名称", "导出文件名称", paramStr, colNames)
2. 示例一:大数据集导出固定参数值编辑
2.1 新建模板
2.1.1 新建数据集
新建普通报表,新建数据集,如下图所示:
ds1:SELECT * FROM 销量 where 1=1 and 地区 in ('${area}') and 销售员 in ('${stuff}')
ds2:SELECT 销售员 FROM 销量 where 地区 in ('${area}')
2.1.2 设计报表
报表主体样式如下表所示:
2.2 设置查询控件
编辑参数面板,新增两个标签控件,两个下拉复选框控件,一个查询控件。如下图所示:
2.2.1 地区控件
选中第一个下拉复选框控件,设置控件名称为area,标签名称为地区:,数据字典设置为销量表中的地区,返回值类型为字符串,分隔符为',',如下图所示:
2.2.2 销售员控件
选中第二个下拉复选框控件,设置控件名称为stuff,标签名称为销售员:,数据字典设置为数据集 ds2中的销售员,返回值类型为字符串,分隔符为',',如下图所示:
2.3 设置导出控件
2.3.1 新增控件
新增一个按钮控件,点击控件设置>属性,设置按钮名字为大数据集导出,如下图所示:
2.3.2 设置点击事件
选中按钮控件,点击控件设置>事件,新增点击事件,输入 JavaScript 语句,如下图所示:
JavaScript 代码如下:
//接口为directExportToExcel: function (dsName, fileName, params, colNames)
//注意参数中的特殊字符需要进行url编码,比如大括号,冒号等
var paramStr = encodeURIComponent("{area:\"华北','华东\",stuff:\"孙林','王伟\"}")
//数据集传参,字符串参数建议写成格式\"text\",参数多值写法为\"text1','text2\"
var colNames = encodeURIComponent("地区,销售员,产品类型,产品,销量")
//指定导出的数据列,导出字段按此顺序排列,为空默认导出所有
_g().directExportToExcel("ds1", "销量", paramStr, colNames
注1:这里的参数名是指模板参数名,而不是数据集中的数据列名。
注2:在 SQL 参数值的前后需要加上 \ ,防止被解析。
2.4 效果预览
保存模板,点击分页预览。
点击大数据集导出按钮,可以将「地区为华北、华东且销售员为孙伟、王林」的 ds1 数据集导出为 Excel 文件。导出内容与查询内容无关,如下图所示:
注:不支持移动端。
3. 示例二:大数据集导出动态参数值编辑
3.1 新建模板
2.1.1 新建数据集
新建普通报表,新建数据集,如下图所示:
ds1:SELECT * FROM 销量 where 1=1 and 地区 in ('${area}') and 销售员 in ('${stuff}')
ds2:SELECT 销售员 FROM 销量 where 地区 in ('${area}')
3.1.2 设计报表
报表主体样式如下表所示:
3.2 设置查询控件
编辑参数面板,新增两个标签控件,两个下拉复选框控件,一个查询控件。如下图所示:
3.2.1 地区控件
选中第一个下拉复选框控件,设置控件名称为area,标签名称为地区:,数据字典设置为销量表中的地区,返回值类型为字符串,分隔符为',',如下图所示:
3.2.2 销售员控件
选中第二个下拉复选框控件,设置控件名称为stuff,标签名称为销售员:,数据字典设置为数据集 ds2中的销售员,返回值类型为字符串,分隔符为',',如下图所示:
3.3 设置动态导出列
新增一个标签控件,一个下拉复选框控件
选中下拉复选框控件,点击控件设置>属性,设置控件名称为col,标签名称为导出列,数据字典类型为公式,实际值为TABLEDATAFIELDS("ds1"),如下图所示:
3.4 设置导出控件
3.4.1 新增控件
新增一个按钮控件,点击控件设置>属性,设置按钮名字为大数据集导出,如下图所示:
3.4.2 设置点击事件
选中按钮控件,点击控件设置>事件,新增点击事件,输入 JavaScript 语句,如下图所示:
JavaScript 代码如下:
var widgetNames = ['area', 'stuff'];
//定义数组存放控件名称
function getWidgetValueByName(name) {
var widget = _g().parameterEl.getWidgetByName(name);
//根据控件名获取控件值
if (widget == undefined) return;
var obj = {};
obj[name] = widget.getValue();
return obj;
//返回控件值组成的数组
}
var paramJson = widgetNames.map(getWidgetValueByName).reduce(function(a, b) {
return Object.assign(a, b)
});
var paramJsonStr = JSON.stringify(paramJson);
//将JSON数据转换为字符串
var col = this.options.form.getWidgetByName("col").getValue();
//alert(col);
//参数进行URL编码
var colNames = encodeURIComponent(col)
//var colNames = encodeURIComponent("地区,销售员,产品类型,产品,销量")
//指定导出的数据列,导出字段按此顺序排列,为空默认导出所有
//调用导出接口
//console.log(paramJsonStr);
//console.log(colNames);
_g().directExportToExcel("ds1", "销量", encodeURIComponent(paramJsonStr), colNames)
3.5 效果预览
保存模板,点击分页预览。
查询地区、销售员,选择需要导出的数据列,点击大数据集导出按钮,导出内容与查询内容一致,且仅导出指定的数据列。如下图所示:
注:不支持移动端。
4. 已完成模板编辑
4.1 示例一
已完成模板,可参见:%FR_HOME%\webapps\webroot\WEB-INF\reportlets\doc\Parameter\大数据集导出固定参数值.cpt
点击下载模板:大数据量导出固定参数值.cpt
4.2 示例二
已完成模板,可参见:%FR_HOME%\webapps\webroot\WEB-INF\reportlets\doc\Parameter\大数据集导出动态参数值.cpt
点击下载模板:大数据量导出动态参数值.cpt