导出API

编辑
文档创建者:印然 (67260 )     浏览次数:9759次     编辑次数:27次     最近更新:jiangsr 于 2018-01-23     

目录:

1.描述编辑

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

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

输出则指将报表保存为各种格式文件,FineReport支持将报表保存为cpt、内置数据cpt、Pdf、Excel、Word、Svg、Csv、Image(包含png、 jpg、gif、 bmp、wbmp)等多种文件格式,释放导出进程。

2.实现原理编辑

我们以Parameter.cpt模板作为被导出模板,参数为报表参数,且设置默认值为华东
2.1 导出成内置数据集模板
导出成内置数据集模板,顾名思义是将原模板的数据源根据参数条件查询出结果并转为内置数据集,然后把模板导出,不需要对原模板进行计算(数据列扩展、公式计算等)。
// 将未执行模板工作薄导出为内置数据集模板 outputStream = new FileOutputStream(new File("E:\\EmbExport.cpt")); EmbeddedTableDataExporter templateExporter = new EmbeddedTableDataExporter(); templateExporter.export(outputStream, workbook);
2.2 导出模板文件
我们可以将原模板通过程序编辑后再次导出为模板文件,或者将某一路径下的模板保存至另一路径下。
// 将模板工作薄导出模板文件,在导出前您可以编辑导入的模板工作薄,可参考报表调用章节 outputStream = new FileOutputStream(new File("E:\\TmpExport.cpt")); ((WorkBook) workbook).export(outputStream);
2.3 导出Excel文件
模板工作薄WorkBook执行后为结果工作薄ResultWorkBook,我们可以把计算后的结果导出成Excel文件。
// 将结果工作薄导出为Excel文件 outputStream = new FileOutputStream(new File("E:\\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("D:\\ExcelExport.xlsx")); StreamExcel2007Exporter ExcelExport1 = new StreamExcel2007Exporter(); ExcelExport1.export(outputStream, workbook.execute(parameterMap,new WriteActor()));
2.4 导出Word文件 
// 将结果工作薄导出为Word文件 outputStream = new FileOutputStream(new File("E:\\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("E:\\PdfExport.pdf")); PDFExporterProcessor PdfExport = PDFExporterFactory.getPDFExporter(); PdfExport.export(outputStream, workbook.execute(parameterMap,new WriteActor()));
注:2016年12月30日以后的jar,原先使用new PDFExportor()接口已经淘汰 ,任然可以兼容使用,安装性能优化插件后也兼容使用PDFExportor(),但是无法达到提升性能的效果,若想提升性能需要更换新接口。
另:新的接口为PDFExporterFactory.getPDFExporter(boolean isPrint) 和PDFExporterFactory.getPDFExporter() isPrint默认为false
2.6 导出Txt文件
// 将结果工作薄导出为Txt文件(txt文件本身不支持表格、图表等,被导出模板一般为明细表) outputStream = new FileOutputStream(new File("E:\\TxtExport.txt")); TextExporter TxtExport = new TextExporter(); TxtExport.export(outputStream, workbook.execute(parameterMap,new WriteActor()));
2.7 导出Csv文件
// 将结果工作薄导出为Csv文件 outputStream = new FileOutputStream(new File("E:\\CsvExport.csv")); CSVExporter CsvExport = new CSVExporter(); CsvExport.export(outputStream, workbook.execute(parameterMap,new WriteActor()));
2.8 导出Svg文件
//将结果工作薄导出为SVG文件 outputStream = new FileOutputStream(new File("D:\\SvgExport.svg")); SVGExporter SvgExport = new SVGExporter(); SvgExport.export(outputStream, workbook.execute(parameterMap,new WriteActor()));
2.9 导出Image文件
//将结果工作薄导出为image文件 outputStream = new FileOutputStream(new File("D:\\PngExport.png")); ImageExporter ImageExport = new ImageExporter(); ImageExport.export(outputStream, workbook.execute(parameterMap,new WriteActor()));
注:Image图片支持png, jpg, gif, bmp, wbmp格式,只需要修改后缀,这里示例是png格式,也可以修改为JpgExport.jpg
2.10 释放进程
通过导出API在后台导出excel等文件,会产生很多进程,通过下面的方案释放进程。
在导出完成之后添加下面代码:
outputStream.close(); ModuleContext.stopModules();

3.示例编辑

3.1 完整可执行代码
package com.fr.io; import java.io.File; import java.io.FileOutputStream; import com.fr.base.FRContext; import com.fr.general.ModuleContext; import com.fr.base.Parameter; import com.fr.dav.LocalEnv; import com.fr.io.exporter.CSVExporter; import com.fr.io.exporter.EmbeddedTableDataExporter; import com.fr.io.exporter.ExcelExporter; import com.fr.io.exporter.PDFExporter; import com.fr.io.exporter.PDFExporterProcessor; import com.fr.io.exporter.TextExporter; import com.fr.io.exporter.WordExporter; import com.fr.io.exporter.SVGExporter; import com.fr.io.exporter.ImageExporter; import com.fr.io.exporter.excel.stream.StreamExcel2007Exporter; import com.fr.main.impl.WorkBook; import com.fr.main.workbook.ResultWorkBook; import com.fr.report.module.EngineModule; import com.fr.stable.WriteActor; import com.fr.web.core.reserve.PDFExporterFactory; public class ExportApi { public static void main(String[] args) { // 定义报表运行环境,才能执行报表 String envpath = "D:\\FineReport_8.0\\WebReport\\WEB-INF"; FRContext.setCurrentEnv(new LocalEnv(envpath)); ModuleContext.startModule(EngineModule.class.getName()); ResultWorkBook rworkbook = null; try { // 未执行模板工作薄 WorkBook workbook = (WorkBook) TemplateWorkBookIO .readTemplateWorkBook(FRContext.getCurrentEnv(), "\\doc\\Primary\\Parameter\\Parameter.cpt"); // 获取报表参数并设置值,导出内置数据集时数据集会根据参数值查询出结果从而转为内置数据集 Parameter[] parameters = workbook.getParameters(); parameters[0].setValue("华东"); // 定义parametermap用于执行报表,将执行后的结果工作薄保存为rworkBook java.util.Map parameterMap = new java.util.HashMap(); for (int i = 0; i < parameters.length; i++) { parameterMap.put(parameters[i].getName(), parameters[i] .getValue()); } // 定义输出流 FileOutputStream outputStream; // 将未执行模板工作薄导出为内置数据集模板 outputStream = new FileOutputStream(new File("D:\\EmbExport.cpt")); EmbeddedTableDataExporter templateExporter = new EmbeddedTableDataExporter(); templateExporter.export(outputStream, workbook); // 将模板工作薄导出模板文件,在导出前您可以编辑导入的模板工作薄,可参考报表调用章节 outputStream = new FileOutputStream(new File("D:\\TmpExport.cpt")); ((WorkBook) workbook).export(outputStream); // 将结果工作薄导出为2003Excel文件 outputStream = new FileOutputStream(new File("D:\\ExcelExport.xls")); ExcelExporter ExcelExport = new ExcelExporter(); ExcelExport.export(outputStream, workbook.execute(parameterMap,new WriteActor())); // 将结果工作薄导出为Excel文件 outputStream = new FileOutputStream(new File("D:\\ExcelExport.xlsx")); StreamExcel2007Exporter ExcelExport1 = new StreamExcel2007Exporter(); ExcelExport1.export(outputStream, workbook.execute(parameterMap,new WriteActor())); // 将结果工作薄导出为Word文件 outputStream = new FileOutputStream(new File("D:\\WordExport.doc")); WordExporter WordExport = new WordExporter(); WordExport.export(outputStream, workbook.execute(parameterMap,new WriteActor())); // 将结果工作薄导出为Pdf文件 outputStream = new FileOutputStream(new File("D:\\PdfExport.pdf")); PDFExporterProcessor PdfExport = PDFExporterFactory.getPDFExporter(); PdfExport.export(outputStream, workbook.execute(parameterMap,new WriteActor())); // 将结果工作薄导出为Txt文件(txt文件本身不支持表格、图表等,被导出模板一般为明细表) outputStream = new FileOutputStream(new File("D:\\TxtExport.txt")); TextExporter TxtExport = new TextExporter(); TxtExport.export(outputStream, workbook.execute(parameterMap,new WriteActor())); // 将结果工作薄导出为Csv文件 outputStream = new FileOutputStream(new File("D:\\CsvExport.csv")); CSVExporter CsvExport = new CSVExporter(); CsvExport.export(outputStream, workbook.execute(parameterMap,new WriteActor())); //将结果工作薄导出为SVG文件 outputStream = new FileOutputStream(new File("D:\\SvgExport.svg")); SVGExporter SvgExport = new SVGExporter(); SvgExport.export(outputStream, workbook.execute(parameterMap,new WriteActor())); //将结果工作薄导出为image文件 outputStream = new FileOutputStream(new File("D:\\PngExport.png")); ImageExporter ImageExport = new ImageExporter(); ImageExport.export(outputStream, workbook.execute(parameterMap,new WriteActor())); outputStream.close(); ModuleContext.stopModules(); } catch (Exception e) { e.printStackTrace(); } } 
注:在使用API导出不同类型文件时,除了需要导入FineReport的fr-third-9.0.jar和fr-report-9.0.jar和fr-core-9.0.jar包之外,还需要导入%FR_HOME%\WebReport\WEB-INF\lib下面的sqlite-jdbc.jar和tomcat\lib下面的serverlet-api.jar。

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

4.聚合报表导出编辑

注:由于聚合报表不支持WriteActor(),因此需要换成PageActor()

聚合报表导出,只需要将WriteActor()换成PageActor(),即可实现输出各种格式的文件。

导出pdf,具体代码如下:

// 将结果工作薄导出为Pdf文件 outputStream = new FileOutputStream(new File("D:\\PdfExport.pdf")); PDFExporterProcessor PdfExport = PDFExporterFactory.getPDFExporter(); PdfExport.export(outputStream, workbook.execute(parameterMap,new PageActor())); 

同时,需要在头部引入PageActor(),具体代码如下:

import com.fr.stable.PageActor;

5.决策报表导出编辑

决策报表导出,结果工作簿改用以下方法 即可:

ResultWorkBook re = FSFormletHandler.executeForm("xxxx.frm", new HashMap<String, Object>());

同时,需要在头部引入FSFormletHandler,具体代码如下:

import com.fr.fs.web.FSFormletHandler;

5.1完整示例代码如下

package com.fr.io; import java.io.File; import java.io.FileOutputStream; import com.fr.base.FRContext; import com.fr.general.ModuleContext; import com.fr.dav.LocalEnv; import com.fr.fs.web.FSFormletHandler; import com.fr.io.exporter.PDFExporterProcessor; import com.fr.io.exporter.ImageExporter; import com.fr.main.workbook.ResultWorkBook; import com.fr.report.module.EngineModule; import com.fr.web.core.reserve.PDFExporterFactory; public class ExportApi { public static void main(String[] args) { // 定义报表运行环境,才能执行报表 String envpath = "F:\\FR\\FineReport_9.0\\WebReport\\WEB-INF"; FRContext.setCurrentEnv(new LocalEnv(envpath)); ModuleContext.startModule(EngineModule.class.getName()); try { java.util.Map paraMap = new java.util.HashMap(); paraMap.put("company", "VINET"); ResultWorkBook re = FSFormletHandler.executeForm("doc\\frm\\example.frm",paraMap); FileOutputStream outputStream; // 将结果工作薄导出为Pdf文件 outputStream = new FileOutputStream(new File("D:\\example.pdf")); PDFExporterProcessor PdfExport = PDFExporterFactory.getPDFExporter(); PdfExport.export(outputStream,re); //将结果工作薄导出为image文件 outputStream = new FileOutputStream(new File("D:\\example.png")); ImageExporter ImageExport = new ImageExporter(); ImageExport.export(outputStream,re); outputStream.close(); ModuleContext.stopModules(); } catch (Exception e) { e.printStackTrace(); } } }

索引:

Excel导出的多种方式

后台批量导出Excel

Excel直接转成模板cpt

多个报表导入一个Excel

附件列表


主题: 二次开发
如果您认为本文档还有待完善,请编辑

文档内容仅供参考,如果你需要获取更多帮助,请咨询帆软技术支持
关于技术问题,您还可以通过帆软论坛获取帮助,论坛上有非常多的大神,有些水平比帆软工程师还要高哦。
若您还有其他非技术类问题,可以联系帆软传说哥(qq:1745114201

此页面有帮助吗?