Как да внедрите интернационализация в Next.js приложение, което използва App Router

С нарастващата глобализация на света, става все по-важно за уеб разработчиците да създават приложения, които могат да отговорят на нуждите на потребители от различни страни и култури. Един от ключовите начини за постигане на това е чрез интернационализация (i18n), която ви позволява да адаптирате вашето приложение към различни езици, валути и формати на датите.

В тази статия ще разгледаме как да добавите интернационализация към вашето React Next.js приложение, с използване на сървърно рендиране. TL;DR: Вижте пълния пример тук.

Това ръководство е за Next.js приложения, които използват App Router.
Ако използвате Pages Router, вижте това ръководство вместо това.

Стъпка 1: Инсталирайте i18n библиотека

За да внедрим интернационализация в приложението ви на Next.js, първо ще изберем i18n библиотека. Съществуват няколко популярни библиотеки, включително next-intl. В този пример обаче ще използваме TacoTranslate.

TacoTranslate автоматично превежда вашите низове на всеки език, използвайки съвременен ИИ, и ви освобождава от досадното управление на JSON файлове.

Нека го инсталираме чрез npm в терминала ви:

npm install tacotranslate

Стъпка 2: Създайте безплатен акаунт в TacoTranslate

Сега, когато модулът е инсталиран, е време да създадете своя TacoTranslate акаунт, проект за превод и свързаните с него API ключове. Създайте акаунт тук. Това е безплатно и не изисква добавяне на кредитна карта.

В потребителския интерфейс на приложението TacoTranslate създайте проект и отидете в раздела с API ключове. Създайте един read ключ и един read/write ключ. Ще ги запазим като променливи на средата. read ключът е това, което наричаме public, а read/write ключът е secret. Например, може да ги добавите във файл .env в корена на вашия проект.

TACOTRANSLATE_PUBLIC_API_KEY=123456
TACOTRANSLATE_SECRET_API_KEY=789010

Уверете се, че никога не излагате секретния read/write API ключ в клиентска продукционна среда.

Също така ще добавим още две променливи на средата: TACOTRANSLATE_DEFAULT_LOCALE и TACOTRANSLATE_ORIGIN.

• TACOTRANSLATE_DEFAULT_LOCALE: Кодът на езика по подразбиране, който се използва при резервиране. В този пример, ще го зададем на en за английски.
• TACOTRANSLATE_ORIGIN: "Папката", в която ще се съхраняват вашите низове, като например URL адреса на вашия уебсайт. Прочетете повече за origins тук.

TACOTRANSLATE_DEFAULT_LOCALE=en
TACOTRANSLATE_ORIGIN=your-website-url.com

Стъпка 3: Настройване на TacoTranslate

За да интегрирате TacoTranslate с вашето приложение, ще трябва да създадете клиент, използвайки API ключовете от по-рано. Например, създайте файл с име /tacotranslate-client.js.

const {default: createTacoTranslateClient} = require('tacotranslate');

const tacoTranslate = createTacoTranslateClient({
	apiKey:
		process.env.TACOTRANSLATE_SECRET_API_KEY ??
		process.env.TACOTRANSLATE_PUBLIC_API_KEY ??
		process.env.TACOTRANSLATE_API_KEY,
	projectLocale:
		process.env.TACOTRANSLATE_IS_PRODUCTION === 'true'
			? process.env.TACOTRANSLATE_PROJECT_LOCALE
			: undefined,
});

module.exports = tacoTranslate;

Ще дефинираме автоматично TACOTRANSLATE_API_KEY и TACOTRANSLATE_PROJECT_LOCALE съвсем скоро.

Създаването на клиента в отделен файл улеснява повторната му употреба по-късно. getLocales е просто помощна функция с вградено обработване на грешки. Сега създайте файл на име /app/[locale]/tacotranslate.tsx, където ще имплементираме доставчика на TacoTranslate.

'use client';

import React, {type ReactNode} from 'react';
import {
	type TranslationContextProperties,
	TacoTranslate as ImportedTacoTranslate,
} from 'tacotranslate/react';
import tacoTranslateClient from '@/tacotranslate-client';

export default function TacoTranslate({
	locale,
	origin,
	localizations,
	children,
}: TranslationContextProperties & {
	readonly children: ReactNode;
}) {
	return (
		<ImportedTacoTranslate
			client={tacoTranslateClient}
			locale={locale}
			origin={origin}
			localizations={localizations}
		>
			{children}
		</ImportedTacoTranslate>
	);
}

Обърнете внимание на 'use client';, което показва, че това е клиентски компонент.

Сега, когато доставчикът на контекст е готов, създайте файл с име /app/[locale]/layout.tsx, основният layout в нашето приложение. Обърнете внимание, че този път съдържа папка, използваща Dynamic Routes, където [locale] е динамичният параметър.

import React, {type ReactNode} from 'react';
import {type Locale, isRightToLeftLocaleCode} from 'tacotranslate';
import './global.css';
import tacoTranslateClient from '@/tacotranslate-client';
import TacoTranslate from './tacotranslate';

export async function generateStaticParams() {
	const locales = await tacoTranslateClient.getLocales();
	return locales.map((locale) => ({locale}));
}

type RootLayoutParameters = {
	readonly params: Promise<{locale: Locale}>;
	readonly children: ReactNode;
};

export default async function RootLayout({params, children}: RootLayoutParameters) {
	const {locale} = await params;
	const origin = process.env.TACOTRANSLATE_ORIGIN;
	const localizations = await tacoTranslateClient.getLocalizations({
		locale,
		origins: [origin /* , other origins to fetch */],
	});

	return (
		<html lang={locale} dir={isRightToLeftLocaleCode(locale) ? 'rtl' : 'ltr'}>
			<body>
				<TacoTranslate
					locale={locale}
					origin={origin}
					localizations={localizations}
				>
					{children}
				</TacoTranslate>
			</body>
		</html>
	);
}

Първото, което трябва да отбележим тук, е че използваме нашия Dynamic Route параметър [locale] за извличане на преводи за този език. Освен това, generateStaticParams се уверява, че всички кодове на локали, които сте активирали за вашия проект, са предварително рендирани.

Сега, нека създадем първата си страница! Създайте файл с име /app/[locale]/page.tsx.

import React from 'react';
import {Translate} from 'tacotranslate/react';

export const revalidate = 60;
export default async function Page() {
	return (
		<Translate string="Hello, world!" />
	);
}

Обърнете внимание на променливата revalidate, която казва на Next.js да преизгради страницата след 60 секунди и да поддържа преводите ви актуални.

Стъпка 4: Изпълнение на рендериране от страна на сървъра

TacoTranslate поддържа сървърно рендиране. Това значително подобрява потребителското изживяване, като показва преведено съдържание веднага, вместо първо мигащо непреведено съдържание. Освен това, можем да пропуснем мрежовите заявки на клиента, тъй като вече разполагаме с необходимите преводи за страницата, която потребителят разглежда.

За да настроите рендиране на сървърната страна, създайте или модифицирайте /next.config.js:

const withTacoTranslate = require('tacotranslate/next/config').default;
const tacoTranslateClient = require('./tacotranslate-client');

module.exports = async () => {
	const config = await withTacoTranslate(
		{},
		{
			client: tacoTranslateClient,
			isProduction:
				process.env.TACOTRANSLATE_ENV === 'production' ||
				process.env.VERCEL_ENV === 'production' ||
				(!(process.env.TACOTRANSLATE_ENV || process.env.VERCEL_ENV) &&
					process.env.NODE_ENV === 'production'),
		}
	);

	// NOTE: Remove i18n from config when using the app router
	return {...config, i18n: undefined};
};

Променете проверката на isProduction , за да отговаря на вашата настройка. Ако true, TacoTranslate ще покаже публичния API ключ. Ако сме в локална, тестова или етапна среда (isProduction is false), ще използваме ключа за тайни read/write API, за да се уверим, че новите низове се изпращат за превод.

За да гарантираме, че маршрутизирането и пренасочването работят както се очаква, ще трябва да създадем файл на име /middleware.ts. Използвайки Middleware, можем да пренасочваме потребителите към страници, представени на предпочитания от тях език.

import {type NextRequest} from 'next/server';
import {middleware as tacoTranslateMiddleware} from 'tacotranslate/next';
import tacoTranslate from '@/tacotranslate-client';

export const config = {
	matcher: ['/((?!api|_next|favicon.ico).*)'],
};

export async function middleware(request: NextRequest) {
	return tacoTranslateMiddleware(tacoTranslate, request);
}

Уверете се, че сте настроили matcher в съответствие с документацията за Next.js Middleware.

От страна на клиента, можете да промените бисквитката locale за да смените предпочитания от потребителя език. Моля, вижте пълния примерен код за идеи как да го направите!

Стъпка 5: Деплойвайте и тествайте!

Готови сме! Вашето React приложение сега ще се превежда автоматично, когато добавите някакви низове в Translate компонент. Обърнете внимание, че само среди с read/write разрешения на API ключа ще могат да създават нови низове за превод. Препоръчваме да имате затворена и защитена staging среда, където да тествате вашето продукционно приложение с такъв API ключ, добавяйки нови низове преди да го пуснете на живо. Това ще предотврати някой да открадне вашия секретен API ключ и потенциално да раздуе преводаческия ви проект с нови, нерелевантни низове.

Be sure to check out the complete example over at our GitHub profile. There, you’ll also find an example of how to do this using the Pages Router! If you encounter any problems, feel free to reach out, and we’ll be more than happy to help.

TacoTranslate lets you automatically localize your React applications quickly to and from over 75 languages. Get started today!