Java生成PDF报表

素颜马尾好姑娘i 2022-08-20 15:17 190阅读 0赞

一、前言

前几天，做ASN条码收货模块，需要实现打印下载收货报表，经一番查找，选定iText--用于生成PDF文档的一个Java类库。废话不多说，进入正题。

二、iText简介

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

iText的安装非常方便，在[http://itextpdf.com/][http_itextpdf.com] 网站上下载iText.jar文件后，只需要在系统的CLASSPATH中加入iText.jar的路径，在程序中就可以使用iText类库了。

三、建立第一个PDF文档

用iText生成PDF文档需要5个步骤：

①建立com.lowagie.text.Document对象的实例。  
　　Document document = new Document();

②建立一个书写器(Writer)与document对象关联，通过书写器(Writer)可以将文档写入到磁盘中。  
　　PDFWriter.getInstance(document, new FileOutputStream("Helloworld.PDF"));

③打开文档。  
　　document.open();

④向文档中添加内容。  
　　document.add(new Paragraph("Hello World"));

⑤关闭文档。  
　　document.close();

通过上面的5个步骤，就能产生一个Helloworld.PDF的文件，文件内容为"Hello World"。

建立com.lowagie.text.Document对象的实例

com.lowagie.text.Document对象的构建函数有三个，分别是：  
　　public Document();  
　　public Document(Rectangle pageSize);  
　　public Document(Rectangle pageSize,  
　　int marginLeft,  
　　int marginRight,  
　　int marginTop,  
　　int marginBottom);

构建函数的参数pageSize是文档页面的大小，对于第一个构建函数，页面的大小为A4，同Document(PageSize.A4)的效果一样；对于第三个构建函数，参数marginLeft、marginRight、marginTop、marginBottom分别为左、右、上、下的页边距。

通过参数pageSize可以设定页面大小、面背景色、以及页面横向/纵向等属性。iText定义了A0-A10、AL、LETTER、HALFLETTER、\_11x17、LEDGER、NOTE、B0-B5、ARCH\_A-ARCH\_E、FLSA 和FLSE等纸张类型，也可以通过Rectangle pageSize = new Rectangle(144, 720);自定义纸张。通过Rectangle方法rotate()可以将页面设置成横向。

书写器（Writer）对象

一旦文档(document)对象建立好之后，需要建立一个或多个书写器(Writer)对象与之关联。通过书写器(Writer)对象可以将具体文档存盘成需要的格式，如com.lowagie.text.PDF.PDFWriter可以将文档存成PDF文件，com.lowagie.text.html.HtmlWriter可以将文档存成html文件。

设定文档属性

在文档打开之前，可以设定文档的标题、主题、作者、关键字、装订方式、创建者、生产者、创建日期等属性，调用的方法分别是：  
　　public boolean addTitle(String title)  
　　public boolean addSubject(String subject)  
　　public boolean addKeywords(String keywords)  
　　public boolean addAuthor(String author)  
　　public boolean addCreator(String creator)  
　　public boolean addProducer()  
　　public boolean addCreationDate()  
　　public boolean addHeader(String name, String content)

其中方法addHeader对于PDF文档无效，addHeader仅对html文档有效，用于添加文档的头信息。  
当新的页面产生之前，可以设定页面的大小、书签、脚注（HeaderFooter）等信息，调用的方法是：  
　　public boolean setPageSize(Rectangle pageSize)  
　　public boolean add(Watermark watermark)  
　　public void removeWatermark()  
　　public void setHeader(HeaderFooter header)  
　　public void resetHeader()  
　　public void setFooter(HeaderFooter footer)  
　　public void resetFooter()  
　　public void resetPageCount()  
　　public void setPageCount(int pageN)

如果要设定第一页的页面属性，这些方法必须在文档打开之前调用。

对于PDF文档，iText还提供了文档的显示属性，通过调用书写器的setViewerPreferences方法可以控制文档打开时Acrobat Reader的显示属性，如是否单页显示、是否全屏显示、是否隐藏状态条等属性。

另外，iText也提供了对PDF文件的安全保护，通过书写器（Writer）的setEncryption方法，可以设定文档的用户口令、只读、可打印等属性。

添加文档内容

所有向文档添加的内容都是以对象为单位的，如Phrase、Paragraph、Table、Graphic对象等。比较常用的是段落(Paragraph)对象，用于向文档中添加一段文字。  
四、文本处理

iText中用文本块(Chunk)、短语(Phrase)和段落(paragraph)处理文本。  
文本块(Chunk)是处理文本的最小单位，有一串带格式（包括字体、颜色、大小）的字符串组成。如以下代码就是产生一个字体为HELVETICA、大小为10、带下划线的字符串：  
Chunk chunk1 = new Chunk("This text is underlined", FontFactory.getFont(FontFactory.HELVETICA, 12, Font.UNDERLINE));

短语(Phrase)由一个或多个文本块(Chunk)组成，短语(Phrase)也可以设定字体，但对于其中以设定过字体的文本块(Chunk)无效。通过短语(Phrase)成员函数add可以将一个文本块(Chunk)加到短语(Phrase)中，如：phrase6.add(chunk);

段落(paragraph)由一个或多个文本块(Chunk)或短语(Phrase)组成，相当于WORD文档中的段落概念，同样可以设定段落的字体大小、颜色等属性。另外也可以设定段落的首行缩进、对齐方式（左对齐、右对齐、居中对齐）。通过函数setAlignment可以设定段落的对齐方式，setAlignment的参数1为居中对齐、2为右对齐、3为左对齐，默认为左对齐。

五、表格处理

iText中处理表格的类为：com.lowagie.text.Table和com.lowagie.text.PDF.PDFPTable，对于比较简单的表格处理可以用com.lowagie.text.Table，但是如果要处理复杂的表格，这就需要com.lowagie.text.PDF.PDFPTable进行处理。这里就类com.lowagie.text.Table进行说明。

类com.lowagie.text.Table的构造函数有三个：

①Table (int columns)  
　　②Table(int columns, int rows)  
　　③Table(Properties attributes)

参数columns、rows、attributes分别为表格的列数、行数、表格属性。创建表格时必须指定表格的列数，而对于行数可以不用指定。

建立表格之后，可以设定表格的属性，如：边框宽度、边框颜色、衬距（padding space 即单元格之间的间距）大小等属性。下面通过一个简单的例子说明如何使用表格，代码如下：

![复制代码][copycode.gif]

1 Table table = new Table(3);
     2 table.setBorderWidth(1);
     3 table.setBorderColor(new Color(0, 0, 255));
     4 table.setPadding(5);
     5 table.setSpacing(5);
     6 Cell cell = new Cell("header");
     7 cell.setHeader(true);
     8 cell.setColspan(3);
     9 table.addCell(cell);
    10 table.endHeaders();
    11 cell = new Cell("example cell with colspan 1 and rowspan 2");
    12 cell.setRowspan(2);
    13 cell.setBorderColor(new Color(255, 0, 0));
    14 table.addCell(cell);
    15 table.addCell("1.1");
    16 table.addCell("2.1");
    17 table.addCell("1.2");
    18 table.addCell("2.2");
    19 table.addCell("cell test1");
    20 cell = new Cell("big cell");
    21 cell.setRowspan(2);
    22 cell.setColspan(2);
    23 table.addCell(cell);
    24 table.addCell("cell test2");

![复制代码][copycode.gif]

运行结果如下：  
　　header cell test2

代码1-5行用于新建一个表格，如代码所示，建立了一个列数为3的表格，并将边框宽度设为1，颜色为蓝色，衬距为5。

代码6-10行用于设定表格的表头，第7行cell.setHeader(true);是将该单元格作为表头信息显示；第8行cell.setColspan(3);指定了该单元格占3列；为表格添加表头信息时，要注意的是一旦表头信息添加完了之后，必须调用endHeaders()方法，如第10行，否则当表格跨页后，表头信息不会再显示。

代码11-14行是向表格中添加一个宽度占一列，长度占二行的单元格。

往表格中添加单元格(cell)时，按自左向右、从上而下的次序添加。如执行完11行代码后，表格的右下方出现2行2列的空白，这是再往表格添加单元格时，先填满这个空白，然后再另起一行，15-24行代码说明了这种添加顺序。

六、图像处理

iText中处理表格的类为com.lowagie.text.Image，目前iText支持的图像格式有：GIF, Jpeg, PNG, wmf等格式，对于不同的图像格式，iText用同样的构造函数自动识别图像格式。通过下面的代码分别获得gif、jpg、png图像的实例。  
　　Image gif = Image.getInstance("vonnegut.gif");  
　　Image jpeg = Image.getInstance("myKids.jpg");  
　　Image png = Image.getInstance("hitchcock.png");

图像的位置

图像的位置主要是指图像在文档中的对齐方式、图像和文本的位置关系。IText中通过函数public void setAlignment(int alignment)进行处理，参数alignment为Image.RIGHT、Image.MIDDLE、Image.LEFT分别指右对齐、居中、左对齐；当参数alignment为Image.TEXTWRAP、Image.UNDERLYING分别指文字绕图形显示、图形作为文字的背景显示。这两种参数可以结合以达到预期的效果，如setAlignment(Image.RIGHT|Image.TEXTWRAP)显示的效果为图像右对齐，文字围绕图像显示。

图像的尺寸和旋转

如果图像在文档中不按原尺寸显示，可以通过下面的函数进行设定：  
　　public void scaleAbsolute(int newWidth, int newHeight)  
　　public void scalePercent(int percent)  
　　public void scalePercent(int percentX, int percentY)

函数public void scaleAbsolute(int newWidth, int newHeight)直接设定显示尺寸；函数public void scalePercent(int percent)设定显示比例，如scalePercent(50)表示显示的大小为原尺寸的50%；而函数scalePercent(int percentX, int percentY)则图像高宽的显示比例。

如果图像需要旋转一定角度之后在文档中显示，可以通过函数public void setRotation(double r)设定，参数r为弧度，如果旋转角度为30度，则参数r= Math.PI / 6。

七、中文处理

默认的iText字体设置不支持中文字体，需要下载远东字体包iTextAsian.jar，否则不能往PDF文档中输出中文字体。通过下面的代码就可以在文档中使用中文了：  
　　BaseFont bfChinese = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT\_EMBEDDED);  
　　com.lowagie.text.Font FontChinese = new com.lowagie.text.Font(bfChinese, 12, com.lowagie.text.Font.NORMAL);  
　　Paragraph pragraph=new Paragraph("你好", FontChinese);

八、分页处理

如果只是简单的显示当前页码，使用以下代码即可（设定了页面的大小后，会自动分页）。

1 HeaderFooter footer = new HeaderFooter(new Phrase("页码：",keyfont), true);  
    2 footer.setBorder(Rectangle.NO_BORDER);  
    3 document.setHeader(footer);

如果要显示当前页码以及总页码。

则需要计算总页数，设定每页大小，使用pdf.newPage( )手动分页。

详见一下代码：

![复制代码][copycode.gif]

1 package com.foster;
      2 
      3 import java.io.File;
      4 import java.io.FileOutputStream;
      5 import java.util.ArrayList;
      6 import java.util.List;
      7 
      8 import com.lowagie.text.Cell;
      9 import com.lowagie.text.Document;
     10 import com.lowagie.text.DocumentException;
     11 import com.lowagie.text.Font;
     12 import com.lowagie.text.HeaderFooter;
     13 import com.lowagie.text.Image;
     14 import com.lowagie.text.Paragraph;
     15 import com.lowagie.text.Table;
     16 import com.lowagie.text.pdf.BaseFont;
     17 import com.lowagie.text.pdf.PdfPCell;
     18 import com.lowagie.text.pdf.PdfWriter;
     19 
     20 public class PDFReport {
     21 
     22     
     23     public static void main(String[] args) throws Exception, DocumentException {
     24         
     25         List<String> ponum=new ArrayList<String>();
     26         add(ponum, 26);
     27         List<String> line=new ArrayList<String>();
     28         add(line, 26);
     29         List<String> part=new ArrayList<String>();
     30         add(part, 26);
     31         List<String> description=new ArrayList<String>();
     32         add(description, 26);
     33         List<String> origin=new ArrayList<String>();
     34         add(origin, 26);
     35         
     36         //Create Document Instance
     37         Document document=new Document();
     38         
     39         //add Chinese font
     40         BaseFont bfChinese=BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
     41         
     42         //Font headfont=new Font(bfChinese,10,Font.BOLD);
     43         Font keyfont=new Font(bfChinese,8,Font.BOLD);
     44         Font textfont=new Font(bfChinese,8,Font.NORMAL);
     45         
     46         //Create Writer associated with document
     47         PdfWriter.getInstance(document, new FileOutputStream(new File("D:\\POReceiveReport.pdf")));
     48         
     49         document.open();
     50         
     51         //Seperate Page controller
     52         int recordPerPage=10;
     53         int fullPageRequired=ponum.size()/recordPerPage;
     54         int remainPage=ponum.size()%recordPerPage>1?1:0;
     55         int totalPage=fullPageRequired+remainPage;
     56         
     57         for(int j=0;j<totalPage;j++){
     58             document.newPage();
     59             
     60             //create page number
     61             String pageNo=leftPad("页码: "+(j+1)+" / "+totalPage,615);
     62             Paragraph pageNumber=new Paragraph(pageNo, keyfont) ;
     63             document.add(pageNumber);
     64             
     65             //create title image
     66             Image jpeg=Image.getInstance("D:\\title.JPG");
     67             jpeg.setAlignment(Image.ALIGN_CENTER);
     68             jpeg.scaleAbsolute(530, 37);
     69             document.add(jpeg);
     70             
     71             //header information
     72             Table tHeader=new Table(2);
     73             float[] widthsHeader={2f,3f};
     74             tHeader.setWidths(widthsHeader);
     75             tHeader.setWidth(100);
     76             tHeader.getDefaultCell().setBorder(PdfPCell.NO_BORDER);
     77             
     78             
     79             String compAdd="河源市高新技术开发区兴业大道中66号";
     80             String company="丰达音响（河源）有限公司";
     81             String vendor="V006";
     82             String vendorName="中山市卢氏五金有限公司";
     83             String ccn="FHH";
     84             String mas_loc="FHH";
     85             String delivery_note="20130718001";
     86             String receive_date="20130718";
     87             String dept="H11";
     88             String asn="0123456789";
     89             
     90             
     91             Cell c1Header=new Cell(new Paragraph("地址："+compAdd,keyfont));
     92             tHeader.addCell(c1Header);
     93             c1Header=new Cell(new Paragraph("供应商："+vendor,keyfont));
     94             tHeader.addCell(c1Header);
     95             c1Header=new Cell(new Paragraph("公司："+company,keyfont));
     96             tHeader.addCell(c1Header);
     97             c1Header=new Cell(new Paragraph("供应商工厂："+vendorName,keyfont));
     98             tHeader.addCell(c1Header);
     99             c1Header = new Cell(new Paragraph("CCN:   "+ccn+"    Master Loc:   "+mas_loc,keyfont));
    100             tHeader.addCell(c1Header);
    101             c1Header = new Cell(new Paragraph("送货编号: "+delivery_note+"                             送货日期: "+receive_date,keyfont));
    102             tHeader.addCell(c1Header);
    103             c1Header=new Cell(new Paragraph("Dept："+dept,keyfont));
    104             tHeader.addCell(c1Header);
    105             c1Header=new Cell(new Paragraph("ASN#："+asn,keyfont));
    106             tHeader.addCell(c1Header);
    107             document.add(tHeader);
    108             
    109             //record header field
    110             Table t=new Table(5);
    111             float[] widths={1.5f,1f,1f,1.5f,1f};
    112             t.setWidths(widths);
    113             t.setWidth(100);
    114             t.getDefaultCell().setBorder(PdfPCell.NO_BORDER);
    115             Cell c1 = new Cell(new Paragraph("PO#",keyfont));
    116             t.addCell(c1);
    117             c1 = new Cell(new Paragraph("Line",keyfont));
    118             t.addCell(c1);
    119             c1 = new Cell(new Paragraph("Part#",keyfont));
    120             t.addCell(c1);
    121             c1 = new Cell(new Paragraph("Description",keyfont));
    122             t.addCell(c1); 
    123             c1 = new Cell(new Paragraph("Origin",keyfont));
    124             t.addCell(c1); 
    125             
    126             //calculate the real records within a page ,to calculate the last record number of every page
    127             int maxRecordInPage= j+1 ==totalPage ? (remainPage==0?recordPerPage:(ponum.size()%recordPerPage)):recordPerPage;
    128             
    129             for(int i=j*recordPerPage;i<((j*recordPerPage)+maxRecordInPage);i++){
    130                 Cell c2=new Cell(new Paragraph(ponum.get(i), textfont));
    131                 t.addCell(c2);
    132                 c2=new Cell(new Paragraph(line.get(i), textfont));
    133                 t.addCell(c2);
    134                 c2=new Cell(new Paragraph(part.get(i), textfont));
    135                 t.addCell(c2);
    136                 c2=new Cell(new Paragraph(description.get(i), textfont));
    137                 t.addCell(c2);
    138                 c2=new Cell(new Paragraph(origin.get(i), textfont));
    139                 t.addCell(c2);
    140             }
    141             document.add(t);
    142             
    143             if(j+1==totalPage){
    144 
    145                 Paragraph foot11 = new Paragraph("文件只作  Foster 收貨用"+printBlank(150)+"__________________________",keyfont);
    146                 document.add(foot11);
    147                 Paragraph foot12 = new Paragraph("Printed from Foster supplier portal"+printBlank(134)+company+printBlank(40)+"版本: 1.0",keyfont);
    148                 document.add(foot12);
    149                 HeaderFooter footer11=new HeaderFooter(foot11, true);
    150                 footer11.setAlignment(HeaderFooter.ALIGN_BOTTOM);
    151                 HeaderFooter footer12=new HeaderFooter(foot12, true);
    152                 footer12.setAlignment(HeaderFooter.ALIGN_BOTTOM);
    153             }
    154         }
    155         document.close();
    156     }
    157     
    158     public static String leftPad(String str, int i) {
    159         int addSpaceNo = i-str.length();
    160         String space = ""; 
    161         for (int k=0; k<addSpaceNo; k++){
    162                 space= " "+space;
    163         };
    164         String result =space + str ;
    165         return result;
    166      }
    167     
    168     public static void add(List<String> list,int num){
    169         for(int i=0;i<num;i++){
    170             list.add("test"+i);
    171         }
    172     }
    173     
    174     public static String printBlank(int tmp){
    175           String space="";
    176           for(int m=0;m<tmp;m++){
    177               space=space+" ";
    178           }
    179           return space;
    180     }
    181 
    182 }

![复制代码][copycode.gif]

为了使副标题严格对齐，使用了表格table进行控制，但是却没能找到去掉表格边框的方法..........郁闷.......

九、总结

总的来说，iText是一套java环境下不错的制作PDF的组件。因为iText支持jsp/javabean下的开发，这使得B/S应用中的报表问题能得到很好的解决。由于iText毕竟不是专门为制作报表设计，所有报表中的内容、格式都需要通过写代码实现，相对于那些专业的支持可视化设计的报表软件来说，编程的工作量就有一定程度的增加。

[http_itextpdf.com]: http://itextpdf.com/
[copycode.gif]: /images/20220731/6c5af8ae6c3947dfbb6dd399e82559d6.png