SpringBoot+ItextPdf生成PDF+頁眉+水印
前言
文本已收錄至個人GitHub倉庫，歡迎Star：github.com/bin39232820…
種一棵樹最好的時間是十年前，其次是如今
我知道不少人不玩qq了,可是懷舊一下,歡迎加入六脈神劍Java菜鳥學習羣，羣聊號碼：549684836 鼓勵你們在技術的路上寫博客css
絮叨
哈哈，有沒有發現小六六老是寫些用的不多的東西，沒辦法，這種東西都是用到的時候，百度踩坑，而後懟出來的，若是不寫點文章記錄下來，那下次又得從新懟一遍前面的過程，因此小六六偷點懶，記錄一下，下次就簡單了，說說場景吧，小六六目前負責的系統有一個題庫的需求，就是要求把學生作錯的題目生成一個pdf,或者是歷年的真題生成一個pdf，而後給到用戶下載，去用筆寫，我原本想，這種需求不該該是運營教務那邊直接上傳就行了，可是他們不幹，非得讓咱們代碼生成，而後產品小姐姐又被他們說動了，而後最後只好接了，不過我絕對不是屈服在小姐姐的美色之下，我只是單純的以爲這個需求又意思。哈哈html
itext介紹
iText是著名的開放源碼的站點sourceforge一個項目，是用於生成PDF文檔的一個java類庫。經過iText不只能夠生成PDF或rtf的文檔，並且能夠將XML、Html文件轉化爲PDF文件。前端
其實這邊我說下又2種方式生成pdfjava
- 能夠用原生的api,去建立pdf 所須要的每個元素，這種也是一種實現方式，可是怎麼說呢？就是你必須學他的api,有點多，哈哈
- 能夠直接用itextpdf 這個jar,這樣就能夠把html直接變成pdf，那咱們只須要用一個模板引擎，而後把他渲染，而後拿到這個頁面，就能夠生成咱們須要的pdf了，下面的文章也是用的第二種方式，而後我把大體的過程記錄一下
引入依賴
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.github.superad.pdf.kit</groupId>
<artifactId>pdf-kit</artifactId>
<packaging>jar</packaging>
<name>${project.artifactId}</name>
<version>1.1-RELEASE</version>
<properties>
<java.src.version>1.7</java.src.version>
<java.target.version>1.7</java.target.version>
<project.encoding>UTF-8</project.encoding>
</properties>
<parent>
<groupId>org.sonatype.oss</groupId>
<artifactId>oss-parent</artifactId>
<version>7</version>
</parent>
<dependencies>
<!--pdf生成工具類-->
<!--pdf生成 itext-->
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>itextpdf</artifactId>
<version>5.4.2</version>
</dependency>
<dependency>
<groupId>com.itextpdf.tool</groupId>
<artifactId>xmlworker</artifactId>
<version>5.4.1</version>
</dependency>
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>itext-asian</artifactId>
<version>5.2.0</version>
</dependency>
<dependency>
<groupId>org.xhtmlrenderer</groupId>
<artifactId>flying-saucer-pdf</artifactId>
<version>9.0.3</version>
</dependency>
<!--freemarker-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.26-incubating</version>
</dependency>
<!--jfreechart-->
<dependency>
<groupId>jfree</groupId>
<artifactId>jfreechart</artifactId>
<version>1.0.2</version>
</dependency>
<!--log-->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.0.13</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.0.13</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-access</artifactId>
<version>1.0.13</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.5</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>log4j-over-slf4j</artifactId>
<version>1.7.21</version>
</dependency>
<!--util-->
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>20.0</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.14.8</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-io</artifactId>
<version>1.3.2</version>
</dependency>
<dependency>
<groupId>commons-lang</groupId>
<artifactId>commons-lang</artifactId>
<version>2.6</version>
</dependency>
<!--servlet-->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
<scope>provided</scope>
</dependency>
</dependencies>
<!--增長的配置,過濾ttf文件的匹配-->
<profiles>
<profile>
<id>release</id>
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>
</build>
<distributionManagement>
<snapshotRepository>
<id>oss</id>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
</snapshotRepository>
<repository>
<id>oss</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
</repository>
</distributionManagement>
</profile>
</profiles>
<licenses>
<license>
<name>The Apache Software License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>
<scm>
<tag>alpha</tag>
<url>https://github.com/superad/pdf-kit.git</url>
<connection>scm:git:https://github.com/superad/pdf-kit.git</connection>
<developerConnection>scm:git:https://github.com/superad/pdf-kit.git</developerConnection>
</scm>
<developers>
<developer>
<name>fangguangming</name>
<email>563508194@qq.com</email>
</developer>
</developers>
</project>
複製代碼
啓動類
package pdf.kit;
import com.google.common.collect.Lists;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang.exception.ExceptionUtils;
import pdf.kit.component.PDFHeaderFooter;
import pdf.kit.component.PDFKit;
import pdf.kit.component.chart.ScatterPlotChart;
import pdf.kit.component.chart.model.XYLine;
import pdf.kit.component.chart.impl.DefaultLineChart;
import java.util.ArrayList;
import java.util.List;
/**
*
* 360報告
*
*/
@Slf4j
public class ReportKit360 {
public static List<XYLine> getTemperatureLineList() {
List<XYLine> list= Lists.newArrayList();
for(int i=1;i<=7;i++){
XYLine line=new XYLine();
float random=Math.round(Math.random()*10);
line.setXValue("星期"+i);
line.setYValue(20+random);
line.setGroupName("下週");
list.add(line);
}
for(int i=1;i<=7;i++){
XYLine line=new XYLine();
float random=Math.round(Math.random()*10);
line.setXValue("星期"+i);
line.setYValue(20+random);
line.setGroupName("這周");
list.add(line);
}
return list;
}
public String createPDF(String templatePath,Object data, String fileName){
//pdf保存路徑
try {
//設置自定義PDF頁眉頁腳工具類
PDFHeaderFooter headerFooter=new PDFHeaderFooter();
PDFKit kit=new PDFKit();
kit.setHeaderFooterBuilder(headerFooter);
//設置輸出路徑
kit.setSaveFilePath("./hello.pdf");
String saveFilePath=kit.exportToFile(fileName,data);
return saveFilePath;
} catch (Exception e) {
log.error("PDF生成失敗{}", ExceptionUtils.getFullStackTrace(e));
return null;
}
}
public static void main(String[] args) {
ReportKit360 kit=new ReportKit360();
TemplateBO templateBO=new TemplateBO();
templateBO.setTemplateName("考前-真題+考前");
templateBO.setFreeMarkerUrl("A 正確");
templateBO.setITEXTUrl("咱們去了猴山，那裏有不少的猴子，都是紅屁股，有的在玩盪鞦韆，有的在避雨，有的在自得其樂地撓癢癢............真可愛。還有一隻最威武的猴王，它站在最高的山頭上，一動也不動地站着，它在看着這一羣調皮的小猴子們，不讓它們受到大猴子們的欺負 在動物園裏，我還看到了不少別的動物。好比說活潑可愛的小熊貓、大熊貓;漂亮大方的丹頂鶴、孔雀;威風凜凜的獅子、老虎;光滑無比的海獅、海豹;還有讓人懼怕的鱷魚;龐然大物般的大象;懶惰的黑熊;兇狠的狼和金錢豹;有着美麗花紋的長頸鹿、梅花鹿、斑馬等等............這些動物我都很喜歡哦!0");
templateBO.setJFreeChartUrl("B 錯誤");
List<String> scores=new ArrayList<String>();
scores.add("90");
scores.add("95");
scores.add("98");
templateBO.setScores(scores);
// List<XYLine> lineList=getTemperatureLineList();
// DefaultLineChart lineChart=new DefaultLineChart();
// lineChart.setHeight(500);
// lineChart.setWidth(300);
// String picUrl=lineChart.draw(lineList,0);
// templateBO.setPicUrl(picUrl);
//
// //散點圖
// String scatterUrl=ScatterPlotChart.draw(ScatterPlotChartTest.getData(),1,"他評得分(%)","自評得分(%)");
// templateBO.setScatterUrl(scatterUrl);
String templatePath="E:\\code\\pdf-kit\\src\\test\\resources\\templates";
String path= kit.createPDF(templatePath,templateBO,"hello.pdf");
System.out.println(path);
}
}
複製代碼
小六六說下思路，其實很簡單，就是從數據庫把數據查出來，渲染到模板引擎上，最後拿到那個渲染以後的靜態頁面，而後把他轉成pdf,而後傳到oss,返回一個url 給前端git
模板
<!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>${ITEXTUrl}</p></div>
<div>
<ul>
<li>${freeMarkerUrl}</li>
<li>${JFreeChartUrl}</li>
</ul>
</div>
</div>
<!--第一頁結束-->
<!---分頁標記-->
<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>
<span style="page-break-after:always;"></span>
<div class="page">
aaa
</div>
<!--第二頁結束-->
</body>
</html>
複製代碼
pdf生成類
package pdf.kit.component;
import com.itextpdf.text.BaseColor;
import com.itextpdf.text.Document;
import com.itextpdf.text.Element;
import com.itextpdf.text.PageSize;
import com.itextpdf.text.pdf.*;
import com.itextpdf.tool.xml.XMLWorkerFontProvider;
import com.itextpdf.tool.xml.XMLWorkerHelper;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.xhtmlrenderer.pdf.ITextRenderer;
import pdf.kit.component.builder.HeaderFooterBuilder;
import pdf.kit.component.builder.PDFBuilder;
import pdf.kit.exception.PDFException;
import pdf.kit.util.CustomEvent;
import pdf.kit.util.FreeMarkerUtil;
import pdf.kit.util.PDFBuilder1;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.nio.charset.Charset;
@Slf4j
public class PDFKit {
//PDF頁眉、頁腳定製工具
private HeaderFooterBuilder headerFooterBuilder;
private String saveFilePath;
/**
* @description 導出pdf到文件
* @param fileName 輸出PDF文件名
* @param data 模板所須要的數據
*
*/
public String exportToFile(String fileName,Object data){
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{
//設置輸出路徑
outputStream=new FileOutputStream(saveFilePath);
//設置文檔大小
Document document = new Document(PageSize.A4);
PdfWriter writer = PdfWriter.getInstance(document, outputStream);
//設置頁眉頁腳
PDFBuilder1 builder = new PDFBuilder1();
writer.setPageEvent(builder);
writer.setPageEvent(new CustomEvent("www.hqjy.com"));
//輸出爲PDF文件
convertToPDF(writer,document,htmlData);
}catch(Exception ex){
throw new PDFException("PDF export to File fail",ex);
}finally{
IOUtils.closeQuietly(outputStream);
}
return saveFilePath;
}
/**
* 生成PDF到輸出流中（ServletOutputStream用於下載PDF）
* @param ftlPath ftl模板文件的路徑（不含文件名）
* @param data 輸入到FTL中的數據
* @param response HttpServletResponse
* @return
*/
public OutputStream exportToResponse(String ftlPath,Object data,
HttpServletResponse response){
String html= FreeMarkerUtil.getContent(ftlPath,data);
try{
OutputStream out = null;
ITextRenderer render = null;
out = response.getOutputStream();
//設置文檔大小
Document document = new Document(PageSize.A4);
PdfWriter writer = PdfWriter.getInstance(document, out);
//設置頁眉頁腳
PDFBuilder builder = new PDFBuilder(headerFooterBuilder,data);
writer.setPageEvent(builder);
//輸出爲PDF文件
convertToPDF(writer,document,html);
return out;
}catch (Exception ex){
throw new PDFException("PDF export to response fail",ex);
}
}
/**
* @description PDF文件生成
*/
private void convertToPDF(PdfWriter writer,Document document,String htmlString) throws Exception{
//獲取字體路徑
String fontPath=getFontPath();
document.open();
try {
XMLWorkerHelper.getInstance().parseXHtml(writer,document,
new ByteArrayInputStream(htmlString.getBytes()),
XMLWorkerHelper.class.getResourceAsStream("/default.css"),
Charset.forName("UTF-8"),new XMLWorkerFontProvider(fontPath));
} catch (IOException e) {
e.printStackTrace();
throw new PDFException("PDF文件生成異常",e);
}finally {
document.close();
}
}
/**
* @description 建立默認保存路徑
*/
private String getDefaultSavePath(String fileName){
String classpath=PDFKit.class.getClassLoader().getResource("").getPath();
String saveFilePath=classpath+"pdf/"+fileName;
File f=new File(saveFilePath);
if(!f.getParentFile().exists()){
f.mkdirs();
}
return saveFilePath;
}
/**
* @description 獲取字體設置路徑
*/
public static String getFontPath() {
String classpath=PDFKit.class.getClassLoader().getResource("").getPath();
String fontpath=classpath+"fonts";
return fontpath;
}
public HeaderFooterBuilder getHeaderFooterBuilder() {
return headerFooterBuilder;
}
public void setHeaderFooterBuilder(HeaderFooterBuilder headerFooterBuilder) {
this.headerFooterBuilder = headerFooterBuilder;
}
public String getSaveFilePath() {
return saveFilePath;
}
public void setSaveFilePath(String saveFilePath) {
this.saveFilePath = saveFilePath;
}
}
複製代碼
設置頁眉和頁腳 +水印
package pdf.kit.util;
import com.itextpdf.text.Document;
import com.itextpdf.text.Element;
import com.itextpdf.text.pdf.*;
/**
* @author 小六六
* @version 1.0
* @date 2020/4/29 11:14
*/
public class CustomEvent extends PdfPageEventHelper {
private String waterMark;
public CustomEvent(String waterMark) {
this.waterMark = waterMark;
}
@Override
public void onStartPage(PdfWriter writer, Document document) {
try {
// 加入水印
PdfContentByte waterMar = writer.getDirectContentUnder();
// 開始設置水印
waterMar.beginText();
// 設置水印透明度
PdfGState gs = new PdfGState();
// 設置填充字體不透明度爲0.2f
gs.setFillOpacity(0.1f);
// 設置水印字體參數及大小
BaseFont baseFont = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H",
BaseFont.EMBEDDED);
waterMar.setFontAndSize(baseFont,60);
// 設置透明度
waterMar.setGState(gs);
// 設置水印對齊方式 水印內容 X座標 Y座標 旋轉角度
waterMar.showTextAligned(Element.ALIGN_CENTER, waterMark , 300, 500, 45);
//結束設置
waterMar.endText();
waterMar.stroke();
} catch (Exception e) {
e.printStackTrace();
}
}
}
複製代碼
package pdf.kit.util;
/**
* @author 小六六
* @version 1.0
* @date 2020/4/29 10:35
*/
import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Element;
import com.itextpdf.text.Font;
import com.itextpdf.text.Phrase;
import com.itextpdf.text.pdf.BaseFont;
import com.itextpdf.text.pdf.ColumnText;
import com.itextpdf.text.pdf.PdfPageEventHelper;
import com.itextpdf.text.pdf.PdfWriter;
import java.io.IOException;
public class PDFBuilder1 extends PdfPageEventHelper {
private Phrase leftHeader;
private Phrase rigntHeader;
public static final int marginX = 90;
public static final int marginY = 70;
private static BaseFont baseFont;
// 生成下劃線空白佔位符
private static String Blank;
// 頁眉字體
private static Font font;
// 下劃線字體
private static Phrase blankPhrase;
public PDFBuilder1() {
//this.leftHeader = new Phrase(header[0], PDFBuilder.font);
//this.rigntHeader = new Phrase(header[1], PDFBuilder.font);
}
static {
try {
// 中文字體依賴itext得itext-asian包
baseFont = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
StringBuilder sb = new StringBuilder();
for (int i = 0; i < 210; i++) {
sb.append("\u00a0");
}
Blank = sb.toString();
font = new Font(PDFBuilder1.baseFont, 16, Font.UNDEFINED);
blankPhrase = new Phrase(PDFBuilder1.Blank, new Font(PDFBuilder1.baseFont, Font.DEFAULTSIZE, Font.UNDERLINE));
} catch (DocumentException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* @param writer
* @param document
*/
@Override
public void onEndPage(PdfWriter writer, Document document) {
int yMargin = -20;
float top = document.top(yMargin);
float bottom=document.bottom(-10);
// 第一頁不生成頁眉頁腳
if (document.getPageNumber() == 1) {
return;
}
//生成下劃線，使用空格佔位
ColumnText.showTextAligned(writer.getDirectContent(),
Element.ALIGN_LEFT, PDFBuilder1.blankPhrase,
document.left(-1), top, 0);
// //生成左側頁眉
// ColumnText.showTextAligned(writer.getDirectContent(),
// Element.ALIGN_LEFT, leftHeader,
// document.left(), top, 0);
// //生成右側頁眉
// ColumnText.showTextAligned(writer.getDirectContent(),
// Element.ALIGN_RIGHT, rigntHeader,
// document.right(), top, 0);
ColumnText.showTextAligned(
writer.getDirectContent(),
Element.ALIGN_LEFT,
new Phrase("我是頁眉", font),
document.left(),
document.top() + 20, 0);
//生成下劃線，使用空格佔位
ColumnText.showTextAligned(writer.getDirectContent(),
Element.ALIGN_LEFT, PDFBuilder1.blankPhrase,
document.left(-1), bottom, 0);
//生成頁腳頁數
ColumnText.showTextAligned(writer.getDirectContent(), Element.ALIGN_LEFT, new Phrase("我是頁尾", PDFBuilder1.font), document.left(), document.bottom(-30), 0);
}
}
複製代碼
結果
固然這個是沒有樣式的，得前端把樣式畫好，再去生成github
結尾
具體的代碼我放到一個倉庫了，你們有須要的能夠去下載 gitee.com/ybliu/sprin…spring
平常求贊
好了各位，以上就是這篇文章的所有內容了，能看到這裏的人呀，都是真粉。數據庫
創做不易，各位的支持和承認，就是我創做的最大動力，咱們下篇文章見apache
六脈神劍 | 文 【原創】若是本篇博客有任何錯誤，請批評指教，不勝感激 ！api
相關文章
- 1. JAVA用word文檔生成或轉換成PDF文檔，並支持水印、頁眉、頁腳功能
- 2. itext生成pdf（附帶頁眉，頁腳，頁碼）
- 3. 如何批量給PDF添加頁眉和頁腳文字水印和圖片水印？這裏有方法
- 4. itext 生成pdf文件添加頁眉頁腳
- 5. 前端頁面水印生成實現
- 6. 網頁生成PDF
- 7. python pdf加水印
- 8. 給pdf加水印
- 9. pdf增長水印
- 10. Java 添加頁眉頁腳到PDF
- 更多相關文章...
- • Eclipse 生成jar包 - Eclipse 教程
- • XSL-FO 頁面 - XSL-FO 教程
- • 使用阿里雲OSS+CDN部署前端頁面與加速靜態資源
- • 爲了進字節跳動，我精選了29道Java經典算法題，帶詳細講解
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
歡迎關注本站公眾號,獲取更多信息
相關文章