Java生成pdf文件或jpg圖片的案例講解
更新時間：2021年01月30日 10:28:53 作者：砒霜拌辣椒
這篇文章主要介紹了Java生成pdf文件或jpg圖片的案例講解，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
在一些業(yè)務場景中，需要生成pdf文件或者jpg圖片，有時候還需要帶上水印。我們可以事先用freemarker定義好html模板，然后把模板轉(zhuǎn)換成pdf或jpg文件。
同時freemarker模板還支持變量的定義，在使用時可以填充具體的業(yè)務數(shù)據(jù)。
1、Maven導包
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.4.RELEASE</version> </parent> <dependencies> <!-- freemarker --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> </dependency> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> </dependency> <!-- pdf核心包 --> <dependency> <groupId>com.itextpdf</groupId> <artifactId>itextpdf</artifactId> <version>5.5.12</version> </dependency> <!-- 適配中文字體 --> <dependency> <groupId>com.itextpdf</groupId> <artifactId>itext-asian</artifactId> <version>5.2.0</version> </dependency> <!-- html轉(zhuǎn)pdf --> <dependency> <groupId>com.itextpdf.tool</groupId> <artifactId>xmlworker</artifactId> <version>5.5.12</version> </dependency> <!-- pdf轉(zhuǎn)圖片 --> <dependency> <groupId>org.apache.pdfbox</groupId> <artifactId>pdfbox</artifactId> <version>2.0.5</version> </dependency> </dependencies>
2、接口定義
2.1、請求
@Data
public class GeneratePdfReq {
/**
* 生成pdf文件的絕對路徑
*/
@NotBlank(message = "生成pdf文件的絕對路徑不能為空")
@Pattern(regexp = "^.*(\\.pdf|\\.jpg)$", message = "生成的文件必須以.pdf或.jpg結(jié)尾")
private String absolutePath;
/**
* 使用html模板的絕對路徑
*/
@NotBlank(message = "使用的模板路徑不能為空")
private String templateName;
/**
* 渲染模板的業(yè)務數(shù)據(jù)
*/
private Object dataModel;
/**
* 水印信息
*/
private WaterMarkInfo waterMarkInfo;
/**
* pdf文件的寬，默認A4
*/
private float width = 595;
/**
* pdf文件的高，默認A4
*/
private float height = 842;
}
2.2、水印
@Data
public class WaterMarkInfo {
/**
* 如果為null設置水印時會報錯
*/
private String waterMark = "";
/**
* 水印透明度,值越小透明度越高
*/
private float opacity = 0.2F;
/**
* 水印字體，如果亂碼設置為本地宋體字體:fonts/simsun.ttc,1
*/
private String fontName = "STSong-Light";
/**
* 水印編碼格式，如果亂碼設置為:BaseFont.IDENTITY_H
*/
private String encoding = "UniGB-UCS2-H";
/**
* 字體大小
*/
private float fontSize = 24;
/**
* 橫坐標在頁面寬度的百分比,左下角為原點
*/
private float x = 50;
/**
* 縱坐標在頁面高度的百分比,左下角為原點
*/
private float y = 40;
/**
* 水印旋轉(zhuǎn)角度
*/
private float rotation = 45;
}
2.3、響應
@Data
public class GeneratePdfResp {
/**
* 生成pdf的絕對路徑
*/
private String absolutePath;
}
3、應用代碼
3.1、渲染freemarker模板獲取html網(wǎng)頁
@Service("freeMarkerService")
@Slf4j
public class FreeMarkerServiceImpl implements FreeMarkerService {
@Autowired
private FreeMarkerConfigurer freeMarkerConfigurer;
/**
* 渲染html后獲取整個頁面內(nèi)容
*
* @param templatePath 模板路徑
* @param dataModel 業(yè)務數(shù)據(jù)，一般以map形式傳入
* @return
*/
@Override
public String getHtml(String templatePath, Object dataModel) {
log.info("開始將模板{}渲染為html,業(yè)務數(shù)據(jù){}", templatePath, JSONUtil.toJsonPrettyStr(dataModel));
Configuration cfg = freeMarkerConfigurer.getConfiguration();
cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER); // freemaker異常時仍舊拋出，統(tǒng)一異常處理
cfg.setClassicCompatible(true);// 不需要對null值預處理，否則需要在模板取值時判斷是否存在，不然報錯
StringWriter stringWriter = new StringWriter();
try {
// 設置模板所在目錄，絕對路徑方式，不打進jar包
// cfg.setDirectoryForTemplateLoading(new File(templatePath).getParentFile());
// Template temp = cfg.getTemplate(new File(templatePath).getName());
// 相對路徑設置模板所在目錄，模板打進jar包，默認就是resources目錄下的/templates目錄。
cfg.setClassForTemplateLoading(this.getClass(), "/templates");
Template temp = cfg.getTemplate(templatePath);
temp.process(dataModel, stringWriter);
} catch (Exception e) {
log.error(PdfErrorCode.PDF_TEMPLATE_RENDER_FAIL.getDesc(), e);
throw new PdfBizException(PdfErrorCode.PDF_TEMPLATE_RENDER_FAIL);
}
return stringWriter.toString();
}
}
3.2、將html網(wǎng)頁轉(zhuǎn)pdf，并添加水印
@Service("pdfService")
@Slf4j
public class PdfServiceImpl implements PdfService {
public static final String FONT_PATH = "fonts/simsun.ttc,1";
@Autowired
private WaterMarkerService waterMarkerService;
/**
* html頁面內(nèi)容轉(zhuǎn)pdf，并給每頁附上水印
*
* @param html html頁面內(nèi)容
* @param width pdf的寬
* @param height pdf的高
* @param waterMarkInfo 水印信息
* @return
*/
@Override
public byte[] html2Pdf(String html, float width, float height, WaterMarkInfo waterMarkInfo) {
log.info("=================開始將html轉(zhuǎn)換為pdf=================");
ByteArrayOutputStream out = new ByteArrayOutputStream();
this.html2Pdf(html, width, height, out);
byte[] bytes = out.toByteArray();
// 設置水印
if (waterMarkInfo != null) {
bytes = waterMarkerService.addWaterMarker(bytes, waterMarkInfo);
}
return bytes;
}
/**
* html轉(zhuǎn)pdf
*
* @param html html頁面內(nèi)容
* @param width pdf的寬
* @param height pdf的高
* @param out 輸出流，pdf文件用此流輸出，需要pdf文檔關閉后流中才會有數(shù)據(jù)
*/
@Override
@SneakyThrows
public void html2Pdf(String html, float width, float height, OutputStream out) {
@Cleanup Document document = new Document(new RectangleReadOnly(width, height)); // 默認A4縱向
// 這里需要關閉document才能讓生成的pdf字節(jié)數(shù)據(jù)刷到輸出流中
PdfWriter writer = PdfWriter.getInstance(document, out); // 關閉可能導致生成的pdf顯示異常（Chrome）
document.open();
// 設置字體,這里統(tǒng)一用simsun.ttc即宋體
XMLWorkerFontProvider asianFontProvider = new XMLWorkerFontProvider() {
@Override
public Font getFont(String fontname, String encoding, boolean embedded, float size, int style, BaseColor color, boolean cached) {
Font font;
try {
font = new Font(BaseFont.createFont(FONT_PATH, BaseFont.IDENTITY_H, BaseFont.EMBEDDED));
} catch (Exception e) {
log.error(PdfErrorCode.SET_PDF_FONT_FAIL.getDesc(), e);
throw new PdfBizException(PdfErrorCode.SET_PDF_FONT_FAIL);
}
font.setStyle(style);
font.setColor(color);
if (size > 0) {
font.setSize(size);
}
return font;
}
};
// 生成pdf
try {
XMLWorkerHelper.getInstance().parseXHtml(writer, document, new ByteArrayInputStream(html.getBytes("UTF-8")), null, Charset.forName("UTF-8"), asianFontProvider);
// 如果系統(tǒng)已經(jīng)裝有simsun.ttc字體，則不需要單獨設置字體也不需要itext-asian jar包
// XMLWorkerHelper.getInstance().parseXHtml(writer, document, new ByteArrayInputStream(html.getBytes("UTF-8")), null, Charset.forName("UTF-8"));
} catch (RuntimeWorkerException e) {
log.error(PdfErrorCode.HTML_CONVERT2PDF_FAIL.getDesc(), e);
throw new PdfBizException(PdfErrorCode.HTML_CONVERT2PDF_FAIL);
}
}
}
添加水印實現(xiàn)類
@Service("waterMarkerService")
@Slf4j
public class WaterMarkerServiceImpl implements WaterMarkerService {
/**
* 給pdf文件每頁添加水印
*
* @param source pdf文件的字節(jié)數(shù)組形式
* @param waterMarkInfo 水印信息
* @return
*/
@Override
public byte[] addWaterMarker(byte[] source, WaterMarkInfo waterMarkInfo) {
log.info("開始設置水印數(shù)據(jù){}", JSONUtil.toJsonPrettyStr(waterMarkInfo));
ByteArrayOutputStream out = new ByteArrayOutputStream();
this.addWaterMarker(source, waterMarkInfo, out);
return out.toByteArray();
}
/**
* 給pdf文件每頁添加水印
*
* @param source pdf文件的字節(jié)數(shù)組形式
* @param waterMarkInfo 水印信息
* @param out 輸出流，pdf文件用此流輸出，需要pdf文檔關閉后流中才會有數(shù)據(jù)
*/
@Override
@SneakyThrows
public void addWaterMarker(byte[] source, WaterMarkInfo waterMarkInfo, OutputStream out) {
@Cleanup PdfReader reader = new PdfReader(source);
// 這里需要關閉PdfStamper才能讓生成的pdf字節(jié)數(shù)據(jù)刷到輸出流中
@Cleanup PdfStamper pdfStamper = new PdfStamper(reader, out);
BaseFont font = BaseFont.createFont(waterMarkInfo.getFontName(), waterMarkInfo.getEncoding(), BaseFont.EMBEDDED);
PdfGState gs = new PdfGState();
gs.setFillOpacity(waterMarkInfo.getOpacity());
// 給每頁pdf生成水印
for (int i = 1; i <= reader.getNumberOfPages(); i++) {
PdfContentByte waterMarker = pdfStamper.getUnderContent(i);
waterMarker.beginText();
// 設置水印透明度
waterMarker.setGState(gs);
// 設置水印字體和大小
waterMarker.setFontAndSize(font, waterMarkInfo.getFontSize());
// 設置水印位置、內(nèi)容、旋轉(zhuǎn)角度
float X = reader.getPageSize(i).getWidth() * waterMarkInfo.getX() / 100;
float Y = reader.getPageSize(i).getHeight() * waterMarkInfo.getY() / 100;
waterMarker.showTextAligned(Element.ALIGN_CENTER, waterMarkInfo.getWaterMark(), X, Y, waterMarkInfo.getRotation());
// 設置水印顏色
waterMarker.setColorFill(BaseColor.GRAY);
waterMarker.endText();
}
}
}
3.3、整合實現(xiàn)
@Slf4j
@Service("generatePdfService")
public class GeneratePdfServiceImpl implements RestService {
@Autowired
private FreeMarkerService freeMarkerService;
@Autowired
private PdfService pdfService;
@Override
@SneakyThrows
public GeneratePdfResp service(GeneratePdfReq generatePdfReq) {
log.info("開始生成pdf文件,請求報文:{}", JSONUtil.toJsonPrettyStr(generatePdfReq));
/*
1.根據(jù)freemarker模板填充業(yè)務數(shù)據(jù)獲取完整的html字符串
*/
String html = freeMarkerService.getHtml(generatePdfReq.getTemplateName(), generatePdfReq.getDataModel());
/*
2.生成pdf文件（內(nèi)存）
*/
byte[] bytes = pdfService.html2Pdf(html, generatePdfReq.getWidth(), generatePdfReq.getHeight(), generatePdfReq.getWaterMarkInfo());
/*
3.本地保存pdf文件
*/
File targetFile = new File(generatePdfReq.getAbsolutePath());
// 上級目錄不存在則創(chuàng)建
if (!targetFile.getParentFile().exists()) {
targetFile.getParentFile().mkdirs();
}
// 根據(jù)不同文件名后綴生成對應文件
if (generatePdfReq.getAbsolutePath().endsWith("pdf")) {
FileUtils.writeByteArrayToFile(targetFile, bytes);
} else {
@Cleanup PDDocument document = PDDocument.load(bytes);
PDFRenderer renderer = new PDFRenderer(document);
BufferedImage bufferedImage = renderer.renderImageWithDPI(0, 150);// 只打第一頁,dpi越大圖片越高清也越耗時
ByteArrayOutputStream baos = new ByteArrayOutputStream();
ImageIO.write(bufferedImage, "jpg", baos);
FileUtils.writeByteArrayToFile(targetFile, baos.toByteArray());
}
log.info("文件本地保存完成,文件路徑:[{}]", targetFile.getAbsolutePath());
/*
4.組織返回
*/
GeneratePdfResp generatePdfResp = new GeneratePdfResp();
generatePdfResp.setAbsolutePath(targetFile.getAbsolutePath());
return generatePdfResp;
}
}
3.4、controller
@Slf4j
@RestController
public class PdfController {
@Autowired
private RestService generatePdfService;
@PostMapping(value = "/html2Pdf")
public GeneratePdfResp html2Pdf(@RequestBody @Validated GeneratePdfReq req) {
GeneratePdfResp resp = generatePdfService.service(req);
return resp;
}
}
4、應用
4.1、freemarker模板（html模板）
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta http-equiv="Content-Style-Type" content="text/css"/>
<style>
body {
font-family: SimSun
}
</style>
<title>html模板</title>
</head>
<body>
<div>
<p style="margin:0pt; orphans:0; text-align:center; widows:0">
<span style="font-family:SimSun; font-size:16pt">html模板</span><br/>
</p>
<p>姓名：${name}</p>
<p>證件號碼：${cardNo}</p>
<p>日期：${date}</p>
</div>
</body>
</html>
4.2、接口調(diào)用生成pdf
5、說明
1、根據(jù)參數(shù)后綴名可以生成pdf或jpg文件，生成的pdf文件默認為A4大小，也可以通過請求參數(shù)設置大小。
2、pdf文件會根據(jù)html模板內(nèi)容大小自動分頁。
3、如果生成圖片，多頁不會生成多張圖片，可以把高度設置大一些，最后會生成長圖。
4、水印每頁都會自動添加。
5、為了提高代碼的復用性和可維護性，工程內(nèi)渲染html模板、生成pdf文件、添加水印都有單獨的接口實現(xiàn)。
代碼地址
github：https://github.com/senlinmu1008/spring-boot/tree/master/html2pdf
gitee：https://gitee.com/ppbin/spring-boot/tree/master/html2pdf
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。如有錯誤或未考慮完全的地方，望不吝賜教。
相關文章
使用IDEA對SpringBoot應用進行遠程調(diào)試方式
文章介紹了如何在IDEA中對部署在服務器上的SpringBoot應用進行遠程調(diào)試,通過配置遠程調(diào)試端口和啟動參數(shù),本地IDEA可以設置斷點并進行調(diào)試2025-02-02
下面小編就為大家?guī)硪黄狫ava 虛擬機(JVM)之基本概念詳解。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-05-05
這篇文章主要介紹了@Validated和@Valid三種異常捕獲處理方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-10-10
這篇文章主要給大家介紹了關于Spring中Context的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用Spring具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2019-08-08
這篇文章主要介紹了簡單了解springboot eureka交流機制,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-04-04
Eclipse配置python開發(fā)環(huán)境過程圖解
這篇文章主要介紹了Eclipse配置python開發(fā)環(huán)境過程圖解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-03-03
這篇文章主要為大家詳細介紹了java實現(xiàn)微信掃碼支付功能，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-07-07
FastJson對于JSON格式字符串、JSON對象及JavaBean之間的相互轉(zhuǎn)換操作
這篇文章主要介紹了FastJson對于JSON格式字符串、JSON對象及JavaBean之間的相互轉(zhuǎn)換,非常不錯，具有參考借鑒價值，需要的朋友可以參考下2017-11-11
觀察者模式是極其重要的一個設計模式，也是我?guī)啄觊_發(fā)過程中使用最多的設計模式，本文首先概述觀察者模式的基本概念和Demo實現(xiàn)，接著是觀察者模式在Java和Spring中的應用，最后是對觀察者模式的應用場景和優(yōu)缺點進行總結(jié)2022-11-11
這篇文章主要介紹了JAVA得到數(shù)組中最大值和最小值的簡單實例，需要的朋友可以參考下2017-04-04