历史版本38 :导出API 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 描述编辑

FineReport 提供了强大的输入输出功能,所有的这些输入输出的类都在 com.fr.report.io 包里面。

报表的输入指从报表的模板文件(XML格式的)创建 WorkBook 对象,在报表调用章节已经介绍过。

输出则指将报表保存为各种格式文件,FineReport 支持将报表保存为 cpt、内置数据 cpt、pdf、excel、Word、svg、csv、image(包含png、 jpg、gif、 bmp)等多种文件格式,释放导出进程。


2. 原理编辑

我们以 Parameter.cpt 模板作为被导出模板,参数为报表参数,且设置默认值为华东


2.1 导出成内置数据集模板

导出成内置数据集模板,顾名思义是将原模板的数据源根据参数条件查询出结果并转为内置数据集,然后把模板导出,不需要对原模板进行计算(数据列扩展、公式计算等)。

// 将未执行模板工作薄导出为内置数据集模板              outputStream = new FileOutputStream(new File("C:\\test\\EmbExport.cpt"));            EmbeddedTableDataExporter templateExporter = new EmbeddedTableDataExporter();            templateExporter.export(outputStream, workbook);


2.2 导出模板文件

我们可以将原模板通过程序编辑后再次导出为模板文件,或者将某一路径下的模板保存至另一路径下。

// 将模板工作薄导出模板文件,在导出前您可以编辑导入的模板工作薄,可参考报表调用章节  
            
outputStream = new FileOutputStream(new File("C:\\test\\TmpExport.cpt"));            
((WorkBook) workbook).export(outputStream);

2.3 导出 2003Excel 文件

模板工作薄 WorkBook 执行后为结果工作薄 ResultWorkBook,我们可以把计算后的结果导出成 Excel 文件。

// 将结果工作薄导出为 2003Excel 文件              outputStream = new FileOutputStream(new File("C:\\test\\ExcelExport.xls"));            ExcelExporter ExcelExport = new ExcelExporter();            ExcelExport.export(outputStream, workbook.execute(parameterMap, new WriteActor()));

注:导出 Excel 的其他格式可以参考文档:Excel 导出的多种方式 章节

注:如果需要导出 2007 版 Excel,需要将 ExcelExporter ExcelExport = new ExcelExporter() 改成StreamExcel2007Exporter ExcelExport = new StreamExcel2007Exporter();,具体代码如下:

// 将结果工作薄导出为 Excel文件  
outputStream = new FileOutputStream(new File("C:\\test\\ExcelExport.xlsx"));
StreamExcel2007Exporter ExcelExport1 = new StreamExcel2007Exporter();
ExcelExport1.export(outputStream, workbook.execute(parameterMap, new WriteActor()));


2.4 导出 Word 文件 

// 将结果工作薄导出为 Word 文件              

outputStream = new FileOutputStream(new File("C:\\test\\WordExport.doc"));           
WordExporter WordExport = new WordExporter();          
WordExport.export(outputStream, workbook.execute(parameterMap, new WriteActor()));

注:FineReport 报表导出 Word 不支持导出悬浮元素,因此若您需导出的模板中包含有悬浮元素如图表,请将其改为单元格元素。


2.5 导出 pdf 文件

// 将结果工作薄导出为 pdf 文件  
outputStream = new FileOutputStream(new File("C:\\test\\PdfExport.pdf"));
PDFExporter PdfExport = new PDFExporter();
PdfExport.export(outputStream, workbook.execute(parameterMap, new WriteActor()));


2.6 导出 txt 文件

// 将结果工作薄导出为 txt 文件(txt 文件本身不支持表格、图表等,被导出模板一般为明细表)  
outputStream = new FileOutputStream(new File("C:\\test\\TxtExport.txt"));
TextExporter TxtExport = new TextExporter();
TxtExport.export(outputStream, workbook.execute(parameterMap, new WriteActor()));


2.7 导出 csv 文件

// 将结果工作薄导出为 csv 文件  
outputStream = new FileOutputStream(new File("C:\\test\\CsvExport.csv"));
CSVExporter CsvExport = new CSVExporter();
CsvExport.export(outputStream, workbook.execute(parameterMap, new WriteActor()));


2.8 导出 SVG 文件

//将结果工作薄导出为 SVG 文件  
outputStream = new FileOutputStream(new File("C:\\test\\SvgExport.svg"));
SVGExporter SvgExport = new SVGExporter();
SvgExport.export(outputStream, workbook.execute(parameterMap, new WriteActor()));


2.9 导出 image 文件

//将结果工作薄导出为 image 文件  
outputStream = new FileOutputStream(new File("C:\\test\\PngExport.png"));
ImageExporter ImageExport = new ImageExporter();
ImageExport.export(outputStream, workbook.execute(parameterMap, new WriteActor()));

注:Image 图片支持 png、jpg、 gif、 bmp 格式,这里示例是 png 格式,默认为 jpg。


2.10 释放进程

通过导出 API 在后台导出 Excel 等文件,会产生很多进程,通过下面的方案释放进程。

在导出完成之后添加下面代码:

outputStream.close();
ModuleContext.stopModules();


3. 示例编辑

3.1 完整可执行代码详见:

https://git.fanruan.com/demo/example/src/release/10.0/src/main/java/com/fr/io/ExportApi.java

注:在使用 API 导出不同类型文件时,除了需要导入 FineReport 默认 JAR 包之外,还需要导入%FR_HOME%\webroot\WEB-INF\lib下面的 sqlite-jdbc.jar  tomcat\lib下面的 serverlet-api.jar

编译运行该代码后,就会在对应的文件夹下生成不同格式的文件,这样就导出成功了,如下图:

222

4. 错误代码:1120 出现原因及解决方法编辑

运行编译好的代码时,会弹出错误提示:错误代码:1120 当前 HSQL 数据库已被另一线程锁定。

原因:导出的时候使用了运行环境,所以会把 db.lck 给死锁,导出一次后再次导出就会报错。

解决方法:

方法一:关闭 Eclipse 进程,%FR_HOME%\webapps\webroot\WEB-INF\embed\finedb的 db.lck 文件删除,再次运行Eclipse 即可。

注:该方法在运行一次后仍会报错,需要反复删除 db.lck 文件。

方法二:迁移平台数据,具体可以参考 配置外接数据库

索引:

多个报表导入一个 Excel

Excel 直接转成模板cpt

通过代码创建模板

Excel 导出的多种方式

后台批量导出 Excel