Hur man implementerar internationalisering i en Next.js-applikation som använder App Router

I takt med att världen blir mer globaliserad blir det allt viktigare för webbutvecklare att bygga applikationer som kan tillgodose användare från olika länder och kulturer. Ett av de viktigaste sätten att uppnå detta är genom internationalisering (i18n), vilket gör att du kan anpassa din applikation till olika språk, valutor och datumformat.

I denna artikel kommer vi att utforska hur du lägger till internationalisering i din React Next.js-applikation, med server-side rendering. TL;DR: Se hela exemplet här.

Denna guide är för Next.js-applikationer som använder App Router.
Om du använder Pages Router, se istället denna guide.

Steg 1: Installera ett i18n-bibliotek

För att implementera internationalisering i din Next.js-applikation väljer vi först ett i18n-bibliotek. Det finns flera populära bibliotek, inklusive next-intl. I detta exempel kommer vi dock att använda TacoTranslate.

TacoTranslate översätter automatiskt dina strängar till valfritt språk med hjälp av banbrytande AI och befriar dig från det tidskrävande arbetet med att hantera JSON-filer.

Låt oss installera det med npm i din terminal:

npm install tacotranslate

Steg 2: Skapa ett gratis TacoTranslate-konto

Nu när du har installerat modulen är det dags att skapa ditt TacoTranslate-konto, ett översättningsprojekt och tillhörande API-nycklar. Skapa ett konto här. Det är gratis och kräver inte att du lägger till ett kreditkort.

Inom TacoTranslate-applikationens användargränssnitt skapar du ett projekt och navigerar till fliken för API-nycklar. Skapa en read nyckel och en read/write nyckel. Vi sparar dem som miljövariabler. read nyckeln kallar vi public och read/write nyckeln är secret. Till exempel kan du lägga till dem i en .env fil i roten av ditt projekt.

TACOTRANSLATE_PUBLIC_API_KEY=123456
TACOTRANSLATE_SECRET_API_KEY=789010

Se till att aldrig läcka den hemliga read/write API-nyckeln till klient-sida produktionsmiljöer.

Vi kommer också att lägga till två miljövariabler till: TACOTRANSLATE_DEFAULT_LOCALE och TACOTRANSLATE_ORIGIN.

• TACOTRANSLATE_DEFAULT_LOCALE: Den förvalda standardvärdeslokalkoden. I detta exempel sätter vi den till en för engelska.
• TACOTRANSLATE_ORIGIN: Den “mapp” där dina strängar kommer att lagras, till exempel URL:en till din webbplats. Läs mer om origins här.

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

Steg 3: Konfigurera TacoTranslate

För att integrera TacoTranslate med din applikation behöver du skapa en klient med API-nycklarna från tidigare. Skapa till exempel en fil med namnet /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;

Vi kommer automatiskt att definiera TACOTRANSLATE_API_KEY och TACOTRANSLATE_PROJECT_LOCALE inom kort.

Att skapa klienten i en separat fil gör det enkelt att använda den igen senare. getLocales är bara en hjälpfunktion med inbyggd felhantering. Skapa nu en fil med namnet /app/[locale]/tacotranslate.tsx, där vi kommer att implementera TacoTranslate providern.

'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>
	);
}

Observera 'use client'; som indikerar att detta är en klientkomponent.

Med contextprovidern nu redo, skapa en fil med namnet /app/[locale]/layout.tsx, rotlayouten i vår applikation. Notera att denna sökväg har en mapp som använder Dynamic Routes, där [locale] är den dynamiska parametern.

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>
	);
}

Det första att notera här är att vi använder vår Dynamic Route parameter [locale] för att hämta översättningar för det språket. Dessutom säkerställer generateStaticParams att alla locale-koder du har aktiverat för ditt projekt för-renderas.

Nu ska vi bygga vår första sida! Skapa en fil med namnet /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!" />
	);
}

Observera variabeln revalidate som talar om för Next.js att bygga om sidan efter 60 sekunder och hålla dina översättningar uppdaterade.

Steg 4: Implementera server-side rendering

TacoTranslate stödjer server-side rendering. Detta förbättrar användarupplevelsen avsevärt genom att visa översatt innehåll omedelbart, istället för en blinkning av oöversatt innehåll först. Dessutom kan vi hoppa över nätverksförfrågningar på klienten, eftersom vi redan har de översättningar vi behöver för sidan användaren tittar på.

För att ställa in server-side rendering, skapa eller ändra /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};
};

Ändra isProduction kontrollen så att den passar din konfiguration. Om true används, kommer TacoTranslate att använda den publika API-nyckeln. Om vi är i en lokal, test- eller staging-miljö (isProduction is false) använder vi den hemliga read/write API-nyckeln för att säkerställa att nya strängar skickas för översättning.

För att säkerställa att routing och omdirigering fungerar som förväntat behöver vi skapa en fil med namnet /middleware.ts. Genom att använda Middleware kan vi omdirigera användare till sidor som visas på deras föredragna språk.

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);
}

Se till att ställa in matcher i enlighet med Next.js Middleware-dokumentation.

På klienten kan du ändra locale cookie för att ändra användarens föredragna språk. Se det kompletta exempel-koden för idéer om hur du gör detta!

Steg 5: Distribuera och testa!

Vi är klara! Din React-applikation kommer nu att automatiskt översättas när du lägger till några strängar i en Translate komponent. Observera att endast miljöer med read/write behörigheter för API-nyckeln kommer att kunna skapa nya strängar för översättning. Vi rekommenderar att du har en sluten och säker staging-miljö där du kan testa din produktionsapplikation med en sådan API-nyckel, och lägga till nya strängar innan du går live. Detta förhindrar att någon stjäl din hemliga API-nyckel och potentiellt fyller på ditt översättningsprojekt med nya, orelaterade strängar.

Se till att kolla in det kompletta exemplet på vår GitHub-profil. Där hittar du också ett exempel på hur du gör detta med Pages Router! Om du stöter på några problem, tveka inte att höra av dig, så hjälper vi dig mer än gärna.

TacoTranslate låter dig automatiskt lokalisera dina React-applikationer snabbt till och från vilket språk som helst. Kom igång idag!