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

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

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

To integrate TacoTranslate with your application, you’ll need to create a client using the API keys from earlier. For example, create a file named /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: Имплементиране на рендиране на сървъра (server side rendering)

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 ключ и потенциално да раздуе проекта ви за превод, като добави нови, несвързани низове.

Не забравяйте да разгледате пълния пример в нашия профил в GitHub. Там ще намерите и пример как да го направите, използвайки Pages Router ! Ако срещнете някакви проблеми, не се колебайте да се свържете с нас, и с удоволствие ще ви помогнем.

TacoTranslate ви позволява автоматично да локализирате вашите React приложения бързо на и от всеки език. Започнете днес!