Java纯后端生成PDF格式报表的三种方案(包含echarts图表)

近做了一个奇葩的需求，研究了一下Java纯后端生成PDF报表的方案，顺便将研究的方案做个总结复盘，分享一下。

需求分析：Java后端定时任务统计汇总成报表数据，并生成PDF格式的报表文件，并通过邮件、企业微信等发送给指定接收人。报表界面包含动态文字说明、折线图、饼图、条形图等图表，界面效果和前端生成的界面相同。

功能难点：前端要生成样式好看的图表比较简单，像Echarts这些前端工具都有现成的功能来完成。但是现在的需求是后端定时任务生成报表文件，报表界面的渲染都必须有后端来完成，由于缺少前端的用户操作动作，也无法在前端生成图表的图片后传到后端来。

方案一：

使用FreeMarker+iText生成PDF文件。

原理和流程：

FreeMarker是一款模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本（HTML网页、电子邮件、配置文件、源代码等）的通用工具。

iText是一种生成PDF报表的Java组件。通过在服务器端使用Jsp或JavaBean生成PDF报表，客户端采用超链接显示或下载得到生成的报表，这样就很好的解决了B/S系统的报表处理问题。

具体的流程如下：

缺点：这种方案只能生成很简单的Table模板，由于iText对html的要求非常严格，太复杂的界面会报错，所以无法生成Echarts的图表。

方案二：

SwingUI+JFreeChart+JFreePDF生成PDF文件

这里JFreeChart和JFreePDF都是maven依赖包

JFreeChart是Java客户端应用的一个界面组件，在SwingUI上画出图表控件。

JFreePDF是能将JPanel面板截屏生成PDF的插件。

流程和原理：

缺点：

由于是将JPanel截屏生成的PDF。所以界面样式上比较难看，比不上前端界面生成的报表页面。

而且JFreePDF这个maven依赖的插件是基于JDK11开发的，如果要兼容JDK8，就要到github上将源码下载下来，自己编译生成一个兼容JDK8的依赖包。

方案三：（最终采用方案）

使用wkhtmltopdf+静态html界面生成pdf界面

wkhtmltopdf是一个将静态html网页截屏生成pdf文件的工具，Linux、Mac、Windows各个操作系统的版本都有。只需要输入目标网页的URL就能将网页完成的导出PDF文件。

流程和原理：

1.在操作系统安装wkhtmltopdf工具

2.前端编码html+jquery+echarts的纯静态页面，由于wkhtmltopdf工具使用内置的WebKit内核版本较低，所以不兼容太新的js语言，像VueJS这些最新的框架就无法使用这个工具。目前测试的能够兼容的echarts版本是4.2.1.

3.调用wkhtmltopdf命令输入静态网页地址生成pdf文件。

之前为了调试网页写了一个Java桌面应用来调用wkhtmltopdf工具生成pdf。

github地址：https://github.com/WrathLi/html2pdf

缺点：

1.需要在服务器系统中先安装wkhtmltopdf工具；

2.只能单独开发一个纯静态的html页面来生成报表

优点：

界面美观，因为是直接截取html网页，所以和前端生成的图表样式一样。

开发量最小。

最终效果：

tml2canvas

简介

我们可以直接在浏览器端使用html2canvas,对整个或局部页面进行‘截图’。但这并不是真的截图，而是通过遍历页面DOM结构，收集所有元素信息及相应样式，渲染出canvas image。

由于html2canvas只能将它能处理的生成canvas image，因此渲染出来的结果并不是100%与原来一致。但它不需要服务器参与，整个图片都由客户端浏览器生成，使用很方便。

使用

使用的API也很简洁，下面代码可以将某个元素渲染成canvas：

html2canvas(element, {
 onrendered: function(canvas) {
 // canvas is the final rendered <canvas> element
 }
});

通过onrendered方法，可以将生成的canvas进行回调，比如插入到页面中：

html2canvas(element, {
 onrendered: function(canvas) {
 document.body.appendChild(canvas);
 }
});

做个小例子代码如下，在线展示链接demo1

<html>
 <head>
 <title>html2canvas example</title>
 <style type="text/css">...</style>
 </head>
 <body>
 <header>
 <nav>
 <ul>
 <li>one</li>
 ...
 </ul>
 </nav>
 </header>
 <section>
 <aside>
 <h3>it is a title</h3>
 <a href="">Stone Giant</a>
 ...
 </aside>
 <article>
 <img src="./Stone.png">
 <h2>Stone Giant</h2>
 <p>Coming ... </p>
 <p>以一团石头...</p>
 </article>
 </section>
 <footer>write by linwalker @2017</footer>
 <script type="text/javascript" src="./html2canvas.js"></script>
 <script type="text/javascript">
 html2canvas(document.body, {
 onrendered:function(canvas) {
 document.body.appendChild(canvas)
 }
 })
 </script>
 </body>
</html>

这个例子将页面body中的元素渲染成canvas，并插入到body中

jsPDF

jsPDF库可以用于浏览器端生成PDF。

文字生成PDF

使用方法如下：

// 默认a4大小，竖直方向，mm单位的PDF
var doc = new jsPDF();
// 添加文本‘Download PDF’
doc.text('Download PDF!', 10, 10);
doc.save('a4.pdf');

在线演示demo2

图片生成PDF

使用方法如下：

// 三个参数，第一个方向，第二个单位，第三个尺寸格式
var doc = new jsPDF('landscape','pt',[205, 115])
// 将图片转化为dataUrl
var imageData = ‘data:image/png;base64,iVBORw0KGgo...’;
doc.addImage(imageData, 'PNG', 0, 0, 205, 115);
doc.save('a4.pdf');

在线演示demo3

文字与图片生成PDF

// 三个参数，第一个方向，第二个尺寸，第三个尺寸格式
var doc = new jsPDF('landscape','pt',[205, 155])
// 将图片转化为dataUrl
var imageData = ‘data:image/png;base64,iVBORw0KGgo...’;
//设置字体大小
doc.setFontSize(20);
//10,20这两参数控制文字距离左边，与上边的距离
doc.text('Stone', 10, 20);
// 0, 40, 控制文字距离左边，与上边的距离
doc.addImage(imageData, 'PNG', 0, 40, 205, 115);
doc.save('a4.pdf')

在线演示demo4

生成pdf需要把转化的元素添加到jsPDF实例中，也有添加html的功能，但某些元素无法生成在pdf中，因此可以使用html2canvas + jsPDF的方式将页面转成pdf。通过html2canvas将遍历页面元素，并渲染生成canvas，然后将canvas图片格式添加到jsPDF实例，生成pdf。

html2canvas + jsPDF

单页

将demo1的例子修改下：

<script type="text/javascript" src="./js/jsPdf.debug.js"></script>
<script type="text/javascript">
 var downPdf = document.getElementById("renderPdf");
 downPdf.onclick = function() {
 html2canvas(document.body, {
 onrendered:function(canvas) {
 //返回图片dataURL，参数：图片格式和清晰度(0-1)
 var pageData = canvas.toDataURL('image/jpeg', 1.0);
 //方向默认竖直，尺寸ponits，格式a4[595.28,841.89]
 var pdf = new jsPDF('', 'pt', 'a4');
 //addImage后两个参数控制添加图片的尺寸，此处将页面高度按照a4纸宽高比列进行压缩
 pdf.addImage(pageData, 'JPEG', 0, 0, 595.28, 592.28/canvas.width * canvas.height );
 pdf.save('stone.pdf');
 }
 })
 }
</script>

在线演示demo5

如果页面内容根据a4比例转化后高度超过a4纸高度呢，生成的pdf会怎么样？会分页吗？

你可以试试，验证一下自己的想法: demo6

jsPDF提供了一个很有用的API，addPage()，我们可以通过pdf.addPage()，来添加一页pdf，然后通过pdf.addImage(...)，将图片赋予这页pdf来显示。

那么我们如何确定哪里分页？

这个问题好回答，我们可以设置一个pageHeight，超过这个高度的内容放入下一页pdf。

来捋一下思路，将html页面内容生成canvas图片，通过addImage将第一页图片添加到pdf中，超过一页内容，通过addPage()添加pdf页数,然后再通过addImage将下一页图片添加到pdf中。

嗯～，很好！巴特，难道没有发现问题吗？

这个方法实现的前提是 — — 我们能根据pageHeight先将整页内容生成的canvas图片分割成对应的小图片，然后一个萝卜一个坑，一页一页addImage进去。

What? 想一想我们的canvas是肿么来的，不用拉上去，直接看下面：

html2canvas(document.body, {
 onrendered:function(canvas) {
 //it is here we handle the canvas
 }
})

这里的body就是要生成canvas的元素对象，一个元素生成一个canvas；那么我们需要一页一页的canvas，也就是说。。。

你觉得可能吗？我觉得不太现实，按这思路要获取页面上不同位置的DOM元素，然后通过htnl2canvas(element,option)来处理，先不说能不能刚好在每个pageHeight的位置刚好找到一个DOM元素，就算找到了，这样做累不累。

累的话

：）可以看看下面这种方法

多页

我提供的思路是我们只生成一个canvas，对就一个，转化元素就是你要转成pdf内容的母元素，在这篇demo里就是body了；其他不变，也是超过一页内容就addPage，然后addImage,只不过这里添加的是同一个canvas。

当然这样做只会出现多页重复的pdf，那到底怎么实现正确分页显示。其实主要利用了jsPDF的两点：

- 超过jsPDF实例格式尺寸的内容不显示
（var pdf = new jsPDF('', 'pt', 'a4'); demo中就是a4纸的尺寸）
- addImage有两个参数可以控制图片在pdf中的位置

虽然每一页pdf上显示的图片是相同的，但我们通过调整图片的位置，产生了分页的错觉。以第二页为例，将竖直方向上的偏移设置为-841.89即一张a4纸的高度，又因为超过a4纸高度范围的图片不显示，所以第二页显示了图片竖直方向上[841.89,1682.78]范围内的内容，这就得到了分页的效果，以此类推。

还是看代码吧：

html2canvas(document.body, {
 onrendered:function(canvas) {
 var contentWidth = canvas.width;
 var contentHeight = canvas.height;
 //一页pdf显示html页面生成的canvas高度;
 var pageHeight = contentWidth / 592.28 * 841.89;
 //未生成pdf的html页面高度
 var leftHeight = contentHeight;
 //页面偏移
 var position = 0;
 //a4纸的尺寸[595.28,841.89]，html页面生成的canvas在pdf中图片的宽高
 var imgWidth = 595.28;
 var imgHeight = 592.28/contentWidth * contentHeight;
 var pageData = canvas.toDataURL('image/jpeg', 1.0);
 var pdf = new jsPDF('', 'pt', 'a4');
 //有两个高度需要区分，一个是html页面的实际高度，和生成pdf的页面高度(841.89)
 //当内容未超过pdf一页显示的范围，无需分页
 if (leftHeight < pageHeight) {
 pdf.addImage(pageData, 'JPEG', 0, 0, imgWidth, imgHeight );
 } else {
 while(leftHeight > 0) {
 pdf.addImage(pageData, 'JPEG', 0, position, imgWidth, imgHeight)
 leftHeight -= pageHeight;
 position -= 841.89;
 //避免添加空白页
 if(leftHeight > 0) {
 pdf.addPage();
 }
 }
 }
 pdf.save('content.pdf');
 }
})

在线演示demo7

两边留边距

修改imgWidth，并且在addImage时x方向参数设置你要的边距，具体代码如下

var imgWidth = 555.28;
var imgHeight = 555.28/contentWidth * contentHeight;
...
pdf.addImage(pageData, 'JPEG', 20, 0, imgWidth, imgHeight );
...
pdf.addImage(pageData, 'JPEG', 20, position, imgWidth, imgHeight);

在线演示demo8

tml2pdf

selenium

Selenium 通过使用 WebDriver 支持市场上所有主流浏览器的自动化。 Webdriver 是一个 API 和协议，它定义了一个语言中立的接口，用于控制 web 浏览器的行为。每个浏览器都有一个特定的 WebDriver 实现，称为驱动程序。驱动程序是负责委派给浏览器的组件，并处理与 Selenium 和浏览器之间的通信。

这种分离是有意识地努力让浏览器供应商为其浏览器的实现负责的一部分。 Selenium 在可能的情况下使用这些第三方驱动程序，但是在这些驱动程序不存在的情况下，它也提供了由项目自己维护的驱动程序。

Selenium 框架通过一个面向用户的界面将所有这些部分连接在一起，该界面允许透明地使用不同的浏览器后端，从而实现跨浏览器和跨平台自动化。

selenium 驱动

# selenium 驱动
https://selenium-python.readthedocs.io/installation.html#drivers
https://selenium-python.readthedocs.io/api.html

selenium-java

主要依赖

        <dependency>
            <groupId>org.seleniumhq.selenium</groupId>
            <artifactId>selenium-java</artifactId>
            <version>4.16.1</version>
        </dependency>

测试代码

        // 获取 java 版本
        String version = System.getProperty("java.specification.version");

        // 获取系统类型
        String platform = System.getProperty("os.name", "");
        platform = platform.toLowerCase().contains("window") ? "win" : "linux";

        // 当前程序目录
        String current = System.getProperty("user.dir");

        System.out.println("current:" + current);

        // firefox 运行参数配置
        FirefoxOptions options = new FirefoxOptions();
        // 无头模式
        options.addArguments("--headless");
        // 最大化
        options.addArguments("--start-maximized");

        FirefoxDriver browser = new FirefoxDriver(options);

        Path url = Paths.get(current, "..", "index.html");
        System.out.println("url:" + url.toString());

        // NOTE 要使用 file 协议
        browser.get(String.format("file://%s", url.toString()));

        // 打印设置
        PrintOptions print = new PrintOptions();
        Pdf pdf = browser.print(print);

        // pdf base64 内容
        String content = pdf.getContent();
        // 解码内容
        Base64.Decoder decoder = Base64.getDecoder();
        byte[] buffer = decoder.decode(content);

        try {
            // 将 byte 写入文件
            Path file = Paths.get(String.format("java%s_%s.pdf", version, platform));
            Files.write(file, buffer);
        } catch (IOException e) {
            throw new RuntimeException(e);
        } finally {
            browser.quit();
        }