• WKHtmltoPdf

    踩过的坑

    请一定要使用下面的这种方式获取系统的可执行命令，否则会报一堆的找不到目录等错误！！！

    1.  String osname = System.getProperty("os.name").toLowerCase();
    2.  String cmd = osname.contains("windows") ? "where wkhtmltopdf" : "which wkhtmltopdf";
    3.  p = Runtime.getRuntime().exec(cmd);

    由于wkhtmltoPdf是基于操作系统层面的pdf转换，因此，程序想获得Html转换pdf就需要经历四次IO操作，如果pdf的大小大于3M时，就会变得缓慢，建议考虑使用itext5进行pdf转换。下面是itext4、itext5和wkhtmltoPdf之间的耗时对比；

     

    原理

    1、wkhtmltopdf是一个独立安装、通过命令行交互、开源免费的将html内容转为pdf或图片的工具，命令行交互意味着只要能够调用本地命令（cmd或shell等）的开发语言均可使用，比如Java。其本质是使用内置浏览器内核渲染目标网页，然后再将网页渲染结果转换为PDF文档或图片。wkhtmltopdf官网地址：wkhtmltopdf，选择合适的系统版本安装即可。

    2、创建待转换的目标HTML页面，可用任何熟悉的技术栈，要注意的一点是尽量保存页面为静态，尽量减少动态效果、交互。wkhtmltopdf也可支持直接转换html文件，不过还是建议以url方式来转换，更简便。

    3、 部署运行html web服务，切换到bin目录，运行命令行进行转换：

    /wkhtmltopdf http://yourdomain/target.html SAVE_PATH/target.pdf

    4、命令结构：wkhtmltopdf [GLOBAL OPTION]... [OBJECT]...

    在命令行上可通过 wkhtmltopdf –H 来查看所有的配置说明。官网文档：https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

    JAVA调用

    1、首先需要封装命令参数

    1. private static String buildCmdParam(String srcAbsolutePath, String destAbsolutePath, Integer pageHeight, Integer pageWidth) {
    2.         StringBuilder cmd = new StringBuilder();
    3.         cmd.append(findExecutable()).append(space)
    4.                 .append("--margin-left").append(space)
    5.                 .append("0").append(space)
    6.                 .append("--margin-right").append(space)
    7.                 .append("0").append(space)
    8.                 .append("--margin-top").append(space)
    9.                 .append("0").append(space)
    10.                 .append("--margin-bottom").append(space)
    11.                 .append("0").append(space)
    12.                 .append("--page-height").append(space)
    13.                 .append(pageHeight).append(space)
    14.                 .append("--page-width").append(space)
    15.                 .append(pageWidth).append(space)
    16.  
    17.                 .append(srcAbsolutePath).append(space)
    18. //                .append("--footer-center").append(space)
    19. //                .append("[page]").append(space)
    20. //                .append("--footer-font-size").append(space)
    21. //                .append("14").append(space)
    22. //
    23. //                .append("--disable-smart-shrinking").append(space)
    24. //                .append("--load-media-error-handling").append(space)
    25. //                .append("ignore").append(space)
    26. //                .append("--load-error-handling").append(space)
    27. //                .append("ignore").append(space)
    28. //                .append("--footer-right").append(space)
    29. //                .append("WanG提供技术支持").append(space)
    30.                 .append(destAbsolutePath);
    31.         return cmd.toString();
    32.     }
    33.     /**
    34.      * 获取当前系统的可执行命令
    35.      *
    36.      * @return
    37.      */
    38.     public static String findExecutable() {
    39.         Process p;
    40.         try {
    41.             String osname = System.getProperty("os.name").toLowerCase();
    42.             String cmd = osname.contains("windows") ? "where wkhtmltopdf" : "which wkhtmltopdf";
    43.             p = Runtime.getRuntime().exec(cmd);
    44.             new Thread(new ProcessStreamHandler(p.getErrorStream())).start();
    45.             p.waitFor();
    46.             return IOUtils.toString(p.getInputStream(), Charset.defaultCharset());
    47.         } catch (IOException e) {
    48.             log.info("根据当前系统返回 wkhtmltopdf 执行命令失败，IO异常：", e);
    49.         } catch (InterruptedException e) {
    50.             log.info("根据当前系统返回 wkhtmltopdf 执行命令失败，中断异常：", e);
    51.         }
    52.         return "";
    53.     }

    2、获取当前系统的命令参数

    Process proc = Runtime.getRuntime().exec(finalCmd);

    3、等待程序执行结果，并以ByteArrayOutputStream形式返回，最后在finally里面删除由于工具转换过程中生成的临时文件

    1. private static ByteArrayOutputStream doProcess(String finalCmd, File htmlTempFile, File wkpdfDestTempFile) {
    2.         InputStream is = null;
    3.         try {
    4.             Process proc = Runtime.getRuntime().exec(finalCmd);
    5.             new Thread(new ProcessStreamHandler(proc.getInputStream())).start();
    6.             new Thread(new ProcessStreamHandler(proc.getErrorStream())).start();
    7.  
    8.             proc.waitFor();
    9.             ByteArrayOutputStream baos = new ByteArrayOutputStream();
    10.             is = new FileInputStream(wkpdfDestTempFile);
    11.             byte[] buf = new byte[1024];
    12.  
    13.             while (is.read(buf, 0, buf.length) != -1) {
    14.                 baos.write(buf, 0, buf.length);
    15.             }
    16.  
    17.             return baos;
    18.         } catch (IOException | InterruptedException e) {
    19.             log.error("html转换pdf出错", e);
    20.             throw new RuntimeException("html转换pdf出错了");
    21.         } finally {
    22.             if (htmlTempFile != null) {
    23.                 boolean delete = htmlTempFile.delete();
    24.             }
    25.             if (wkpdfDestTempFile != null) {
    26.                 boolean delete = wkpdfDestTempFile.delete();
    27.             }
    28.             if (is != null) {
    29.                 try {
    30.                     is.close();
    31.                 } catch (IOException e) {
    32.                     e.printStackTrace();
    33.                 }
    34.             }
    35.         }
    36.     }

    完整代码如下

    1. import cn.hutool.core.io.FileUtil;
    2. import cn.hutool.core.util.CharsetUtil;
    3. import cn.hutool.core.util.StrUtil;
    4. import lombok.extern.slf4j.Slf4j;
    5. import org.apache.commons.io.IOUtils;
    6.  
    7. import java.io.*;
    8. import java.nio.charset.Charset;
    9. import java.nio.charset.StandardCharsets;
    10. import java.util.Random;
    11.  
    12. @Slf4j
    13. public class WkHtmltoxPdf {
    14.     //空格
    15.     private static final String space = " ";
    16.  
    17.     //文件前缀
    18.     private static final String PREFIX = "tempFile";
    19.  
    20.     //文件后缀-html
    21.     private static final String SUFIX_HTML = ".html";
    22.     //文件后缀pdf
    23.     private static final String SUFIX_PDF = ".pdf";
    24.  
    25.     private static final Random RANDOM = new Random(100);
    26.  
    27.     private static String FILEDIR_PATH = "/Users/yangfan/tools/wkhtmltox";
    28.  
    29.     private static final Integer PAGE_HEIGHT = 60;
    30.  
    31.     private static final Integer PAGE_WIDTH = 100;
    32.  
    33.     public static void main(String[] args) {
    34.         testWkPdf(getHtml(), PAGE_HEIGHT, PAGE_WIDTH);
    35.     }
    36.  
    37.     public static void testWkPdf(String html, Integer pageHeight, Integer pageWidth) {
    38.         byte[] bytes = html2pdf(html, pageHeight, pageWidth).toByteArray();
    39.         storagePdf(bytes, FILEDIR_PATH, RANDOM.nextInt() + SUFIX_PDF);
    40.     }
    41.  
    42.     /**
    43.      * 存储pdf文件
    44.      *
    45.      * @param bfile    pdf字节流
    46.      * @param filePath 文件路径
    47.      * @param fileName 文件名称
    48.      */
    49.     public static void storagePdf(byte[] bfile, String filePath, String fileName) {
    50.         BufferedOutputStream bos = null;
    51.         FileOutputStream fos = null;
    52.         File file = null;
    53.         try {
    54.             File dir = new File(filePath);
    55.             if ((!dir.exists()) && (dir.isDirectory())) {
    56.                 boolean mkdirs = dir.mkdirs();
    57.             }
    58.             file = new File(filePath + "/" + fileName);
    59.             fos = new FileOutputStream(file);
    60.             bos = new BufferedOutputStream(fos);
    61.             bos.write(bfile);
    62.         } catch (Exception e) {
    63.             e.printStackTrace();
    64.         } finally {
    65.             if (bos != null) {
    66.                 try {
    67.                     bos.close();
    68.                 } catch (IOException e1) {
    69.                     e1.printStackTrace();
    70.                 }
    71.             }
    72.             if (fos != null) {
    73.                 try {
    74.                     fos.close();
    75.                 } catch (IOException e1) {
    76.                     e1.printStackTrace();
    77.                 }
    78.             }
    79.         }
    80.     }
    81.  
    82.     /**
    83.      * 将传入的页面转换成pdf，返回pdf字节数组
    84.      * 默认自动随机生成文件名称
    85.      *
    86.      * @param html html页面信息
    87.      * @return byte[] pdf字节流
    88.      */
    89.     public static ByteArrayOutputStream html2pdf(String html, Integer pageHeight, Integer pageWidth) {
    90.         String fileName = System.currentTimeMillis() + RANDOM.nextInt() + "";
    91.         String dest = FILEDIR_PATH;
    92.         return doHtml2pdf(html, dest, pageHeight, pageWidth);
    93.     }
    94.  
    95.     private static ByteArrayOutputStream doHtml2pdf(String html, String dest, Integer pageHeight, Integer pageWidth) {
    96.         String wkhtmltopdf = findExecutable();
    97.         //将内存中的html文件存储到一个临时地方
    98.         File htmlTempFile = createFile(PREFIX, SUFIX_HTML, dest);
    99.         FileUtil.writeString(html, htmlTempFile, CharsetUtil.UTF_8);
    100.  
    101.         //wk转换pdf之后的pdf存储文件地址
    102.         File wkpdfDestTempFile = createFile(PREFIX, SUFIX_PDF, dest);
    103.  
    104.         if (StrUtil.isBlank(wkhtmltopdf)) {
    105.             log.info("no wkhtmltopdf found!");
    106.             throw new RuntimeException("html转换pdf出错了,未找到wkHtml工具");
    107.         }
    108.  
    109.         String srcAbsolutePath = htmlTempFile.getAbsolutePath();
    110.         String destAbsolutePath = wkpdfDestTempFile.getAbsolutePath();
    111.  
    112.         File parent = wkpdfDestTempFile.getParentFile();
    113.         if (!parent.exists()) {
    114.             boolean dirsCreation = parent.mkdirs();
    115.             log.info("create dir for new file,{}", dirsCreation);
    116.         }
    117.  
    118.         String finalCmd = buildCmdParam(srcAbsolutePath, destAbsolutePath, pageHeight, pageWidth);
    119.  
    120.         return doProcess(finalCmd, htmlTempFile, wkpdfDestTempFile);
    121.  
    122.     }
    123.  
    124.     /**
    125.      * 执行wkHtmltox命令，读取生成的的pdf文件，输出执行结果，最后删除由于执行wk命令生成的零时的pdf文件和html文件
    126.      *
    127.      * @param finalCmd          cmd命令
    128.      * @param htmlTempFile      html零时文件
    129.      * @param wkpdfDestTempFile 生成的pdf文件
    130.      * @return byte[] pdf字节流
    131.      */
    132.     private static ByteArrayOutputStream doProcess(String finalCmd, File htmlTempFile, File wkpdfDestTempFile) {
    133.         InputStream is = null;
    134.         try {
    135.             Process proc = Runtime.getRuntime().exec(finalCmd);
    136.             new Thread(new ProcessStreamHandler(proc.getInputStream())).start();
    137.             new Thread(new ProcessStreamHandler(proc.getErrorStream())).start();
    138.  
    139.             proc.waitFor();
    140.             ByteArrayOutputStream baos = new ByteArrayOutputStream();
    141.             is = new FileInputStream(wkpdfDestTempFile);
    142.             byte[] buf = new byte[1024];
    143.  
    144.             while (is.read(buf, 0, buf.length) != -1) {
    145.                 baos.write(buf, 0, buf.length);
    146.             }
    147.  
    148.             return baos;
    149.         } catch (IOException | InterruptedException e) {
    150.             log.error("html转换pdf出错", e);
    151.             throw new RuntimeException("html转换pdf出错了");
    152.         } finally {
    153.             if (htmlTempFile != null) {
    154.                 boolean delete = htmlTempFile.delete();
    155.             }
    156.             if (wkpdfDestTempFile != null) {
    157.                 boolean delete = wkpdfDestTempFile.delete();
    158.             }
    159.             if (is != null) {
    160.                 try {
    161.                     is.close();
    162.                 } catch (IOException e) {
    163.                     e.printStackTrace();
    164.                 }
    165.             }
    166.         }
    167.     }
    168.  
    169.     public static File createFile(String prefix, String sufix, String fileDirPath) {
    170.         File file = null;
    171.         File fileDir = new File(fileDirPath);
    172.         try {
    173.             file = File.createTempFile(prefix, sufix, fileDir);
    174.         } catch (IOException e) {
    175.             log.info("创建文件失败：", e.getCause());
    176.         }
    177.         return file;
    178.     }
    179.  
    180.     private static String buildCmdParam(String srcAbsolutePath, String destAbsolutePath, Integer pageHeight, Integer pageWidth) {
    181.         StringBuilder cmd = new StringBuilder();
    182.         cmd.append(findExecutable()).append(space)
    183.                 .append("--margin-left").append(space)
    184.                 .append("0").append(space)
    185.                 .append("--margin-right").append(space)
    186.                 .append("0").append(space)
    187.                 .append("--margin-top").append(space)
    188.                 .append("0").append(space)
    189.                 .append("--margin-bottom").append(space)
    190.                 .append("0").append(space)
    191.                 .append("--page-height").append(space)
    192.                 .append(pageHeight).append(space)
    193.                 .append("--page-width").append(space)
    194.                 .append(pageWidth).append(space)
    195.  
    196.                 .append(srcAbsolutePath).append(space)
    197. //                .append("--footer-center").append(space)
    198. //                .append("[page]").append(space)
    199. //                .append("--footer-font-size").append(space)
    200. //                .append("14").append(space)
    201. //
    202. //                .append("--disable-smart-shrinking").append(space)
    203. //                .append("--load-media-error-handling").append(space)
    204. //                .append("ignore").append(space)
    205. //                .append("--load-error-handling").append(space)
    206. //                .append("ignore").append(space)
    207. //                .append("--footer-right").append(space)
    208. //                .append("WanG提供技术支持").append(space)
    209.                 .append(destAbsolutePath);
    210.         return cmd.toString();
    211.     }
    212.  
    213.     /**
    214.      * 获取当前系统的可执行命令
    215.      *
    216.      * @return
    217.      */
    218.     public static String findExecutable() {
    219.         Process p;
    220.         try {
    221.             String osname = System.getProperty("os.name").toLowerCase();
    222.             String cmd = osname.contains("windows") ? "where wkhtmltopdf" : "which wkhtmltopdf";
    223.             p = Runtime.getRuntime().exec(cmd);
    224.             new Thread(new ProcessStreamHandler(p.getErrorStream())).start();
    225.             p.waitFor();
    226.             return IOUtils.toString(p.getInputStream(), Charset.defaultCharset());
    227.         } catch (IOException e) {
    228.             log.info("根据当前系统返回 wkhtmltopdf 执行命令失败，IO异常：", e);
    229.         } catch (InterruptedException e) {
    230.             log.info("根据当前系统返回 wkhtmltopdf 执行命令失败，中断异常：", e);
    231.         }
    232.         return "";
    233.     }
    234.  
    235.     private static class ProcessStreamHandler implements Runnable {
    236.         private InputStream is;
    237.  
    238.         public ProcessStreamHandler(InputStream is) {
    239.             this.is = is;
    240.         }
    241.  
    242.         @Override
    243.         public void run() {
    244.             BufferedReader reader = null;
    245.             try {
    246.                 InputStreamReader isr = new InputStreamReader(is, StandardCharsets.UTF_8);
    247.                 reader = new BufferedReader(isr);
    248.                 String line;
    249.                 while ((line = reader.readLine()) != null) {
    250.                     log.debug("---++++++++++--->" + line);
    251.                 }
    252.             } catch (IOException e) {
    253.                 e.printStackTrace();
    254.             } finally {
    255.                 if (reader != null) {
    256.                     try {
    257.                         reader.close();
    258.                     } catch (IOException e) {
    259.                         e.printStackTrace();
    260.                     }
    261.                 }
    262.             }
    263.         }
    264.     }
    265. }

  • 相关阅读:
    “第五十一天”
    使用Django开发一款竞争对手产品监控系统
    .NET源码解读kestrel服务器及创建HttpContext对象流程
    HJ3 明明的随机数
    nodejs+vue校园跑腿系统elementui
    设计模式_解释器模式
    计算机网络---TCP/UDP
    Cenots7 离线安装部署PostgreSQL
    js 正则表达式
    刷题笔记22——二叉搜索树BST
  • 原文地址：https://blog.csdn.net/weixin_38829588/article/details/127433450