Как да внедрите интернационализация в приложение на 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 адресът на вашия уебсайт. Прочетете повече за произходите тук.

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 ключа ще могат да създават нови низове за превод. Препоръчваме да имате затворена и защитена стейджинг среда, където да тествате продукционното си приложение с такъв 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!