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

В клиентската част можете да промените бисквитката 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!