跳到内容

如何在 Next.js 应用程序中实现 JSON-LD

JSON-LD 是一种结构化数据格式,搜索引擎和 AI 可以使用它来帮助它们理解页面内容之外的页面结构。例如,您可以使用它来描述一个人、一个事件、一个组织、一部电影、一本书、一个食谱以及许多其他类型的实体。

我们目前对 JSON-LD 的建议是在您的 layout.jspage.js 组件中将结构化数据渲染为 <script> 标签。

以下代码片段使用 JSON.stringify,它不会清除用于 XSS 注入的恶意字符串。为了防止此类漏洞,您可以从 JSON-LD 有效负载中清除 HTML 标签,例如,将字符 < 替换为其 Unicode 等效项 \u003c

请查看您组织推荐的清除潜在危险字符串的方法,或使用社区维护的 JSON.stringify 替代方案,例如 serialize-javascript

app/products/[id]/page.tsx
export default async function Page({ params }) {
  const { id } = await params
  const product = await getProduct(id)
 
  const jsonLd = {
    '@context': 'https://schema.org',
    '@type': 'Product',
    name: product.name,
    image: product.image,
    description: product.description,
  }
 
  return (
    <section>
      {/* Add JSON-LD to your page */}
      <script
        type="application/ld+json"
        dangerouslySetInnerHTML={{
          __html: JSON.stringify(jsonLd).replace(/</g, '\\u003c'),
        }}
      />
      {/* ... */}
    </section>
  )
}

您可以使用 Google 的 富媒体搜索结果测试工具 或通用的 Schema Markup Validator 验证和测试您的结构化数据。

您可以使用社区包(如 schema-dts)使用 TypeScript 为 JSON-LD 键入。

import { Product, WithContext } from 'schema-dts'
 
const jsonLd: WithContext<Product> = {
  '@context': 'https://schema.org',
  '@type': 'Product',
  name: 'Next.js Sticker',
  image: 'https://nextjs.net.cn/imgs/sticker.png',
  description: 'Dynamic at the speed of static.',
}