Java开发入门到精通--使用Java开发在线生成平PDF文档-职坐标

Java开发入门到精通--使用Java开发在线生成平PDF文档

小职 2021-10-15 来源：Java极客技术阅读 353 评论 0

摘要：本篇主要介绍了Java开发入门到精通--使用Java开发在线生成平PDF文档，通过具体的内容展现，希望对Java开发的学习有一定的帮助。

本篇主要介绍了Java开发入门到精通--使用Java开发在线生成平PDF文档，通过具体的内容展现，希望对Java开发的学习有一定的帮助。

Java开发入门到精通--使用Java开发在线生成平PDF文档

一、介绍

在实际的业务开发的时候，研发人员往往会碰到很多这样的一些场景，需要提供相关的电子凭证信息给用户，例如网银/支付宝/微信购物支付的电子发票、订单的库存打印单、各种电子签署合同等等，以方便用户查看、打印或者下载。

例如下图的电子发票!

Java开发入门到精通--使用Java开发在线生成平PDF文档

熟悉这块业务的童鞋，一定特别清楚，目前最常用的解决方案是：把相关的数据信息，通过一些技术手段生成对应的 PDF 文件，然后返回给用户，以便预览、下载或者打印。

不太熟悉这项技术的童鞋，也不用着急，今天我们一起来详细了解一下在线生成 PDF 文件的技术实现手段!

二、案例实现

在介绍这个代码实践之前，我们先来了解一下这个第三方库：iText，对，没错，它就是我们今天的主角。

iText是著名的开放源码站点sourceforge一个项目，是用于生成PDF文档的一个java类库，通过iText不仅可以生成PDF或rtf的文档，而且还可以将XML、Html文件转化为PDF文件。

iText目前有两套版本，分别是iText5和iText7。iText5应该是网上用的比较多的一个版本。iText5因为是很多开发者参与贡献代码，因此在一些规范和设计上存在不合理的地方。iText7是后来官方针对iText5的重构，两个版本差别还是挺大的。不过在实际使用中，一般用到的都比较简单的 API，所以不用特别拘泥于使用哪个版本。

2.1、添加 iText 依赖包

在使用它之前，我们先引人相关的依赖包!

<groupId>com.itextpdf</groupId>

<artifactId>itextpdf</artifactId>

</dependency>

<groupId>com.itextpdf.tool</groupId>

<artifactId>xmlworker</artifactId>

</dependency>

<groupId>com.itextpdf</groupId>

<artifactId>itext-asian</artifactId>

</dependency>

<groupId>org.xhtmlrenderer</groupId>

<artifactId>flying-saucer-pdf-itext5</artifactId>

</dependency>

<groupId>net.sf.jtidy</groupId>

<artifactId>jtidy</artifactId>

</dependency>

</dependencies>

2.2、简单实现

老规矩，我们先来一个hello world，代码如下：

public class CreatePDFMainTest {

public static void main(String[] args) throws Exception {

Document document = new Document(PageSize.A4);

//第二步，创建Writer实例

PdfWriter.getInstance(document, new FileOutputStream("hello.pdf"));

//创建中文字体

BaseFont bfchinese = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);

Font fontChinese = new Font(bfchinese, 12, Font.NORMAL);

//第三步，打开文档

document.open();

//第四步，写入内容

Paragraph paragraph = new Paragraph("hello world", fontChinese);

document.add(paragraph);

//第五步，关闭文档

document.close();

}

打开hello.pdf文件，内容如下!

Java开发入门到精通--使用Java开发在线生成平PDF文档

2.3、复杂实现

在实际的业务开发中，因为业务场景非常复杂，而且变化快，我们往往不会采用上面介绍的写入内容方式来生成文件，而是采用HTML文件转化为PDF文件。

例如下面这张入库单!

Java开发入门到精通--使用Java开发在线生成平PDF文档

我们应该如何快速实现呢?

首先，我们采用html语言编写一个入库单页面，将其命令为printDemo.html，源代码如下：

<html>

<body>

<div>

<tbody>

<tr>

</td>

</tr>

<tr>

</tr>

</tbody>

</table>

</div>

<div>

<table width="100%"

style="border-collapse: collapse; border-spacing: 0;border:0px;">

<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%">数量</td>

</tr>

<tr>

<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">xxx沐浴露</td>

</tr>

<tr>

<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">xxx洗发水</td>

</tr>

<tr>

<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000;">xxx洗衣粉</td>

</tr>

<tr>

<td style="text-align: center; border-left: 1px solid #000000; border-top: 1px solid #000000; border-bottom: 1px solid #000000;">xxx洗面奶</td>

</tr>

</table>

</div>

</body>

</html>

接着，我们将html文件转成PDF文件，源码如下：

public class CreatePDFMainTest {

/**

* 创建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为文件结束

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文件转成PDF

writeToOutputStreamAsPDF(htmlStr);

}

运行程序，打开pdfDemo.pdf，结果如下!

Java开发入门到精通--使用Java开发在线生成平PDF文档

2.4、变量替换方式

上面的html文件，是我们事先已经编辑好的，才能正常渲染。

但是在实际的业务开发的时候，例如下面的商品内容，完全是动态的，还是xxx-202109入库单的名称，以及二维码，都是动态的。

这个时候，我们可以采用freemarker模板引擎，通过定义变量来动态填充内容，直到转换出来的结果就是我们想要的html页面。

当然，还有一种办法，例如下面这个，我们也可以在html页面里面定义${name}变量，然后在读取完文件之后，我们将其变量进行替换成我们想填充的任何值，这其实也是模板引擎最核心的一个玩法。

<html>

<head>

</head>

<body>

<div>欢迎，登录博客网站</div>

</body>

</html>

三、总结

itext框架是一个非常实用的第三方pdf文件生成库，尤其是面对比较简单的pdf文件内容渲染的时候，它完全满足我们的需求。

我是小职，记得找我

✅ 解锁高薪工作

✅ 免费获取基础课程·答疑解惑·职业测评

Java开发入门到精通--使用Java开发在线生成平PDF文档

java语言学习 javaweb从入门到精通 java网络编程

本文由 @小职发布于职坐标。未经许可，禁止转载。

喜欢 | 0

不喜欢 | 0

看完这篇文章有何感觉？已经有0人表态，0%的人喜欢快给朋友分享吧~

后参与评论

加入IT交流圈

JAVA工程师交流群 +加入

大数据架构师交流群 +加入

人工智能Python交流群 +加入

WEB/H5前端交流群 +加入

编程语言 直通车

索取资料
答疑解惑
技术交流
职业测评
面试技巧
高薪秘笈

海同师资推荐更多>>

黄骈联系TA

认证System Analyst，System Architect

程光淼联系TA

精通C、C++等语言、智能芯片开发

热门就业培训班更多>>

【零基础】人工智能+Python全栈开发课程

JAVA30天热搜词更多>>

java语言学习 java从入门到精通第3版pdf java7从入门到精通 java从入门到精通精讲教程 java语言编程 java从入门到精通下载 java语言包教学视频 java语言基础 java从入门到精通第3版光盘会java好找工作吗 java程序设计实例 java语言程序设计进阶pdf java小程序实例下载 java9新特性 java经典实例 java经典编程300例 java语言程序设计8 java窗口程序实例 java应用程序实例 java语言程序设计基础篇所有答案