Java 生成 PDF 文件

brandonbai發表於2019-04-23

最近專案需要實現PDF下載的功能,由於沒有這方面的經驗,從網上花了很長時間才找到相關的資料。整理之後,發現有如下幾個框架可以實現這個功能。

1. 開源框架支援

  • iText,生成PDF文件,還支援將XML、Html檔案轉化為PDF檔案;
  • Apache PDFBox,生成、合併PDF文件;
  • docx4j,生成docx、pptx、xlsx文件,支援轉換為PDF格式。

比較:

  • iText開源協議為AGPL,而其他兩個框架協議均為Apache License v2.0。
  • 使用PDFBox生成PDF就像畫圖似的,文字和影象根據頁面座標畫上去的,需要根據字數手動換行。
  • docx4j用來生成docx文件,提供了將WORD文件轉換為PDF文件的功能,並不能直接生成PDF文件。

2. 實現方案

格式複雜 格式簡單
資料量大 docx4j+freemarker docx4j或PDFBox
資料量小 docx4j PDFBox

2.1 純資料生成PDF

1.docx4j,適用於生成格式簡單或格式複雜且資料量小的PDF文件; 2.Apache PDFBox,適用於生成格式簡單且資料量小的PDF文件。

1.docx4j docx4j是一個開源Java庫,用於建立和操作Microsoft Open XML(Word docx,Powerpoint pptx和Excel xlsx)檔案。它類似於Microsoft的OpenXML SDK,但適用於Java。docx4j使用JAXB來建立記憶體中的物件表示,程式設計師需要花時間瞭解JAXB和Open XML檔案結構 。

// word物件
WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage.createPackage();
// 文件主體
MainDocumentPart mainDocumentPart = wordMLPackage.getMainDocumentPart();
// 換行符
Br br = objectFactory.createBr();
// 段落
P p = objectFactory.createP();
// 段落設定
PPr ppr = objectFactory.createPPr();
// 文字位置
Jc jc = new Jc();
jc.setVal(je);
ppr.setJc(jc);
// 行設定
RPr rpr = objectFactory.createRPr();
// 字型設定
RFonts rFonts = objectFactory.createRFonts();
rFonts.setAscii("Times New Roman");
rFonts.setEastAsia("宋體");
rpr.setRFonts(rFonts);
// 行
R r = objectFactory.createR();
// 文字
Text text = objectFactory.createText();
text.setValue("這是一段普通文字");
r.setRPr(rpr);
r.getContent().add(br);
r.getContent().add(text);
p.getContent().add(r);
p.setPPr(ppr);
// 新增到正文中
mainDocumentPart.addObject(p);
// 匯出
//..
複製程式碼

2.Apache PDFBox Apache PDFBox是處理PDF文件的一個開源的Java工具。該專案允許建立新的PDF文件,處理現有文件以及從文件中提取內容的功能。Apache PDFBox還包括幾個命令列實用程式。

String formTemplate = "/Users/xiaoming/Desktop/test_pdfbox.pdf";
// 定義文件物件
PDDocument document = new PDDocument();
// 定義一頁,大小A4
PDPage page = new PDPage(PDRectangle.A4);
document.addPage(page);
// 獲取字型
PDType0Font font = PDType0Font.load(document, new File("/Users/xiaoming/work/tmp/simsun.ttf"));
// 定義頁面內容流
PDPageContentStream stream = new PDPageContentStream(document, page);
// 設定字型及文字大小
stream.setFont(font, 12);
// 設定畫筆顏色
stream.setNonStrokingColor(Color.BLACK);
// 新增矩形
stream.addRect(29, 797, 100, 14);
// 填充矩形
stream.fill();
stream.setNonStrokingColor(Color.BLACK);
// 文字填充開始
stream.beginText();
// 設定行距
stream.setLeading(18f);
// 設定文字位置
stream.newLineAtOffset(30, 800);
// 填充文字
stream.showText("呵呵");
// 換行
stream.newLine();
stream.showText("哈哈");
stream.newLine();
stream.showText("嘻嘻");
// 文字填充結束
stream.endText();
// 關閉流
stream.close();
// 儲存
document.save(formTemplate);
// 釋放資源
document.close();
複製程式碼

2.2 模版+資料生成PDF

FreeMarker+docx4j,適用於生成格式複雜且資料量大的PDF文件

Apache FreeMarker是一個模板引擎,用於根據模板和更改資料生成文字輸出(HTML網頁,電子郵件,配置檔案,原始碼等)。模板是用FreeMarker模板語言(FTL)編寫的,是一種簡單的專用語言。

Office2003以上,Word是可以以XML文字格式儲存的。先將要生成的PDF轉換為Word文件 ,再將其儲存為XML文字,通過模版引擎將資料填充到XML文字中,最後再反向轉換為PDF文件。簡單來說就是PDF->Word->XML->Word->PDF的流程。

步驟 描述 工具
1 word -> xml 手動
2 xml -> ftl 手動,參考《XML格式Word文件常用標籤介紹》
3 ftl + obj = xml freemarker
4 xml -> pdf docx4j
步驟
  • 1 把pdf文件對應的word(docx)製作出來
    簡歷.png
  • 2 把word文件另存為xml檔案
    另存為xml
  • 3 將xml檔案製作為freemarker模版(ftl)檔案
    製作模版檔案
  • 4 將資料和ftl檔案組裝為xml文字
Map<String, Object> map = new HashMap<>();
map.put("name", "小明");
map.put("address", "北京市朝陽區");
map.put("email", "xiaoming@abc.com");
StringWriter stringWriter = new StringWriter();
BufferedWriter writer = new BufferedWriter(stringWriter);
template.process(map, writer);
String xmlStr = stringWriter.toString();
複製程式碼
  • 5 使用docx4j將xml文字載入為word文件物件
ByteArrayInputStream in = new ByteArrayInputStream(xmlStr.getBytes());
WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage.load(in);
複製程式碼
  • 6 使用docx4j將word文件轉存為pdf文件
String outputfilepath = "/Users/xiaoming/簡歷.pdf";
FileOutputStream os = new FileOutputStream(new File(outputFilePath));
FOSettings foSettings = Docx4J.createFOSettings();
foSettings.setWmlPackage(wordMLPackage);
Docx4J.toFO(foSettings, os, Docx4J.FLAG_EXPORT_PREFER_XSL);
// Docx4J.toPDF(wordMLPackage, new FileOutputStream(new File(outputfilepath)));
複製程式碼

2.3 Word轉PDF

docx4j

WordprocessingMLPackage mlPackage = WordprocessingMLPackage.load(new File("abc.docx"));
Mapper fontMapper = new IdentityPlusMapper();  
// fontMapper.put("華文行楷", PhysicalFonts.get("STXingkai"));  
mlPackage.setFontMapper(fontMapper);  
OutputStream os = new java.io.FileOutputStream("abc.pdf");    
FOSettings foSettings = Docx4J.createFOSettings();  
foSettings.setWmlPackage(mlPackage);  
Docx4J.toFO(foSettings, os, Docx4J.FLAG_EXPORT_PREFER_XSL);  
複製程式碼

2.4 合併多個PDF

Apache PDFBox,將多個PDF文件合併

String folderName = "/Users/xiaoming/pdfs";
String destPath = "/Users/xiaoming/all.pdf";
PDFMergerUtility mergePdf = new PDFMergerUtility();
String[] filesInFolder = getFiles(folderName);
Arrays.sort(filesInFolder, new Comparator<String>() {
      @Override
      public int compare(String o1, String o2) {
          return o1.compareTo(o2);
      }
});
for (int i = 0; i < filesInFolder.length; i++) {
     mergePdf.addSource(folderName + File.separator + filesInFolder[i]);
}
mergePdf.setDestinationFileName(destPath);
mergePdf.mergeDocuments(MemoryUsageSetting.setupMainMemoryOnly());
複製程式碼

示例程式碼

github.com/brandonbai/…

連結

相關文章