手把手教你使用Java开发在线生成平PDF文档

一、介绍

在实际的业务开发的时候,研发人员往往会碰到很多这样的一些场景,需要提供相关的电子凭证信息给用户,例如网银/支付宝/微信购物支付的电子发票、订单的库存打印单、各种电子签署合同等等,以方便用户查看、打印或者下载。

成都地区优秀IDC服务器托管提供商(创新互联建站).为客户提供专业的四川移动机房托管,四川各地服务器托管,四川移动机房托管、多线服务器托管.托管咨询专线:18982081108

例如下图的电子发票!

熟悉这块业务的童鞋,一定特别清楚,目前最常用的解决方案是:把相关的数据信息,通过一些技术手段生成对应的 PDF 文件,然后返回给用户,以便预览、下载或者打印。

不太熟悉这项技术的童鞋,也不用着急,今天我们一起来详细了解一下在线生成 PDF 文件的技术实现手段!

二、案例实现

在介绍这个代码实践之前,我们先来了解一下这个第三方库:iText,对,没错,它就是我们今天的主角。

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

iText目前有两套版本,分别是iText5和iText7。iText5应该是网上用的比较多的一个版本。iText5因为是很多开发者参与贡献代码,因此在一些规范和设计上存在不合理的地方。iText7是后来官方针对iText5的重构,两个版本差别还是挺大的。不过在实际使用中,一般用到的都比较简单的 API,所以不用特别拘泥于使用哪个版本。

2.1、添加 iText 依赖包

在使用它之前,我们先引人相关的依赖包!

 
 
 
 
  1.  
  2.      
  3.      
  4.         com.itextpdf 
  5.         itextpdf 
  6.         5.5.11 
  7.      
  8.      
  9.         com.itextpdf.tool 
  10.         xmlworker 
  11.         5.5.11 
  12.      
  13.      
  14.      
  15.         com.itextpdf 
  16.         itext-asian 
  17.         5.2.0 
  18.      
  19.      
  20.      
  21.         org.xhtmlrenderer 
  22.         flying-saucer-pdf-itext5 
  23.         9.1.16 
  24.      
  25.      
  26.      
  27.         net.sf.jtidy 
  28.         jtidy 
  29.         r938 
  30.      
  31.          
  32.  

2.2、简单实现

老规矩,我们先来一个hello world,代码如下:

 
 
 
 
  1. public class CreatePDFMainTest { 
  2.  
  3.     public static void main(String[] args) throws Exception { 
  4.         Document document = new Document(PageSize.A4); 
  5.         //第二步,创建Writer实例 
  6.         PdfWriter.getInstance(document, new FileOutputStream("hello.pdf")); 
  7.         //创建中文字体 
  8.         BaseFont bfchinese = BaseFont.createFont("STSong-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED); 
  9.         Font fontChinese = new Font(bfchinese, 12, Font.NORMAL); 
  10.         //第三步,打开文档 
  11.         document.open(); 
  12.         //第四步,写入内容 
  13.         Paragraph paragraph = new Paragraph("hello world", fontChinese); 
  14.         document.add(paragraph); 
  15.         //第五步,关闭文档 
  16.         document.close(); 
  17.     } 

打开hello.pdf文件,内容如下!

2.3、复杂实现

在实际的业务开发中,因为业务场景非常复杂,而且变化快,我们往往不会采用上面介绍的写入内容方式来生成文件,而是采用HTML文件转化为PDF文件。

例如下面这张入库单!

我们应该如何快速实现呢?

首先,我们采用html语言编写一个入库单页面,将其命令为printDemo.html,源代码如下:

 
 
 
 
  1.  
  2.   
  3.   
  4.    
  5.   出库单 
  6.   
     
  7.    
     
  8.      
  9.       
  10.        
  11.        入库单 
  12.         
  13.          
  14.         
  15.        
  16.        
  17.        操作人:xxx 
  18.        创建时间:2021-09-14 12:00:00 
  19.        
  20.       
  21.      
  22.    
 
  •    
  •  
  •    
     
  •     
  •      style="border-collapse: collapse; border-spacing: 0;border:0px;"> 
  •        
  •        
  •         width="10%">序号 
  •        
  •         width="30%">商品 
  •        
  •         width="30%">单位 
  •        
  •         width="30%">数量 
  •        
  •        
  •        
  •        xxx沐浴露 
  •        箱 
  •        
  •        
  •        
  •        
  •        xxx洗发水 
  •        箱 
  •        
  •        
  •        
  •        
  •        xxx洗衣粉 
  •        箱 
  •        
  •        
  •        
  •        
  •        xxx洗面奶 
  •        箱 
  •        
  •        
  •      
  •    
  •  
  •    
  •   
  •  
  •  
  • 接着,我们将html文件转成PDF文件,源码如下:

     
     
     
     
    1. public class CreatePDFMainTest { 
    2.  
    3.  
    4.     /** 
    5.      * 创建PDF文件 
    6.      * @param htmlStr 
    7.      * @throws Exception 
    8.      */ 
    9.     private static void writeToOutputStreamAsPDF(String htmlStr) throws Exception { 
    10.         String targetFile = "pdfDemo.pdf"; 
    11.         File targeFile = new File(targetFile); 
    12.         if(targeFile.exists()) { 
    13.             targeFile.delete(); 
    14.         } 
    15.  
    16.         //定义pdf文件尺寸,采用A4横切 
    17.         Document document = new Document(PageSize.A4, 25, 25, 15, 40);// 左、右、上、下间距 
    18.         //定义输出路径 
    19.         PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream(targetFile)); 
    20.         PdfReportHeaderFooter header = new PdfReportHeaderFooter("", 8, PageSize.A4); 
    21.         writer.setPageEvent(header); 
    22.         writer.addViewerPreference(PdfName.PRINTSCALING, PdfName.NONE); 
    23.         document.open(); 
    24.  
    25.         // CSS 
    26.         CSSResolver cssResolver = new StyleAttrCSSResolver(); 
    27.         CssAppliers cssAppliers = new CssAppliersImpl(new XMLWorkerFontProvider(){ 
    28.  
    29.             @Override 
    30.             public Font getFont(String fontname, String encoding, boolean embedded, float size, int style, BaseColor color) { 
    31.                 try { 
    32.                     //用于中文显示的Provider 
    33.                     BaseFont bfChinese = BaseFont.createFont("STSongStd-Light", "UniGB-UCS2-H", BaseFont.NOT_EMBEDDED); 
    34.                     return new Font(bfChinese, size, style); 
    35.                 } catch (Exception e) { 
    36.                     return super.getFont(fontname, encoding, size, style); 
    37.                 } 
    38.             } 
    39.         }); 
    40.  
    41.         //html 
    42.         HtmlPipelineContext htmlContext = new HtmlPipelineContext(cssAppliers); 
    43.         htmlContext.setTagFactory(Tags.getHtmlTagProcessorFactory()); 
    44.         htmlContext.setImageProvider(new AbstractImageProvider() { 
    45.             @Override 
    46.             public Image retrieve(String src) { 
    47.                 //支持图片显示 
    48.                 int pos = src.indexOf("base64,"); 
    49.                 try { 
    50.                     if (src.startsWith("data") && pos > 0) { 
    51.                         byte[] img = Base64.decode(src.substring(pos + 7)); 
    52.                         return Image.getInstance(img); 
    53.                     } else if (src.startsWith("http")) { 
    54.                         return Image.getInstance(src); 
    55.                     } 
    56.                 } catch (BadElementException ex) { 
    57.                     return null; 
    58.                 } catch (IOException ex) { 
    59.                     return null; 
    60.                 } 
    61.                 return null; 
    62.             } 
    63.  
    64.             @Override 
    65.             public String getImageRootPath() { 
    66.                 return null; 
    67.             } 
    68.         }); 
    69.  
    70.  
    71.         // Pipelines 
    72.         PdfWriterPipeline pdf = new PdfWriterPipeline(document, writer); 
    73.         HtmlPipeline html = new HtmlPipeline(htmlContext, pdf); 
    74.         CssResolverPipeline css = new CssResolverPipeline(cssResolver, html); 
    75.  
    76.         // XML Worker 
    77.         XMLWorker worker = new XMLWorker(css, true); 
    78.         XMLParser p = new XMLParser(worker); 
    79.         p.parse(new ByteArrayInputStream(htmlStr.getBytes())); 
    80.  
    81.         document.close(); 
    82.     } 
    83.  
    84.     /** 
    85.      * 读取 HTML 文件 
    86.      * @return 
    87.      */ 
    88.     private static String readHtmlFile() { 
    89.         StringBuffer textHtml = new StringBuffer(); 
    90.         try { 
    91.             File file = new File("printDemo.html"); 
    92.             BufferedReader reader = new BufferedReader(new FileReader(file)); 
    93.             String tempString = null; 
    94.             // 一次读入一行,直到读入null为文件结束 
    95.             while ((tempString = reader.readLine()) != null) { 
    96.                 textHtml.append(tempString); 
    97.             } 
    98.             reader.close(); 
    99.         } catch (IOException e) { 
    100.             return null; 
    101.         } 
    102.         return textHtml.toString(); 
    103.     } 
    104.  
    105.     public static void main(String[] args) throws Exception { 
    106.         //读取html文件 
    107.         String htmlStr = readHtmlFile(); 
    108.         //将html文件转成PDF 
    109.         writeToOutputStreamAsPDF(htmlStr); 
    110.     } 

    运行程序,打开pdfDemo.pdf,结果如下!

    2.4、变量替换方式

    上面的html文件,是我们事先已经编辑好的,才能正常渲染。

    但是在实际的业务开发的时候,例如下面的商品内容,完全是动态的,还是xxx-202109入库单的名称,以及二维码,都是动态的。

    这个时候,我们可以采用freemarker模板引擎,通过定义变量来动态填充内容,直到转换出来的结果就是我们想要的html页面。

    当然,还有一种办法,例如下面这个,我们也可以在html页面里面定义${name}变量,然后在读取完文件之后,我们将其变量进行替换成我们想填充的任何值,这其实也是模板引擎最核心的一个玩法。

     
     
     
     
    1.  
    2.   
    3.    
    4.    
    5.   
    6.   
    7.   
      您好:${name}
       
    8.   
      欢迎,登录博客网站
       
    9.   
    10.  

     三、总结

    itext框架是一个非常实用的第三方pdf文件生成库,尤其是面对比较简单的pdf文件内容渲染的时候,它完全满足我们的需求。

    但是对于那种复杂的pdf文档,可能需要我们自己单独进行适配开发。具体的深度玩法,大家可以参阅itext官方API。

    鉴于笔者才疏学浅,难免会有理解不到位的地方,欢迎网友批评指出!

    四、参考

    1、博客园 - JAVA使用ItextPDF

    当前题目:手把手教你使用Java开发在线生成平PDF文档
    网站地址:http://www.csdahua.cn/qtweb/news42/543542.html

    网站建设、网络推广公司-快上网,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

    广告

    声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 快上网

    成都快上网为您推荐相关内容

    品牌网站建设知识

    同城分类信息