使用Java在線生成pdf文檔的代碼實現(xiàn)
更新時間：2025年04月16日 08:48:47 作者：程序員小假
在實際的業(yè)務(wù)開發(fā)的時候,研發(fā)人員往往會碰到很多這樣的一些場景,需要提供相關(guān)的電子憑證信息給用戶,熟悉這塊業(yè)務(wù)的童鞋,一定特別清楚,目前最常用的解決方案通過一些技術(shù)手段生成對應(yīng)的PDF文件,下面小編給大家詳細說說
一、介紹
在實際的業(yè)務(wù)開發(fā)的時候，研發(fā)人員往往會碰到很多這樣的一些場景，需要提供相關(guān)的電子憑證信息給用戶，例如網(wǎng)銀／支付寶／微信購物支付的電子發(fā)票、訂單的庫存打印單、各種電子簽署合同等等，以方便用戶查看、打印或者下載。
熟悉這塊業(yè)務(wù)的童鞋，一定特別清楚，目前最常用的解決方案是：把相關(guān)的數(shù)據(jù)信息，通過一些技術(shù)手段生成對應(yīng)的 PDF 文件，然后返回給用戶，以便預(yù)覽、下載或者打印。
不太熟悉這項技術(shù)的童鞋，也不用著急，一起來詳細了解一下在線生成 PDF 文件的技術(shù)實現(xiàn)手段！
二、案例實現(xiàn)
在介紹這個代碼實踐之前，先來了解一下這個第三方庫：iText。
iText是著名的開放源碼站點sourceforge一個項目，是用于生成PDF文檔的一個java類庫，通過iText不僅可以生成PDF或rtf的文檔，而且還可以將XML、Html文件轉(zhuǎn)化為PDF文件。
iText目前有兩套版本，分別是iText5和iText7。iText5應(yīng)該是網(wǎng)上用的比較多的一個版本。iText5因為是很多開發(fā)者參與貢獻代碼，因此在一些規(guī)范和設(shè)計上存在不合理的地方。iText7是后來官方針對iText5的重構(gòu)，兩個版本差別還是挺大的。不過在實際使用中，一般用到的都比較簡單的 API，所以不用特別拘泥于使用哪個版本。
2.1、添加 iText 依賴包
在使用它之前，先引人相關(guān)的依賴包！
<dependencies>
<!-- pdf:start -->
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>itextpdf</artifactId>
<version>5.5.11</version>
</dependency>
<dependency>
<groupId>com.itextpdf.tool</groupId>
<artifactId>xmlworker</artifactId>
<version>5.5.11</version>
</dependency>
<!-- 支持中文 -->
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>itext-asian</artifactId>
<version>5.2.0</version>
</dependency>
<!-- 支持css樣式渲染 -->
<dependency>
<groupId>org.xhtmlrenderer</groupId>
<artifactId>flying-saucer-pdf-itext5</artifactId>
<version>9.1.16</version>
</dependency>
<!-- 轉(zhuǎn)換html為標(biāo)準xhtml包 -->
<dependency>
<groupId>net.sf.jtidy</groupId>
<artifactId>jtidy</artifactId>
<version>r938</version>
</dependency>
<!-- pdf:end -->
</dependencies>
2.2、簡單實現(xiàn)
先來一個hello world，代碼如下：
public class CreatePDFMainTest {
public static void main(String[] args) throws Exception {
Document document = new Document(PageSize.A4);
//第二步，創(chuàng)建Writer實例
PdfWriter.getInstance(document, new FileOutputStream("hello.pdf"));
//創(chuàng)建中文字體
BaseFont bfchinese = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
Font fontChinese = new Font(bfchinese, 12, Font.NORMAL);
//第三步，打開文檔
document.open();
//第四步，寫入內(nèi)容
Paragraph paragraph = new Paragraph("hello world", fontChinese);
document.add(paragraph);
//第五步，關(guān)閉文檔
document.close();
}
}
打開hello.pdf文件，內(nèi)容如下！
2.3、復(fù)雜實現(xiàn)
在實際的業(yè)務(wù)開發(fā)中，因為業(yè)務(wù)場景非常復(fù)雜，而且變化快，往往不會采用上面介紹的寫入內(nèi)容方式來生成文件，而是采用HTML文件轉(zhuǎn)化為PDF文件。
應(yīng)該如何快速實現(xiàn)呢？
首先采用html語言編寫一個入庫單頁面，將其命令為printDemo.html，源代碼如下：
<html>
<head></head>
<body>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>出庫單</title>
<div>
<div>
<table width="100%" border="0" cellspacing="0" cellpadding="0">
<tbody>
<tr>
<td height="40" colspan="2"><h3 style="font-weight: bold; text-align: center; letter-spacing: 5px; font-size: 24px;">入庫單</h3></td>
<td width="12%" height="20" rowspan="2">
<img style="width: 105px;height: 105px;" src="data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9AQAAAACn+1GIAAAAqElEQVR42u3VMQ7DMAwDQP6A//8lx24qKRRw0s1yu8Uw4OQGIaHsBHUfLzzwAxCAInoZg6dI9dUUBIOyHEG56CmodAaxwtfbboLTVWpeU9+EDAH37m9CmkTYxDGUE0agMIakk3y4Ut8G37iom02M4bPniHWAtqFDTjjSGLrZvXAOmTnL1124C73r6Yo8Ane61k6eQeVjIM2h482D1RwScrpNjuH5R/0b3s6ZZNyKlt3iAAAAAElFTkSuQmCC" />
</td>
</tr>
<tr>
<td width="50%" height="30">操作人：xxx</td>
<td width="50%" height="30" colspan="2">創(chuàng)建時間：2021-09-14 12:00:00</td>
</tr>
</tbody>
</table>
</div>
<div style="margin-top: 5px; margin-bottom: 6px; margin-left: 4px"></div>
<div>
<table width="100%"
style="border-collapse: collapse; border-spacing: 0;border:0px;">
<tr style="height: 25px;">
<td style="background: #eaeaea; text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;"
width="10%">序號</td>
<td style="background: #eaeaea; text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;"
width="30%">商品</td>
<td style="background: #eaeaea; text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;"
width="30%">單位</td>
<td style="background: #eaeaea; text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000; border-right: 1px solid #000000;"
width="30%">數(shù)量</td>
</tr>
<tr>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">1</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">xxx沐浴露</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">箱</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000; border-right: 1px solid #000000;">3</td>
</tr>
<tr>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">2</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">xxx洗發(fā)水</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">箱</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000; border-right: 1px solid #000000;">4</td>
</tr>
<tr>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">3</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">xxx洗衣粉</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">箱</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000; border-right: 1px solid #000000;">5</td>
</tr>
<tr>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000; border-bottom: 1px solid #000000;">4</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000; border-bottom: 1px solid #000000;">xxx洗面奶</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000; border-bottom: 1px solid #000000;">箱</td>
<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000; border-right: 1px solid #000000; border-bottom: 1px solid #000000;">5</td>
</tr>
</table>
</div>
</div>
</body>
</html>
接著，將html文件轉(zhuǎn)成PDF文件，源碼如下：
public class CreatePDFMainTest {
/**
* 創(chuàng)建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為文件結(jié)束
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文件轉(zhuǎn)成PDF
writeToOutputStreamAsPDF(htmlStr);
}
}
運行程序，打開pdfDemo.pdf，結(jié)果如下！
2.4、變量替換方式
上面的html文件，是事先已經(jīng)編輯好的，才能正常渲染。
但是在實際的業(yè)務(wù)開發(fā)的時候，例如下面的商品內(nèi)容，完全是動態(tài)的，還是xxx-202109入庫單的名稱，以及二維碼，都是動態(tài)的。
這個時候，可以采用freemarker模板引擎，通過定義變量來動態(tài)填充內(nèi)容，直到轉(zhuǎn)換出來的結(jié)果就是想要的html頁面。
當(dāng)然，還有一種辦法，例如下面這個，也可以在html頁面里面定義${name}變量，然后在讀取完文件之后，將其變量進行替換成想填充的任何值，這其實也是模板引擎最核心的一個玩法。
<html>
<head>
<meta charset="utf-8">
<title></title>
</head>
<body>
<div>您好：${name}</div>
<div>歡迎，登錄博客網(wǎng)站</div>
</body>
</html>
三、總結(jié)
itext框架是一個非常實用的第三方pdf文件生成庫，尤其是面對比較簡單的pdf文件內(nèi)容渲染的時候，它完全滿足需求。
但是對于那種復(fù)雜的pdf文檔，可能需要自己單獨進行適配開發(fā)。具體的深度玩法，大家可以參閱itext官方API。
以上就是使用Java開發(fā)在線生成pdf文檔的代碼實現(xiàn)的詳細內(nèi)容，更多關(guān)于Java在線生成pdf文檔的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
作為初步進入java開發(fā)學(xué)習(xí)的小白來說,學(xué)習(xí)java語言一開始的時候得一步步的學(xué)習(xí),比如說java輸入語句應(yīng)該這么去實現(xiàn)呢,這篇文章主要給大家介紹了關(guān)于Java輸入語句的相關(guān)資料,需要的朋友可以參考下2024-03-03
在日常開發(fā)中,我們經(jīng)常會遇到需要處理大型 Word 文檔的場景,本文介紹一種基于 Java 的自動化處理方式,利用一個基于 Java 的 Word 文檔處理庫,通過兩種不同的策略來拆分 Word 文檔,感興趣的小伙伴可以了解下2026-05-05
JDBC連接MySql數(shù)據(jù)庫步驟 以及查詢、插入、刪除、更新等
這篇文章主要介紹了JDBC連接MySql數(shù)據(jù)庫步驟，以及查詢、插入、刪除、更新等十一個處理數(shù)據(jù)庫信息的功能,需要的朋友可以參考下2018-05-05
這篇文章主要為大家詳細介紹了Mybatis分頁插件的使用方法，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-12-12
SpringMVC中的參數(shù)接收機制主要分為四種核心形式,理解這四種參數(shù)的來源和適用場景,可以掌握SpringMVC中80%的參數(shù)接收機制,本文給大家介紹Spring MVC 四種核心傳參形式對比分析,感興趣的朋友跟隨小編一起看看吧2026-01-01
這篇文章主要介紹了Java中初始化List集合的6種方式詳解,List 是 Java 開發(fā)中經(jīng)常會使用的集合,在使用List時需要進行初始化操作,今天我們就來看一下常用的幾種list集合初始化方式,需要的朋友可以參考下2023-10-10
關(guān)于weblogic部署Java項目的包沖突問題的解決
這篇文章主要介紹了關(guān)于weblogic部署Java項目的包沖突問題的解決，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-01-01
這篇文章主要介紹了RabbitMQ消息單獨與批量的TTL，TTL全名是Time To Live存活時間，表示當(dāng)消息由生產(chǎn)端存入MQ當(dāng)中的存活時間，當(dāng)時間到達的時候還未被消息就會被自動清除，感興趣的同學(xué)可以參考下文2023-05-05
Java Stream的基本概念以及創(chuàng)建方法
這篇文章主要介紹了Java Stream的基本概念以及創(chuàng)建方法，幫助大家更好的理解和學(xué)習(xí)Java，感興趣的朋友可以了解下2020-08-08
Java如何將字符串轉(zhuǎn)為數(shù)字int的三種方式詳析
這篇文章主要給大家介紹了關(guān)于Java如何將字符串轉(zhuǎn)為數(shù)字int的三種方式,在編程中我們經(jīng)常需要進行各種數(shù)據(jù)類型之間的轉(zhuǎn)換操作,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2023-10-10