当前位置:首页 > 文章列表 > 文章 > 前端 > Creating a Nextjs API to Convert HTML to PDF with Puppeteer (Vercel-Compatible)

Creating a Nextjs API to Convert HTML to PDF with Puppeteer (Vercel-Compatible)

来源:dev.to 2024-10-28 14:10:11 0浏览 收藏

一分耕耘,一分收获!既然打开了这篇文章《Creating a Nextjs API to Convert HTML to PDF with Puppeteer (Vercel-Compatible)》,就坚持看下去吧!文中内容包含等等知识点...希望你能在阅读本文后,能真真实实学到知识或者帮你解决心中的疑惑,也欢迎大佬或者新人朋友们多留言评论,多给建议!谢谢!

Creating a Nextjs API to Convert HTML to PDF with Puppeteer (Vercel-Compatible)

将 html 转换为 pdf 是 web 应用程序中的常见要求。在这篇博文中,我们将探索如何创建一个 next.js api 路由,使用 puppeteer 将 html 转换为 pdf,并确保它在部署到 vercel 时正常工作。

挑战

虽然 puppeteer 是一款功能强大的 html 到 pdf 转换工具,但在部署到 vercel 等无服务器环境时,它带来了挑战。主要问题是:

  1. puppeteer 需要 chromium 二进制文件,这超出了 vercel 的大小限制。
  2. 无服务器函数的执行时间和资源有限。

解决方案

我们将使用 @sparticuz/chromium-min 和 puppeteer-core 的组合来克服这些限制。我们将采用以下方法:

  1. 使用专为无服务器环境设计的最小 chromium 构建。
  2. 配置 puppeteer 以使用这个最小的 chromium 版本。
  3. 优化 pdf 生成过程以实现无服务器执行。

第 1 步:设置项目

首先,创建一个新的 next.js 项目或使用现有的项目。然后,安装必要的依赖项:

npm install @sparticuz/chromium-min puppeteer-core

为了确保兼容性和最佳性能,使用所需软件包的正确版本非常重要。截至最新测试,推荐使用以下版本:

{
  "dependencies": {
    "@sparticuz/chromium-min": "^129.0.0",
    "puppeteer-core": "^23.5.0"
  }
}

第2步:创建api路由

在 app/api/html-to-pdf/route.js (对于 next.js 13+ 应用程序路由器)或 pages/api/html-to-pdf.js (对于 pages 路由器)创建一个新文件。代码如下:

const chromium = require("@sparticuz/chromium-min");
const puppeteer = require("puppeteer-core");

async function getbrowser() {
  return puppeteer.launch({
    args: [...chromium.args, "--hide-scrollbars", "--disable-web-security"],
    defaultviewport: chromium.defaultviewport,
    executablepath: await chromium.executablepath(
      `https://github.com/sparticuz/chromium/releases/download/v129.0.0/chromium-v129.0.0-pack.tar`
    ),
    headless: chromium.headless,
    ignorehttpserrors: true
  });
}

export async function post(request) {
  try {
    const { html } = await request.json();

    const browser = await getbrowser();
    const page = await browser.newpage();
    await page.setcontent(html, { waituntil: "networkidle0" });
    const pdfbuffer = await page.pdf({
      format: "a4",
      printbackground: true,
      margin: { top: "1cm", right: "1cm", bottom: "1cm", left: "1cm" }
    });
    await browser.close();

    return new response(pdfbuffer, {
      headers: {
        "content-type": "application/pdf",
        "content-disposition": 'attachment; filename="output.pdf"'
      }
    });
  } catch (error) {
    console.error("error generating pdf:", error);
    return new response(json.stringify({ error: "failed to generate pdf" }), {
      status: 500,
      headers: { "content-type": "application/json" }
    });
  }
}

第 3 步:理解代码

让我们分解一下这段代码的关键部分:

浏览器配置

getbrowser 函数使用最小的 chromium 二进制文件设置 puppeteer:

async function getbrowser() {
  return puppeteer.launch({
    args: [...chromium.args, "--hide-scrollbars", "--disable-web-security"],
    defaultviewport: chromium.defaultviewport,
    executablepath: await chromium.executablepath(
      `https://github.com/sparticuz/chromium/releases/download/v129.0.0/chromium-v129.0.0-pack.tar`
    ),
    headless: chromium.headless,
    ignorehttpserrors: true
  });
}

此配置使用 @sparticuz/chromium-min 包来提供与无服务器环境兼容的最小 chromium 二进制文件。

pdf 生成

pdf生成的主要逻辑在post函数中:

  1. 从请求正文中提取 html。
  2. 使用 getbrowser 函数启动浏览器实例。
  3. 创建一个新页面并将其内容设置为提供的 html。
  4. 从页面内容生成 pdf。
  5. 关闭浏览器以释放资源。
  6. 返回 pdf 作为带有适当标题的响应。

第 4 步:使用 api

要使用此 api,请发送 post 请求,并在请求正文中包含 html 内容:

const response = await fetch('/api/html-to-pdf', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ html: '

Hello, World!

' }), }); if (response.ok) { const blob = await response.blob(); // Handle the PDF blob (e.g., download or display) }

部署注意事项

部署到 vercel 时,请记住以下几点:

  1. 执行时间:vercel 业余计划的最长执行时间为 10 秒,专业计划的最长执行时间为 60 秒。优化您的 html 和 pdf 生成过程以适应这些限制。

  2. 内存使用情况:注意内存使用情况。最小的 chromium 二进制文件会有所帮助,但复杂的 pdf 可能仍会占用大量内存。

  3. 冷启动:无服务器函数可能会经历冷启动。第一次调用可能会比较慢,因为它需要下载并设置 chromium 二进制文件。

  4. 错误处理:实施强大的错误处理来管理超时或资源限制。

  5. 缓存:考虑对频繁生成的 pdf 实施缓存策略,以减少无服务器函数的负载。

结论

这种方法允许您使用 next.js 和 puppeteer 创建功能强大的 html 到 pdf 转换 api,与 vercel 的无服务器环境兼容。通过利用 @sparticuz/chromium-min 和 puppeteer-core,我们克服了在无服务器环境中运行 puppeteer 的主要挑战。

以上就是《Creating a Nextjs API to Convert HTML to PDF with Puppeteer (Vercel-Compatible)》的详细内容,更多关于的资料请关注golang学习网公众号!

版本声明
本文转载于:dev.to 如有侵犯,请联系study_golang@163.com删除
高阶函数在 Java 函数式库中的实现方式高阶函数在 Java 函数式库中的实现方式
上一篇
高阶函数在 Java 函数式库中的实现方式
如何向 Python 中的现有对象实例添加方法?
下一篇
如何向 Python 中的现有对象实例添加方法?
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ljg-skills -
    ljg-skills
    ljg-skills 是李继刚开源的 AI 技能与提示词集合,面向大模型使用者整理了一批可复用的 prompt、角色设定和任务技能模板,适合用于学习提示词设计、搭建个人 AI 工作流和沉淀团队常用智能体能力。
    128次使用
  • MELO音乐 - AI 音乐生成平台,支持多模态创作能力
    MELO音乐
    MELO音乐是一站式AI视频与音乐制作助手,对标suno, udio的高品质体验。提供伴奏生成、原创写词、无损导出、哼唱识曲、混音变声等全套音频与短视频编辑工具。无论是流行Kpop、电音说唱、民谣古风、摇滚儿歌还是商用轻音乐,MELO为你免费谱曲,轻松做同款!
    148次使用
  • UniScribe - AI 免费在线音视频转文字平台
    UniScribe
    UniScribe 是一款 AI 音视频转文字与内容整理工具,支持上传音频、视频文件或粘贴 YouTube 链接,自动生成转写文本、摘要、思维导图和关键问题,并支持多格式导出,适合会议记录、课程学习、访谈整理和内容创作复盘。
    127次使用
  • 剧云 - 免费 AI 智能中文剧本创作平台
    剧云
    剧云是专业中文剧本创作平台,安全稳定运行十余年,集成AI编剧、剧本医生审核、人物小传、剧情关系图、大纲编写、多人协作、Word导入导出、版权管控功能,数据安全防护,轻松高效创作剧本。
    284次使用
  • 万象有声 - AI 一站式有声内容创作平台
    万象有声
    万象有声,一个专为有声创作者打造的新一代智能有声内容创作平台。平台提供专业的智能拆章、智能画本编辑、AI配音、AI生成音效、后期制作、智能对轨、智能审听等有声创作全流程工具,可以帮助创作者高效、低成本创作出引人入胜的有声作品。立即体验,让有声书制作更简单!
    285次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码