pdf在线预览_SpringBoot + FreeMarker + FlyingSaucer 实现PDF在线预览、打印、下载

关键技术点：

1. Freemarker模板引擎
模板语法
2. FlyingSaucer根据模板生成pdf
兼容中文(及中文换行问题)
兼容CSS(绝对、相对定位)
兼容图片
多页输出
(示例代码没有dao、service层，生产环境中自行添加，本示例完整，不坑人)

实现步骤

SpringBoot项目搭建

项目结构截图

Maven依赖配置

PDF工具类编写

PdfUtils.java，方法上有完整注释，思路是利用模板引擎动态处理模板参数，先生成html字符串放在StringWriter中，再用HTML字符串生成Document，再利用FlyingSaucer的ITextRenderer处理Document，最后输出pdf。

中文字符坑点：

 填坑：

generateAll方法中

①需要拷贝宋体字体文件到resource目录下(字体位置在“c:/Windows/Fonts/simsun.ttc”)，方便集成和迁移

②在页面中设置body的样式,必须写成英文，同时大小写敏感，

另外：也有不少文章直接根据操作系统类型取宋体字体文件路径的全路径，如下，显得代码臃肿：

注意: generateAll方法中已经实现了一个模板接收多个参数对象,输出多页到一个pdf文件中,读者可根据自己需要改造

FreeMarker模板编写

跟编写普通html页面一样,定义2个页面,一个主页面index.ftl，一个pdf模板页面pdfPage.ftl

 文件结构:

index.ftl,很简单,一个标题,两个按钮,一个预览功能,一个下载功能,同时预接收一个${title}参数

注:freemarker的语法和原理,读者自行科普

pdfPage.ftl 

坑点(用户经常有页面尺寸需求,比如纸张类型): 1. 页面尺寸(A3,A4)设置和脚标设置页面尺寸填坑: 在节点中加入CSS3页面page属性,以毫米为单位设置size,即最终输出pdf每页的大小A3: 297mm * 420mm (纵向)A4: 210mm * 297mm (纵向)A3: 420mm * 297mm (横向)A4: 297mm * 210mm (横向)这些都可以写成${XXX}占位符形式,通过后端代码传入脚标填坑: 见下图

2. CSS路径和图片路径填坑css路径:  引用css文件必须用http://全路径,如上图,可以把css文件单独放到一台服务器上,通过域名或者ip+端口访问.填坑图片路径:  css中引用的图片一样要使用http://全路径,如下图:

Controller代码编写

写两个Controller，PublicController.java 和 PdfController.java
PublicController.java用来访问主页面, PdfController.java用来接受预览和下载请求
PublicController.java

PdfController.java

配置application.yml

运行演示

运行项目,访问http://localhost:8999/

点击预览效果如下(有个小坑,就是input控件中的汉字有问题,反正我实际生产中pdf模板不用input控件),其实这个页面已集成了下载和打印功能，这是Chrome自带的pdf预览。

再点击下载,效果如下:

显示已下载,从pdf软件打开该pdf文件效果如下：

大功告成!

坑点总结

1. 中文字体
2. Css路径
3. 图片路径
4. 页面尺寸(纸张大小)

建议

该示例只是为了演示如何利用freemarker模板引擎生成pdf预览、下载，其中数据都为静态数据，在实际项目中调整数据来源可完美达到预期效果，目前支持比较好的是Chrome内核浏览器，为达到更好的浏览器支持，可以用PDF.js来完成兼容。

PdfUtils.java只是对模板操作做了简单封装,可以根据自己的需要进行二次封装，generateAll方法中已经实现了一个模板接收多个参数对象,输出多页到一个pdf文件中,读者可根据自己需要改造(比如把多个不同的模板输出到一个pdf文件中)。