Html转PDF导出wkhtmltopdf工具教程及工具类

最新推荐文章于 2025-04-21 20:15:00 发布

原创最新推荐文章于 2025-04-21 20:15:00 发布

· 354 阅读

4 ·

版权

文章标签：

#pdf

1wkhtmltopdf的安装与使用

官网下载： wkhtmltopdfhttps://wkhtmltopdf.org/downloads.html

2工具类介绍

package com.auxgroup.tms.server.util;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import java.io.*;

/**
 * @Description 描述
 * @Author huazhongqiang
 * @Date 2025-01-13 9:39
 */
@Component
@Slf4j
public class HtmlToPdfUtil {
    // wkhtmltopdf在系统中的路径，使用该组件的时候需要安装一个软件
    private static final String toPdfTool = "D:\\HzqApp\\wkhtmltopdf\\bin\\wkhtmltopdf.exe";

    /**
     * html字符串转pdf并写入输出流
     *
     * @param htmlString   html字符串
     * @param outputStream 输出流
     * @return 转换成功返回true
     */
    public static boolean convertFromHtmlString(String htmlString, OutputStream outputStream) {
        File tempHtmlFile = null;
        File tempPdfFile = null;
        try {
            // 创建临时HTML文件
            tempHtmlFile = File.createTempFile("temp", ".html");
            tempHtmlFile.deleteOnExit(); // 确保程序退出时删除临时文件

            // 将HTML字符串写入临时文件
            try (FileWriter writer = new FileWriter(tempHtmlFile)) {
                writer.write(htmlString);
            }

            // 创建临时PDF文件
            tempPdfFile = File.createTempFile("temp", ".pdf");
            tempPdfFile.deleteOnExit(); // 确保程序退出时删除临时文件

            // 使用临时文件路径调用convert方法
            if (!convert(tempHtmlFile.getAbsolutePath(), tempPdfFile.getAbsolutePath())) {
                return false;
            }

            // 将生成的PDF文件内容写入输出流
            try (InputStream inputStream = new FileInputStream(tempPdfFile)) {
                byte[] buffer = new byte[1024];
                int bytesRead;
                while ((bytesRead = inputStream.read(buffer)) != -1) {
                    outputStream.write(buffer, 0, bytesRead);
                }
            }

            return true;
        } catch (IOException e) {
            e.printStackTrace();
            return false;
        } finally {
            // 删除临时文件
            if (tempHtmlFile != null && tempHtmlFile.exists()) {
                tempHtmlFile.delete();
            }
            if (tempPdfFile != null && tempPdfFile.exists()) {
                tempPdfFile.delete();
            }
        }
    }

    /**
     * html转pdf
     *
     * @param srcPath  html路径，可以是硬盘上的路径，也可以是网络路径
     * @param destPath pdf保存路径
     * @return 转换成功返回true
     */
    private static boolean convert(String srcPath, String destPath) {
        File file = new File(destPath);
        File parent = file.getParentFile();
        // 如果pdf保存路径不存在，则创建路径
        if (!parent.exists()) {
            parent.mkdirs();
        }
        StringBuilder cmd = new StringBuilder();
        if (System.getProperty("os.name").indexOf("Windows") == -1) {
            // 非windows 系统
            //toPdfTool = FileUtil.convertSystemFilePath("/home/ubuntu/wkhtmltox/bin/wkhtmltopdf");
        }
        cmd.append(toPdfTool);
        cmd.append(" ");
        cmd.append("-n --enable-local-file-access");
        log.info("=================================================" + cmd.toString());
        cmd.append(" ");
        cmd.append(" --encoding utf-8"); // 设置字符编码为UTF-8
        cmd.append(" --page-size A4");//纸张设置为A4
        cmd.append("  --margin-top 3cm ");// 设置页面上边距 (default 10mm)
        cmd.append(" --header-spacing 5 ");// (设置页眉和内容的距离,默认0)
        cmd.append(" --footer-spacing 5 ");// (设置页脚和内容的距离)
        cmd.append(srcPath);
        cmd.append(" ");
        cmd.append(destPath);

        boolean result = true;
        try {
            Process proc = Runtime.getRuntime().exec(cmd.toString());
            HtmlToPdfInterceptor error = new HtmlToPdfInterceptor(proc.getErrorStream());
            HtmlToPdfInterceptor output = new HtmlToPdfInterceptor(proc.getInputStream());
            error.start();
            output.start();
            proc.waitFor();
        } catch (Exception e) {
            result = false;
            e.printStackTrace();
        }
        return result;
    }

    public static void main(String[] args) {
        String htmlString = "<html><head><meta charset=\"UTF-8\"></head><body><h1>测试PDF生成</h1><p>这是一个测试HTML字符串。</p></body></html>";
        try (FileOutputStream outputStream = new FileOutputStream("D:\\html\\abc_from_string.pdf")) {
            HtmlToPdfUtil.convertFromHtmlString(htmlString, outputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }


}

3导出效果

xx.pdf