iText之PDF添加页码

发表于2021-08-27更新于2021-09-06字数统计489阅读时长4分

重写事件

由于我的这个项目是基于ruoyi框架实现，因此我在RuoYi-Vue/ruoyi-common/src/main/java/com/ruoyi/common/utils/pdf目录下新建PdfPageXofYEventHelper.java，并添加代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
package com.ruoyi.common.utils.pdf;

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.ExceptionConverter;
import com.itextpdf.text.pdf.*;

import java.io.IOException;

public class PdfPageXofYEventHelper extends PdfPageEventHelper {
    public PdfTemplate total;

    public BaseFont baseFont;

    /**
     * 重写PdfPageEventHelper中的onOpenDocument方法
     */
    @Override
    public void onOpenDocument(PdfWriter writer, Document document) {
        // 得到文档的内容并为该内容新建一个模板
        total = writer.getDirectContent().createTemplate(500, 500);
        try {
            baseFont = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
        } catch (Exception e) {
            throw new ExceptionConverter(e);
        }
    }

    /**
     * 重写PdfPageEventHelper中的onEndPage方法
     */
    @Override
    public void onEndPage(PdfWriter writer, Document document) {
        // 新建获得用户页面文本和图片内容位置的对象
        PdfContentByte pdfContentByte = writer.getDirectContent();
        // 保存图形状态
        pdfContentByte.saveState();
        String text = "第 " + writer.getPageNumber() + " 页, 共 ";
        // 获取点字符串的宽度
        float textSize = baseFont.getWidthPoint(text, 9);
        pdfContentByte.beginText();
        // 设置随后的文本内容写作的字体和字号
        pdfContentByte.setFontAndSize(baseFont, 9);

        // 定位'X/'
        float x = (float) ((document.right() + document.left()) / 2.2);
//        float x = document.right();
        float y = 20f;
        pdfContentByte.setTextMatrix(x, y);
        pdfContentByte.showText(text + "   页");
        pdfContentByte.endText();

        // 将模板加入到内容（content）中- // 定位'Y'
        pdfContentByte.addTemplate(total, x + textSize, y);

        pdfContentByte.restoreState();
    }

    /**
     * 重写PdfPageEventHelper中的onCloseDocument方法
     */
    @Override
    public void onCloseDocument(PdfWriter writer, Document document) {
        total.beginText();
        try {
            baseFont = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
            total.setFontAndSize(baseFont, 9);
        } catch (DocumentException | IOException e) {
            e.printStackTrace();
        }
        total.setTextMatrix(0, 0);
        // 设置总页数的值到模板上，并应用到每个界面
        total.showText(String.valueOf(writer.getPageNumber()));
        total.endText();
    }
}

代码中调用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 1.新建document对象
document = new Document(PageSize.A4);
// 2.建立一个书写器(Writer)与document对象关联，通过书写器(Writer)可以将文档写入到磁盘中。
writer = PdfWriter.getInstance(document, os);

//--------------------------页码添加---------------------------
// 设置页面布局
writer.setViewerPreferences(PdfWriter.PageLayoutOneColumn);
// 为这篇文档设置页面事件(X/Y)
writer.setPageEvent(new PdfPageXofYEventHelper());
//--------------------------页码添加---------------------------

// 3.打开文档
document.open();

效果

XOfY