Nextjs+I18n多語言國際化最佳實踐(搜尋引擎友善)
註:這個最佳實務是基於next的pages路由。並不適合app路由。目錄基本想法使用next-i18ne […]
註:這個最佳實務是基於next的pages路由。並不適合app路由。
目錄
基本思路
使用next-i18next。
在「pages」目錄中增加[locales]目錄,將主要業務邏輯放到這個目錄中。
pages目錄中的index等頁面用於判斷語言,然後呼叫對應本地化頁面邏輯
public目錄中增加locales目錄,用於翻譯文件。
安裝
pnpm add next-i18next react-i18next i18nex
配置
檔案目錄
|components ..LangSwitcher.js ..LocLink.js ..MdRenderer.js |lib ..getStatic.js |pages ..[locales] ....index.js .._app.js .._document.js .. index.js |public ..locales ....en ......common.json ......index.md ....es ......common.json ..... .index.md |next-i18next.config.js |next.config.js
next.config.js
const { i18n } = require('./next-i18next.config'); const nextConfig = { i18n }
next-i18next.config.js
module.exports = { 'development', i18n: { defaultLocale: 'en', // locales: [ 'en', 'de', 'es',"cn"], locales: [ { name: "English", code: "en", iso: "en-US", dir: "ltr" }, { name: "español",code: "es", iso: "es-ES", dir: "ltr" }, { name: "中文",code: "zh_cn", iso: "zh-CN", dir: "ltr" }, { name: "Deutsch",code: "de", iso: "de-DE", dir: "ltr" }, { name: "Italiano",code: "it", iso: "it-IT", dir: "ltr" }, { name: "日本語",code: "ja", iso: " ja-JP", dir: "ltr" }, { name: "한국인",code: "ko", iso: "ko-KR", dir: "ltr" }, { name: "Português",code: " pt", iso: "pt-PT", dir: "ltr" }, ], }, }
對於locales的配置,考慮到對使用者展示語言選擇的場景,我沒有按照網路上大多數的配置方式。
lib/getStatic.js
import { serverSideTranslations } from "next-i18next/serverSideTranslations"; import i18nextConfig from "@/next-i18next.config"; export const getI18nPaths = () => i18nextConfig.i18n.loc. : { locale: lng.code,//add code }, })); export const getStaticPaths = () => ({ fallback: false, paths: getI18nPaths(), }); export const getI18nProps = async (ctx, ns); = ["common"]) => { const locale = ctx?.params?.locale || i18nextConfig.i18n.defaultLocale; let props = { ...(await serverSideTranslations(locale, ns)), }; return props; }; export const makeStaticProps = (ns = []) => async (ctx) => ({ props: await getI18nProps(ctx, ns), });
這是用來取得語言翻譯檔案和在服務端翻譯的邏輯。
_app.js
import { appWithTranslation } from "next-i18next"; import Layout from '../components/layout' import { NextPage } from 'next'; const MyApp = ({ Component, pageProps }) => ; export default appWithTranslation(MyApp);
注意:如果不使用可以直接將這個標籤去掉。
_docoument.js
import i18nextConfig from "@/next-i18next.config"; // 其他程式碼import Document, { Html, Head, Main, NextScript, } from 'next/document' class MyDocument extends Document { render() { const currentument' class MyDocument extends Document { render() { const currentument' class MyDocument extends Document { render() { const currentLocale = this. props.__NEXT_DATA__.query.locale || i18nextConfig.i18n.defaultLocale; console.log(currentLocale) return <html lang="{currentLocale}">
<head>
<link href="/app.css" />
<link rel="shortcut icon" href="/icon.png" />
</head>
<body>
<main />
<nextscript />
</body>
</html>; } } export default MyDocument
index.js
import Home, { getStaticProps } from "./[locale]/index"; export default Home; export { getStaticProps };
[locales]資料夾
用來實現類似www.xxx.com/es的國際化路由
public/locales資料夾
用來存放翻譯文件。
組件
語言選擇器:LangSwitcher.js
程式碼
'use client'
import React from "react";
import { useRouter } from "next/router"
import i18nextConfig from '@/next-i18next.config'
console.log(i18nextConfig.i18n.defaultLocale)
const LangSwitcher = ({ lang, ...rest}) => {
const router = useRouter();
const GetHref=(locale)=> {
console.log(locale)
let href = rest.href || router.asPath
let pName = router.pathname
Object.keys(router.query).forEach(k => {
if (k === 'locale') {
pName = pName.replace(`[${k}]`, locale)
return
}
pName = pName.replace(`[${k}]`, router.query[k])
})
if (locale == i18nextConfig.i18n.defaultLocale) {
if (pName == '/' + i18nextConfig.i18n.defaultLocale) {
href = '/'
} else {
href = `${href}`
}
} else {
if (locale) {
href = rest.href ? `/${locale}${rest.href}` : pName
}
if (href.indexOf(`/${locale}`) < 0) {
href = `/${locale}${href}`
}
}
return href
}
const LocalChanged = (value) => {
const thehref = GetHref(value)
router.push(thehref)
}
return (
<div>
🌐
<select onChange={(e) => LocalChanged(e.target.value)} defaultValue={lang} className="h-8 m-2 p-1 rounded border-current">
<option value={lang} > {GetLangData(lang).name}</option>
{i18nextConfig.i18n.locales.map(locale => {
if (locale.code === lang) return null
return (<option value={locale.code} key={locale.code}> {locale.name}</option>)
})}
</select>
</div>
)
}
//export
export function GetLangData(lang) {
var res = {}
{
i18nextConfig.i18n.locales.map(locale => {
if (locale.code === lang) {
console.log(locale)
res = locale
}
})
}
return res
}
export default LangSwitcher
使用方法:
引入組件,直接使用,並且lang參數設定為目前的語言。
import LangSwitcher from './LangSwitcher' const { i18n } = useTranslation('home');
在地化Link元件:LocLink.js
import React from "react"; import Link from "next/link"; import { useRouter } from "next/router"; import i18nextConfig from '@/next-i18next.config' const LinkComponent = ({ children, skipLocaleandling, .. .rest }) => { const router = useRouter(); const locale = rest.locale || router.query.locale || ""; console.log(router) let href = rest.href || router.asPath; console.log(href) if (href.indexOf("http") === 0) skipLocaleHandling = true; if (locale && !skipLocaleHandling) { // href = href console.log(i18nextConfig.i18n.defaultaultLoc) console. log(locale) locale==i18nextConfig.i18n.defaultLocale ? href : router.pathname.replace("[locale]", locale); } console.log(href) return (
<>
<link href="{href}" legacybehavior>
<a {...rest}>{孩子}</a>
</Link>
</>
); }; export default LinkComponent;
在地化Markdown檔案取得與渲染元件:MdRenderer.js
import ReactMarkdown from 'react-markdown' import { useState, useEffect } from "react"; import { useRouter } from "next/router" export default function MdRenderer({ path }) { const [a, setA] = useState("" ); const router = useRouter() fetch(path, { next: { revalidate: 0 } }) .then(response => response.text()) .then(data => { setA(data) } ).catch( err=>{console.log(err)}) return ( {a && ( {a} )} ) }
使用方法
t函數
- 引入“useTranslation”
- 定義t
- 使用{t('xxx')},即可
import { useTranslation } from "next-i18next"; const { t } = useTranslation(["common"]);//common.json為翻譯檔案{t("xxx")}
如何取得目前的語言
import { useTranslation } from "next-i18next"; const { i18n } = useTranslation('home'); console.log(i18n.language)
如何循環取得語言列表
取得語言列表,可以自訂語言導航。
import i18nextConfig from '@/next-i18next.config' {i18nextConfig.i18n.locales.map(locale => { if (locale.code === i18nextConfig.i18n.defaultLocale) return( {locale.name} ) const thehref="/"+locale.code return ( {locale.name} ) })}
內容段落的翻譯
如果內容是從後端取得的,那麼,這就不需要了。
但,如果內容有前端,有json裡非常麻煩,所以,可以存在markdown中,然後在需要展示這個內容的地方取得對應語言版本的markdown文件,然後解析顯示出來。
import MdRenderer from '../../components/MdRenderer'
總結
多語言,可以讓一個網站取得更多的流量。這個nextjs的多語言最佳實踐,充分考慮了SEO的需要。搜尋引擎友善。
適合做工具站、關鍵字站、新聞和內容站。