大数据集导出

素颜马尾好姑娘i 2023-06-24 15:27 13阅读 0赞

# ps:1.报表模式应该为 数据分析 模式 #

2.设置列名 columns 时候，不应该有空格存在，逗号后边也不能有，MySQL复制所有列名时，会自带空格；

3.实例：

//获取参数控件值  
var Data\_Source = this.options.form.getWidgetByName("var\_Data\_Source").getValue();   
//alert(Data\_Source);

//获取参数控件值

var end\_Estimate\_Year\_Month = this.options.form.getWidgetByName("var\_end\_Estimate\_Year\_Month").getValue();   
//alert(end\_Estimate\_Year\_Month);

//获取参数控件值

var start\_Estimate\_Year\_Month = this.options.form.getWidgetByName("var\_start\_Estimate\_Year\_Month").getValue();   
//alert(start\_Estimate\_Year\_Month);

//获取参数控件值

var month = this.options.form.getWidgetByName("var\_month").getValue();   
//alert(month);

//获取参数控件值

var year = this.options.form.getWidgetByName("var\_year").getValue();   
//alert(year);

//接口为directExportToExcel: function (dsName, fileName, params, colNames)  
//注意参数中的特殊字符需要进行url编码，比如大括号，冒号等。

//将变量值赋值到URL中

var paramStr = encodeURIComponent("\{var\_Data\_Source:"+Data\_Source+",var\_end\_Estimate\_Year\_Month:"+end\_Estimate\_Year\_Month+", var\_start\_Estimate\_Year\_Month:"+start\_Estimate\_Year\_Month+", var\_month:"+month+", var\_year:"+year+"\}")  
//alert(paramStr)

//数据集传参,//指定导出的数据列，导出字段按此顺序排列，为空默认导出所有,最好不要为空；并且列名之间不能有空格  
var colNames = encodeURIComponent("id,Data\_Source,Sequence,Year,Month,Estimate\_Year,Estimate\_Month,Estimate\_Year\_Month,AR\_Source,Operating\_Unit,Trx\_Number,Order\_Number,Delivery,Sales\_BU,Salesrep\_Number,Salesperson,Order\_Type,Customer\_Number,Customer,Customer\_Short\_Name,Account\_Type\_1,Distributor,Bill\_to,Tier1\_end\_customer,GL\_Date,Departure\_Date,Ordered\_Item,Description,Size,Currency,Quantity,Unit\_Price,Amount,Exchange\_Rate,Local\_Currency,Total\_Amount\_Local\_Currency,Exchange\_Rate\_TM,Total\_Amount\_CNY,Total\_Amount\_USD,Total\_Amount\_EUR,Total\_Amount\_JPY,Tax\_Classification\_Code,Warehouse,Shipping\_Org\_Area,Customer\_PO,Incoterms,Payment\_Terms,Included\_in\_Revenue,Account\_Type,Cutting,Granule\_Quantity,Market\_Segments,Organization,Opp\_No,Ship\_To\_Location,Item\_Category,Tokyo\_Flag,Sales\_Rounting\_Num,Outship\_Flag,Inship\_Flag,Legal\_Entity,BD\_FD\_Flag,Group1,Group2,Group3,Business\_Area,MP\_Region,Technique\_Type,Type,NL\_TM,Global\_Account\_Region,Parent\_Account,Oper\_Sign,Record\_Date");

\_g().directExportToExcel("ds1",Data\_Source+"-"+start\_Estimate\_Year\_Month+"~"+end\_Estimate\_Year\_Month+"明细",paramStr,colNames);

# 大数据集导出 #

## 1. 版本 ##

<table style="width:600px;"> 
 <tbody> 
  <tr> 
   <th>&nbsp; 报表服务器版本</th> 
   <th>JAR 包</th> 
  </tr> 
  <tr> 
   <td style="vertical-align:middle;">10.0</td> 
   <td style="vertical-align:middle;">2018-12-27</td> 
  </tr> 
 </tbody> 
</table>

## 2. 概述 ##

### 2.1 应用场景 ###

目前 FineReport 对于大数据量的模板导出时，可能存在时间过长或内存占用过大的情况。

为了防止这样造成宕机的风险，FineReport 10.0 新增了「大数据集导出」的功能，可直接根据数据集结果进行导出。

### 2.2 功能描述 ###

此功能主要是针对明细表，它可以实现跳过报表计算直接取数导出。

## 3. 思路 ##

通过自定义 JS 调用接口，实现原理如下：

1）使用 SXSSFWorkbook 流式行导出，速度快；

2）使用生产者消费者模式，一个线程用于取数，把数据行存在队列中，另一线程读取行导出；

## 4. 接口 ##

注：此功能只支持关系型数据库，且 SQL Server 数据库需要把游标设置为服务器游标。

<table> 
 <tbody> 
  <tr> 
   <th>Key&nbsp;&nbsp;</th> 
   <th>Value&nbsp;&nbsp;</th> 
   <th>举例&nbsp;&nbsp;</th> 
  </tr> 
  <tr> 
   <td>sessionID</td> 
   <td>具体sessionID</td> 
   <td>&nbsp;&nbsp;</td> 
  </tr> 
  <tr> 
   <td>dsName</td> 
   <td>数据集名称</td> 
   <td>ds1</td> 
  </tr> 
  <tr> 
   <td>params</td> 
   <td>数据集参数 JSON，参数名:参数值</td> 
   <td>{ <p>id: '9527',</p> <p>name:'Stephen'</p> <p>}</p> </td> 
  </tr> 
  <tr> 
   <td>columns</td> 
   <td>列名称用逗号分割，不指定使用数据集所有字段</td> 
   <td>col1,col2,...</td> 
  </tr> 
  <tr> 
   <td>fileName</td> 
   <td>导出文件名称，不指定使用默认的“模板名-数据集名称.xlsx”</td> 
   <td>&nbsp;&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

接口示例如下：

//接口为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)

## 5. 示例一：导出数据集参数为单个值 ##

### 5.1 模板设置 ###

打开模板 %FR\_HOME%\\webapps\\webroot\\WEB-INF\\reportlets\\doc\\Parameter\\使用常用参数组合.cpt

### 5.2 控件设置 ###

在参数面板中添加导出按钮，并新增点击事件，如下图所示：

![1562816716987200.png][]

JS 代码如下：

//接口为directExportToExcel: function (dsName, fileName, params, colNames)
    //注意参数中的特殊字符需要进行url编码，比如大括号，冒号等。
    var paramStr = encodeURIComponent("{area:华北,province:河北}")
    //数据集传参
    var colNames = encodeURIComponent("订单ID,货主名称,货主地区,货主省份,货主城市,货主地址")
    //指定导出的数据列，导出字段按此顺序排列，为空默认导出所有；另外列名逗号之间不能有空格
    _g().directExportToExcel("ds1","订单",paramStr,colNames)

注：这里的参数名是指模板参数名，而不是数据集中的数据列名。

### 5.3 实现效果 ###

点击导出按钮，可以将 ds1 数据集导出来，如下所示：

![111.png][]

## 6. 示例二：导出数据集参数为多个值 ##

### 6.1 模板设置 ###

打开模板%FR\_HOME%\\webapps\\webroot\\WEB-INF\\reportlets\\doc\\Parameter\\使用常用参数组合.cpt

### 6.2 控件设置 ###

在参数面板中添加导出按钮，并新增点击事件，如下图所示：

![1562817491188305.png][]

JS 代码如下：

//接口为directExportToExcel: function (dsName, fileName, params, colNames)
    //注意参数中的特殊字符需要进行url编码，比如大括号，冒号等。
    var paramStr = encodeURIComponent("{area:\"华北','华东\",province:\"北京','山东\"}")
    //数据集传参
    var colNames = encodeURIComponent("订单ID,货主名称,货主地区,货主省份,货主城市,货主地址")
    //指定导出的数据列，导出字段按此顺序排列，为空默认导出所有；另外列名逗号之间不能有空格
    _g().directExportToExcel("ds1","订单",paramStr,colNames)

注：在sql参数值的前后需要加上 \\ ，防止被解析。

注：这里的参数名是指模板参数名，而不是数据集中的数据列名。

### 6.3 实现效果 ###

点击导出按钮，可以将 ds1 数据集导出来，如下所示：

![222.png][]

## 7. 已完成模板 ##

### 7.1 示例一模板 ###

已完成模板，可参见：%FR\_HOME%\\webapps\\webroot\\WEB-INF\\reportlets\\doc\\Parameter\\大数据集导出-单数据.cpt

模板下载请点击：[大数据集导出-单数据.cpt][-_.cpt]

### 7.2 示例二模板 ###

已完成模板，可参见：%FR\_HOME%\\webapps\\webroot\\WEB-INF\\reportlets\\doc\\Parameter\\大数据集导出-多数据.cpt

模板下载请点击：[大数据集导出-多数据.cpt][-_.cpt 1]

[1562816716987200.png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9oZWxwLmZpbmVyZXBvcnQuY29tL3VwbG9hZHMvMjAxOTA3MTEvMTU2MjgxNjcxNjk4NzIwMC5wbmc?x-oss-process=image/format,png
[111.png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9oZWxwLmZpbmVyZXBvcnQuY29tL3VwbG9hZHMvMjAxOTA3MTEvMTU2MjgxNzA5NzYwNzc3Ni5wbmc?x-oss-process=image/format,png
[1562817491188305.png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9oZWxwLmZpbmVyZXBvcnQuY29tL3VwbG9hZHMvMjAxOTA3MTEvMTU2MjgxNzQ5MTE4ODMwNS5wbmc?x-oss-process=image/format,png
[222.png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9oZWxwLmZpbmVyZXBvcnQuY29tL3VwbG9hZHMvMjAxOTA3MTEvMTU2MjgxNzc3NTg3OTA2OS5wbmc?x-oss-process=image/format,png
[-_.cpt]: https://help.finereport.com/uploads/file/20190711/1562817940917990.cpt
[-_.cpt 1]: https://help.finereport.com/uploads/file/20190711/1562817961200547.cpt