بهترین راه‌حل برای بین‌المللی‌سازی (i18n) در اپلیکیشن‌های Next.js

نحوه کار

با جهانی‌تر شدن جهان، برای توسعه‌دهندگان وب روزبه‌روز مهم‌تر می‌شود که برنامه‌هایی بسازند که بتوانند نیازهای کاربران از کشورهای و فرهنگ‌های مختلف را برآورده کنند. یکی از راه‌های کلیدی برای رسیدن به این هدف، بین‌المللی‌سازی (i18n) است که به شما اجازه می‌دهد برنامه‌تان را با زبان‌ها، ارزها و فرمت‌های تاریخ مختلف سازگار کنید.

در این آموزش، نحوه افزودن بین‌المللی‌سازی به برنامه React Next.js خود، همراه با رندر سمت سرور، را بررسی خواهیم کرد. TL;DR: کل مثال را اینجا ببینید.

این راهنما برای برنامه‌های Next.js است که از Pages Router استفاده می‌کنند.
اگر از App Router استفاده می‌کنید، لطفاً به این راهنما مراجعه کنید.

مرحلهٔ ۱: یک کتابخانهٔ i18n را نصب کنید

برای پیاده‌سازی بین‌المللی‌سازی در برنامه Next.js خود، ابتدا یک کتابخانه i18n انتخاب خواهیم کرد. چندین کتابخانه محبوب وجود دارند، از جمله next-intl. با این حال، در این مثال، ما از TacoTranslate استفاده خواهیم کرد.

TacoTranslate به‌طور خودکار رشته‌های شما را با استفاده از هوش مصنوعی پیشرفته به هر زبانی ترجمه می‌کند و شما را از مدیریت زمان‌بر فایل‌های JSON بی‌نیاز می‌سازد.

بیایید آن را با استفاده از npm در ترمینال نصب کنیم:

npm install tacotranslate

مرحلهٔ ۲: یک حساب رایگان TacoTranslate ایجاد کنید

اکنون که ماژول را نصب کرده‌اید، وقت آن است که حساب TacoTranslate خود، یک پروژه ترجمه و کلیدهای API مرتبط را ایجاد کنید. اینجا یک حساب کاربری بسازید. رایگان است و نیازی به وارد کردن کارت اعتباری ندارد.

در رابط کاربری برنامهٔ TacoTranslate، یک پروژه ایجاد کنید و به زبانهٔ کلیدهای API آن بروید. یک کلید read و یک کلید read/write بسازید. ما آن‌ها را به‌عنوان متغیرهای محیطی ذخیره خواهیم کرد. کلید read همان چیزی است که ما آن را public می‌نامیم و کلید read/write secret است. برای مثال، می‌توانید آن‌ها را در یک فایل .env در ریشهٔ پروژه‌تان اضافه کنید.

TACOTRANSLATE_PUBLIC_API_KEY=123456
TACOTRANSLATE_SECRET_API_KEY=789010

حتماً هرگز کلید API محرمانه read/write را در محیط‌های تولید سمتِ کاربر فاش نکنید.

همچنین دو متغیر محیطی دیگر اضافه خواهیم کرد: TACOTRANSLATE_DEFAULT_LOCALE و TACOTRANSLATE_ORIGIN.

• TACOTRANSLATE_DEFAULT_LOCALE: کد لوکال پیش‌فرض برای بازگشت. در این مثال آن را روی en برای زبان انگلیسی تنظیم می‌کنیم.
• TACOTRANSLATE_ORIGIN: “پوشه”یی که رشته‌های شما در آن ذخیره خواهند شد، مانند آدرس URL وب‌سایت شما. برای اطلاعات بیشتر درباره origins اینجا را بخوانید.

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

مرحله ۳: راه‌اندازی 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_DEFAULT_LOCALE ?? '',
});

module.exports = tacoTranslate;

به‌زودی TACOTRANSLATE_API_KEY را به‌طور خودکار تعریف خواهیم کرد.

ایجاد کلاینت در یک فایل جداگانه استفادهٔ مجدد آن را در آینده آسان‌تر می‌کند. اکنون با استفاده از یک /pages/_app.tsx سفارشی، ارائه‌دهندهٔ TacoTranslate را اضافه خواهیم کرد.

import React from 'react';
import {type AppProps} from 'next/app';
import {type Origin, type Locale, type Localizations} from 'tacotranslate';
import TacoTranslate from 'tacotranslate/react';
import TacoTranslateHead from 'tacotranslate/next/head';
import tacoTranslate from '../tacotranslate-client';

type PageProperties = {
	origin: Origin;
	locale: Locale;
	locales: Locale[];
	localizations: Localizations;
};

export default function App({Component, pageProps}: AppProps<PageProperties>) {
	const {origin, locale, locales, localizations} = pageProps;

	return (
		<TacoTranslate
			client={tacoTranslate}
			origin={origin}
			locale={locale}
			localizations={localizations}
		>
			<TacoTranslateHead rootUrl="https://your-website.com" locales={locales} />
			<Component {...pageProps} />
		</TacoTranslate>
	);
}

اگر قبلاً pageProps و _app.tsx سفارشی دارید، لطفاً تعریف را با ویژگی‌ها و کدهای ذکر شده در بالا گسترش دهید.

مرحله ۴: پیاده‌سازی رندر سمت سرور

TacoTranslate امکان رندر سمت سرور ترجمه‌های شما را فراهم می‌کند. این موضوع تجربهٔ کاربری را به‌طور قابل توجهی بهبود می‌بخشد زیرا محتوای ترجمه‌شده را فوراً نمایش می‌دهد، به‌جای اینکه ابتدا برای مدت کوتاهی محتوای ترجمه‌نشده نمایش داده شود. علاوه بر این، می‌توانیم درخواست‌های شبکه‌ای از سمت کلاینت را حذف کنیم، زیرا همهٔ ترجمه‌های مورد نیاز را از قبل در اختیار داریم.

ما با ایجاد یا اصلاح /next.config.js شروع می‌کنیم.

const withTacoTranslate = require('tacotranslate/next/config').default;
const tacoTranslateClient = require('./tacotranslate-client');

module.exports = async () => {
	const config = {};

	return withTacoTranslate(config, {
		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'),
	});
};

بررسی isProduction را متناسب با تنظیمات خود تغییر دهید. اگر true باشد، TacoTranslate کلید API عمومی را نمایش می‌دهد. اگر در یک محیط محلی، آزمایشی یا پیش‌تولید باشیم (isProduction is false)، از کلید API محرمانه read/write استفاده خواهیم کرد تا مطمئن شویم رشته‌های جدید برای ترجمه ارسال می‌شوند.

تا کنون ما تنها اپلیکیشن Next.js را با فهرستی از زبان‌های پشتیبانی‌شده تنظیم کرده‌ایم. گام بعدی واکشی ترجمه‌ها برای همهٔ صفحات شماست. برای انجام این کار، بسته به نیازتان از یکی از getTacoTranslateStaticProps یا getTacoTranslateServerSideProps استفاده خواهید کرد.

این توابع سه آرگومان می‌گیرند: یک شی Next.js Static Props Context, پیکربندی برای TacoTranslate، و خصوصیات اختیاری Next.js. توجه داشته باشید که مقدار revalidate در getTacoTranslateStaticProps به‌طور پیش‌فرض روی 60 تنظیم شده است، بنابراین ترجمه‌های شما به‌روز باقی می‌مانند.

برای استفاده از هر یک از این توابع در یک صفحه، فرض کنیم فایل صفحه‌ای مانند /pages/hello-world.tsx دارید.

import {Translate} from 'tacotranslate/react';
import getTacoTranslateStaticProps from 'tacotranslate/next/get-static-props';
import tacoTranslateClient from '../tacotranslate-client';

export async function getStaticProps(context) {
	return getTacoTranslateStaticProps(context, {client: tacoTranslateClient});
}

export default function Page() {
	return <Translate string="Hello, world!"/>;
}

اکنون باید بتوانید از کامپوننت Translate برای ترجمهٔ رشته‌ها در تمام کامپوننت‌های React خود استفاده کنید.

import {Translate} from 'tacotranslate/react';

function Component() {
	return <Translate string="Hello, world!"/>
}

مرحله ۵: استقرار و آزمایش!

تمام شد! اپلیکیشن Next.js شما اکنون به‌صورت خودکار وقتی هر رشته‌ای را به یک 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 App 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!