Documentation: t 함수 in express-intlayer

express-intlayer 패키지의 t 함수는 Express 애플리케이션에서 지역화된 응답을 제공하기 위한 핵심 유틸리티입니다. 이는 사용자의 선호 언어에 기반하여 내용을 동적으로 선택함으로써 국제화(i18n)를 간소화합니다.

개요

t 함수는 주어진 언어 세트에 대한 번역을 정의하고 검색하는 데 사용됩니다. 이는 클라이언트의 요청 설정(예: Accept-Language 헤더)에 따라 반환할 적절한 언어를 자동으로 결정합니다. 선호하는 언어가 사용 불가능한 경우, 구성에서 지정한 기본 로케일로 부드럽게 대체됩니다.

주요 기능

• 동적 지역화: 클라이언트에 가장 적합한 번역을 자동으로 선택합니다.
• 기본 로케일로의 폴백: 클라이언트의 선호 언어가 사용 가능하지 않으면 기본 로케일로 폴백하여 사용자 경험의 연속성을 보장합니다.
• 경량 및 빠름: 고성능 애플리케이션을 위해 설계되어 최소한의 오버헤드를 보장합니다.
• 엄격 모드 지원: 신뢰할 수 있는 동작을 위해 선언된 로케일 준수를 강제합니다.

함수 시그니처

t(translations: Record<string, string>): string;

매개변수

• translations: 키가 로케일 코드(예: en, fr, es-MX)이고, 값이 해당하는 번역 문자열인 객체입니다.

반환값

• 클라이언트의 선호 언어로 된 내용을 나타내는 문자열입니다.

국제화 요청 핸들러 로드하기

express-intlayer에서 제공하는 국제화 기능이 올바르게 작동하도록 하려면, 반드시 Express 애플리케이션의 시작 부분에 국제화 미들웨어를 로드해야 합니다. 이는 t 함수를 활성화하고 로케일 감지 및 번역의 적절한 처리를 보장합니다.

모든 경로가 국제화의 혜택을 누릴 수 있도록 app.use(intlayer()) 미들웨어를 모든 경로 이전에 배치해야 합니다:

import express, { type Express } from "express";import { intlayer } from "express-intlayer";const app: Express = express();// 국제화 요청 핸들러 로드하기app.use(intlayer());// 미들웨어 로드 후 경로 정의하기app.get("/", (_req, res) => {  res.send(    t({      en: "Hello, World!",      fr: "Bonjour le monde!",      es: "¡Hola, Mundo!",    })  );});

왜 필요한가

• 로케일 감지: intlayer 미들웨어는 헤더, 쿠키 또는 기타 구성된 방법에 따라 사용자의 선호 로케일을 감지하기 위해 들어오는 요청을 처리합니다.
• 번역 컨텍스트: t 함수가 올바르게 작동할 수 있도록 필요한 컨텍스트를 설정하여 번역이 올바른 언어로 반환되도록 보장합니다.
• 오류 방지: 이 미들웨어 없이 t 함수를 사용하면 필수 로케일 정보가 없기 때문에 런타임 오류가 발생합니다.

사용 예제

기본 예제

다양한 언어로 지역화된 콘텐츠 제공하기:

app.get("/", (_req, res) => {  res.send(    t({      en: "Welcome!",      fr: "Bienvenue!",      es: "¡Bienvenido!",    })  );});

클라이언트 요청:

• Accept-Language: fr를 가진 클라이언트는 Bienvenue!를 받습니다.
• Accept-Language: es를 가진 클라이언트는 ¡Bienvenido!를 받습니다.
• Accept-Language: de를 가진 클라이언트는 Welcome! (기본 로케일)를 받습니다.

오류 처리

다양한 언어로 오류 메시지 제공하기:

app.get("/error", (_req, res) => {  res.status(500).send(    t({      en: "An unexpected error occurred.",      fr: "Une erreur inattendue s'est produite.",      es: "Ocurrió un error inesperado.",    })  );});

로케일 변형 사용하기

로케일별 변형에 대한 번역 지정하기:

app.get("/greet", (_req, res) => {  res.send(    t({      en: "Hello!",      "en-GB": "Hello, mate!",      fr: "Bonjour!",      "es-MX": "¡Hola, amigo!",      "es-ES": "¡Hola!",    })  );});

고급 주제

폴백 메커니즘

선호하는 로케일이 사용 불가능한 경우, t 함수는 구성에서 정의된 기본 로케일로 폴백합니다:

import { Locales, type IntlayerConfig } from "intlayer";const config = {  internationalization: {    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],    defaultLocale: Locales.ENGLISH,  },} satisfies IntlayerConfig;export default config;

예를 들어:

• defaultLocale이 Locales.CHINESE이고 클라이언트가 Locales.DUTCH를 요청하는 경우, 반환된 번역은 Locales.CHINESE 값으로 기본값을 사용합니다.
• defaultLocale이 정의되어 있지 않으면, t 함수는 Locales.ENGLISH 값으로 폴백합니다.

엄격 모드 강제

t 함수가 선언된 로케일에 대한 엄격한 준수를 강제하도록 구성합니다:

구성 예:

import { type IntlayerConfig } from "intlayer";const config = {  // ... 기존 구성  internationalization: {    // ... 기존 국제화 구성    strictMode: "strict", // 엄격 모드 강제  },} satisfies IntlayerConfig;export default config;

TypeScript 통합

t 함수는 TypeScript와 함께 사용할 때 타입 안전합니다. 타입 안전한 번역 객체를 정의합니다:

import { type LanguageContent } from "express-intlayer";const translations: LanguageContent<string> = {  en: "Good morning!",  fr: "Bonjour!",  es: "¡Buenos días!",};app.get("/morning", (_req, res) => {  res.send(t(translations));});

일반적인 오류 및 문제 해결

효과적인 사용을 위한 팁

1. 번역 중앙화: 번역 관리를 위해 중앙 집중식 모듈이나 JSON 파일을 사용하여 유지 보수성을 향상시킵니다.
2. 번역 검증: 모든 언어 변형이 해당하는 번역을 갖추고 있는지 확인하여 불필요한 폴백을 방지합니다.
3. 프론트엔드 i18n과 결합: 앱 전반에 걸쳐 원활한 사용자 경험을 위해 프론트엔드 국제화와 동기화합니다.
4. 성능 벤치마킹: 번역 추가 시 앱의 응답 시간을 테스트하여 최소한의 영향을 확보합니다.

결론

t 함수는 백엔드 국제화를 위한 강력한 도구입니다. 이를 효과적으로 사용함으로써 글로벌 청중을 위한 보다 포용적이고 사용자 친화적인 애플리케이션을 만들 수 있습니다. 고급 사용 및 자세한 구성 옵션에 대해서는 문서를 참조하세요.