1. itext7史上最全实战总结

1.1. 前言

最近有个需求需要我用Java手动写一份PDF报告,经过考察几种pdf开源代码,最终选取了itext7,此版本为7.1.11,由于发现网上关于该工具的博文比较少,特别是实战博文几乎没有,在我踩完各种坑,最终把PDF成型后,打算把经验分享出来,本文通过摘录解释来说明,内容来自本人GitHub itext-pdf

1.2. 配置文件

项目采用了Spring Cloud config所以配置在git上,仅仅研究itext7不需要用到数据库等功能,请直接运行PdfMain类的main方法,即可生成模拟的PDF报告

1.3. 版本POM

itext7相关pom

<properties>
<itext.version>7.1.11</itext.version>
</properties>
<dependencies>
<!-- itext7 -->
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>kernel</artifactId>
<version>${itext.version}</version>
</dependency>
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>io</artifactId>
<version>${itext.version}</version>
</dependency>
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>layout</artifactId>
<version>${itext.version}</version>
</dependency>
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>forms</artifactId>
<version>${itext.version}</version>
</dependency>
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>pdfa</artifactId>
<version>${itext.version}</version>
</dependency>
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>pdftest</artifactId>
<version>${itext.version}</version>
</dependency>
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>font-asian</artifactId>
<version>${itext.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.18</version>
</dependency> <!--itext7 html转pdf用到的包-->
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>html2pdf</artifactId>
<version>3.0.0</version>
</dependency>
</dependencies>

1.4. 干货

itext7语义本身和前端css很像,所以有点前端基础还是比较容易掌握的

1.4.1. 添加图片

  1. 读取项目中图片文件
  2. 设置边距
  3. 设置宽高扩大缩小
Image indexImage = new Image(ImageDataFactory.create(GenoReportBuilder.class.getClassLoader().getResource("image/gene.png")));
indexImage.setMargins(-50, -60, -60, -60);
indexImage.scale(1, 1.05f);

1.4.2. 添加指定空白页

  1. 添加第2页为空白页,立即刷新后再继续添加
pdf.addNewPage(2).flush();

1.4.3. Div、Paragraph

    Div div = new Div();
div.setWidth(UnitValue.createPercentValue(100));
div.setHeight(UnitValue.createPercentValue(100));
div.setHorizontalAlignment(HorizontalAlignment.CENTER);
Paragraph p1 = new Paragraph();
p1.setHorizontalAlignment(HorizontalAlignment.CENTER);
p1.setMaxWidth(UnitValue.createPercentValue(75));
p1.setMarginTop(180f);
p1.setCharacterSpacing(0.4f);
Style large = new Style();
large.setFontSize(22);
large.setFontColor(GenoColor.getThemeColor());
p1.add(new Text("尊敬的 ").addStyle(large));
...
Paragraph p2 = new Paragraph();
...
div.add(p1);
div.add(p2);
  1. 整块的内容用Div包裹,这里整块包裹的好处是什么?一方面排版分明成体系,另一方面若需求是整块的内容必须在同一个版面,你可以对Div设置div.setKeepTogether(true);,尽量保证若整块的内容超出了一页,那这块内容会自动整块出现在下一页,上一页剩下的就留白了
  2. 可以看到DivParagraph可以设置很多属性,实际上我们常用的组件除了这两种,还有TableCellList,他们大部分的属性都是一样的,只是部分属性只在部分组件起效果,所以当你设置某个属性没起效果也不用奇怪
  3. Paragraph需要特别注意的一点,想要段落文字居中,不要用setHorizontalAlignment(HorizontalAlignment.CENTER);这是组件的居中对段落无效,甚至对段落里你放Text也无效,需要改用setTextAlignment(TextAlignment.CENTER);
  4. Paragraph段落的行距也是个高频问题,这里给出官方我看到的解释,参考https://itextpdf.com/en/resources/books/itext-7-building-blocks/chapter-4-adding-abstractelement-objects-part-1,搜关键字setFixedLeading,我的理解该方法设值行高绝对值,官方解释是两行文字中间基线之间的距离
  5. 如果想了解详细的什么属性哪里能起作用哪里不行,请访问该地址

1.4.4. Table

  1. useAllAvailableWidth表示页面有多宽,我就有多宽
  2. table.startNewRow();表示新起一行,table每画一行都要新起一行
  3. 同样table内容需要居中,和段落一样,请设置new Cell().setTextAlignment(TextAlignment.CENTER)
  4. 每个table中cell都有默认高度,会比实际输入字体高些,此时设置setHeight,若更大没有问题,若高度小于或接近字体大小文字可能就消失了,若想让Cell高度更接近文字高度,请设置Cellpadding,即cell.setPadding(-2),设置负值即可

1.4.5. Tab,\t

  1. itext7中如果要表示段落前的空格,不能使用\t,但换行可以使用\n

  2. 若要实现Tab效果可以有多个方法

    1. \u00a0符号,大概7、8个该符号可表示tab,可能不是很准确
    p1.add(new Text("\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0壹基因衷心祝愿您身体健康、享受品质生活!"));
    1. p1.setFirstLineIndent(24),表示段落前留多少空,需要知道一个字多大,设置成两倍就行
    2. Tab也是集成AbstractElement的组件,通过以下方式也可实现相同的效果
      p2.add(new Tab());
    p2.addTabStops(new TabStop(20, TabAlignment.LEFT));

1.4.6. 换页

我常用的换页方法为如下,该方法可保证立即换页

doc.add(new AreaBreak(AreaBreakType.NEXT_PAGE));

当然PdfDocumentaddNewPage其实也可以用,但有时候你没把握好刷新时间可能导致某些混乱

1.4.7. 画图或画文字

能画出多么复杂的图形看是谁画了,在我的PDF中,我画的最复杂的图形如下

该图形由多个弧形区域加线段加文字组成,包括数字上的小箭头也是画出来的,画这个的代码过多,想要了解详细的可以自行下载研究,这里介绍API功能

  1. lineTo画线段
  2. roundRectangle可用来画角是弧形的方形,也可以用来画圆
  3. showText用来画文字

以上几种结合填充即可把三角形,多边形画出来了

    PdfPage page = pdf.getPage(pdf.getNumberOfPages());
pageSize = pdf.getDefaultPageSize();
PdfCanvas pdfCanvas = new PdfCanvas(page); pdfCanvas.saveState().moveTo(pageSize.getWidth() / 2 - 100 + i * 40, yOffset - 203)
.lineTo(pageSize.getWidth() / 2 - 100 + i * 40, yOffset - 208)
.stroke().restoreState(); pdfCanvas.setLineWidth(2);
pdfCanvas.setStrokeColor(color);
pdfCanvas.roundRectangle(pageSize.getWidth() / 2 - 3 + posXOffset, yOffset - 188, 6, 6, 3)
.stroke(); pdfCanvas.beginText()
.setFontAndSize(font, 12)
.moveText(pageSize.getWidth() / 2 - text.length() * 12 / 2, yOffset - 45);
pdfCanvas.showText(text);
pdfCanvas.endText();

1.4.8. Html段落转Pdf段落

我们可能遇到把一段Html文本转换成itext7的段落放进来,此时需要用到它的htmlToPdf模块,该模块对应POM

    <!--itext7 html转pdf用到的包-->
<dependency>
<groupId>com.itextpdf</groupId>
<artifactId>html2pdf</artifactId>
<version>3.0.0</version>
</dependency>

至于使用,设置好配置属性,使用也很简单,通常我们需要支持中文,所有配置如下,字体可以自己换

    ConverterProperties proper = new ConverterProperties();
//字体设置,解决中文不显示问题
FontSet fontSet = new FontSet();
fontSet.addFont(GenoReportBuilder.class.getClassLoader().getResource("font/SourceHanSansCN-Regular.ttf").getPath(), PdfEncodings.IDENTITY_H); FontProvider fontProvider = new FontProvider(fontSet);
proper.setFontProvider(fontProvider); String content = "html内容";
List<IElement> elements = HtmlConverter.convertToElements(content, proper);

转换的内容是IElement集合,而IElement是什么呢?给张图就了解了

也就是说只要你的html内容是<div></div>包裹的,你直接把元素转成itext7的Div然后adddocument就可以实现html内容的添加了,当然你也可以用instanceof判断不同内容不同处理

如下是我的处理例子供参考,我把输入html内容样式进行了一定修改后转成itext7组件,这里特别提心,html转过来的itext7组件可能会不支持部分样式的修改,所以需要在html中进行css样式的添加,这里我就把字体和高度统一用css设值了

    Div overall = new Div();
java.util.List<IElement> iElements = getFixContent(value);
for (IElement iElement : iElements) {
Style style = new Style();
style.setFontSize(10);
style.setCharacterSpacing(0.7f);
if (iElement instanceof Div) {
Div div = (Div) iElement;
java.util.List<IElement> children = div.getChildren();
// 全部段落改成相同样式
this.addParagraphStyleCircle(style, children);
overall.add(div);
} else if (iElement instanceof Paragraph) {
Paragraph element = (Paragraph) iElement;
overall.add(element.addStyle(style));
}
}
doc.add(overall);
  • getFixContent
    private java.util.List<IElement> getFixContent(String content) {
if (content.startsWith("<div>")) {
content = content.replaceAll("<div>", "<div style='line-height:18pt;font-size:16px;'>");
} else {
content = "<div style='line-height:18pt;font-size:16px;'>" + content + "</div>";
}
return HtmlConverter.convertToElements(content, proper);
}
  • addParagraphStyleCircle
    private void addParagraphStyleCircle(Style style, java.util.List<IElement> children) {
for (IElement child : children) {
if (child instanceof Paragraph) {
Paragraph element = (Paragraph) child;
element.addStyle(style);
java.util.List<IElement> children1 = element.getChildren();
this.addParagraphStyleCircle(style, children1);
}
if (child instanceof Div) {
Div div = (Div) child;
java.util.List<IElement> children1 = div.getChildren();
this.addParagraphStyleCircle(style, children1);
}
if (child instanceof Text) {
Text text = (Text) child;
text.addStyle(style);
}
}
}

1.4.9. 监听事件

在编写pdf的时候,比如一篇整体的文章,我们需要在页眉位置添加关于这篇文章的固定文本或者图形,类似于打个标签,表示你翻了这么多页一直在看这篇文章,当第二篇文章的时候就换一个,举个例子

  • 第一页

  • 第二页

这种需求我们如何实现呢?思路分析发现,我们需要知道什么时候文章内容一页写不起了,换了一页的时候我们需要添加一个同样的页眉。这样我们就需要知道页是何时添加的,监听事件就是处理这种问题的

  • pdf是PdfDocument,可添加的事件有START_PAGEINSERT_PAGEREMOVE_PAGEEND_PAGE共四个,如上需求我们需要监听START_PAGE事件,在事件处理中做相应的处理,我在事件中使用PdfCanvas画了头部内容
HeaderTextEvent headerTextEvent = new HeaderTextEvent(title, font);
pdf.addEventHandler(PdfDocumentEvent.START_PAGE, headerTextEvent);
  • HeaderTextEvent类,Painting仅仅是封装了PdfCanvas
public class HeaderTextEvent implements IEventHandler {

    private String text;
private PdfFont font; public HeaderTextEvent(String text,PdfFont font) {
this.text = text;
this.font = font;
} @Override
public void handleEvent(Event event) {
PdfDocumentEvent docEvent = (PdfDocumentEvent) event;
PdfDocument pdfDoc = docEvent.getDocument();
Painting painting = new Painting(pdfDoc, font);
painting.drawHeader();
painting.drawHeaderText(text);
painting.close();
}
}

在添加内容前添加相应事件,同时需要记得在不需要的时候移除

// 移除监听器
pdf.removeEventHandler(PdfDocumentEvent.START_PAGE, headerTextEvent);

1.4.10. 添加目录

我没有找到itext7原生是否有目录添加,根据我自己的需求,我用Table组件来实现了自定义目录,由于我的PDF是用来打印的,所以我并没有给目录添加Link,也就是页面跳转,不过当你彻底理解了我的项目,我想这个需求实现也不难

  • 实现效果如下,随着内容的增长,目录自动增长

先说下遇到的困难,目录顾明思意,必须要有内容才会有目录,所以实际上目录是最后添加的,但如果我们添加内容到最后再跳转到前面的页面来添加目录,有三个问题:

  1. 目录有几页如何知道?
  2. 目录有几页不知道,如何知道内容在第几页?
  3. 由于目录不确定,所以后续内容的页码其实也是不确定的,也就是说页码也不是一页页可以添加过去的

而经过实践你会发现,我们不能够回到前几页去修改已存在的页面,因为会提示你已经flush了,不能修改。

这时我看到了movePage这个方法,也就是可以通过移动页面,把目录在内容之后生成,后再移动到前几页,但是页码还是不能修改,发现脑袋不够想了只能用上屁股,灵光一闪,不能一遍生成为什么不能二次渲染呢?于是研究读取原pdf在原pdf上修改,二次渲染的时候填上页码及移动页面,主要代码如下,包括了读取中间文件,移动目录,添加每页页码

PdfReader reader = null;
PdfWriter writer = null;
String inPath = getInPath();
try {
reader = new PdfReader(new File(inPath));
writer = new PdfWriter(new File(outPath));
} catch (IOException e) {
e.printStackTrace();
}
PdfDocument pdf = new PdfDocument(reader, writer);
Document doc = new Document(pdf);
int startPage = 7;
int numberOfPages = pdf.getNumberOfPages();
for (int i = 0; i < catalogSize; i++) {
pdf.movePage(numberOfPages, startPage);
}
String forbidPage = properties.getProperty("forbidPage");
for (int pageNumber = 1; pageNumber < numberOfPages + 1; pageNumber++) { if (pageNumber > 6 + catalogSize && pageNumber != 8 + catalogSize) {
if (forbidPage != null && (pageNumber - catalogSize) >= Integer.parseInt(forbidPage)) {
continue;
}
PageSize pageSize = pdf.getDefaultPageSize();
doc.showTextAligned(new Paragraph(String.format("- %d -", pageNumber)), pageSize.getWidth() / 2, 30, pageNumber, TextAlignment.CENTER, VerticalAlignment.MIDDLE, 0);
}
}

1.5. 总结

经过上述总结,我基本上把项目中的大多基本点和难点都概括进去了,初次用itext7写PDF的同学基本会遇到的问题基本都在上述这些,不理解的就把项目下下来运行Main方法慢慢调试,理解透我这个项目,还有其它问题那基本只能翻官网

项目Github: https://github.com/tzxylao/onegeno-itext-pdf

itext7官网:https://itextpdf.com/

itext7史上最全实战总结的更多相关文章

  1. Linux记录-史上最全的MySQL高性能优化实战总结(转载)

       史上最全的MySQL高性能优化实战总结! 1.1 前言 MySQL对于很多Linux从业者而言,是一个非常棘手的问题,多数情况都是因为对数据库出现问题的情况和处理思路不清晰.在进行MySQL的优 ...

  2. Vue2.0史上最全入坑教程(下)—— 实战案例

    书接上文 前言:经过前两节的学习,我们已经可以创建一个vue工程了.下面我们将一起来学习制作一个简单的实战案例. 说明:默认我们已经用vue-cli(vue脚手架或称前端自动化构建工具)创建好项目了 ...

  3. nacos 实战(史上最全)

    文章很长,而且持续更新,建议收藏起来,慢慢读! 高并发 发烧友社群:疯狂创客圈(总入口) 奉上以下珍贵的学习资源: 疯狂创客圈 经典图书 : 极致经典 + 社群大片好评 < Java 高并发 三 ...

  4. JVM 内存溢出 实战 (史上最全)

    文章很长,建议收藏起来,慢慢读! 疯狂创客圈为小伙伴奉上以下珍贵的学习资源: 疯狂创客圈 经典图书 : <Netty Zookeeper Redis 高并发实战> 面试必备 + 大厂必备 ...

  5. 吐血总结|史上最全的MySQL学习资料!!

    在日常工作与学习中,无论是开发.运维.还是测试,对于数据库的学习是不可避免的,同时也是日常工作的必备技术之一.在互联网公司,开源产品线比较多,互联网企业所用的数据库占比较重的还是MySQL. 在刚刚出 ...

  6. 了解iOS消息推送一文就够:史上最全iOS Push技术详解

    本文作者:陈裕发, 腾讯系统测试工程师,由腾讯WeTest整理发表. 1.引言 开发iOS系统中的Push推送,通常有以下3种情况: 1)在线Push:比如QQ.微信等IM界面处于前台时,聊天消息和指 ...

  7. 移动端IM开发者必读(二):史上最全移动弱网络优化方法总结

    1.前言 本文接上篇<移动端IM开发者必读(一):通俗易懂,理解移动网络的“弱”和“慢”>,关于移动网络的主要特性,在上篇中已进行过详细地阐述,本文将针对上篇中提到的特性,结合我们的实践经 ...

  8. Springcloud 配置 | 史上最全,一文全懂

    Springcloud 高并发 配置 (一文全懂) 疯狂创客圈 Java 高并发[ 亿级流量聊天室实战]实战系列之15 [博客园总入口 ] 前言 疯狂创客圈(笔者尼恩创建的高并发研习社群)Spring ...

  9. Feign Ribbon Hystrix 三者关系 | 史上最全, 深度解析

    史上最全: Feign Ribbon Hystrix 三者关系 | 深度解析 疯狂创客圈 Java 分布式聊天室[ 亿级流量]实战系列之 -25[ 博客园 总入口 ] 前言 疯狂创客圈(笔者尼恩创建的 ...

随机推荐

  1. Mahout聚类和kafaka相关知识

    1.说几种距离测度Mahout: 欧式距离测度:平方欧式距离测度:曼哈顿距离测度:余弦距离测度:加权距离测度 2.K-means算法参数:

  2. 近期总结的一些Java基础

    1.面向过程:当需要实现一个功能的时候,每一个过程中的详细步骤和细节都要亲力亲为. 2.面向对象:当需要实现一个功能的时候,不关心详细的步骤细节,而是找人帮我做事. 3.类和对象的关系:   a-类是 ...

  3. 图形学_Bezier曲线

    Bezier曲线由n个控制点生成,举个例子:当n=2时,点$P_0$.$P_1$之间遵从计算: $P_0=(1-t)P_0+tP_1$ 而推广为n维时,有: $P^n_0=(1-t)P^{n-1}_0 ...

  4. 【Hadoop离线基础总结】流量日志分析网站整体架构模块开发

    目录 数据仓库设计 维度建模概述 维度建模的三种模式 本项目中数据仓库的设计 ETL开发 创建ODS层数据表 导入ODS层数据 生成ODS层明细宽表 统计分析开发 流量分析 受访分析 访客visit分 ...

  5. docker redis shell

    docker中安装好redis后,运行 docker ps 指令,查看所有运行中的镜像信息 然后运行 docker inspect --format "{{ .State.Pid}}&quo ...

  6. leetcode-4. 寻找两个正序数组的中位数

    leetcode-4. 寻找两个正序数组的中位数. 给定两个大小为 m 和 n 的正序(从小到大)数组 nums1 和 nums2. 请你找出这两个正序数组的中位数,并且要求算法的时间复杂度为 O(l ...

  7. @Resource、@Autowired等几个注解的区别

    1.@Resource注解和@Autowired的区别 @Autowired注解:是按类型装配依赖对象,默认情况下它要求依赖对象必须存在,如果允许null值,可以设置它required属性为false ...

  8. linux磁盘已满,查看哪个文件占用多

    1.使用df -h查看磁盘空间占用情况 2.使用sudo du -s -h /* | sort -nr命令查看那个目录占用空间大 3.然后那个目录占用多 再通过sudo du -s -h /var/* ...

  9. 前端:参数传错了,spring-boot:那错误信息我给你显示的友好点儿

    之前两篇文章 Spring-boot自定义参数校验注解和如何在spring-boot中进行参数校验,我们介绍了,参数校验以及如何自定义参数校验注解,但是当传递参数出错时,只是把错误信息打印到了控制台, ...

  10. 适用于任何Html内容的jQuery Slider插件 - AnySlider

    任何Slider都是一个易于使用且支持触摸的jQuery插件,允许您为任何html内容创建可自定义的滑块,如图像,文本,视频等. 特征: 重量轻,易于使用 支持键盘导航 使用淡入淡出或幻灯片过渡以及自 ...