Java实现HTML转PDF的两款工具(itext-pdfhtml和x-easypdf)介绍与使用

 更新时间:2025年11月14日 09:40:01   作者:SimonKing  
这篇文章主要为大家详细介绍了Java实现HTML转PDF的两款工具(itext-pdfhtml和x-easypdf)的介绍与使用,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下

01 引言

之前在前文中介绍了三款HtmlPDF的工具。这不,又发现了两款类似的工具,整理一下分享给大家。

02 itext-pdfhtml-java

2.1 简介

iText pdfHTMLiText7套件的一个附加组件,专门用于将HTMLCSS内容转换为PDF文档。它基于iText核心PDF生成引擎,提供了高质量的HTMLPDF转换功能。性能表现非常优异。

主要特性:

  • 完整的HTML5CSS3支持:能够处理现代网页布局和样式
  • 字体嵌入:自动处理Web字体和系统字体
  • 响应式设计:支持媒体查询和响应式布局
  • 高保真转换:保持HTML内容的视觉保真度
  • Java原生:专为Java生态系统设计

GitHub地址:github.com/itext/itext-pdfhtml-java

官方地址:itextpdf.com/products/convert-html-css-to-pdf-pdfhtml

2.2 案例

使用起来也非常简单,下面官方的案例:

Maven依赖

<dependency>
    <groupId>com.itextpdf</groupId>
    <artifactId>html2pdf</artifactId>
    <version>6.2.1</version>
</dependency>

实践代码

@RequestMapping("index6")
public void index6(Model model, HttpServletResponse response) throws IOException {
    List<Map<String, Object>> list = new ArrayList<>();
    for (int i = 0; i < 3; i++) {
        Map<String, Object> item = new HashMap<>();
        item.put("image1", "http://example.com/2eb97.jpg");
        item.put("image2", "http://example.com/2f9c3.jpg");
        item.put("vehicleName", "路虎Defender[卫士](进口)2023款Defender130 48V[卫士 130 48V] 3.0T手自-体P400 HSE");
        item.put("brandName", "路虎");
        item.put("seriesName", "Defender[卫士]");
        item.put("modelYear", "2023款");
        item.put("licenseYear", SDF.format(new Date()));
        item.put("displayMileage", DF.format(new BigDecimal("9657")));
        item.put("dealDate", SDF.format(new Date()));
        item.put("dealPrice", DF.format(new BigDecimal("702400")));

        item.put("licenseCode", "沪A952714");

        list.add(item);
    }
    model.addAttribute("list", list);
    Map<String, Object> map = new HashMap<>();
    map.put("list", list);

    Context context = new Context(Locale.getDefault(), map);
    String htmlContent = templateEngine.process("index", context);
    System.out.println(htmlContent);

    // ---------------------------------------------------
    /*itext-html2pdf*/
    ConverterProperties properties = new ConverterProperties();

    FontProvider fontProvider = new FontProvider();
    fontProvider.addSystemFonts();
//        fontProvider.addFont("C:\\Windows\\Fonts\\simhei.ttf");
    // 添加系统字体
    properties.setFontProvider(fontProvider);

    HtmlConverter.convertToPdf(htmlContent, response.getOutputStream(), properties);
}

同样默认是不支持中文的,需要通过FontProvider添加指定的字体。fontProvider.addSystemFonts();直接添加系统字体,也可以通过addFont()添加自定义字体。页面必须声明字体,否则会出现乱码。

03 x-easypdf

3.1 简介

x-easypdf是一个java语言简化处理pdf的框架,包含fop模块与pdfbox模块,fop模块以创建功能为主,基于xsl-fo模板生成pdf文档,以数据源的方式进行模板渲染;pdfbox模块以编辑功能为主,对标准的pdfbox进行扩展,添加了成吨的功能。

HtmlPdfpdfbox模块下的一个转化器的功能,是基于 playwright 实现的。而playwright的依赖需要手动引入。Playwright是一个跨语言的浏览器自动化库,由Microsoft开发。虽然主要用于端到端测试,但其强大的PDF生成功能也使其成为HTMLPDF的优秀工具。

Gitee地址:gitee.com/dromara/x-easypdf

官网地址:x-easypdf.cn/

3.2 案例

x-easypdf是对playwrigh的功能做了一层包装,使用起来更方便。

Maven依赖

<dependency>
    <groupId>org.dromara</groupId>
    <artifactId>x-easypdf</artifactId>
    <version>3.4.7</version>
</dependency>
<dependency>
    <groupId>com.microsoft.playwright</groupId>
    <artifactId>playwright</artifactId>
    <version>1.53.0</version>
</dependency>

实践代码01

@RequestMapping("index10")
public void index10(HttpServletResponse response) throws IOException {
    // 获取html转换器
    HtmlConvertor convertor = PdfHandler.getDocumentConvertor().getHtmlConvertor();
    Document pdf = convertor.toPdf("http://127.0.0.1:8080/page/index");
    pdf.save(response.getOutputStream());
}

注意事项

playwrigh是基于浏览器引擎的,首次调用会下载默认的浏览器,下载完成之后,后续的使用就流畅了。而且默认支持中文,因为使用浏览器引擎,所以对于HtmlCss支持较好。但是消耗资源较高。

但是这里convertor.toPdf()目前支持传入地址和文件。不支持直接html内容直接转化的。但是playwrigh本身是支持的。

小编已经给x-easypdf作者提了issuesgitee.com/dromara/x-e…

**注意:**截止发稿,官方已经在3.5.0版本支持了html内容转Pdf

实战代码02

使用模板引擎的方式:

官网地址:x-easypdf.cn/guide/pdfbox/advance/templater

依然是建立在playwrigh基础之上。

@RequestMapping("index12")
public void index12(HttpServletResponse response) throws IOException {
    List<Map<String, Object>> list = new ArrayList<>();
    for (int i = 0; i < 3; i++) {
        Map<String, Object> item = new HashMap<>();
        item.put("image1", "http://example.com/2eb97.jpg");
        item.put("image2", "http://example.com/2f9c3.jpg");
        item.put("vehicleName", "路虎Defender[卫士](进口)2023款Defender130 48V[卫士 130 48V] 3.0T手自-体P400 HSE");
        item.put("brandName", "路虎");
        item.put("seriesName", "Defender[卫士]");
        item.put("modelYear", "2023款");
        item.put("licenseYear", SDF.format(new Date()));
        item.put("displayMileage", DF.format(new BigDecimal("9657")));
        item.put("dealDate", SDF.format(new Date()));
        item.put("dealPrice", DF.format(new BigDecimal("702400")));

        item.put("licenseCode", "沪A952714");

        list.add(item);
    }
    Map<String, Object> map = new HashMap<>();
    map.put("list", list);

    ThymeleafTemplater templater = PdfHandler.getDocumentTemplater().getThymeleafTemplater();
    templater.setTemplatePath("templates");
    templater.setTemplateName("index.html");
    templater.setTemplateData(map);

    // 获取 html 内容
    String content = templater.getHtmlContent();
    System.out.println(content);

    // 转换文档
    Document document = templater.transform();
    document.save(response.getOutputStream());
}

这里需要说明的是:由于x-easypdf自行解析了Thymeleaf模版,所以无法使用spring-boot-starter-thymeleaf的配置。templatePathtemplateName都需要写完整。templatePathclasspath下的路径。

模板引擎可能会出现nested exception is java.lang.NoClassDefFoundError: ognl/PropertyAccessor的错误,需要引入ognl,且版本不能超过3.2。从 3.2 开始,会报java.lang.NoClassDefFoundError: ognl/DefaultMemberAccess。有效版本:

<dependency>
	<groupId>ognl</groupId>
	<artifactId>ognl</artifactId>
	<version>3.1.28</version>
</dependency>

边距可以通过打印样式控制:

@page {
    size: A4;
    margin: 20px;
}

3.3playwrigh原生写法

@RequestMapping("index11")
public void index11(HttpServletResponse response) throws IOException {
    try (Playwright playwright = Playwright.create();
         Browser browser = playwright.chromium().launch()) {
        BrowserContext context = browser.newContext();
        Page page = context.newPage();

        // 从HTML内容生成PDF
        page.setContent("<h1>Hello, Playwright!</h1>");
        byte[] pdf = page.pdf();

        ByteArrayInputStream bais = new ByteArrayInputStream(pdf);
        IOUtils.copy(bais, response.getOutputStream());
    }
}

04 小结

iText pdfHTML内存占用低,转换速度快,适合服务器端批量处理。而Playwright需要更多资源,但渲染质量极高,适合对视觉保真度要求高的场景,所以x-easypdf也是一样的。如果只是针对HtmlPdf的服务端转化的场景iText pdfHTML的优势更明显一下,关键它快!

也有粉丝朋友留言说jasperreports也很好用,小编也试了一下。jasperreports需要加载特定的模板,也许是因为不是很熟悉,用起来感觉有点别扭。这里就不推荐了,有兴趣的可以去试试!

以上就是Java实现HTML转PDF的两款工具(itext-pdfhtml和x-easypdf)介绍与使用的详细内容,更多关于Java HTML转PDF的资料请关注脚本之家其它相关文章!

相关文章

  • 关于SpringBoot中的XA事务详解

    关于SpringBoot中的XA事务详解

    这篇文章主要介绍了关于SpringBoot中的XA事务详解,事务管理可以确保数据的一致性和完整性,同时也可以避免数据丢失和冲突等问题。在分布式环境中,XA 事务是一种常用的事务管理方式,需要的朋友可以参考下
    2023-07-07
  • Java中队列Queue和Deque的区别与代码实例

    Java中队列Queue和Deque的区别与代码实例

    学过数据结构的,一定对队列不陌生,java也实现了队列,下面这篇文章主要给大家介绍了关于Java中队列Queue和Deque区别的相关资料,需要的朋友可以参考下
    2021-08-08
  • Springboot3整合Elasticsearch8(elasticsearch-java)最佳实践

    Springboot3整合Elasticsearch8(elasticsearch-java)最佳实践

    文章推荐使用Elasticsearch官方新客户端(ElasticsearchJavaAPIClient)替代已废弃的RestHighLevelClient,对比SpringDataElasticsearch和easy-es的优缺点,详解SpringBoot3整合步骤及高阶用法,强调新客户端功能全且适配最新版本,感兴趣的朋友一起看看吧
    2025-07-07
  • 史上最全的IDEA快捷键总结

    史上最全的IDEA快捷键总结

    这篇文章主要介绍了史上最全的IDEA快捷键总结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-01-01
  • 一篇文章让你彻底学会Java之exists()方法

    一篇文章让你彻底学会Java之exists()方法

    Java中File.exists()方法用于检查文件或目录是否存在,是文件操作的前置检查工具,这篇文章主要介绍了Java之exists()方法的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-07-07
  • Mybatis 入参类型方式全面详解

    Mybatis 入参类型方式全面详解

    这篇文章主要为大家介绍了Mybatis入参的类型方式全面示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-06-06
  • Java利用AQS实现自定义锁

    Java利用AQS实现自定义锁

    本文主要介绍了Java利用AQS实现自定义锁,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • Java file.delete删除文件失败,Windows磁盘出现无法访问的文件问题

    Java file.delete删除文件失败,Windows磁盘出现无法访问的文件问题

    这篇文章主要介绍了Java file.delete删除文件失败,Windows磁盘出现无法访问的文件问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-06-06
  • 使用java实现手机短信验证全过程

    使用java实现手机短信验证全过程

    这篇文章主要介绍了使用java实现手机短信验证全过程,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-04-04
  • mybatis映射文件mapper.xml的具体写法

    mybatis映射文件mapper.xml的具体写法

    在开发过程中,需要开发人员配置mapper映射文件,本文主要介绍了mybatis映射文件mapper.xml的具体写法,感兴趣的可以了解一下
    2021-09-09

最新评论