[关闭]
@HUST-SuWB 2016-01-21T09:16:28.000000Z 字数 6303 阅读 719

基于iText的PDF导出功能的实现

项目实战

背景

由于项目开发中的一个导出的需求，去调研了下对于大量文字、图片和表格的数据，怎样最简单的导出成PDF文件。经过短暂的调研，很快就确定下了使用iText。原因也很简单，iText的官网做得很好，相关的资料也很多，实在不行，还有本《iText in action》的书。挂一下这本书的PDF版本，大家有钱还是去支持正版图书吧。
其实，把官网上的例子看完了基本上常见的需求都能解决了。我简单的列了一下，我需要的功能大概包括：段落文本的添加、表格的绘制、图片的绘制、简单的排版、中文字符的显示等。实际的开发下来，感觉对于图表的某些操作算是费了点时间，这个就大家自己去感受了。

代码清单

  1. package tool;
  3. import java.io.FileOutputStream;
  4. import java.io.IOException;
  5. import java.net.MalformedURLException;
  6. import java.text.SimpleDateFormat;
  7. import java.util.ArrayList;
  8. import java.util.Date;
  9. import java.util.List;
  11. import com.itextpdf.text.BaseColor;
  12. import com.itextpdf.text.Document;
  13. import com.itextpdf.text.DocumentException;
  14. import com.itextpdf.text.Element;
  15. import com.itextpdf.text.Font;
  16. import com.itextpdf.text.FontFactory;
  17. import com.itextpdf.text.Image;
  18. import com.itextpdf.text.PageSize;
  19. import com.itextpdf.text.Paragraph;
  20. import com.itextpdf.text.Phrase;
  21. import com.itextpdf.text.pdf.BaseFont;
  22. import com.itextpdf.text.pdf.ColumnText;
  23. import com.itextpdf.text.pdf.PdfContentByte;
  24. import com.itextpdf.text.pdf.PdfPCell;
  25. import com.itextpdf.text.pdf.PdfPTable;
  26. import com.itextpdf.text.pdf.PdfTemplate;
  27. import com.itextpdf.text.pdf.PdfWriter;
  29. /**
  30.  * pdf操作类
  31.  * @author suwb
  32.  * @since 2016-01-20
  33.  *
  34.  */
  35. public class PDFTool {
  37.     private Font font;
  38.     private BaseFont bfChinese;
  39.     private Document doc;
  40.     private static final String RESULT = "src/source/pdf/";
  41.     private static final float TABLEPERCENT = 97;
  43.     public PDFTool() throws Exception {
  44.         // 设置中文字体
  45.         bfChinese = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED);
  46.         font = new Font(bfChinese);
  47.         font.setSize(15);
  48.         font.setStyle(FontFactory.HELVETICA);
  49. //      font.setStyle(Font.BOLD);//加粗
  50.         font.setColor(new BaseColor(0,0,0));
  51.     }
  53.     public void helloWorld() throws DocumentException, IOException {
  54.         doc = new Document(PageSize.A4, 20, 20, 20, 20);
  55.         PdfWriter writer = PdfWriter.getInstance(doc, new FileOutputStream(RESULT + 
  56.                 new SimpleDateFormat("HHmmss").format(new Date()) + "_中文.pdf"));
  57.         //http://developers.itextpdf.com/question/how-add-text-image
  58.         writer.setStrictImageSequence(true);
  59.         doc.open();
  60.         PdfContentByte cb = writer.getDirectContent();
  61.         addText("中国人");
  62.         addText("韩国人");
  63.         List<Object[]> contents = new ArrayList<Object[]>();
  64.         for(int i=0;i<2;i++){
  65.             Object[] object = new Object[2];
  66.             object[0] = "华科" + i;
  67.             object[1] = "武大" + i;
  68.             contents.add(object);
  69.         }
  70.         addImage((RESULT + "1.png"), cb, null);
  71.         addText("中国人");
  72.         addTable(new String[]{"序号一", "序号二"}, contents);
  73.         addText("韩国人");
  74.         addImage((RESULT + "2.png"), cb, null);
  75.         addText("韩国人");
  76.         doc.close();
  77.     }
  79.     /**
  80.      * 编辑标题
  81.      * @param text 段落的文本内容
  82.      * @param fontSize 标题的字体大小
  83.      * @throws DocumentException 
  84.      */
  85.     public void addTitle(String title, int fontSize) 
  86.             throws DocumentException{
  87.         Font titleFont = new Font(font);
  88.         titleFont.setSize(fontSize);
  89.         Paragraph content = new Paragraph(title, titleFont);
  90.         content.setAlignment(Element.ALIGN_CENTER);
  91.         doc.add(content);
  92.     }
  94.     /**
  95.      * 编辑文本
  96.      * @param text 段落的文本内容
  97.      * @throws DocumentException 
  98.      */
  99.     public void addText(String text) 
  100.             throws DocumentException{
  101.         Paragraph content = new Paragraph(text, font);
  102.         content.setAlignment(Element.ALIGN_LEFT);
  103.         doc.add(content);
  104.     }
  106.     /**
  107.      * 自定义文本大小的编辑文本
  108.      * @param text 段落的文本内容
  109.      * @param fontSize 字体大小
  110.      * @throws DocumentException 
  111.      */
  112.     public void addText(String text, int fontSize) 
  113.             throws DocumentException{
  114.         Font textFont = new Font(font);
  115.         textFont.setSize(fontSize);
  116.         Paragraph content = new Paragraph(text, textFont);
  117.         content.setAlignment(Element.ALIGN_LEFT);
  118.         doc.add(content);
  119.     }
  121.     /**
  122.      * 编辑表格
  123.      * @param header 表格头
  124.      * @param contents 表格内容
  125.      * @throws DocumentException 
  126.      */
  127.     public void addTable(Object[] header, List<Object[]> contents) 
  128.             throws DocumentException{
  129.         PdfPTable table = new PdfPTable(header.length);
  130.         table.setWidthPercentage(TABLEPERCENT);
  131.         for(int i = 0; i < header.length; i++){
  132.             Paragraph paragraph = new Paragraph(header[i].toString(), font);
  133.             paragraph.setAlignment(Element.ALIGN_CENTER);
  134.             paragraph.setLeading(0, 1);
  135.             PdfPCell cell = new PdfPCell();
  136.             cell.addElement(paragraph);
  137.             table.addCell(cell);
  138.         }
  139.         for(int j = 0; j < header.length*contents.size(); j++){
  140.             int m = j/(header.length);//行
  141.             int n = j%(header.length);//列
  142.             String content = contents.get(m)[n]!=null?contents.get(m)[n].toString():"";
  143.             Paragraph paragraph = new Paragraph(content, font);
  144.             paragraph.setAlignment(Element.ALIGN_CENTER);
  145.             paragraph.setLeading(0, 1);
  146.             PdfPCell cell = new PdfPCell();
  147.             cell.addElement(paragraph);
  148.             table.addCell(cell);
  149.         }
  150.         doc.add(table);
  151.     }
  153.     /**
  154.      * 编辑图片+水印
  155.      * @param imagePath 图片的路径
  156.      * @param cb PdfContentByte包含用户定位文本和图形内容页面对象
  157.      * @param watermark 水印[默认可设置为null]
  158.      * @throws IOException 
  159.      * @throws MalformedURLException 
  160.      * @throws DocumentException 
  161.      */
  162.     public void addImage(String imagePath, PdfContentByte cb, String watermark) 
  163.             throws MalformedURLException, IOException, DocumentException{
  164.         if(watermark!=null){
  165.             PdfPTable table = new PdfPTable(1);
  166.             table.addCell(getWatermarkedImage(cb, Image.getInstance(imagePath), watermark));
  167.             doc.add(table);
  168.         }else {
  169.             Image img = Image.getInstance(imagePath);  
  170.             float height = img.getHeight();  
  171.             float width = img.getWidth();  
  172.             int percent = getPercent2(height, width);
  173.             img.setAlignment(Image.MIDDLE);
  174.             img.scalePercent(percent + 3);
  175.             doc.add(img); 
  176.         }
  177.     }
  179.     /**
  180.      * 添加空行
  181.      * @param number 空行数
  182.      * @throws DocumentException 
  183.      */
  184.     public void addBlankLine(int number) throws DocumentException{
  185.         Paragraph blankLine = new Paragraph("\n");
  186.         for(int i=0; i<number; i++){
  187.             doc.add(blankLine);
  188.         }
  189.     }
  191.     /**
  192.      * 第一种解决方案 在不改变图片形状的同时，判断，如果h>w，则按h压缩，否则在w>h或w=h的情况下，按宽度压缩。
  193.      * @param h
  194.      * @param w
  195.      * @return
  196.      */
  197.     public int getPercent(float h, float w) {
  198.         int p = 0;
  199.         float p2 = 0.0f;
  200.         if (h > w) {
  201.             p2 = 297 / h * 100;
  202.         } else {
  203.             p2 = 210 / w * 100;
  204.         }
  205.         p = Math.round(p2);
  206.         return p;
  207.     }
  209.     /**
  210.      * 第二种解决方案，统一按照宽度压缩。这样来的效果是，所有图片的宽度是相等的。
  211.      * @param args
  212.      */
  213.     public int getPercent2(float h, float w) {
  214.         int p = 0;
  215.         float p2 = 0.0f;
  216.         p2 = 530 / w * 100;
  217.         p = Math.round(p2);
  218.         return p;
  219.     }
  221.     public Image getWatermarkedImage(PdfContentByte cb, Image img, String watermark) throws DocumentException {
  222.         float width = img.getScaledWidth();
  223.         float height = img.getScaledHeight();
  224.         PdfTemplate template = cb.createTemplate(width, height);
  225.         template.addImage(img, width, 0, 0, height, 0, 0);
  226.         ColumnText.showTextAligned(template, Element.ALIGN_CENTER,
  227.                 new Phrase(watermark, font), width / 2, height / 2, 30);
  228.         return Image.getInstance(template);
  229.     }
  230. }

解释&参考

首先给我最直接参考的资料来源是网上的一片博客，这篇博客基本上把基础的问题都解决了，但是有一些他没有说清楚的点，比如实际上官方的iText的jar包是不支持中文的，解决方式常用的就是去下载一个中文扩展包，具体可见这篇博客，但是我后续找到了一个更简便的方式，网上直接有人提供扩展了中文之后的iText包，最终我采用的就是这个jar包解决中文问题。
然后，针对实际操作中遇到的关于表格和图片的问题，直接参考了官网的图片资料和表格资料。如果对表格有更加深入的需求，比如各种不规则的排版，则可以好好看看这一篇：http://developers.itextpdf.com/content/zugferd-future-invoicing/5-creating-pdf-invoices-basic-profile。
另外，如果最终的排版中碰到了乱序的问题，可以参考官网上的这篇Q&A，重点在于

  1. writer.setStrictImageSequence(true);

最后，如果是用于常见的B/S系统中，那么你会需要看看如何在web开发中使用这种pdf的导出功能，这里，很可能你会碰到一些坑，这里只能帮你们填两个坑，参考如下：
http://bbs.csdn.net/topics/380054889
http://www.360doc.com/content/12/0612/13/1967709_217660151.shtml

最后

给图片加上水印后图片的大小变得不可控了，导致排版上非常的难看。这个功能由于时间问题，暂时还没有继续研究如何解决，只能后续在研究了。

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注