java根據(jù)模板導(dǎo)出PDF的詳細(xì)實現(xiàn)過程
題記：
由于業(yè)務(wù)的需要，需要根據(jù)模板定制pdf文檔，經(jīng)測試根據(jù)模板導(dǎo)出word成功了；但是導(dǎo)出pdf相對麻煩了一點。兩天的研究測試java導(dǎo)出PDF，終于成功了，期間走了不少彎路，今分享出來，歡迎大家有問題在此交流，與君共勉！
一、需求
根據(jù)業(yè)務(wù)需要，需要在服務(wù)器端生成可動態(tài)配置的PDF文檔，方便數(shù)據(jù)可視化查看。
此文的測試是在客戶端通過java程序的測試，直接運行java類獲得成功！
二、解決方案
iText+FreeMarker+JFreeChart生成可動態(tài)配置的PDF文檔。
iText有很強大的PDF處理能力，但是樣式和排版不好控制，直接寫PDF文檔，數(shù)據(jù)的動態(tài)渲染很麻煩。
FreeMarker能配置動態(tài)的html模板，正好解決了樣式、動態(tài)渲染和排版問題。
JFreeChart有這方便的畫圖API，能畫出簡單的折線、柱狀和餅圖，基本能滿足需要。
三、實現(xiàn)功能
1、能動態(tài)配置PDF文檔內(nèi)容
2、能動態(tài)配置中文字體顯示
3、設(shè)置自定義的頁眉頁腳信息
4、能動態(tài)生成業(yè)務(wù)圖片
5、完成PDF的分頁和圖片的嵌入
四、主要代碼結(jié)構(gòu)說明：
1、component包：PDF生成的組件 對外提供的是PDFKit工具類和HeaderFooterBuilder接口，其中PDFKit負(fù)責(zé)PDF的生成，HeaderFooterBuilder負(fù)責(zé)自定義頁眉頁腳信息。
2、builder包：負(fù)責(zé)PDF模板之外的額外信息填寫，這里主要是頁眉頁腳的定制。
3、chart包：JFreeChart的畫圖工具包，目前只有一個線形圖。
4、test包：測試工具類
5、util包：FreeMarker等工具類。
項目采用maven架構(gòu)，開發(fā)工具為MyEclipse10，環(huán)境為jdk1.7
五、關(guān)鍵代碼說明
1、模板配置
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta http-equiv="Content-Style-Type" content="text/css"/>
<title></title>
<style type="text/css">
body {
font-family: pingfang sc light;
}
.center{
text-align: center;
width: 100%;
}
</style>
</head>
<body>
<!--第一頁開始-->
<div class="page" >
<div class="center"><p>${templateName}</p></div>
<div><p>iText官網(wǎng):${ITEXTUrl}</p></div>
<div><p>FreeMarker官網(wǎng):${freeMarkerUrl}</p></div>
<div><p>JFreeChart教程:${JFreeChartUrl}</p></div>
<!--外部鏈接-->
<p>靜態(tài)logo圖</p>
<div>
<img src="${imageUrl}" alt="美團點評" width="512" height="359"/>
</div>
<!--動態(tài)生成的圖片-->
<p>氣溫變化對比圖</p>
<div>
<img src="${picUrl}" alt="我的圖片" width="500" height="270"/>
</div>
</div>
<!--第一頁結(jié)束-->
<!---分頁標(biāo)記-->
<span style="page-break-after:always;"></span>
<!--第二頁開始-->
<div class="page">
<div>第二頁開始了</div>
<div>列表值:</div>
<div>
<#list scores as item>
<div><p>${item}</p></div>
</#list>
</div>
</div>
<!--第二頁結(jié)束-->
</body>
</html>2、獲取模板內(nèi)容并填充數(shù)據(jù)
public static String getContent(String fileName,Object data){
String templatePath=getPDFTemplatePath(fileName).replace("\\", "/");
String templateFileName=getTemplateName(templatePath).replace("\\", "/");
String templateFilePath=getTemplatePath(templatePath).replace("\\", "/");
System.out.println("templatePath:"+templatePath);
System.out.println("templateFileName:"+templateFileName);
System.out.println("templateFilePath:"+templateFilePath);
if(StringUtils.isEmpty(templatePath)){
throw new FreeMarkerException("templatePath can not be empty!");
}
try{System.out.println("進到這里了，有來無回1");
Configuration config = new Configuration(Configuration.VERSION_2_3_25);
config.setDefaultEncoding("UTF-8");
config.setDirectoryForTemplateLoading(new File(templateFilePath));
config.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
config.setLogTemplateExceptions(false);System.out.println("進到這里了，有來無回2");
Template template = config.getTemplate(templateFileName);System.out.println("進到這里了，有來無回3");
StringWriter writer = new StringWriter();
template.process(data, writer);
writer.flush();
String html = writer.toString();
return html;
}catch (Exception ex){
throw new FreeMarkerException("FreeMarkerUtil process fail",ex);
}
}public static String getContent(String fileName,Object data){
String templatePath=getPDFTemplatePath(fileName);//根據(jù)PDF名稱查找對應(yīng)的模板名稱
String templateFileName=getTemplateName(templatePath);
String templateFilePath=getTemplatePath(templatePath);
if(StringUtils.isEmpty(templatePath)){
throw new FreeMarkerException("templatePath can not be empty!");
}
try{
Configuration config = new Configuration(Configuration.VERSION_2_3_25);//FreeMarker配置
config.setDefaultEncoding("UTF-8");
config.setDirectoryForTemplateLoading(new File(templateFilePath));//注意這里是模板所在文件夾，不是文件
config.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
config.setLogTemplateExceptions(false);
Template template = config.getTemplate(templateFileName);//根據(jù)模板名稱 獲取對應(yīng)模板
StringWriter writer = new StringWriter();
template.process(data, writer);//模板和數(shù)據(jù)的匹配
writer.flush();
String html = writer.toString();
return html;
}catch (Exception ex){
throw new FreeMarkerException("FreeMarkerUtil process fail",ex);
}
}3、導(dǎo)出模板到PDF文件
/**
* @description 導(dǎo)出pdf到文件
* @param fileName 輸出PDF文件名
* @param data 模板所需要的數(shù)據(jù)
*
*/
public String exportToFile(String fileName,Object data){
try {
String htmlData= FreeMarkerUtil.getContent(fileName, data);
if(StringUtils.isEmpty(saveFilePath)){
saveFilePath=getDefaultSavePath(fileName);
}
File file=new File(saveFilePath);
if(!file.getParentFile().exists()){
file.getParentFile().mkdirs();
}
FileOutputStream outputStream=null;
try{
//設(shè)置輸出路徑
outputStream=new FileOutputStream(saveFilePath);
//設(shè)置文檔大小
Document document = new Document(PageSize.A4);
PdfWriter writer = PdfWriter.getInstance(document, outputStream);
//設(shè)置頁眉頁腳
PDFBuilder builder = new PDFBuilder(headerFooterBuilder,data);
builder.setPresentFontSize(10);
writer.setPageEvent(builder);
//輸出為PDF文件
convertToPDF(writer,document,htmlData);
}catch(Exception ex){
throw new PDFException("PDF export to File fail",ex);
}finally{
IOUtils.closeQuietly(outputStream);
}
} catch (Exception e) {
e.printStackTrace();
}
return saveFilePath;
}4、測試工具類
public String createPDF(Object data, String fileName){
//pdf保存路徑
try {
//設(shè)置自定義PDF頁眉頁腳工具類
PDFHeaderFooter headerFooter=new PDFHeaderFooter();
PDFKit kit=new PDFKit();
kit.setHeaderFooterBuilder(headerFooter);
//設(shè)置輸出路徑
kit.setSaveFilePath("D:/Users/hello.pdf");
String saveFilePath=kit.exportToFile(fileName,data);
return saveFilePath;
} catch (Exception e) {
System.out.println("竟然失敗了，艸！");
e.printStackTrace();
// log.error("PDF生成失敗{}", ExceptionUtils.getFullStackTrace(e));
log.error("PDF生成失敗{}");
return null;
}
}
public static void main(String[] args) {
ReportKit360 kit=new ReportKit360();
TemplateBO templateBO=new TemplateBO();
templateBO.setTemplateName("Hello iText! Hello freemarker! Hello jFreeChart!");
templateBO.setFreeMarkerUrl("http://www.zheng-hang.com/chm/freemarker2_3_24/ref_directive_if.html");
templateBO.setITEXTUrl("http://developers.itextpdf.com/examples-itext5");
templateBO.setJFreeChartUrl("http://www.yiibai.com/jfreechart/jfreechart_referenced_apis.html");
templateBO.setImageUrl("E:/圖片2/004d.jpg");
List<String> scores=new ArrayList<String>();
scores.add("94");
scores.add("95");
scores.add("98");
templateBO.setScores(scores);
List<Line> lineList=getTemperatureLineList();
DefaultLineChart lineChart=new DefaultLineChart();
lineChart.setHeight(500);
lineChart.setWidth(300);
String picUrl=lineChart.draw(lineList,0);
templateBO.setPicUrl(picUrl);System.out.println("picUrl:"+picUrl);
String path= kit.createPDF(templateBO,"hello.pdf");
System.out.println("打印："+path);
}此測試工具類中，要注意幾點：
1）templateBO.setImageUrl("E:/圖片2/004d.jpg");中的參數(shù)修改為自己本地有的圖片；
2）程序可能會報找不到模板引擎hello.ftl文件的錯誤，一定要將源碼中的hello.ftl放在本地硬盤對應(yīng)的目錄中；
六、生成效果圖
七、遇到的坑
1、FreeMarker配置模板文件樣式，在實際PDF生成過程中，可能會出現(xiàn)一些不一致的情形，目前解決方法，就是換種方式調(diào)整樣式。
2、字體文件放在resource下，在打包時會報錯，運行mvn -X compile 會看到詳細(xì)錯誤：
這是字體文件是二進制的，而maven項目中配置了資源文件的過濾，不能識別二進制文件導(dǎo)致的，plugins中增加下面這個配置就好了：
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>
<!--增加的配置,過濾ttf文件的匹配-->
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>2.7</version>
<configuration>
<encoding>UTF-8</encoding>
<nonFilteredFileExtensions>
<nonFilteredFileExtension>ttf</nonFilteredFileExtension>
</nonFilteredFileExtensions>
</configuration>
</plugin>
</plugins>
</build>3、PDF分頁配置：
在ftl文件中，增加分頁標(biāo)簽： <span style="page-break-after:always;"></span>
八、項目說明
此項目最初是由github上的開源項目經(jīng)二次開發(fā)而成，附github源碼地址：https://github.com/superad/pdf-kit；
但是github上的源碼bug太多，幾乎不能運行，經(jīng)過一天的測試修改，才完全消除了它的bug；經(jīng)過測試已經(jīng)在windows系統(tǒng)，jdk1.7，MyEclipse10中運行成功；此項目只需要在MyEclipse中右擊ReportKit360.java文件，然后選擇run as java application即可，如圖：
下面是整合到web網(wǎng)站中，在網(wǎng)頁中填充內(nèi)容，然后自動生成pdf文檔后在網(wǎng)頁端查看或者下載。
九、整合到web項目中遇到的坑
1、讀取的模板.ftl文檔時，
發(fā)現(xiàn)讀取的內(nèi)容htmlData開始多了一個？，幾經(jīng)搜索后發(fā)現(xiàn)是因為文檔編碼格式的原因，于是在editplus中將其打開并重新另存為無bom格式的文檔后重新讀取，發(fā)現(xiàn)?消失了。
雖然解決了讀取的問題，但是還是沒有解決下載pdf亂碼的問題。
2、又重新debug項目之后發(fā)現(xiàn)，不是字體讀取的問題，因為文件夾下的字體是能夠讀取到的，于是懷疑是編碼問題，將所有編碼修改為UTF-8格式，仍沒有解決亂碼問題，又繼續(xù)debug項目，幾經(jīng)細(xì)致查看后，感覺應(yīng)該是文件讀取時是在web容器中的，這一步編碼不太容易修改，于是決定按照讀取是什么編碼就改為什么編碼，最終獲得成功。
web項目代碼結(jié)構(gòu)如下：
啟動服務(wù)器后，在瀏覽器中輸入http://localhost:8080/項目名/index.action后回車，即可進入前端輸入pdf文檔內(nèi)容的頁面，輸入完成后點擊提交，即可下載pdf文檔，生成的文檔格式完全正確，并且沒有亂碼。
參考文章：http://www.dbjr.com.cn/article/112366.htm
總結(jié)
到此這篇關(guān)于java根據(jù)模板導(dǎo)出PDF的文章就介紹到這了,更多相關(guān)java根據(jù)模板導(dǎo)出PDF內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java中的ConcurrentLinkedQueue松散隊列解析
這篇文章主要介紹了Java中的ConcurrentLinkedQueue松散隊列解析,鏈表是松散的,鏈表節(jié)點并不都是有效的,允許存在無效節(jié)點val=null,但是只有最后一個節(jié)點才能next=null,需要的朋友可以參考下2023-12-12
java讀寫ini文件、FileOutputStream問題
這篇文章主要介紹了java讀寫ini文件、FileOutputStream問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-04-04
本篇文章主要介紹了java對象與json對象間的相互轉(zhuǎn)換的方法，詳細(xì)介紹了json字符串和java對象相互轉(zhuǎn)換，有興趣的可以了解一下2017-01-01
java web開發(fā)中獲取tomcat上properties文件內(nèi)容的方法
java web開發(fā)中如何獲取tomcat上properties文件內(nèi)容的方法，方便文件存儲位置的修改，解耦和，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-07-07
這篇文章主要介紹了Spring整合Mybatis實操分享，文章首先通過介紹Mybatis的工作原理展開Spring整合Mybatis的詳細(xì)內(nèi)容，需要的小伙伴可以參考一下2022-04-04
這篇文章主要為大家詳細(xì)介紹了java回溯算法解數(shù)獨問題，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-01-01
java調(diào)用遠(yuǎn)程服務(wù)器的shell腳本以及停止的方法實現(xiàn)
這篇文章主要介紹了java調(diào)遠(yuǎn)程服務(wù)器的shell腳本以及停止的方法實現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-03-03
這篇文章主要介紹了java new一個對象的過程實例解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-12-12
這篇文章主要介紹了Socket下載一個文本文件的實例代碼，非常不錯，具有參考借鑒價值,需要的朋友可以參考下2017-06-06
使用GSON庫將Java中的map鍵值對應(yīng)結(jié)構(gòu)對象轉(zhuǎn)換為JSON
GSON是由Google開發(fā)并開源的實現(xiàn)Java對象與JSON之間相互轉(zhuǎn)換功能的類庫,這里我們來看一下使用GSON庫將Java中的map鍵值對應(yīng)結(jié)構(gòu)對象轉(zhuǎn)換為JSON的示例:2016-06-06