Как да внедрите интернационализация в 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: Кодът на подразбиращия се локал (fallback). В този пример ще го зададем на en за английски.
• TACOTRANSLATE_ORIGIN: „Папката“, в която ще се съхраняват вашите низове, например URL адресът на вашия уебсайт. Прочетете повече за origin-ите тук.

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 в съответствие с документацията за Middleware на Next.js.

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

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

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