在实际业务开发中,研发人员经常会遇到需要为用户提供电子凭证的场景,比如支付发票、订单打印单、电子合同等。这些凭证需要方便用户查看、打印或下载。目前最常用的解决方案是将相关数据生成PDF文件返回给用户。对于不熟悉这项技术的开发者,可以通过本文了解在线生成PDF的技术实现方式。
第三方库简介
生成PDF文件常用的第三方库是iText,它是一个开源的Java类库,不仅支持生成PDF和RTF文档,还能将XML、HTML文件转换为PDF。iText有两个主要版本:iText5和iText7。iText5是较早版本,由于是多人协作开发,在规范和设计上存在一些不合理之处。iText7是对iText5的重构版本,两者差异较大。但在实际业务中,通常使用的API较为简单,因此不必纠结版本选择。
添加依赖包
在使用iText之前,需要在项目中引入相关依赖。如果是Maven项目,可以在pom.xml文件中添加以下依赖:
<dependency>
<groupId>com.itextpdf</groupId>
<version>5.5.13</version>
对于iText7,可以替换为对应的版本号。
简单PDF生成
com.itextpdf
itextpdf
5.5.11
com.itextpdf.tool
xmlworker
5.5.11
com.itextpdf
itext-asian
5.2.0
org.xhtmlrenderer
flying-saucer-pdf-itext5
9.1.16
net.sf.jtidy
jtidy
r938
通过iText可以快速生成简单的PDF文件。以下是一个基础示例代码:
Document document = new Document();
PdfWriter.getInstance(document, new FileOutputStream("simple.pdf"));
document.open();
document.add(new Paragraph("Hello, this is a simple PDF."));
public class CreatePDFMainTest {
public static void main(String[] args) throws Exception {
Document document = new Document(PageSize.A4);
//第二步,创建Writer实例
PdfWriter.getInstance(document, new FileOutputStream("hello.pdf"));
//创建中文字体
BaseFont bfchinese = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
Font fontChinese = new Font(bfchinese, 12, Font.NORMAL);
//第三步,打开文档
document.open();
//第四步,写入内容
Paragraph paragraph = new Paragraph("hello world", fontChinese);
document.add(paragraph);
//第五步,关闭文档
document.close();
}
}
运行代码后,会在项目目录下生成一个名为simple.pdf的文件,内容为“Hello, this is a simple PDF.”。
复杂业务场景实现
在实际业务中,PDF内容通常较为复杂且动态变化,因此直接通过代码写入内容的方式并不适用。更常见的做法是将HTML文件转换为PDF。例如,假设有一个入库单页面template.html,可以通过以下代码将其转换为PDF:
Document document = new Document();
PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream("output.pdf"));
document.open();
XMLWorkerHelper.getInstance().parseXHtml(writer, document, new FileInputStream("template.html"));
出库单
入库单
操作人:xxx
创建时间:2021-09-14 12:00:00
style="border-collapse: collapse; border-spacing: 0;border:0px;">
序号
商品
单位
数量
1
xxx沐浴露
箱
3
2
xxx洗发水
箱
4
3
xxx洗衣粉
箱
5
4
xxx洗面奶
箱
5
这样,template.html的内容会被渲染为PDF文件。
动态内容填充
public class CreatePDFMainTest {
/**
* 创建PDF文件
* @param htmlStr
* @throws Exception
*/
private static void writeToOutputStreamAsPDF(String htmlStr) throws Exception {
String targetFile = "pdfDemo.pdf";
File targeFile = new File(targetFile);
if(targeFile.exists()) {
targeFile.delete();
}
//定义pdf文件尺寸,采用A4横切
Document document = new Document(PageSize.A4, 25, 25, 15, 40);// 左、右、上、下间距
//定义输出路径
PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream(targetFile));
PdfReportHeaderFooter header = new PdfReportHeaderFooter("", 8, PageSize.A4);
writer.setPageEvent(header);
writer.addViewerPreference(PdfName.PRINTSCALING, PdfName.NONE);
document.open();
// CSS
CSSResolver cssResolver = new StyleAttrCSSResolver();
CssAppliers cssAppliers = new CssAppliersImpl(new XMLWorkerFontProvider(){
@Override
public Font getFont(String fontname, String encoding, boolean embedded, float size, int style, BaseColor color) {
try {
//用于中文显示的Provider
BaseFont bfChinese = BaseFont.createFont("STSongStd-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
return new Font(bfChinese, size, style);
} catch (Exception e) {
return super.getFont(fontname, encoding, size, style);
}
}
});
//html
HtmlPipelineContext htmlContext = new HtmlPipelineContext(cssAppliers);
htmlContext.setTagFactory(Tags.getHtmlTagProcessorFactory());
htmlContext.setImageProvider(new AbstractImageProvider() {
@Override
public Image retrieve(String src) {
//支持图片显示
int pos = src.indexOf("base64,");
try {
if (src.startsWith("data") && pos > 0) {
byte[] img = Base64.decode(src.substring(pos + 7));
return Image.getInstance(img);
} else if (src.startsWith("http")) {
return Image.getInstance(src);
}
} catch (BadElementException ex) {
return null;
} catch (IOException ex) {
return null;
}
return null;
}
@Override
public String getImageRootPath() {
return null;
}
});
// Pipelines
PdfWriterPipeline pdf = new PdfWriterPipeline(document, writer);
HtmlPipeline html = new HtmlPipeline(htmlContext, pdf);
CssResolverPipeline css = new CssResolverPipeline(cssResolver, html);
// XML Worker
XMLWorker worker = new XMLWorker(css, true);
XMLParser p = new XMLParser(worker);
p.parse(new ByteArrayInputStream(htmlStr.getBytes()));
document.close();
}
/**
* 读取 HTML 文件
* @return
*/
private static String readHtmlFile() {
StringBuffer textHtml = new StringBuffer();
try {
File file = new File("printDemo.html");
BufferedReader reader = new BufferedReader(new FileReader(file));
String tempString = null;
// 一次读入一行,直到读入null为文件结束
while ((tempString = reader.readLine()) != null) {
textHtml.append(tempString);
}
reader.close();
} catch (IOException e) {
return null;
}
return textHtml.toString();
}
public static void main(String[] args) throws Exception {
//读取html文件
String htmlStr = readHtmlFile();
//将html文件转成PDF
writeToOutputStreamAsPDF(htmlStr);
}
}
在业务场景中,HTML文件的内容往往是动态的,比如订单号、商品名称、二维码等。这时可以使用模板引擎(如Thymeleaf、FreeMarker)动态生成HTML,再转换为PDF。另一种简单的方法是直接在HTML中定义变量占位符,例如${name},然后在代码中进行替换:
String htmlContent = Files.readString(Paths.get("template.html"));
htmlContent = htmlContent.replace("${name}", "Dynamic Value");
替换后的HTML内容再通过iText转换为PDF即可。
适用性与扩展
iText适用于大多数简单的PDF生成需求,但对于复杂的文档布局或特殊格式要求,可能需要额外适配或使用更专业的工具。开发者可以参考官方文档了解更多高级功能,以满足业务需求。

工作时间:8:00-18:00
电子邮件
扫码二维码
获取最新动态
