JasperReport生成pdf文件 Java开发pdf文件 pdf文件生成及下载

Java制作开发pdf文件可以使用JasperReport框架。最近项目中需要后端生成pdf文件，为了高效快捷开发，选用了jasperreport框架。期间踩了不少坑，以此博文做些记录总结，希望对你也有一些帮助。

不管使用何种报表制作框架，一般都要有三个大的步骤：

1. 设计模板
2. 填充参数
3. 渲染导出

使用jasperreport当然也会遵循上面的流程

一、设计pdf报表模板

jasperreport设计报表模板的工具是Jaspersoft Studio(到官网下载即可)，如下图

进入工具制作自己需要的报表模板即可，制作pdf文件模板时需要对studio工具进行一些简单的设置(详见文章末尾说明)，否则预览的时候中文字体将无法显示。设计后的模板如下图示：

二、填充pdf模板参数

模板制作完成后，在工具中编译生成二进制jasper文件就可以在项目中使用了(不编译也行，编译后代码运行时就无需在编译，会提高运行速度)。将jasper文件放到项目resources目录下，如下图：

上图中同时也给出了jasperreport生成pdf文件时需要用到的字体设置(有汉字时必须设置中文字体)，声明字体有三部分：

1. jasperreports_extension.properties配置文件

配置文件内容如下：

net.sf.jasperreports.extension.registry.factory.fonts=net.sf.jasperreports.engine.fonts.SimpleFontExtensionsRegistryFactory
net.sf.jasperreports.extension.simple.font.families.default=fonts/fonts.xml

jasper框架会通过此配置文件去加载指定的字体xml文件

2. 字体族xml声明文件
字体xml文件内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<fontFamilies>
    <fontFamily name="my_songT">
        <normal>
            <ttf>fonts/STSong.TTF</ttf>
            <svg>fonts/STSong.TTF</svg>
            <eot>fonts/STSong.TTF</eot>
            <woff>fonts/STSong.TTF</woff>
        </normal>
        <bold>fonts/STSong.TTF</bold>
        <italic>fonts/STSong.TTF</italic>
        <boldItalic>fonts/STSong.TTF</boldItalic>
        <pdfEncoding>Identity-H</pdfEncoding>
        <pdfEmbedded>true</pdfEmbedded>
        <exportFonts/>
    </fontFamily>
</fontFamilies>

注意：fontFamily name=“my_songT” name的值需要和你设计模板时用到的字体名字一样

3. ttf字体包
ttf字体包是一个字体库，我项目中用的是STSong.TTF，当时为了下载字体包也是一顿好找(很多都是恶心人的诱导下载)，不过还是有好心人分享到了GitHub上，需要的可以由此进入下载

至此生成pdf的准备工作已经ok。然后就是根据你自己的业务组装模板需要的数据，填充模板参数即可。参考如下：

public void exportReportOrder(Integer reportId, HttpServletResponse servletResponse) { 
        //查询自己需要的业务数据
        ReportOrderDetailVO detailVO = this.getReportOrderDetail(reportId);
        OutputStream outputStream;
        try { 
            outputStream = servletResponse.getOutputStream();
            String fileName = reportOrderConverter.getPdfFileName(detailVO);
            //设置http的文件类型及编码方式
            servletResponse.setContentType("application/pdf;charset=utf-8");
            //设置下载的文件名称 名称含有中文的话需要用URLEncoder进行编码
            servletResponse.setHeader("content-disposition", "attachment;filename=" + URLEncoder.encode(fileName, "utf-8"));

            Map<String, String> reportTypeToNameMap = reportTypeEnumService.getCodeToNameMap();
            ExportFraudReportOrderResponse response = reportOrderConverter.assembleFraudReportOrder(detailVO, reportTypeToNameMap);
            //组装模板中需要的参数 用于填充模板中通过$P{xxx}声明的参数
            Map<String, Object> params = reportOrderConverter.assembleReportParams(response);

            List<FraudReportOrderEvidenceImage> imageList = reportOrderConverter.getImageResources(detailVO);
            //设置JasperReport的数据源 我用的是Json类型的数据源(数据源中的数据用于填充模板中detail区域的通过$F{XXX}指定的参数)
            JsonDataSource jsonDataSource = new JsonDataSource(new ByteArrayInputStream(JSON.toJSONString(imageList).getBytes(StandardCharsets.UTF_8)));

            boolean hasImage = reportOrderConverter.hasImage(detailVO);
            if (hasImage) { 
                fileGenerateService.generates(EnumFileMeta.PDF_4_FRAUD_REPORT, outputStream, params, jsonDataSource);
            } else { 
                fileGenerateService.generates(EnumFileMeta.PDF_4_FRAUD_REPORT_WITHOUT_IMAGE, outputStream, params, jsonDataSource);
            }
        } catch (IOException io) { 
            log.error("获取http输出流失败", io);
            throw new ServiceResponseException("获取http输出流失败");
        } catch (Exception e) { 
            log.error("生成报告单失败", e);
            throw new ServiceResponseException("生成报告单失败");
        }
    }

三、渲染导出pdf文件

前面两个步骤完成之后，最后一步就是使用JasperReport框架提供的API生成导出pdf文件就行了，API使用很简单，如下：

/** * * @param fileMeta 自己封装的枚举 可以忽略 * @param outputStream 报表要生成的目的地 项目需求是让用户从浏览器直接下载的 所以此处用的是HttpServletResponse的输出流 * @param params 填充报表模板中$P{xxx}的参数 * @param dataSource 填充报表模板中$F{xxx}的数据源 */
    public void exportFile(EnumFileMeta fileMeta, OutputStream outputStream, Map<String, Object> params, JRDataSource dataSource) { 
        try { 
            //加载项目中resources目录下的报表模板 注意：通过Class加载资源 资源地址必须是绝对路径
            InputStream reportTemplate = this.getClass().getResourceAsStream("/template/fraud_report.jasper");
            //将参数和数据源填充到报表模板中
            JasperPrint jasperPrint = JasperFillManager.fillReport(reportTemplate, params, dataSource);
            //框架导出pdf的API 导出文件到输出流
            JasperExportManager.exportReportToPdfStream(jasperPrint, outputStream);
            return;
        } catch (Exception e) { 
            log.error("pdf文件导出异常", e);
        } finally { 
            try { 
                outputStream.flush();
                outputStream.close();
            } catch (IOException e) { 
                log.error("pdf文件导出 冲刷/关闭输出流异常 ", e);
            }
        }

        throw new ServiceResponseException("pdf文件导出异常");
    }

至此，通过JasperReport框架生成pdf文件就全部完成了。本例成品如下图：

踩坑小计

1. itext包的版本要选对，建议使用2.1.7版本，否则会报错(jasperReport 的依赖只和 itext的 2.1.7 版本兼容，不兼容其他版本)

<dependency>
            <groupId>net.sf.jasperreports</groupId>
            <artifactId>jasperreports</artifactId>
            <version>6.11.0</version>
            <exclusions>
                <exclusion>
                    <artifactId>itext</artifactId>
                    <groupId>com.lowagie</groupId>
                </exclusion>
                <exclusion>
                    <artifactId>commons-collections4</artifactId>
                    <groupId>org.apache.commons</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.lowagie</groupId>
            <artifactId>itext</artifactId>
            <version>2.1.7</version>
        </dependency>

1. 如果在maven pom文件中添加了对resources资源进行了过滤，那么必须声明对jasper文件和ttf文件不过滤，否则会报错：

• 如不声明jasper，那么在加载jasper模板文件时候会报invalid stream header: EFBFBDEF 的错误 ；
• 如不声明ttf，那么在导出pdf文件的时候会报字体找不到的错误：net.sf.jasperreports.engine.util.JRFontNotFoundException: Font “my_songT” is not available to the JVM. See the Javadoc for more details.

原因：如果项目中有二进制或其他敏感文件，请不要使用maven对其进行filter，否则会破坏源文件!!!
pom文件声明如下：

<resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**.*</include>
                    <include>**/**.*</include>
                </includes>
                <filtering>true</filtering>
                <excludes>
                    <exclude>**/*.jasper</exclude>
                    <exclude>**/*.TTF</exclude>
                </excludes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.jasper</include>
                </includes>
                <filtering>false</filtering>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.TTF</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>

JasperStudio工具配置pdf字体

1. 添加字体，选择自己电脑本地的中文TTF字体包，起一个易用的名字，如下图
   

2. 设置pdf导出器，如下图
   

3. 设置模板的时候选择刚才设置的字体，然后就可以通过studio工具快速预览pdf报表了(注：其他模板无需专门配置字体)，如果不使用配置的中文字体，那么预览的时候汉字是无法显示的，如下图：