如何使用 Next.js 和 Puppeteer 捕获网页屏幕截图

以编程方式捕获网页屏幕截图对于生成预览、创建基于图像的报告等非常有用。在本指南中，我们将构建一个 Next.js API 路由，该路由采用 URL 并生成 PNG 屏幕截图。我们的设置使用 Puppeteer 和 chrome-aws-lambda 来利用无头 Chrome 浏览器，使其多功能且可用于生产。

我们将首先设置一个新的 Next.js 项目，并逐步浏览代码以了解 API 如何捕获屏幕截图。

先决条件

• 设置 Next.js 应用
• 使用 Puppeteer 配置 API 路由
• 为捕获接口创建React组件
• Puppeteer 本地配置与部署配置的说明

开始新的 Next.js 项目

1. 创建一个新的 Next.js 应用程序：

npx create-next-app@latest capture-image-app
cd capture-image-app

1. 安装必要的依赖项：

npm install puppeteer puppeteer-core chrome-aws-lambda busboy

第2步：创建生成屏幕截图的API路由

现在，我们将设置一个 API 端点来根据提供的 URL 捕获并返回屏幕截图。

在pages/api文件夹中，创建一个名为generate-png.ts的新文件并添加以下代码：

import { NextApiRequest, NextApiResponse } from "next";
import busboy, { Busboy } from "busboy"; // Use busboy for multipart parsing
import chromium from "chrome-aws-lambda";
import puppeteerCore from "puppeteer-core"; // Import puppeteer-core directly
import puppeteer from "puppeteer"; // Import puppeteer directly

// Conditional import for Puppeteer based on the environment
const puppeteerModule = process.env.NODE_ENV === "production" ? puppeteerCore : puppeteer;

export const config = {
  api: {
    bodyParser: false, // Disable default body parsing to handle raw binary data (Blob)
  },
};

const delay = (ms: number): Promise<void> => new Promise((resolve) => setTimeout(resolve, ms));

export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
): Promise<void> {
  try {
    if (req.method === "POST") {
      const bb: Busboy = busboy({ headers: req.headers });
      let width: number = 1920; // Default width
      let height: number = 0; // Default height
      let delayTime: number = 6000;
      const buffers: Buffer[] = [];

      bb.on("file", (_name: string, file: NodeJS.ReadableStream) => {
        file.on("data", (data: Buffer) => buffers.push(data));
      });

      bb.on("field", (name: string, value: string) => {
        if (name === "width") width = parseInt(value, 10) || 1920;
        if (name === "height") height = parseInt(value, 10) || 0;
        if (name === "delay") delayTime = parseInt(value, 10) || 6000;
      });

      bb.on("finish", async () => {
        const blobBuffer: Buffer = Buffer.concat(buffers);
        const htmlContent: string = blobBuffer.toString("utf-8");

        const browser = await puppeteerModule.launch({
          args: ["--start-maximized"],
          executablePath: process.env.NODE_ENV === "production"
            ? await chromium.executablePath || "/usr/bin/chromium-browser"
            : undefined,  // No custom executable path needed for local
          headless: true,
        });

        const page = await browser.newPage();

        // Load the HTML content directly
        await page.setContent(htmlContent, { waitUntil: "networkidle0" });

        //@ts-expect-error todo
        const bodyHeight = await page.evaluate(() => {
          return document.body.scrollHeight; // Get the full scrollable height of the body
        });

        await page.setViewport({
          width: Number(width),
          height: height || bodyHeight, // Use the provided height or fallback to the full body height
          deviceScaleFactor: 2,
        });

        await delay(delayTime);

        const screenshotBuffer = await page.screenshot({
          fullPage: !height,
          type: "png",
          omitBackground: false,
        });

        await browser.close();

        res.setHeader("Content-Type", "image/png");
        res.setHeader(
          "Content-Disposition",
          "attachment; filename=screenshot.png"
        );
        res.status(200).end(screenshotBuffer);
      });

      req.pipe(bb); // Pipe the request stream to busboy
    } else {
      res.setHeader("Allow", ["POST"]);
      res.status(405).end(`Method ${req.method} Not Allowed`);
    }
  } catch (error) {
    console.error("ERROR", error);
    res.status(500).end("Internal Server Error");
  }
}


</void></void>

*说明：为本地环境和生产环境选择 Puppeteer
*
在此代码中，我们为 puppeteer 设置了动态导入：

• 本地开发：如果 NODE_ENV 不是生产环境，它会使用 puppeteer，它设置起来更简单，并且不需要 chrome-aws-lambda。

• 生产：对于无服务器部署，环境将检测 NODE_ENV 作为生产并加载 puppeteer-core 以及 chrome-aws-lambda，这使得它可以在 AWS Lambda 和其他类似环境中工作。在此设置中，chrome-aws-lambda 提供正确的 Chromium 路径，确保与无服务器提供商的兼容性。

第 3 步：为 UI 创建一个简单的 React 组件

在这里，我们将创建一个简单的表单，让用户输入网页捕获的值。此表单将触发生成功能以捕获并下载 PDF 格式的屏幕截图。

import { useState } from "react";

export default function ScreenCaptureComponent() {
  const [isProcessing, setProcessing] = useState(false);
  const [width, setWidth] = useState<string>("1920");
  const [height, setHeight] = useState<string>("1000");
  const [delay, setDelay] = useState<string>("6000");

  // Function to clone HTML and prepare for capture
  function takeScreenshot() {
    const clonedElement = document.body.cloneNode(true) as HTMLElement;
    const blob = new Blob([clonedElement.outerHTML], { type: "text/html" });
    return blob;
  }

  // Function to capture screenshot by sending cloned HTML to API
  async function generateCapture() {
    setProcessing(true);

    const htmlBlob = takeScreenshot();

    if (!htmlBlob) {
      setProcessing(false);
      return;
    }

    try {
      const formData = new FormData();
      formData.append("file", htmlBlob);
      formData.append("width", width);
      formData.append("height", height);
      formData.append("delay", delay);
      const response = await fetch("/api/generate-png", {
        method: "POST",
        body: formData,
      });

      if (!response.ok) throw new Error("Capture failed");

      const blob = await response.blob();
      const downloadUrl = URL.createObjectURL(blob);
      const link = document.createElement("a");
      link.href = downloadUrl;
      link.download = "capture.png";
      link.click();
      URL.revokeObjectURL(downloadUrl);
    } catch (error) {
      console.error("Failed to capture screenshot", error);
    } finally {
      setProcessing(false);
    }
  }

  return (
    <div style="{{" maxwidth: margin: auto padding: backgroundcolor: borderradius: width: boxshadow: rgba>
      <h2 style="{{" fontsize: fontweight: textalign: marginbottom:>
        Webpage Screenshot Capture
      </h2>
      <form onsubmit="{(e)"> {
          e.preventDefault();
          generateCapture();
        }}
        style={{
          display: "flex",
          flexDirection: "column",
          alignItems: "center",
          marginBottom: "16px",
        }}
      >
        <label style="{{" marginbottom: fontweight: htmlfor="width">
          Width (px)
        </label>
        <select id="width" value="{width}" onchange="{(e)"> setWidth(e.target.value)}
          style={{
            width: "100%",
            padding: "8px",
            marginBottom: "16px",
            borderRadius: "4px",
            border: "1px solid #ccc",
            outline: "none",
          }}
        >
          <option value="1920">1920 (Full HD)</option>
          <option value="1366">1366 (Laptop)</option>
          <option value="1280">1280 (Desktop)</option>
          <option value="1024">1024 (Tablet Landscape)</option>
          <option value="768">768 (Tablet Portrait)</option>
          <option value="375">375 (Mobile)</option>
        </select>

        <label style="{{" marginbottom: fontweight: htmlfor="height">
          Height (px)
        </label>
        <input type="number" id="height" value="{height}" onchange="{(e)"> setHeight(e.target.value)}
          required
          style={{
            width: "100%",
            padding: "8px",
            marginBottom: "16px",
            borderRadius: "4px",
            border: "1px solid #ccc",
            outline: "none",
          }}
        />

        <label style="{{" marginbottom: fontweight: htmlfor="delay">
          Delay (ms)
        </label>
        <input type="number" id="delay" value="{delay}" onchange="{(e)"> setDelay(e.target.value)}
          required
          style={{
            width: "100%",
            padding: "8px",
            marginBottom: "16px",
            borderRadius: "4px",
            border: "1px solid #ccc",
            outline: "none",
          }}
        />

        <button type="submit" disabled style="{{" padding: color: borderradius: transition: backgroundcolor: isprocessing : cursor:>
          {isProcessing ? "Capturing..." : "Capture Screenshot"}
        </button>
      </form>

      {/* Example HTML Element to Capture */}
      <div id="capture-area" style="{{" display:>
        <h3 style="{{" fontsize: fontweight:>
          Content to Capture
        </h3>
        <p>This is an example of the HTML content that will be captured.</p>
      </div>
    </div>
  );
}
</string></string></string>

结论

本教程涵盖在 Next.js 中设置网页捕获工具、使用 Puppeteer 处理屏幕截图以及创建交互式前端组件。请记住在本地使用 puppeteer 并在生产中切换到 puppeteer-core，以减少捆绑包大小并优化无服务器环境。快乐编码！

以上是如何使用 Next.js 和 Puppeteer 捕获网页屏幕截图的详细内容。更多信息请关注PHP中文网其他相关文章！