如何在 Next.js 应用程序中实现 JSON-LD
了解如何向 Next.js 应用程序添加 JSON-LD,以向搜索引擎和 AI 描述你的内容。
JSON-LD 是一种结构化数据格式,搜索引擎和 AI 可以使用它来帮助它们理解页面结构,而不仅仅是纯内容。例如,你可以用它来描述人物、事件、组织、电影、书籍、食谱以及许多其他类型的实体。
我们目前对 JSON-LD 的建议是在 layout.js 或 page.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>
<script
type="application/ld+json"
dangerouslySetInnerHTML={{
__html: JSON.stringify(jsonLd).replace(/</g, '\\u003c'),
}}
/>
</section>
)
}app/products/[id]/page.js
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>
<script
type="application/ld+json"
dangerouslySetInnerHTML={{
__html: JSON.stringify(jsonLd).replace(/</g, '\\u003c'),
}}
/>
</section>
)
}你可以使用 Google 的 Rich Results Test 或通用的 Schema Markup Validator 来验证和测试你的结构化数据。
你可以使用 schema-dts 等社区包,通过 TypeScript 为你的 JSON-LD 添加类型:
tsx
import { Product, WithContext } from 'schema-dts'
const jsonLd: WithContext<Product> = {
'@context': 'https://schema.org',
'@type': 'Product',
name: 'Next.js Sticker',
image: 'https://nextjs.org/imgs/sticker.png',
description: 'Dynamic at the speed of static.',
}小知识:
next/script组件针对加载和执行 JavaScript 进行了优化。由于 JSON-LD 是结构化数据,而不是可执行代码,因此这里使用原生<script>标签是正确的选择。