Sponsor
ntab.devntab.dev 提升效率的新标签页组件
点击查看
Menu

国际化

Next.js 使你能够配置路由和内容渲染以支持多种语言。使你的网站适应不同地区包括翻译内容(本地化)和国际化路由。

术语

  • 区域设置(Locale): 一组语言和格式化首选项的标识符。这通常包括用户的首选语言,可能还包括其地理区域。
    • en-US:在美国使用的英语
    • nl-NL:在荷兰使用的荷兰语
    • nl:荷兰语,没有特定区域

路由概述

建议使用浏览器中的用户语言首选项来选择要使用的区域设置。更改你的首选语言将修改发送到你应用程序的 Accept-Language 头部。

例如,使用以下库,你可以查看传入的 Request 来确定要选择哪个区域设置,基于 Headers、你计划支持的区域设置和默认区域设置。

middleware.js
import { match } from '@formatjs/intl-localematcher'
import Negotiator from 'negotiator'
 
let headers = { 'accept-language': 'en-US,en;q=0.5' }
let languages = new Negotiator({ headers }).languages()
let locales = ['en-US', 'nl-NL', 'nl']
let defaultLocale = 'en-US'
 
match(languages, locales, defaultLocale) // -> 'en-US'

路由可以通过子路径(/fr/products)或域名(my-site.fr/products)进行国际化。有了这些信息,你现在可以在 Middleware 中根据区域设置重定向用户。

middleware.js
import { NextResponse } from "next/server";
 
let locales = ['en-US', 'nl-NL', 'nl']
 
// 获取首选区域设置,类似于上面的方法或使用库
function getLocale(request) { ... }
 
export function middleware(request) {
  // 检查路径名中是否有任何支持的区域设置
  const { pathname } = request.nextUrl
  const pathnameHasLocale = locales.some(
    (locale) => pathname.startsWith(`/${locale}/`) || pathname === `/${locale}`
  )
 
  if (pathnameHasLocale) return
 
  // 如果没有区域设置则重定向
  const locale = getLocale(request)
  request.nextUrl.pathname = `/${locale}${pathname}`
  // 例如,传入请求是 /products
  // 新的 URL 现在是 /en-US/products
  return NextResponse.redirect(request.nextUrl)
}
 
export const config = {
  matcher: [
    // 跳过所有内部路径 (_next)
    '/((?!_next).*)',
    // 可选:仅在根 (/) URL 上运行
    // '/'
  ],
}

最后,确保 app/ 内的所有特殊文件都嵌套在 app/[lang] 下。这使 Next.js 路由器能够在路由中动态处理不同的区域设置,并将 lang 参数转发到每个布局和页面。例如:

app/[lang]/page.tsx
TypeScript
// 你现在可以访问当前区域设置
// 例如 /en-US/products -> `lang` 是 "en-US"
export default async function Page({
  params,
}: {
  params: Promise<{ lang: string }>
}) {
  const lang = (await params).lang;
  return ...
}

根布局也可以嵌套在新文件夹中(例如 app/[lang]/layout.js)。

本地化

根据用户首选区域设置更改显示内容,或本地化,不是 Next.js 特有的功能。下面描述的模式在任何 Web 应用程序中都以相同的方式工作。

假设我们想在应用程序中同时支持英语和荷兰语内容。我们可能会维护两个不同的"字典",这些字典是从某个键到本地化字符串的映射对象。例如:

dictionaries/en.json
{
  "products": {
    "cart": "Add to Cart"
  }
}
dictionaries/nl.json
{
  "products": {
    "cart": "Toevoegen aan Winkelwagen"
  }
}

然后我们可以创建一个 getDictionary 函数来加载所请求区域设置的翻译:

app/[lang]/dictionaries.ts
TypeScript
import 'server-only'
 
const dictionaries = {
  en: () => import('./dictionaries/en.json').then((module) => module.default),
  nl: () => import('./dictionaries/nl.json').then((module) => module.default),
}
 
export const getDictionary = async (locale: 'en' | 'nl') =>
  dictionaries[locale]()

根据当前选择的语言,我们可以在布局或页面中获取字典。

app/[lang]/page.tsx
TypeScript
import { getDictionary } from './dictionaries'
 
export default async function Page({
  params,
}: {
  params: Promise<{ lang: 'en' | 'nl' }>
}) {
  const lang = (await params).lang
  const dict = await getDictionary(lang) // en
  return <button>{dict.products.cart}</button> // Add to Cart
}

因为 app/ 目录中的所有布局和页面默认为 服务器组件(Server Components),我们不需要担心翻译文件的大小影响我们的客户端 JavaScript 包大小。此代码将仅在服务器上运行,只有生成的 HTML 会被发送到浏览器。

静态生成

要为给定的区域设置集生成静态路由,我们可以在任何页面或布局中使用 generateStaticParams。这可以是全局的,例如,在根布局中:

app/[lang]/layout.tsx
TypeScript
export async function generateStaticParams() {
  return [{ lang: 'en-US' }, { lang: 'de' }]
}
 
export default async function RootLayout({
  children,
  params,
}: Readonly<{
  children: React.ReactNode
  params: Promise<{ lang: 'en-US' | 'de' }>
}>) {
  return (
    <html lang={(await params).lang}>
      <body>{children}</body>
    </html>
  )
}

资源