java itextpdf使用HTML模板生成pdf文件，并设置table

Posted 2021-02-07 stenju_1

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了java itextpdf使用HTML模板生成pdf文件，并设置table相关的知识，希望对你有一定的参考价值。

我们这里是maven项目,导入相应jar包：

   <dependency>
        <groupId>org.freemarker</groupId>
        <artifactId>freemarker</artifactId>
        <version>2.3.23</version>
    </dependency>
 	<dependency>
        <groupId>com.itextpdf</groupId>
        <artifactId>itextpdf</artifactId>
        <version>5.4.1</version>
    </dependency>
    <dependency>
        <groupId>com.itextpdf</groupId>
        <artifactId>itext-asian</artifactId>
        <version>5.2.0</version>
    </dependency>
    <dependency>
        <groupId>com.itextpdf.tool</groupId>
        <artifactId>xmlworker</artifactId>
        <version>5.4.1</version>
     </dependency>

注意：建议 itextpdf 和 tool 包版本一致，不然有可能会出现未知错误（我遇到一次~）

第一步：

编写 freemarker模板：freemarker.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8"/>
    <title>Title</title>
    <style>
        body{
            font-family:SimHei;
        }
        .red{
            color: red;
        }
    </style>
</head>
<body>
<div class="red">
    你好，${name}
</div>
</body>
</html>

第二步：获取模板信息，并且合并数据

package com.springdemo.job;

import java.io.File;
import java.io.IOException;

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.pdf.PdfWriter;
import com.itextpdf.tool.xml.XMLWorkerFontProvider;
import com.itextpdf.tool.xml.XMLWorkerHelper;

import freemarker.template.Configuration;

public class Test {

	private static final String DEST = "H:\test\test.pdf";

	private static final String HTML = "freemarker.html";

	private static final String FONT = "simhei.ttf";

	private static Configuration freemarkerCfg = null;

	static {
		freemarkerCfg = new Configuration();
		// 获取freemarker的模板目录
		try {
			freemarkerCfg.setDirectoryForTemplateLoading(new File("H:\test\").getCanonicalFile());
		} catch (IOException e) {
			e.printStackTrace();
		}
	}

	/**
	 * html渲染为pdf
	 * 
	 * @param data
	 *            变量
	 * @param htmlTmp
	 *            模板文件名
	 * @param pdftemp
	 *            pdf导出路径
	 * @return
	 */
	public static String freeMarkerRender(Map<String, Object> data, String htmlTmp, String pdftemp) {

		// 获取模板,并设置编码方式
		Template template = freemarkerCfg.getTemplate(htmlTmp);
		template.setEncoding("UTF-8");

		StringWriter out = new StringWriter();

		// 合并模板跟数据
		template.process(data, out);

		// htmlData 模板字符流
		String htmlData = out.toString();

		// 设置文档格式,数字边距
		Document document = new Document(PageSize.A4, 30, 30, 30, 30);

		PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream(pdftemp));

		// 添加页码
		PDFBuilder builder = new PDFBuilder();
		writer.setPageEvent(builder);

		// 打开文档
		document.open();

		XMLWorkerHelper.getInstance().parseXHtml(writer, document, new ByteArrayInputStream(htmlData.getBytes()), null,
				new MyFontsProvider());

		// 关闭文档
		document.close();

	}

	public static void main(String[] args) throws Exception {
		Map<String, Object> data = new HashMap();
		data.put("name", "test");
		Test.freeMarkerRender(data, HTML, DEST);

	}
}

PDF设置字符集

package com.springdemo.job;
/**
 * 设置字符集
 */
public static class MyFontsProvider extends XMLWorkerFontProvider {


    public MyFontsProvider(){
        super(null, null);
    }

    @Override
    public Font getFont(final String fontname, String encoding, float size, final int style) {
        String fntnames = fontname;
        Font FontChinese = null;
        if (fntnames == null) {
            fntnames = "宋体";
        }
        if (size == 0) {
            size = 4;
        }
        try{
            BaseFont bfChinese = BaseFont.createFont("STSong-Light",
                    "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
            FontChinese = new Font(bfChinese, 12, Font.NORMAL);
        }catch (Exception e){
            e.printStackTrace();
        }
        if(FontChinese==null){
            FontChinese = super.getFont(fntnames, encoding, size, style);
        }
        return FontChinese;
    }

}

设置自动分页类

package com.springdemo.job;

import java.io.IOException;

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Element;
import com.itextpdf.text.Font;
import com.itextpdf.text.PageSize;
import com.itextpdf.text.Phrase;
import com.itextpdf.text.Rectangle;
import com.itextpdf.text.pdf.BaseFont;
import com.itextpdf.text.pdf.ColumnText;
import com.itextpdf.text.pdf.PdfContentByte;
import com.itextpdf.text.pdf.PdfPageEventHelper;
import com.itextpdf.text.pdf.PdfTemplate;
import com.itextpdf.text.pdf.PdfWriter;

public class PDFBuilder extends PdfPageEventHelper {

	/**
	 * 页眉
	 */
	public String header = "";

	/**
	 * 文档字体大小，页脚页眉最好和文本大小一致
	 */
	public int presentFontSize = 12;

	/**
	 * 文档页面大小，最好前面传入，否则默认为A4纸张
	 */
	public Rectangle pageSize = PageSize.A4;

	// 模板
	public PdfTemplate total;

	// 基础字体对象
	public BaseFont bf = null;

	// 利用基础字体生成的字体对象，一般用于生成中文文字
	public Font fontDetail = null;

/**
* 
* Creates a new instance of PdfReportM1HeaderFooter 无参构造方法.
* 
*/
public PdfReportM1HeaderFooter() {

}

/**
* 
* Creates a new instance of PdfReportM1HeaderFooter 构造方法.
* 
* @param yeMei
* 页眉字符串
* @param presentFontSize
* 数据体字体大小
* @param pageSize
* 页面文档大小，A4，A5，A6横转翻转等Rectangle对象
*/
public PdfReportM1HeaderFooter(String yeMei, int presentFontSize, Rectangle pageSize) {
this.header = yeMei;
this.presentFontSize = presentFontSize;
this.pageSize = pageSize;
}

	public void setHeader(String header) {
		this.header = header;
	}

	public void setPresentFontSize(int presentFontSize) {
		this.presentFontSize = presentFontSize;
	}

	/**
	 * 
	 * TODO 文档打开时创建模板
	 * 
	 * @see com.itextpdf.text.pdf.PdfPageEventHelper#onOpenDocument(com.itextpdf.text.pdf.PdfWriter,
	 *      com.itextpdf.text.Document)
	 */
	public void onOpenDocument(PdfWriter writer, Document document) {
		total = writer.getDirectContent().createTemplate(50, 50);// 共 页 的矩形的长宽高
	}

	/**
	 * 
	 * TODO 关闭每页的时候，写入页眉，写入‘第几页共‘这几个字。
	 * 
	 * @see com.itextpdf.text.pdf.PdfPageEventHelper#onEndPage(com.itextpdf.text.pdf.PdfWriter,
	 *      com.itextpdf.text.Document)
	 */
	public void onEndPage(PdfWriter writer, Document document) {

		try {
			if (bf == null) {
				bf = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", false);
			}
			if (fontDetail == null) {
				fontDetail = new Font(bf, presentFontSize, Font.NORMAL);// 数据体字体
			}
		} catch (DocumentException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		}

		// 1.写入页眉
		ColumnText.showTextAligned(writer.getDirectContent(), Element.ALIGN_LEFT, new Phrase(header, fontDetail),
				document.left(), document.top() + 20, 0);
		// 2.写入前半部分的 第 X页/共
		int pageS = writer.getPageNumber();
		String foot1 = "第 " + pageS + " 页 /共";
		Phrase footer = new Phrase(foot1, fontDetail);

		// 3.计算前半部分的foot1的长度，后面好定位最后一部分的‘Y页‘这俩字的x轴坐标，字体长度也要计算进去 = len
		float len = bf.getWidthPoint(foot1, presentFontSize);

		// 4.拿到当前的PdfContentByte
		PdfContentByte cb = writer.getDirectContent();

		// 5.写入页脚1，x轴就是(右margin+左margin + right() -left()- len)/2.0F
		// 再给偏移20F适合人类视觉感受，否则肉眼看上去就太偏左了
		// ,y轴就是底边界-20,否则就贴边重叠到数据体里了就不是页脚了；注意Y轴是从下往上累加的，最上方的Top值是大于Bottom好几百开外的。
		ColumnText.showTextAligned(cb, Element.ALIGN_CENTER, footer,
				(document.rightMargin() + document.right() + document.leftMargin() - document.left() - len) / 2.0F
						+ 20F,
				document.bottom() - 20, 0);

		// 6.写入页脚2的模板（就是页脚的Y页这俩字）添加到文档中，计算模板的和Y轴,X=(右边界-左边界 - 前半部分的len值)/2.0F +
		// len ， y 轴和之前的保持一致，底边界-20
		cb.addTemplate(total,
				(document.rightMargin() + document.right() + document.leftMargin() - document.left()) / 2.0F + 20F,
				document.bottom() - 20); // 调节模版显示的位置

	}

	/**
	 * 
	 * TODO 关闭文档时，替换模板，完成整个页眉页脚组件
	 * 
	 * @see com.itextpdf.text.pdf.PdfPageEventHelper#onCloseDocument(com.itextpdf.text.pdf.PdfWriter,
	 *      com.itextpdf.text.Document)
	 */
	public void onCloseDocument(PdfWriter writer, Document document) {
		// 7.最后一步了，就是关闭文档的时候，将模板替换成实际的 Y 值,至此，page x of y 制作完毕，完美兼容各种文档size。
		total.beginText();
		total.setFontAndSize(bf, presentFontSize);// 生成的模版的字体、颜色
		String foot2 = " " + (writer.getPageNumber() - 1) + " 页";
		total.showText(foot2);// 模版显示的内容
		total.endText();
		total.closePath();
	}
}

第三步：

如果仔细度过那个超入门的朋友会知道设置表头有一个固定表头的功能，比如表格很长的时候PDF自动分页了，原生代码可以做到每一页都显示表头。

实际上看了下iText的源码发现HTML转PDF的时候也是可以的，iText支持一个CSS属性，只需要给你需要重复表头表尾的table标签设置css属性“repeat-header:yes”或“repeat-footer:yes”即可，然后将你需要重复的表头放在thead标签内，表尾放在tfoot标签内。

例：

<table style="repeat-header:yes;repeat-footer:yes;">
        <thead>
            <tr>
                <th>如果表格过长自动分页了，我是重复的表头1</th>
            </tr>
            <tr>
                <th>如果表格过长自动分页了，我是重复的表头2</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>内容....</td>
            </tr>
            <!--  .....  -->
            <tr>
                <td>内容....</td>
            </tr>
        </tbody>
        <tfoot>
            <tr>
                <th>如果表格过长自动分页了，我是重复的表尾1</th>
            </tr>
            <tr>
                <th>如果表格过长自动分页了，我是重复的表尾2</th>
            </tr>
        </tfoot>
    </table>

使用代码写pdf的时候，如果某个小章节完毕了，我们需要另起一页直接new Page()即可。在HTML生成pdf的时候也是有特殊的css属性来控制的，分别是page-break-after:always和page-break-before:always（还有一个page-break-inside属性，但测试没发现有什么特殊的效果）

<span style="page-break-after:always;">这段文字后面会重新分页</span>
<p>正常的文字流，但是因为前面元素强制在后面分页了，后面的文字也强制在前面分页了，因此这段文字会是顶头文字，也是这一页的唯一的文字。</p>
<span style="page-break-before:always;">这段文字前面会重新分页</span>

以上是关于java itextpdf使用HTML模板生成pdf文件，并设置table的主要内容，如果未能解决你的问题，请参考以下文章

java PDF模板生成并导出(文字表格图片)

itextpdf 根据PDF模板生成新的PDF(自我理解)

Java生成PDF之iTextPDF的使用

java生成pdf

使用itext获取pdf模板，生成pdf

itextpdf 怎么生成表格的形式