iText + Freemarker实现pdf的导出，支持中文、css以及图片，页眉页脚，页眉添加图片
程序员文章站
2024-01-04 14:37:46
...
本文为了记录自己的实现过程，具体的实现步骤是参考博文 https://www.cnblogs.com/youzhibing/p/7692366.html 来实现的，只是在他的基础上添加了页眉页脚及页眉图片
前景
原来是决定采用wkhtmlToPdf将html页面转换为pdf，而且html样式保存的还挺好，但是最后尝试下来发现，他转换不了我们框架中的html页面，将框架中的html页面地址进行转换总是会转换成首页的图片，多次查询无果，最终放弃了，改换成itext工具。
由于我们的需求中要求有页眉和页脚，并且页眉中需要有logo图片，所以在网上也是找了很多博客，尝试了网上的很多种方法都不能使用，不知道是我这边的问题还是博主们都没有进行测试就把文章发出来了，最后实在找不到能用的信息我就开始了自己的探索，最终经过我自己的探索，实现了页眉中添加图片的功能，特此记录一下。
本次使用的是Itext5版本，没有采用最新的官方IText7.
大致实现步骤都是基于文初的那边文章，只是添加了一个Build类继承他的PdfPageEventHelper,具体代码如下：
package com.tzCloud.core.utils;
import com.itextpdf.text.Chunk;
import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Element;
import com.itextpdf.text.Font;
import com.itextpdf.text.Image;
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;
import java.io.IOException;
/**
* PDF导出页眉、页脚、水印等处理类
* 设置页面附加属性
*
* @author LiuYu
* @date 2019/11/5 16:45
*/
public class PDFBuilder extends PdfPageEventHelper {
/**
* 页眉
*/
public String header = "itext测试页眉";
/**
* 文档字体大小，页脚页眉最好和文本大小一致
*/
public int presentFontSize = 12;
/**
* 文档页面大小，最好前面传入，否则默认为A4纸张
*/
public Rectangle pageSize = PageSize.A4;
/**
* 模板
*/
public PdfTemplate total;
/**
* 基础字体对象
*/
public BaseFont bf = null;
/**
* 利用基础字体生成的字体对象，一般用于生成中文文字
*/
public Font fontDetail = null;
public void setHeader(String header) {
this.header = header;
}
public void setPresentFontSize(int presentFontSize) {
this.presentFontSize = presentFontSize;
}
/**
*
* TODO 文档打开时创建模板
*
* @see PdfPageEventHelper#onOpenDocument(PdfWriter,
* Document)
*/
@Override
public void onOpenDocument(PdfWriter writer, Document document) {
// 共 页 的矩形的长宽高
total = writer.getDirectContent().createTemplate(50, 50);
}
/**
*
* TODO 关闭每页的时候，写入页眉，写入'第几页共'这几个字。
*
* @see PdfPageEventHelper#onEndPage(PdfWriter,
* Document)
*/
@Override
public void onEndPage(PdfWriter writer, Document document) {
this.addPage(writer, document);
//this.addWatermark(writer);
}
//加分页
public void addPage(PdfWriter writer, Document document){
// 首页不添加页眉和页脚
if(writer.getPageNumber() == 1){
// 用于添加首页的封面背景图，这里首页添加了两张背景图，一个从左上角一个从左下角，具体位置可修改下面的位置信息
try {
// PDF 首页顶部背景图
Image image = Image.getInstance("https://******");
// 设置图片的位置 图片位置左边是左下角为0,0
image.setAbsolutePosition(0, 441);
// 设置图片的大小
image.scaleAbsolute(570, 400);
// PDF 首页底部背景图
Image instance = Image.getInstance("https://*****");
instance.setAbsolutePosition(0, 0);
instance.scaleAbsolute(595, 260);
document.add(image);
document.add(instance);
} catch (IOException | DocumentException e) {
e.printStackTrace();
}
return;
}
//设置分页页眉页脚字体
Image image = null;
try {
// 页眉logo图片实例
image = Image.getInstance("https://******");
if (bf == null) {
bf = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", false);
}
if (fontDetail == null) {
// 数据体字体
fontDetail = new Font(bf, presentFontSize, Font.NORMAL);
}
} catch (DocumentException | IOException e) {
e.printStackTrace();
}
PdfContentByte directContent = writer.getDirectContent();
//1、生成右侧页眉
// document.right(-20) 方法设置页眉的左右间距
// document.top(+20) 方法设置页眉的上下间距
ColumnText.showTextAligned(directContent,
Element.ALIGN_RIGHT, new Phrase("联系电话：400-000-0000", fontDetail),
document.right(), document.top(), 0);
// ！！！！ 最重要的是这个， 如果页眉需要设置图片的话，需要在Phrase对象中添加一个Chunk对象，在Chunk对象中添加图片信息即可
Phrase p1 = new Phrase("", fontDetail);
p1.add(new Chunk(image, 0, -30));
// 1、写入左侧页眉
ColumnText.showTextAligned(directContent,
Element.ALIGN_LEFT, p1,
document.left(), document.top(-20), 0);
// 2、生成右侧页脚
ColumnText.showTextAligned(directContent,
Element.ALIGN_RIGHT, new Phrase(String.valueOf(document.getPageNumber() - 1), fontDetail),
document.right(), document.bottom(-20), 0);
// 2、生成左侧页脚
ColumnText.showTextAligned(directContent,
Element.ALIGN_LEFT, new Phrase("******有限公司", fontDetail),
document.left(), document.bottom(-20), 0);
}
/**
* 加水印
*/
public void addWatermark(PdfWriter writer){
// 水印图片
Image image;
try {
image = Image.getInstance("./web/images/001.jpg");
PdfContentByte content = writer.getDirectContentUnder();
content.beginText();
// 开始写入水印
for(int k=0;k<5;k++){
for (int j = 0; j <4; j++) {
image.setAbsolutePosition(150*j,170*k);
content.addImage(image);
}
}
content.endText();
} catch (IOException | DocumentException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/**
*
* TODO 关闭文档时，替换模板，完成整个页眉页脚组件
*
* @see PdfPageEventHelper#onCloseDocument(PdfWriter,
* Document)
*/
@Override
public void onCloseDocument(PdfWriter writer, Document document) {
// 7.最后一步了，就是关闭文档的时候，将模板替换成实际的 Y 值,至此，page x of y 制作完毕，完美兼容各种文档size。
total.beginText();
// 生成的模版的字体、颜色
total.setFontAndSize(bf, presentFontSize);
//页脚内容拼接 如 第1页/共2页
String foot2 = " " + (writer.getPageNumber()) + " 页";
// 模版显示的内容
total.showText(foot2);
total.endText();
total.closePath();
}
}具体的对PDF每页的操作都可以在这个类中进行实现，通过document的getPageNumber方法可以判断当前在PDF的第几页，然后就可以进行具体的操作了， 就例如上面的代码在首页可以添加背景图等操作。
至此就可以实现在PDF页眉中添加图片了