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

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

В тази статия ще разгледаме как да добавите интернационализация към вашето React Next.js приложение с помощта на server side rendering. 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 адреса на вашия уебсайт. Прочетете повече за 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!