跳到内容
文件系统约定元数据文件opengraph-image 和 twitter-image

opengraph-image 和 twitter-image

opengraph-image 和 twitter-image 文件约定允许您为路由段设置 Open Graph 和 Twitter 图片。

当用户分享指向您网站的链接时，它们对于设置出现在社交网络和消息应用程序上的图片非常有用。

有两种方法可以设置 Open Graph 和 Twitter 图片

图片文件（.jpg、.png、.gif）

通过在路由段中放置 opengraph-image 或 twitter-image 图片文件来设置路由段的共享图片。

Next.js 将评估文件并自动将适当的标签添加到您的应用程序的 <head> 元素中。

文件约定支持的文件类型
opengraph-image.jpg, .jpeg, .png, .gif
twitter-image.jpg, .jpeg, .png, .gif
opengraph-image.alt.txt
twitter-image.alt.txt

须知:

twitter-image 文件大小不得超过 5MB，opengraph-image 文件大小不得超过 8MB。如果图片文件大小超过这些限制，构建将失败。

opengraph-image

将 opengraph-image.(jpg|jpeg|png|gif) 图片文件添加到任何路由段。

<head> 输出
<meta property="og:image" content="<generated>" />
<meta property="og:image:type" content="<generated>" />
<meta property="og:image:width" content="<generated>" />
<meta property="og:image:height" content="<generated>" />

twitter-image

将 twitter-image.(jpg|jpeg|png|gif) 图片文件添加到任何路由段。

<head> 输出
<meta name="twitter:image" content="<generated>" />
<meta name="twitter:image:type" content="<generated>" />
<meta name="twitter:image:width" content="<generated>" />
<meta name="twitter:image:height" content="<generated>" />

opengraph-image.alt.txt

在与 opengraph-image.(jpg|jpeg|png|gif) 图片相同的路由段中添加一个附带的 opengraph-image.alt.txt 文件作为其 alt 文本。

opengraph-image.alt.txt
About Acme
<head> 输出
<meta property="og:image:alt" content="About Acme" />

twitter-image.alt.txt

在与 twitter-image.(jpg|jpeg|png|gif) 图片相同的路由段中添加一个附带的 twitter-image.alt.txt 文件作为其 alt 文本。

twitter-image.alt.txt
About Acme
<head> 输出
<meta property="twitter:image:alt" content="About Acme" />

使用代码生成图片（.js、.ts、.tsx）

除了使用字面图片文件之外，您还可以使用代码程序化地生成图片。

通过创建默认导出函数的 opengraph-image 或 twitter-image 路由来生成路由段的共享图片。

文件约定支持的文件类型
opengraph-image.js, .ts, .tsx
twitter-image.js, .ts, .tsx

须知:

  • 默认情况下，生成的图片是静态优化的（在构建时生成并缓存），除非它们使用动态 API 或未缓存的数据。
  • 您可以使用 generateImageMetadata 在同一文件中生成多张图片。
  • opengraph-image.js 和 twitter-image.js 是特殊的路由处理程序，默认情况下会缓存，除非它使用动态 API 或动态配置选项。

生成图片最简单的方法是使用 next/og 中的 ImageResponse API。

app/about/opengraph-image.tsx
import { ImageResponse } from 'next/og'
import { readFile } from 'node:fs/promises'
import { join } from 'node:path'
 
// Image metadata
export const alt = 'About Acme'
export const size = {
  width: 1200,
  height: 630,
}
 
export const contentType = 'image/png'
 
// Image generation
export default async function Image() {
  // Font loading, process.cwd() is Next.js project directory
  const interSemiBold = await readFile(
    join(process.cwd(), 'assets/Inter-SemiBold.ttf')
  )
 
  return new ImageResponse(
    (
      // ImageResponse JSX element
      <div
        style={{
          fontSize: 128,
          background: 'white',
          width: '100%',
          height: '100%',
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
        }}
      >
        About Acme
      </div>
    ),
    // ImageResponse options
    {
      // For convenience, we can re-use the exported opengraph-image
      // size config to also set the ImageResponse's width and height.
      ...size,
      fonts: [
        {
          name: 'Inter',
          data: interSemiBold,
          style: 'normal',
          weight: 400,
        },
      ],
    }
  )
}
<head> 输出
<meta property="og:image" content="<generated>" />
<meta property="og:image:alt" content="About Acme" />
<meta property="og:image:type" content="image/png" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />

属性

默认导出函数接收以下 props

params (可选)

一个 Promise，它解析为一个对象，其中包含从根段到 opengraph-image 或 twitter-image 所在的段的动态路由参数对象。

须知：如果您使用 generateImageMetadata，函数还将接收一个 id prop，该 prop 是一个 Promise，解析为 generateImageMetadata 返回的项目之一的 id 值。

app/shop/[slug]/opengraph-image.tsx
export default async function Image({
  params,
}: {
  params: Promise<{ slug: string }>
}) {
  const { slug } = await params
  // ...
}
路由URLparams
app/shop/opengraph-image.js/shopundefined
app/shop/[slug]/opengraph-image.js/shop/1Promise<{ slug: '1' }>
app/shop/[tag]/[item]/opengraph-image.js/shop/1/2Promise<{ tag: '1', item: '2' }>

返回

默认导出函数应返回 Blob | ArrayBuffer | TypedArray | DataView | ReadableStream | Response。

须知：ImageResponse 满足此返回类型。

配置导出

您可以选择通过从 opengraph-image 或 twitter-image 路由导出 alt、size 和 contentType 变量来配置图片元数据。

选项类型
altstring
size{ width: number; height: number }
contentTypestring - 图片 MIME 类型

alt

opengraph-image.tsx | twitter-image.tsx
export const alt = 'My images alt text'
 
export default function Image() {}
<head> 输出
<meta property="og:image:alt" content="My images alt text" />

size

opengraph-image.tsx | twitter-image.tsx
export const size = { width: 1200, height: 630 }
 
export default function Image() {}
<head> 输出
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />

contentType

opengraph-image.tsx | twitter-image.tsx
export const contentType = 'image/png'
 
export default function Image() {}
<head> 输出
<meta property="og:image:type" content="image/png" />

路由段配置

opengraph-image 和 twitter-image 是专门的路由处理程序，它们可以使用与页面和布局相同的路由段配置选项。

示例

使用外部数据

此示例使用 params 对象和外部数据来生成图片。

须知：默认情况下，此生成的图片将静态优化。您可以配置单个 fetch options 或路由段选项来更改此行为。

app/posts/[slug]/opengraph-image.tsx
import { ImageResponse } from 'next/og'
 
export const alt = 'About Acme'
export const size = {
  width: 1200,
  height: 630,
}
export const contentType = 'image/png'
 
export default async function Image({
  params,
}: {
  params: Promise<{ slug: string }>
}) {
  const { slug } = await params
  const post = await fetch(`https://.../posts/${slug}`).then((res) =>
    res.json()
  )
 
  return new ImageResponse(
    (
      <div
        style={{
          fontSize: 48,
          background: 'white',
          width: '100%',
          height: '100%',
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
        }}
      >
        {post.title}
      </div>
    ),
    {
      ...size,
    }
  )
}

使用带有本地资源的 Node.js 运行时

这些示例使用 Node.js 运行时从文件系统中获取本地图片并将其作为 base64 字符串或 ArrayBuffer 传递给 <img> 的 src 属性。将本地资产相对于项目根目录放置，而不是示例源文件。

app/opengraph-image.tsx
import { ImageResponse } from 'next/og'
import { join } from 'node:path'
import { readFile } from 'node:fs/promises'
 
export default async function Image() {
  const logoData = await readFile(join(process.cwd(), 'logo.png'), 'base64')
  const logoSrc = `data:image/png;base64,${logoData}`
 
  return new ImageResponse(
    (
      <div
        style={{
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
        }}
      >
        <img src={logoSrc} height="100" />
      </div>
    )
  )
}

将 ArrayBuffer 传递给 <img> 元素的 src 属性不属于 HTML 规范的一部分。next/og 使用的渲染引擎支持它，但由于 TypeScript 定义遵循规范，您需要使用 @ts-expect-error 指令或类似指令来使用此功能。

app/opengraph-image.tsx
import { ImageResponse } from 'next/og'
import { join } from 'node:path'
import { readFile } from 'node:fs/promises'
 
export default async function Image() {
  const logoData = await readFile(join(process.cwd(), 'logo.png'))
  const logoSrc = Uint8Array.from(logoData).buffer
 
  return new ImageResponse(
    (
      <div
        style={{
          display: 'flex',
          alignItems: 'center',
          justifyContent: 'center',
        }}
      >
        {/* @ts-expect-error Satori accepts ArrayBuffer/typed arrays for <img src> at runtime */}
        <img src={logoSrc} height="100" />
      </div>
    )
  )
}

版本历史

版本更改
v16.0.0params 现在是一个解析为对象的 Promise
v13.3.0引入了 opengraph-image 和 twitter-image。