PDFBox/Itext5渲染生成pdf文档
目录
- PDFBox
- 最终效果
- 实现代码
- Itext5
- 最终效果
- 实现代码
PDFBox
使用PDFBox可以渲染生成pdf文档,并且自定义程度高,只是比较麻烦,pdf的内容位置都需要手动设置x(横向)和y(纵向)绝对位置,但是每个企业的单据都是不一样的,一般来说都会设置一个模板,然后内容再填充到适当位置,所以这个功能还是有用的
最终效果
填充数据后效果
实现代码
以下代码基于PDFBox依赖版本-2.0.23
public class Demo01 {public static void main(String[] args) throws Exception{// 设定中文字体File fontFile = new File("C:\\Windows\\Fonts\\simHei.ttf");try (PDDocument document = new PDDocument()) {PDType0Font load = PDType0Font.load(document, fontFile);PDPage page;for (int i = 0; i < 1; i++) {page = new PDPage();document.addPage(page);// 对具体PDPage设定内容try(PDPageContentStream contentStream = new PDPageContentStream(document, page)) {contentStream.setFont(load, 25);contentStream.beginText();// newLineAtOffset方法contentStream.newLineAtOffset(220, 750);contentStream.showText("借用出库打印单");contentStream.setFont(load, 12);contentStream.endText();// 仓库和会员渲染位置contentStream.beginText();contentStream.newLineAtOffset(80, 700); // 80,700contentStream.showText("仓库:");contentStream.newLineAtOffset(300, 0); //380,700contentStream.showText("会员:");contentStream.endText();// 销售员和操作人渲染位置contentStream.beginText();contentStream.newLineAtOffset(80, 675); // 80,675contentStream.showText("销售员:");contentStream.newLineAtOffset(300, 0); //380,675contentStream.showText("操作人:");contentStream.endText();// 操作时间位置contentStream.beginText();contentStream.newLineAtOffset(80, 650); // 80,650contentStream.showText("操作时间:");contentStream.endText();// ----------------实际内容-----------------------// 表头contentStream.beginText();contentStream.newLineAtOffset(80, 625); //80,625contentStream.showText("序号");contentStream.newLineAtOffset(40, 0); //120,625contentStream.showText("商品编号");contentStream.newLineAtOffset(80, 0); //200,625contentStream.showText("商品名称");contentStream.newLineAtOffset(70, 0); //270,625contentStream.showText("单位");contentStream.newLineAtOffset(40, 0); //310,625contentStream.showText("借出数量");contentStream.newLineAtOffset(70, 0); //380,625contentStream.showText("备注");contentStream.newLineAtOffset(100, 0); //480,625contentStream.showText("零售价");contentStream.endText();Map<String, String> contentMap = new HashMap<>();contentMap.put("序号", "1");contentMap.put("商品编号", "000212130023");contentMap.put("商品名称", "洗地机124123");contentMap.put("单位", "个");contentMap.put("借出数量", "13");contentMap.put("备注", "我是备注我是备注");contentMap.put("零售价", "1123300.34");fillContent(contentStream, contentMap, load);// 结尾结构渲染// 合计位置contentStream.beginText();contentStream.newLineAtOffset(80, 150); // 80,150contentStream.showText("合计");contentStream.endText();// 出库数量和总金额位置contentStream.beginText();contentStream.newLineAtOffset(110, 125); // 110,125contentStream.showText("出库数量:");contentStream.newLineAtOffset(270, 0); // 380,125contentStream.showText("总金额:");contentStream.endText();// 签名位置contentStream.beginText();contentStream.newLineAtOffset(80, 50); // 110,125contentStream.showText("签名:_______");contentStream.endText();// 模拟填充模板Map<String, String> map = new HashMap<>();map.put("仓库", "上海仓");map.put("会员", "小明");map.put("销售员", "销售员01");map.put("操作人", "系统管理员");map.put("操作时间", "2025年4月1日23点07分");map.put("出库数量", "1455");map.put("总金额", "285743835.45");fillTemplate(contentStream, map);}}document.save("demo01.pdf");System.out.println("PDF created successfully!");} catch (IOException e) {throw new RuntimeException(e);}}// 填充固定模板方法 该方法不填充中间详细内容public static void fillTemplate(PDPageContentStream contentStream, Map<String, String> map) {try {contentStream.beginText();contentStream.newLineAtOffset(130, 700);contentStream.showText(map.get("仓库"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(430, 700);contentStream.showText(map.get("会员"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(130, 675);contentStream.showText(map.get("销售员"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(430, 675);contentStream.showText(map.get("操作人"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(150, 650);contentStream.showText(map.get("操作时间"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(180, 125);contentStream.showText(map.get("出库数量"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(430, 125);contentStream.showText(map.get("总金额"));contentStream.endText();} catch (IOException e) {throw new RuntimeException(e);}}public static void fillContent(PDPageContentStream contentStream, Map<String, String> map, PDType0Font font) {try {contentStream.setFont(font, 10);contentStream.beginText();contentStream.newLineAtOffset(80, 600);contentStream.showText(map.get("序号"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(120, 600);contentStream.showText(map.get("商品编号"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(200, 600);contentStream.showText(map.get("商品名称"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(270, 600);contentStream.showText(map.get("单位"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(310, 600);contentStream.showText(map.get("借出数量"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(380, 600);contentStream.showText(map.get("备注"));contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(480, 600);contentStream.showText(map.get("零售价"));contentStream.endText();contentStream.setFont(font, 12);} catch (IOException e) {throw new RuntimeException(e);}}
}
上述代码看着确实是挺繁琐,每个内容的位置都需要设置x和y值,但是没办法
PDF文件本质是「坐标画布」:
- PDF的渲染模型基于绝对坐标系(原点在页面左下角),所有元素(文字、图形)必须明确指定位置(x,y)。
- 无布局引擎:PDF规范未定义“自动换行”或“文档流”等高级排版概念,开发者需自行计算坐标。
但是这样设计的好处就是自定义程度高,你可以任意设计一个PDF文档的模板应该是什么样子,内容该如何填充全部由你自由设定,就像低代码平台一样,市面上成熟开源的低代码平台有许多,但是逻辑都是一开始就定好的,如果你想加上许多符合自己公司需求的功能但是平台没有那么都得自行开发,并且自行开发的代码融合进已有的系统不是一件容易的事情,甚至比自行开发一套系统都麻烦。
所以如果你有这样的需求可以看下上述代码实现,上述代码只是一个简单的demo,我只是进行记录方便自己以后用到。
tips:关于一些方法的解释
contentStream.beginText();contentStream.newLineAtOffset(80, 700); // 80,700 --绝对定位contentStream.showText("仓库:");contentStream.newLineAtOffset(300, 0); //380,700 --相对定位(以'仓库:'的位置为准)contentStream.showText("会员:");contentStream.endText();contentStream.beginText();contentStream.newLineAtOffset(80, 675); // 80,675 --绝对定位contentStream.showText("销售员:");contentStream.newLineAtOffset(300, 0); //380,675 --相对定位(以'销售员'的位置为准)contentStream.showText("操作人:");contentStream.endText();
上述代码可以看到在渲染内容时是被包裹在beginText()和endText()方法中间的,这样当你调用newLineAtOffset(x, y)方法时参数中的x和y才从坐标系的绝对位置(绝对位置为画布的左下角0,0)进行定位。如果你在定位时没有重新开启beginText()和endText()时,调用newLineAtOffset(x, y)方法则是参照上一个文本的位置进行相对定位的,相对定位对于需要在同一行的不同位置渲染内容会比较方便。
newLineAtOffset(x, y)方法的官方注释有问题,官方说法是移动到下一行的开头,从当前行的开头进行偏移 (x, y),实测不对,并不会移动到下一行的开头,并且在相对定位时参考的位置也是你上一次的位置的起始点。
如果你需要像写文章那样一段一段的文字进行渲染,那么可以考虑使用另外一个方法
contentStream.beginText();contentStream.newLineAtOffset(80, 500); // 设定绝对位置的起点contentStream.setLeading(20); // 文本行距contentStream.showText("XXXXX"); //渲染内容contentStream.newLine(); //开启新行contentStream.showText("XXXXX"); //渲染内容contentStream.newLine(); //开启新行contentStream.showText("XXXXX"); //渲染内容contentStream.newLine(); //开启新行contentStream.endText();
这个方法更适合大段连贯的文字渲染,你只要设定好固定行距之后就可以直接开启新行,新行的位置会成功进入到下一行的开头并且行距就是你设定的值,这样你就不用每次都自行定位了,效果如下
Itext5
Itext感觉绘制pdf文档确实要比pdfBox强大一些,绘制表格啥的pdfBox都需要自行画线,Itext可以直接生成并填充数据,这方面来说就省下很多功夫了,下面直接贴效果和代码了
最终效果
实现代码
依赖
<dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId><version>3.10</version></dependency><!-- https://mvnrepository.com/artifact/com.itextpdf/itextpdf --><dependency><groupId>com.itextpdf</groupId><artifactId>itextpdf</artifactId><version>5.5.13.3</version></dependency>
public class ItextDemo {public static void main(String[] args) throws Exception {// 输出PDF文件String outputPath = "demo02.pdf";// 创建文档Document document = new Document();try {PdfWriter writer = PdfWriter.getInstance(document, Files.newOutputStream(Paths.get(outputPath)));document.open();// 设置中文字体// 以输入流的形式获取字体,这种方式对于jar包中的字体读取非常有用,路径是无法达到jar包中的字体文件的File file = new File("C:\\Windows\\Fonts\\simHei.ttf");InputStream inputStream = Files.newInputStream(file.toPath());BaseFont bfChinese = BaseFont.createFont("simHei.ttf", BaseFont.IDENTITY_H,BaseFont.EMBEDDED, false, IOUtils.toByteArray(inputStream), null);// 直接使用路径获取
// BaseFont bfChinese = BaseFont.createFont("C:\\Windows\\Fonts\\simHei.ttf", BaseFont.IDENTITY_H, BaseFont.EMBEDDED);// 添加标题Paragraph title = new Paragraph("我是标题1", new Font(bfChinese, 30, Font.BOLD));title.setAlignment(Element.ALIGN_CENTER);document.add(title);PdfContentByte canvas;canvas = writer.getDirectContent();canvas.setFontAndSize(bfChinese, 18);canvas.beginText();// 上方模板canvas.setTextMatrix(20, 700);// 绝对位置canvas.showText("我是内容");canvas.moveText(140, 0); // 相对位置canvas.showText("我是第二个内容");List<Map<String, String>> sampleData = IText5TableMultiRowExample.getSampleData();fillContent(sampleData, bfChinese, canvas);// 下方模板canvas.setTextMatrix(20, 200);canvas.showText("合计");canvas.endText();// 模拟手动分页 (一般实际使用循环完成)document.newPage();// 标题Paragraph title2 = new Paragraph("我是标题2", new Font(bfChinese, 30, Font.BOLD));title2.setAlignment(Element.ALIGN_CENTER);document.add(title2);canvas.setFontAndSize(bfChinese, 10);canvas.beginText();// 上方模板canvas.setTextMatrix(20, 700);canvas.showText("我是内容");canvas.moveText(40, 0);canvas.showText("我是第二个内容");fillContent(sampleData, bfChinese, canvas);// 下方模板canvas.setTextMatrix(20, 200);canvas.showText("合计");canvas.endText();} catch (Exception e) {e.printStackTrace();} finally {document.close();}}public static void fillContent(List<Map<String, String>> dataList, BaseFont bfChinese, PdfContentByte canvas) throws DocumentException {// 创建表格(7列)PdfPTable table = new PdfPTable(7);table.setTotalWidth(500);table.setLockedWidth(true);// 设置列宽(相对宽度)float[] columnWidths = {0.5f, 2f, 3f, 1f, 1f, 1.5f, 3f}; // 根据需要调整table.setWidths(columnWidths);// 设置表头String[] headers = {"序号", "商品编号", "商品名称", "单位", "借出数量", "零售价", "备注"};for (String header : headers) {PdfPCell cell = new PdfPCell(new Phrase(header, new Font(bfChinese, 14, Font.BOLD)));cell.setHorizontalAlignment(Element.ALIGN_CENTER); // 表头居中cell.setPadding(5f); // 内边距table.addCell(cell);}// 填充表格内容for (Map<String, String> map : dataList) {table.addCell(new Phrase(map.get("序号"), new Font(bfChinese, 12)));table.addCell(new Phrase(map.get("商品编号"), new Font(bfChinese, 12)));table.addCell(new Phrase(map.get("商品名称"), new Font(bfChinese, 12)));table.addCell(new Phrase(map.get("单位"), new Font(bfChinese, 12)));table.addCell(new Phrase(map.get("借出数量"), new Font(bfChinese, 12)));table.addCell(new Phrase(map.get("零售价"), new Font(bfChinese, 12)));
// table.addCell(new Phrase(map.get("备注"), new Font(bfChinese, 12)));// 备注字段支持自动换行 通过setPadding设置内边距,增加单元格内容与边框之间的距离,从而间接影响单元格的视觉高度。PdfPCell remarkCell = new PdfPCell(new Phrase(map.get("备注"), new Font(bfChinese, 12)));remarkCell.setPadding(5f);table.addCell(remarkCell);}// 将表格添加到文档table.writeSelectedRows(0, -1, 40, 600, canvas);}
}
PDFBox/Itext5可以各取所需