Java实现Html转PDF

最新推荐文章于 2024-07-26 16:25:12 发布
最新推荐文章于 2024-07-26 16:25:12 发布
阅读量1.6w 收藏 22
点赞数 1
分类专栏： spring boot 文章标签： spring-boot html2pdf wkhtmltopdf Thymeleaf java 8
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/gisboygogogo/article/details/77601308
版权

1.引子

当我们写一个web程序时，经常会遇到将某个特定页面的内容导出成报告的功能。本文将实现利用Java 8，Spring Boot, Wkhtmltopdf, Thymeleaf将HTML页面导出成PDF文本。

2.总纲

在我们实现具体功能前，我们先看看创建一个PDF文档的过程大约分三步走：

a)     浏览器(服务端)发送一个HTTP请求到我们的后台程序，并说明HTML页面的url和所创建的PDF文档的文件名；

b)     写Java后台代码调用并 wkhtmltopdf 命令行工具以读取HTML文档并将其转为PDF文档；

c)     Java后台程序读取转好的PDF文档，并将其返回到到浏览器端。

 

在开始前我们之先，先安装wkhtmltopdf

3.技术实现

1.     安装Wkhtmltopdf

首先我们需要安装wkhtmltopdf命令行工具。我们可以去其官网选择对应的操作系统版本下载并安装（本文作者安装的是windows-64bit版本）

官网下载地址：https://wkhtmltopdf.org/downloads.html

 

如果你用的是 macOS 可以利用Homebrew进行wkhtmltopdf的安装。只要输入如下命令行即可完成安装：

brew install Caskroom/cask/wkhtmltopdf

2.     配置环境变量

我的Wkhtmltopdf是默认安装路径’C:\ProgramFiles\wkhtmltopdf’

计算机-属性-高级系统设置-环境变量-系统变量-Path添加wkhtmltopdf的路径，如下图所示：


配置完Path后我们就可以去写Java代码啦。


开发环境与工具：

a)     Spring Boot 1.4.3 REALEASE

b)     Thymeleaf

c)     Maven 3.3

d)     Eclipse oxygen


3.   项目最终结构


4.    项目依赖 pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>org.thinkingingis</groupId>
  <artifactId>spring-boot-htmltopdf</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>spring-boot-htmltopdf</name>
  <url>http://maven.apache.org</url>
	
  <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.3.RELEASE</version>
  </parent>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <java.version>1.8</java.version>
  </properties>

  <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
	  		<groupId>org.springframework.boot</groupId>
	  		<artifactId>spring-boot-starter-logging</artifactId>
	  	</dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>  
            <groupId>org.webjars</groupId>  
            <artifactId>bootstrap</artifactId>  
            <version>3.3.7</version>  
        </dependency>  
  </dependencies>

  <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

5.  从HTML页面创建PDF文档

5.1  Model层

在我们具体实现HTML转PDF功能之前，我们需要创建一个类用于存放wkhtmltopdf所需要的参数信息。

我们创建PdfFileRequest .java 类，包含两个属性

  filename 属性是我们所创建PDF文档的文件名

  sourceHtmlUrl 属性是HTML文档的URL地址

PdfFileRequest .java

package org.thinkingingis.model;

public class PdfFileRequest {
	
	private String fileName;
	private String sourceHtmlUrl;
	
	public String getFileName() {
		return fileName;
	}
	public void setFileName(String fileName) {
		this.fileName = fileName;
	}
	public String getSourceHtmlUrl() {
		return sourceHtmlUrl;
	}
	public void setSourceHtmlUrl(String sourceHtmlUrl) {
		this.sourceHtmlUrl = sourceHtmlUrl;
	}

}
5.2  Service层

PdfFileCreator.java

package org.thinkingingis.service;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.StringWriter;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.TimeUnit;

import javax.servlet.http.HttpServletResponse;

import org.apache.tomcat.util.http.fileupload.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;
import org.thinkingingis.model.PdfFileRequest;

@Service
public class PdfFileCreator {
	 private static final Logger LOGGER = LoggerFactory.getLogger(PdfFileCreator.class);
	 public void writePdfToResponse(PdfFileRequest fileRequest, HttpServletResponse response) {
	        String pdfFileName = fileRequest.getFileName();
	        requireNotNull(pdfFileName, "The file name of the created PDF must be set");
	        requireNotEmpty(pdfFileName, "File name of the created PDF cannot be empty");
	 
	        String sourceHtmlUrl = fileRequest.getSourceHtmlUrl();
	        requireNotNull(sourceHtmlUrl, "Source HTML url must be set");
	        requireNotEmpty(sourceHtmlUrl, "Source HTML url cannot be empty");
	 
	        List<String> pdfCommand = Arrays.asList(
	                "wkhtmltopdf",
	                sourceHtmlUrl,
	                "-"
	        );
	 
	        ProcessBuilder pb = new ProcessBuilder(pdfCommand);
	        Process pdfProcess;
	 
	        try {
	            pdfProcess = pb.start();
	 
	            try(InputStream in = pdfProcess.getInputStream()) {
	                writeCreatedPdfFileToResponse(in, response);
	                waitForProcessBeforeContinueCurrentThread(pdfProcess);
	                requireSuccessfulExitStatus(pdfProcess);
	                setResponseHeaders(response, fileRequest);
	            }
	            catch (Exception ex) {
	                writeErrorMessageToLog(ex, pdfProcess);
	                throw new RuntimeException("PDF generation failed");
	            }
	            finally {
	                pdfProcess.destroy();
	            }
	        }
	        catch (IOException ex) {
	            throw new RuntimeException("PDF generation failed");
	        }
	    }
	 
	    private void requireNotNull(String value, String message) {
	        if (value == null) {
	            throw new IllegalArgumentException(message);
	        }
	    }
	 
	    private void requireNotEmpty(String value, String message) {
	        if (value.isEmpty()) {
	            throw new IllegalArgumentException(message);
	        }
	    }
	 
	    private void writeCreatedPdfFileToResponse(InputStream in, HttpServletResponse response) throws IOException {
	        OutputStream out = response.getOutputStream();
	        IOUtils.copy(in, out);
	        out.flush();
	    }
	 
	    private void waitForProcessBeforeContinueCurrentThread(Process process) {
	        try {
	            process.waitFor(2, TimeUnit.SECONDS);
	        }
	        catch (InterruptedException ex) {
	            Thread.currentThread().interrupt();
	        }
	    }
	 
	    private void requireSuccessfulExitStatus(Process process) {
	        if (process.exitValue() != 0) {
	            throw new RuntimeException("PDF generation failed");
	        }
	    }
	 
	    private void setResponseHeaders(HttpServletResponse response, PdfFileRequest fileRequest) {
	        response.setContentType("application/pdf");
	        response.setHeader("Content-Disposition", "attachment; filename=\"" + fileRequest.getFileName() + "\"");
	    }
	 
	    private void writeErrorMessageToLog(Exception ex, Process pdfProcess) throws IOException {
	        LOGGER.error("Could not create PDF because an exception was thrown: ", ex);
	        LOGGER.error("The exit value of PDF process is: {}", pdfProcess.exitValue());
	 
	        String errorMessage = getErrorMessageFromProcess(pdfProcess);
	        LOGGER.error("PDF process ended with error message: {}", errorMessage);
	    }
	 
	    private String getErrorMessageFromProcess(Process pdfProcess) {
	        try {
	            BufferedReader reader = new BufferedReader(new InputStreamReader(pdfProcess.getErrorStream()));
	            StringWriter writer = new StringWriter();
	 
	            String line;
	            while ((line = reader.readLine()) != null) {
	                writer.append(line);
	            }
	 
	            return writer.toString();
	        }
	        catch (IOException ex) {
	            LOGGER.error("Could not extract error message from process because an exception was thrown", ex);
	            return "";
	        }
	    }

}
5.3  REST API实现

PdfController.java 

package org.thinkingingis.controller;

import javax.servlet.http.HttpServletResponse;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import org.thinkingingis.model.PdfFileRequest;
import org.thinkingingis.service.PdfFileCreator;

@RestController
public class PdfController {
	
	private final PdfFileCreator pdfFileCreator;
	
	@Autowired
	public PdfController(PdfFileCreator pdfFileCreator) {
		this.pdfFileCreator = pdfFileCreator;
	}
	
	@RequestMapping(value = "/api/pdf", method = RequestMethod.POST)
	public void createPdf(@RequestBody PdfFileRequest fileRequest, HttpServletResponse response) {
		pdfFileCreator.writePdfToResponse(fileRequest, response);
	}
	

}

5.4   Controller层

PrintPdfController.java

package org.thinkingingis.controller;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import javax.servlet.http.HttpServletResponse;

import org.apache.tomcat.util.http.fileupload.IOUtils;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.client.RestTemplate;
import org.thinkingingis.model.PdfFileRequest;

@Controller
@RequestMapping("/print")
public class PrintPdfController {
	private final RestTemplate restTemplate;
	
    public PrintPdfController(RestTemplateBuilder restTemplateBuilder) {
        this.restTemplate = restTemplateBuilder.build();
    }
    
    @RequestMapping(value = "/pdf", method = RequestMethod.GET)
    public void createPdfFromUrl(HttpServletResponse response) {
        PdfFileRequest fileRequest = new PdfFileRequest();
        fileRequest.setFileName("index.pdf");
        fileRequest.setSourceHtmlUrl("http://blog.csdn.net/gisboygogogo/article/");
 
        byte[] pdfFile = restTemplate.postForObject("http://localhost:8080/api/pdf", 
                fileRequest, 
                byte[].class
        );
        writePdfFileToResponse(pdfFile, "index.pdf", response);
    }
 
    private void writePdfFileToResponse(byte[] pdfFile, String fileName, HttpServletResponse response) {
        try (InputStream in = new ByteArrayInputStream(pdfFile)) {
            OutputStream out = response.getOutputStream();
            IOUtils.copy(in, out);
            out.flush();
 
            response.setContentType("application/pdf");
            response.setHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\"");
        }
        catch (IOException ex) {
            throw new RuntimeException("Error occurred when creating PDF file", ex);
        }
    }

}

6. 启动项目

输入 http://localhost:8080/index

点击 ‘打印’ 就会将 ‘http://blog.csdn.net/gisboygogogo/article/’ 页面转成PDF文档，保存即可。



至此，HTML转PDF就实现啦。

下载源码


如果你觉得本文对你有帮助，是可以赞赏一下的：）



如遇到问题，欢迎通过公众号留言给作者，以便共同探讨。

邮箱：thinkingingis@qq.com

微信公众号：


ThinkingInGIS
关注
专栏目录
Java将html转换PDF文件
weixin_43746291的博客
04-26 6532
Java HTML转换为PDF文件 1.场景描述 公司业务中需要将富文本编辑器保存的HTML格式文件转换成PDF文件供前端预览、下载及打印，因为富文本编辑器中，HTML的格式不太规范，并且样式比较多，Java基于IText对HTML文件进行转换对格式要求较为严格，并且转换样式可能出现问题，所以选用了基于WKHtmlToPdf的方式进行文档的转换。 WKHtmlToPdf是一个使用 WebKit 网页渲染引擎开发的用来将 HTML 文档转成 PDF 文档的工具，可以跟多种脚本语言进行集成来转换文档。官方网站：
html转pdf（总结五种方法Java）
热门推荐
weixin_43981813的博客
12-01 2万+
html转pdf
Java实现HTML文件转PDF文件
11-22
实现思路： 1、通过URL获取当前HMTL页面的内容： URL urls = new URL(url); String urlsource = getURLSource(urls); 2、从后台获取数据库内容，内容是JSon格式保存的，把先JSon格式内容转化成Map //获取Map值 Map map = json2Map(); 3、通过JSoup 解析HMTL内容，并动态给HMTL标签内容赋值 //解析HMTL文件并给字符串赋值 urlsource = parseHtml(urlsource, map); 4、把设置发了的HTML文件转化成PDF文件 //把HTML文件转化成PDF文件 htmlToPdf2(urlsource, fileName); 下载下来可以直接使用
使用Java将HTML转换为PDF的技术指南
最新发布
m0_61431263的博客
07-26 1041
iText：是一个强大的库，用于创建和操作PDF文件。它支持添加文本、图片、表格、矢量图形等。：是一个基于iText的扩展，专门用于将XHTML/CSS转换为PDF。它利用CSS渲染引擎（如jsoup或CSSBox）来解析和渲染HTML内容。wkhtmltopdf是一个开源的命令行工具，可以将HTML页面渲染成PDF文件。它基于Qt WebKit渲染引擎，因此能够很好地处理复杂的HTML和CSS。
html转PDF（java版 ）
06-15
对html的规范要求极高,例如：页面中必须闭合，必须: * * *
java实现html转pdf
qq_40852597的博客
03-13 1万+
方法：在实现之前先考虑一个问题，pdf是前端生成还是后端生成。这里采用pdfbox+itext（PDF文件名可自定义）技术在服务端生成。优点：免费，不需要安转软件，速度快，对于开发者而言，开发中仅需导入相应jar,且易部署。3.4 前端页面发起请求，服务端将生成的PDF文件返回。1.需求：将一个html页面转成pdf格式。缺点：对于html标签比较严格。3.1 需要的jar。
JAVA HTML转pdf
07-11
JAVA HTML转pdf，itext转换，已测试成功。所有需要jar已包括
Java实现Html转Pdf的方法
09-03
总结来说，Java实现HTML转PDF的关键在于正确配置`ITextRenderer`，处理好字体和图片资源，以及理解其对HTML和CSS的支持限制。通过以上步骤，我们可以创建一个简单的Java应用，将HTML文档转换为PDF格式，方便在各种...
java 实现 html 转 pdf(含图片)-附件资源
03-02
java 实现 html 转 pdf(含图片)-附件资源
Java实现HTML转PDF的解决方案.docx
10-26
Java 实现 HTML 转 PDF 的解决方案 Java 实现 HTML 转 PDF 的解决方案是指使用 Java 语言将 HTML 页面转换为 PDF 文档的技术方案。本解决方案通常用于生成 PDF 报表、证书、合同等需要保留固定格式的文档。 在本...
java 调用itext 把html转成pdf文档
05-22
通过itext 把html转成pdf文档，只需要把html传给itext，就会直接转成pdf,亲自试用了一下很方便，前提html的格式一定要严格，
java html转pdf
06-14
用java实现html文件转pdf文件 使用pd4ml 无水印 pd4m有点：对html文档格式要求低。 缺点：对某些css元素支持能力有限，比如css:thin 适用于样式简单的html转换
java后端实现html转pdf的工具类,pd4ml
07-01
java后端实现html转pdf的工具类，pd4ml最新3100pro支持中文版本的jar包，无水印的，包括pd4ml.jar、fonts.jar和sc_css2.jar
java的html转pdf
07-05
java实现html转pdf，包括解决base64图片以及中文不显示问题
JAVA使用itextpdf实现HTML转PDF
10-29
要使用iTextPDF在Java中实现HTML到PDF的转换，首先确保项目中引入了所需的依赖。在Maven项目中，可以在`pom.xml`文件中添加如下依赖： ```xml <groupId>com.itextpdf</groupId> <artifactId>itextpdf <version>...
java实现html转PDF
wylsjz的专栏
07-28 3536
java实现html转PDF
评论 15
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值