Intlayer를 사용하여 Next.js 16 웹사이트 번역하기

GitHub에서 애플리케이션 템플릿 및 로케일 경로 없는 애플리케이션 템플릿을 확인하세요.

목차

대안보다 Intlayer를 선택해야 하는 이유는 무엇입니까?

'next-intl' 또는 'i18next'와 같은 주요 솔루션과 비교할 때 Intlayer는 다음과 같은 통합 최적화 기능을 제공하는 솔루션입니다.

Next.js 애플리케이션에서 Intlayer 설정 단계별 가이드

1. 1

   의존성 설치

   npm을 사용하여 필요한 패키지를 설치하세요:

   bash

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   npx intlayer init --interactive
   

   --interactive 플래그는 선택 사항입니다. AI 에이전트인 경우 intlayer-cli init를 사용하세요.

   이 명령은 환경을 감지하고 필요한 패키지를 설치합니다. 예를 들어:

   bash

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   npm install intlayer next-intlayer
   

   • intlayer

     구성 관리, 번역, 콘텐츠 선언, 트랜스파일링 및 CLI 명령어를 위한 국제화 도구를 제공하는 핵심 패키지입니다.

   • next-intlayer

     Intlayer를 Next.js와 통합하는 패키지입니다. Next.js 국제화를 위한 컨텍스트 프로바이더와 훅을 제공합니다. 또한, Intlayer를 Webpack 또는 Turbopack과 통합하기 위한 Next.js 플러그인과 사용자의 선호 로케일 감지, 쿠키 관리, URL 리디렉션 처리를 위한 프록시도 포함되어 있습니다.

2. 2

   프로젝트 구성

   애플리케이션이 지역화된 URL 경로(예: /ko/about, /en/about)를 사용할지, 아니면 경로에 로케일 세그먼트 없이 콘텐츠를 제공할지(예: /about, 쿠키, 헤더 또는 쿼리 파라미터를 통해 감지) 선택하세요.

   로케일 경로 있음로케일 경로 없음

   아키텍처

   이 아키텍처에서는 지역화된 모든 페이지가 [locale] 동적 라우트 세그먼트 아래에 중첩됩니다. 각 언어마다 고유한 전용 URL이 제공되므로 SEO 및 정적 렌더링에 권장됩니다:

   bash

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   .
   ├── src
   │   ├── app
   │   │   ├── [locale]
   │   │   │   ├── layout.tsx            # Intlayer 프로바이더를 위한 로케일 레이아웃
   │   │   │   ├── page.content.ts
   │   │   │   └── page.tsx
   │   │   └── layout.tsx                # 스타일 및 전역 프로바이더를 위한 루트 레이아웃
   │   ├── components
   │   │   ├── client-component-example.content.ts
   │   │   ├── ClientComponentExample.tsx
   │   │   ├── LocaleSwitcher
   │   │   │   ├── localeSwitcher.content.ts
   │   │   │   └── LocaleSwitcher.tsx
   │   │   ├── server-component-example.content.ts
   │   │   └── ServerComponentExample.tsx
   │   └── proxy.ts
   ├── intlayer.config.ts
   ├── next.config.ts
   ├── package.json
   └── tsconfig.json
   

   설정

   애플리케이션에서 지원하는 언어를 선언하기 위해 intlayer.config.ts 설정 파일을 생성합니다:

   intlayer.config.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { Locales, type IntlayerConfig } from "intlayer";
   
   const config: IntlayerConfig = {
     internationalization: {
       locales: [
         Locales.ENGLISH,
         Locales.FRENCH,
         Locales.SPANISH,
         // 다른 로케일들
       ],
       defaultLocale: Locales.ENGLISH,
     },
     routing: {
       mode: "prefix-no-default", // 또는 `prefix-all`
     },
   };
   
   export default config;
   

   아키텍처

   이 아키텍처에서는 라우트의 URL 경로에 [locale] 동적 세그먼트가 포함되지 않습니다. 모든 페이지는 src/app/ 바로 아래에 위치하며 쿠키, 헤더 또는 쿼리 매개변수를 통해 로케일이 결정됩니다. 대시보드, 사내 도구 또는 인증된 앱에 적합합니다:

   bash

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   .
   ├── src
   │   ├── app
   │   │   ├── layout.tsx
   │   │   ├── page.content.ts
   │   │   └── page.tsx
   │   ├── components
   │   │   ├── clientComponentExample
   │   │   │   ├── client-component-example.content.ts
   │   │   │   └── ClientComponentExample.tsx
   │   │   ├── localeSwitcher
   │   │   │   ├── localeSwitcher.content.ts
   │   │   │   └── LocaleSwitcher.tsx
   │   │   └── serverComponentExample
   │   │       ├── server-component-example.content.ts
   │   │       └── ServerComponentExample.tsx
   │   └── proxy.ts
   ├── intlayer.config.ts
   ├── next.config.ts
   ├── package.json
   └── tsconfig.json
   

   설정

   경로 접두사 없이 콘텐츠를 제공하려면 routing.mode 속성을 "search-params"(예: /about?locale=ko) 또는 "no-prefix"로 설정하세요:

   intlayer.config.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { Locales, type IntlayerConfig } from "intlayer";
   
   const config: IntlayerConfig = {
     internationalization: {
       locales: [
         Locales.ENGLISH,
         Locales.FRENCH,
         Locales.SPANISH,
         // 다른 로케일들
       ],
       defaultLocale: Locales.ENGLISH,
     },
     routing: {
       mode: "search-params", // 또는 `no-prefix` - 미들웨어 감지에 유용함
     },
   };
   
   export default config;
   

   이 구성 파일을 통해 지역화된 URL, 프록시 리디렉션, 쿠키 이름, 콘텐츠 선언의 위치 및 확장자 설정, 콘솔에서 Intlayer 로그 비활성화 등 다양한 설정을 할 수 있습니다. 사용 가능한 모든 매개변수 목록은 구성 문서를 참조하세요.

   구성 문서
3. 3

   Next.js 구성에 Intlayer 통합하기

   Next.js 설정을 Intlayer와 함께 사용하도록 구성합니다:

   next.config.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { NextConfig } from "next";
   import { withIntlayer } from "next-intlayer/server";
   
   const nextConfig: NextConfig = {/* 여기에 구성 옵션을 입력하세요 */};
   
   export default withIntlayer(nextConfig);
   

   withIntlayer() Next.js 플러그인은 Intlayer를 Next.js와 통합하는 데 사용됩니다. 이 플러그인은 콘텐츠 선언 파일의 빌드를 보장하고 개발 모드에서 이를 모니터링합니다. 또한 Webpack 또는 Turbopack 환경 내에서 Intlayer 환경 변수를 정의합니다. 추가로, 성능 최적화를 위한 별칭(alias)을 제공하며 서버 컴포넌트와의 호환성을 보장합니다.

   withIntlayer() 함수는 프로미스 함수입니다. 빌드가 시작되기 전에 Intlayer 사전을 준비할 수 있게 해줍니다. 다른 플러그인과 함께 사용하려면 await할 수 있습니다. 예시:

   ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   const nextConfig = await withIntlayer(nextConfig);
   const nextConfigWithOtherPlugins = withOtherPlugins(nextConfig);
   
   export default nextConfigWithOtherPlugins;
   

   동기적으로 사용하고 싶다면 withIntlayerSync() 함수를 사용할 수 있습니다. 예시:

   ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   const nextConfig = withIntlayerSync(nextConfig);
   const nextConfigWithOtherPlugins = withOtherPlugins(nextConfig);
   
   export default nextConfigWithOtherPlugins;
   

   Intlayer는 명령줄 플래그 --webpack, --turbo 또는 --turbopack뿐만 아니라 현재 Next.js 버전을 기반으로 프로젝트가 webpack 또는 Turbopack을 사용하고 있는지 자동으로 감지합니다.

   next>=16부터 Rspack을 사용하는 경우, Turbopack을 비활성화하여 Intlayer가 webpack 구성을 사용하도록 명시적으로 강제해야 합니다:

   ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   withRspack(withIntlayer(nextConfig, { enableTurbopack: false }));
   

4. 4

   동적 로케일 경로 정의

   로케일 경로 있음로케일 경로 없음

   RootLayout의 모든 내용을 제거하고 다음 코드로 교체하세요:

   src/app/layout.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { PropsWithChildren, FC } from "react";
   import "./globals.css";
   
   const RootLayout: FC<PropsWithChildren> = ({ children }) => (
     // 여전히 `next-themes`, `react-query`, `framer-motion` 등과 같은 다른 프로바이더로 children을 감쌀 수 있습니다.
     <>{children}</>
   );
   
   export default RootLayout;
   

   RootLayout 컴포넌트를 비워두면 <html> 태그에 lang 및 dir 속성을 설정할 수 있습니다.

   동적 라우팅을 구현하려면 [locale] 디렉토리에 새 레이아웃을 추가하여 로케일 경로를 제공하세요:

   Intlayer >=9.4Intlayer <9.4

   src/app/[locale]/layout.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { type NextLayoutIntlayer } from "next-intlayer";
   import { IntlayerProvider } from "next-intlayer/server";
   import { Inter } from "next/font/google";
   import { getHTMLTextDir } from "intlayer";
   
   const inter = Inter({ subsets: ["latin"] });
   
   const LocaleLayout: NextLayoutIntlayer = async ({ children, params }) => {
     const { locale } = await params;
     return (
       <html lang={locale} dir={getHTMLTextDir(locale)}>
         <body className={inter.className}>
           <IntlayerProvider locale={locale}>{children}</IntlayerProvider>
         </body>
       </html>
     );
   };
   
   export default LocaleLayout;
   

   단일 IntlayerProvider는 트리의 양쪽 절반을 모두 다룹니다: 서버 훅에서 읽는 요청 범위 서버 컨텍스트를 시드하고, 클라이언트 컴포넌트가 동일한 로케일을 받도록 클라이언트 공급자를 마운트합니다.

   src/app/[locale]/layout.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { type NextLayoutIntlayer, IntlayerClientProvider } from "next-intlayer";
   import { Inter } from "next/font/google";
   import { getHTMLTextDir } from "intlayer";
   
   const inter = Inter({ subsets: ["latin"] });
   
   const LocaleLayout: NextLayoutIntlayer = async ({ children, params }) => {
     const { locale } = await params;
     return (
       <html lang={locale} dir={getHTMLTextDir(locale)}>
         <body className={inter.className}>
           <IntlayerClientProvider locale={locale}>
             {children}
           </IntlayerClientProvider>
         </body>
       </html>
     );
   };
   
   export default LocaleLayout;
   

   [locale] 경로 세그먼트는 로케일을 정의하는 데 사용됩니다. 예: /en-US/about는 en-US를 가리키고 /fr/about는 fr를 가리킵니다.

   이 단계에서 Error: Missing <html> and <body> tags in the root layout. 오류가 발생할 수 있습니다. 이는 /app/page.tsx 파일이 더 이상 사용되지 않으며 삭제할 수 있기 때문에 예상되는 현상입니다. 대신, [locale] 경로 세그먼트가 /app/[locale]/page.tsx 페이지를 활성화합니다. 따라서 브라우저에서 /en, /fr, /es와 같은 경로를 통해 페이지에 접근할 수 있습니다. 기본 로케일을 루트 페이지로 설정하려면 7단계의 proxy 설정을 참조하세요.

   그런 다음, 애플리케이션 Layout에서 generateStaticParams 함수를 구현하세요.

   src/app/[locale]/layout.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   export { generateStaticParams } from "next-intlayer"; // 삽입할 라인
   
   const LocaleLayout: NextLayoutIntlayer = async ({ children, params }) => {
     /*... 나머지 코드 */
   };
   
   export default LocaleLayout;
   

   generateStaticParams는 애플리케이션이 모든 로케일에 대해 필요한 페이지를 사전 빌드하도록 보장하여 런타임 계산을 줄이고 사용자 경험을 향상시킵니다. 자세한 내용은 Next.js의 generateStaticParams 문서를 참조하세요.

   Intlayer는 export const dynamic = 'force-static';와 함께 작동하여 모든 로케일에 대해 페이지가 사전 빌드되도록 보장합니다.

   로케일 경로가 없는 아키텍처에서는 [locale] 디렉터리가 없습니다. 요청 컨텍스트에서 로케일을 읽고 애플리케이션을 IntlayerProvider로 래핑하도록 src/app/layout.tsx를 직접 구성하세요:

   Intlayer >=9.4

   src/app/layout.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { Metadata } from "next";
   import type { ReactNode } from "react";
   import "./globals.css";
   import { getHTMLTextDir, getIntlayer } from "intlayer";
   import { getLocale, IntlayerProvider } from "next-intlayer/server";
   export { generateStaticParams } from "next-intlayer";
   
   export const generateMetadata = async (): Promise<Metadata> => {
     const locale = await getLocale();
     const { title, description, keywords } = getIntlayer("metadata", locale);
   
     return {
       title,
       description,
       keywords,
     };
   };
   
   const RootLayout = async ({
     children,
   }: Readonly<{
     children: ReactNode;
   }>) => {
     const locale = await getLocale();
   
     return (
       <html lang={locale} dir={getHTMLTextDir(locale)}>
         <body>
           <IntlayerProvider locale={locale}>{children}</IntlayerProvider>
         </body>
       </html>
     );
   };
   
   export default RootLayout;
   

   단일 IntlayerProvider는 트리의 두 부분을 모두 커버합니다: 서버 훅에서 읽는 request-scoped 서버 컨텍스트를 제공하고, 클라이언트 컴포넌트가 동일한 로케일을 받도록 클라이언트 provider를 마운트합니다.

   RootLayout에서 모든 내용을 제거하고 다음 코드로 교체하세요:

   src/app/layout.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { Metadata } from "next";
   import type { ReactNode } from "react";
   import "./globals.css";
   import { IntlayerProvider, LocalPromiseParams } from "next-intlayer";
   import { getHTMLTextDir, getIntlayer } from "intlayer";
   import { getLocale } from "next-intlayer/server";
   export { generateStaticParams } from "next-intlayer";
   
   export const generateMetadata = async (): Promise<Metadata> => {
     const locale = await getLocale();
     const { title, description, keywords } = getIntlayer("metadata", locale);
   
     return {
       title,
       description,
       keywords,
     };
   };
   
   const RootLayout = async ({
     children,
   }: Readonly<{
     children: ReactNode;
   }>) => {
     const locale = await getLocale();
   
     return (
       <html lang={locale} dir={getHTMLTextDir(locale)}>
         <body>
           <IntlayerProvider locale={locale}>{children}</IntlayerProvider>
         </body>
       </html>
     );
   };
   
   export default RootLayout;
   

5. 5

   콘텐츠 선언하기

   번역을 저장하기 위해 콘텐츠 선언을 생성하고 관리하세요:

   src/app/[locale]/page.content.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { t, type Dictionary } from "intlayer";
   
   const pageContent = {
     key: "page",
     content: {
       getStarted: {
         main: t({
           en: "Get started by editing",
           fr: "Commencez par éditer",
           es: "Comience por editar",
         }),
         pageLink: "src/app/page.tsx",
       },
     },
   } satisfies Dictionary;
   
   export default pageContent;
   

   콘텐츠 선언은 애플리케이션 내 어디에서나 정의할 수 있으며, contentDir 디렉토리(기본값: ./src)에 포함되기만 하면 됩니다. 그리고 콘텐츠 선언 파일 확장자(기본값: .content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml})와 일치해야 합니다.

   자세한 내용은 콘텐츠 선언 문서를 참조하세요.

   콘텐츠 선언 문서
6. 6

   코드에서 콘텐츠 활용하기

   애플리케이션 전반에서 콘텐츠 사전을 접근하세요:

   Intlayer >=9.4Intlayer <9.4

   src/app/[locale]/page.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { FC } from "react";
   import { ClientComponentExample } from "@components/ClientComponentExample";
   import { ServerComponentExample } from "@components/ServerComponentExample";
   import { type NextPageIntlayer, useIntlayer } from "next-intlayer";
   
   const PageContent: FC = () => {
     const content = useIntlayer("page");
   
     return (
       <>
         <p>{content.getStarted.main}</p>
         <code>{content.getStarted.pageLink}</code>
       </>
     );
   };
   
   const Page: NextPageIntlayer = () => (
     <>
       <PageContent />
       <ServerComponentExample />
   
       <ClientComponentExample />
     </>
   );
   
   export default Page;
   

   • IntlayerProvider는 locale 레이아웃에서 한 번 마운트됩니다. 서버 및 클라이언트 컴포넌트 모두에 locale을 제공하므로 페이지가 더 이상 자신을 래핑하지 않습니다.
   • 서버 hooks는 다음 순서로 locale을 해결합니다: 호출 사이트에서 전달된 locale, 제공자에 의해 시드된 서버 컨텍스트, 요청에 의해 전달된 locale (Intlayer 프록시가 설정한 x-intlayer-locale 헤더, 그 다음 locale 쿠키). 마지막 단계는 레이아웃이 다시 실행되지 않는 페이지 세그먼트만 다시 렌더링하는 클라이언트 측 네비게이션에서 콘텐츠를 올바르게 유지하는 것입니다.

   src/app/[locale]/page.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { FC } from "react";
   import { ClientComponentExample } from "@components/ClientComponentExample";
   import { ServerComponentExample } from "@components/ServerComponentExample";
   import { type NextPageIntlayer } from "next-intlayer";
   import { IntlayerServerProvider, useIntlayer } from "next-intlayer/server";
   
   const PageContent: FC = () => {
     const content = useIntlayer("page");
   
     return (
       <>
         <p>{content.getStarted.main}</p>
         <code>{content.getStarted.pageLink}</code>
       </>
     );
   };
   
   const Page: NextPageIntlayer = async ({ params }) => {
     const { locale } = await params;
   
     return (
       <IntlayerServerProvider locale={locale}>
         <PageContent />
         <ServerComponentExample />
   
         <ClientComponentExample />
       </IntlayerServerProvider>
     );
   };
   
   export default Page;
   

   • IntlayerClientProvider는 클라이언트 측 컴포넌트에 로케일을 제공하는 데 사용됩니다. 레이아웃을 포함한 모든 상위 컴포넌트에 배치할 수 있습니다. 그러나 Next.js가 페이지 간에 레이아웃 코드를 공유하기 때문에 레이아웃에 배치하는 것이 권장됩니다. 레이아웃에서 IntlayerClientProvider를 사용하면 각 페이지마다 다시 초기화하는 것을 방지하여 성능을 향상시키고 애플리케이션 전체에서 일관된 로컬라이제이션 컨텍스트를 유지할 수 있습니다.

   • IntlayerServerProvider는 서버 자식 컴포넌트에 로케일을 제공하는 데 사용됩니다. 레이아웃에서는 설정할 수 없습니다.

     레이아웃과 페이지는 공통 서버 컨텍스트를 공유할 수 없습니다. 서버 컨텍스트 시스템은 요청별 데이터 저장소(React의 cache 메커니즘)를 기반으로 하여 애플리케이션의 서로 다른 세그먼트마다 각 "컨텍스트"가 다시 생성되기 때문입니다. 공급자를 공유 레이아웃에 배치하면 이 격리가 깨져 서버 컨텍스트 값이 서버 컴포넌트에 올바르게 전달되지 않습니다.

   src/components/ClientComponentExample.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   "use client";
   
   import type { FC } from "react";
   import { useIntlayer } from "next-intlayer";
   
   export const ClientComponentExample: FC = () => {
     const content = useIntlayer("client-component-example"); // 관련 콘텐츠 선언 생성
   
     return (
       <div>
         <h2>{content.title}</h2>
         <p>{content.content}</p>
       </div>
     );
   };
   

   Intlayer >=9.4Intlayer <9.4

   src/components/ServerComponentExample.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { FC } from "react";
   import { useIntlayer } from "next-intlayer";
   
   export const ServerComponentExample: FC = () => {
     const content = useIntlayer("server-component-example"); // 관련 콘텐츠 선언 생성
   
     return (
       <div>
         <h2>{content.title}</h2>
         <p>{content.content}</p>
       </div>
     );
   };
   

   next-intlayer는 동형 import 경로입니다: react-server export 조건은 서버 컴포넌트에 ambient-locale 구현을 제공하고, 클라이언트 컴포넌트는 context 기반 구현을 받습니다. 동일한 호출이 양쪽에서 모두 작동합니다.

   src/components/ServerComponentExample.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { FC } from "react";
   import { useIntlayer } from "next-intlayer/server";
   
   export const ServerComponentExample: FC = () => {
     const content = useIntlayer("server-component-example"); // 관련 콘텐츠 선언 생성
   
     return (
       <div>
         <h2>{content.title}</h2>
         <p>{content.content}</p>
       </div>
     );
   };
   

   콘텐츠를 alt, title, href, aria-label 등과 같은 string 속성에서 사용하려면, 함수의 값을 호출해야 합니다. 예를 들어:

   tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   <img src={content.image.src.value} alt={content.image.value} />
   <img src={content.image.src.toString()} alt={content.image.toString()} />
   <img src={String(content.image.src)} alt={String(content.image)} />
   

   useIntlayer 훅에 대해 더 알아보려면 문서를 참조하세요.

   useIntlayer 훅 문서 | next-intlayer

   기존 앱이 있다면, Intlayer Compiler와 extract 명령어를 사용하여 수천 개의 컴포넌트를 몇 초 만에 변환할 수 있습니다.

   Intlayer Compiler

   extract 명령어
7. 7

   로케일 감지를 위한 프록시 구성

   선택사항

   사용자의 선호 로케일을 감지하기 위해 프록시를 설정합니다:

   src/proxy.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   export { intlayerProxy as proxy } from "next-intlayer/proxy";
   
   export const config = {
     matcher:
       "/((?!api|static|assets|robots|sitemap|sw|service-worker|manifest|.*\\..*|_next).*)",
   };
   

   intlayerProxy는 사용자의 선호 로케일을 감지하여 구성에 명시된 적절한 URL로 리디렉션하는 데 사용됩니다. 또한 사용자의 선호 로케일을 쿠키에 저장할 수 있도록 합니다.

   구성

   Intlayer v9 이후, 이 미들웨어는 routing.enableProxy 옵션(true가 기본값)을 준수합니다. 이 파일을 제거하지 않고 pass-through로 전환하려면 설정에서 routing.enableProxy: false를 설정하세요. v9 release notes를 참조하세요.

   v9 release notes

   여러 프록시를 함께 연결해야 하는 경우(예: 인증 또는 커스텀 프록시와 함께 intlayerProxy를 사용하는 경우), Intlayer는 이제 multipleProxies라는 헬퍼를 제공합니다.

   ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { multipleProxies, intlayerProxy } from "next-intlayer/proxy";
   import { customProxy } from "@utils/customProxy";
   
   export const proxy = multipleProxies([intlayerProxy, customProxy]);
   

8. 8

   메타데이터의 국제화

   선택사항

   페이지 제목과 같은 메타데이터를 국제화하려는 경우, Next.js에서 제공하는 generateMetadata 함수를 사용할 수 있습니다. 내부에서 getIntlayer 함수로부터 콘텐츠를 가져와 메타데이터를 번역할 수 있습니다.

   src/app/[locale]/metadata.content.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { type Dictionary, t } from "intlayer";
   import { Metadata } from "next";
   
   const metadataContent = {
     key: "page-metadata",
     content: {
       title: t({
         en: "Create Next App",
         fr: "Créer une application Next.js",
         es: "Crear una aplicación Next.js",
       }),
       description: t({
         en: "Generated by create next app",
         fr: "Généré par create next app",
         es: "Generado por create next app",
       }),
     },
   } satisfies Dictionary<Metadata>;
   
   export default metadataContent;
   

   src/app/[locale]/layout.tsx or src/app/[locale]/page.tsx

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { getIntlayer, getMultilingualUrls } from "intlayer";
   import type { Metadata } from "next";
   import type { LocalPromiseParams } from "next-intlayer";
   
   export const generateMetadata = async ({
     params,
   }: LocalPromiseParams): Promise<Metadata> => {
     const { locale } = await params;
   
     const metadata = getIntlayer("page-metadata", locale);
   
     /**
      * 각 로케일에 대한 모든 URL을 포함하는 객체를 생성합니다.
      *
      * 예시:
      * ```ts
      *  getMultilingualUrls('/about');
      *
      *  // 반환값
      *  // {
      *  //   en: '/about',
      *  //   fr: '/fr/about',
      *  //   es: '/es/about',
      *  // }
      * ```
      */
     const multilingualUrls = getMultilingualUrls("/");
     const localizedUrl =
       multilingualUrls[locale as keyof typeof multilingualUrls];
   
     return {
       ...metadata,
       alternates: {
         canonical: localizedUrl,
         languages: { ...multilingualUrls, "x-default": "/" },
       },
       openGraph: {
         url: localizedUrl,
       },
     };
   };
   
   // ... 나머지 코드
   

   next-intlayer에서 가져온 getIntlayer 함수는 콘텐츠를 IntlayerNode로 래핑하여 시각적 편집기와의 통합을 가능하게 합니다. 반면, intlayer에서 가져온 getIntlayer 함수는 추가 속성 없이 콘텐츠를 직접 반환합니다.

   메타데이터 최적화에 대해 더 알아보기 공식 Next.js 문서에서.

9. 9

   sitemap.xml 및 robots.txt의 다국어화

   선택사항

   sitemap.xml 및 robots.txt를 다국어화하려면 Intlayer에서 제공하는 getMultilingualUrls 함수를 사용할 수 있습니다. 이 함수는 사이트맵에 다국어 URL을 생성할 수 있게 해줍니다.

   src/app/sitemap.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import { getMultilingualUrls } from "intlayer";
   import type { MetadataRoute } from "next";
   
   const sitemap = (): MetadataRoute.Sitemap => [
     {
       url: "https://example.com",
       alternates: {
         languages: {
           ...getMultilingualUrls("https://example.com"),
           "x-default": "https://example.com",
         },
       },
     },
     {
       url: "https://example.com/login",
       alternates: {
         languages: {
           ...getMultilingualUrls("https://example.com/login"),
           "x-default": "https://example.com/login",
         },
       },
     },
     {
       url: "https://example.com/register",
       alternates: {
         languages: {
           ...getMultilingualUrls("https://example.com/register"),
           "x-default": "https://example.com/register",
         },
       },
     },
   ];
   
   export default sitemap;
   

   src/app/robots.ts

   콘텐츠 복사

   코드 복사

   코드를 클립보드에 복사

   import type { MetadataRoute } from "next";
   import { getMultilingualUrls } from "intlayer";
   
   const getAllMultilingualUrls = (urls: string[]) =>
     urls.flatMap((url) => Object.values(getMultilingualUrls(url)) as string[]);
   
   const robots = (): MetadataRoute.Robots => ({
     rules: {
       userAgent: "*",
       allow: ["/"],
       disallow: getAllMultilingualUrls(["/login", "/register"]),
     },
     host: "https://example.com",
     sitemap: `https://example.com/sitemap.xml`,
   });
   
   export default robots;
   

   사이트맵 최적화에 대해 더 알아보기 공식 Next.js 문서에서. robots.txt 최적화에 대해 더 알아보기 공식 Next.js 문서에서.

10. 10

    콘텐츠의 언어 변경하기

    선택사항

    Next.js에서 콘텐츠의 언어를 변경하려면, 권장되는 방법은 Link 컴포넌트를 사용하여 사용자를 적절한 현지화된 페이지로 리디렉션하는 것입니다. Link 컴포넌트는 페이지의 사전 로딩(prefetching)을 가능하게 하여 전체 페이지 새로고침을 방지하는 데 도움이 됩니다.

    src/components/LocaleSwitcher.tsx

    콘텐츠 복사

    코드 복사

    코드를 클립보드에 복사

    "use client";
    
    import type { FC } from "react";
    import {
      Locales,
      getHTMLTextDir,
      getLocaleName,
      getLocalizedUrl,
    } from "intlayer";
    import { useLocale } from "next-intlayer";
    import Link from "next/link";
    
    export const LocaleSwitcher: FC = () => {
      const { locale, pathWithoutLocale, availableLocales, setLocale } =
        useLocale();
    
      return (
        <div>
          <button popoverTarget="localePopover">{getLocaleName(locale)}</button>
          <div id="localePopover" popover="auto">
            {availableLocales.map((localeItem) => (
              <Link
                href={getLocalizedUrl(pathWithoutLocale, localeItem)}
                key={localeItem}
                aria-current={locale === localeItem ? "page" : undefined}
                onClick={() => setLocale(localeItem)}
                replace // "뒤로 가기" 브라우저 버튼이 이전 페이지로 리디렉션되도록 보장합니다.
              >
                <span>
                  {/* 로케일 - 예: FR */}
                  {localeItem}
                </span>
                <span>
                  {/* 해당 로케일의 언어 - 예: Français */}
                  {getLocaleName(localeItem, locale)}
                </span>
                <span dir={getHTMLTextDir(localeItem)} lang={localeItem}>
                  {/* 현재 로케일에서의 언어 - 예: 현재 로케일이 Locales.SPANISH일 때 Francés */}
                  {getLocaleName(localeItem)}
                </span>
                <span dir="ltr" lang={Locales.ENGLISH}>
                  {/* 영어로 된 언어명 - 예: French */}
                  {getLocaleName(localeItem, Locales.ENGLISH)}
                </span>
              </Link>
            ))}
          </div>
        </div>
      );
    };
    

    대안으로 useLocale 훅에서 제공하는 setLocale 함수를 사용할 수 있습니다. 이 함수는 페이지 사전 로딩(prefetching)을 허용하지 않습니다. 자세한 내용은 useLocale 훅 문서를 참고하세요.

    useLocale 훅 문서

    또한 onLocaleChange 옵션에 함수를 설정하여 로케일이 변경될 때 사용자 정의 함수를 실행할 수 있습니다.

    src/components/LocaleSwitcher.tsx

    콘텐츠 복사

    코드 복사

    코드를 클립보드에 복사

    "use client";
    
    import { useLocale } from "next-intlayer";
    import { getLocalizedUrl } from "intlayer";
    
    // ... 나머지 코드
    
    const { setLocale } = useLocale();
    
    return (
      <button onClick={() => setLocale(Locales.FRENCH)}>프랑스어로 변경</button>
    );
    

    문서 참고:

    useLocale 훅

    getLocaleName hook

    getLocalizedUrl hook

    getHTMLTextDir hook

11. 11

    지역화된 링크 컴포넌트 생성하기

    선택사항

    애플리케이션의 내비게이션이 현재 로케일을 준수하도록 하려면, 커스텀 Link 컴포넌트를 만들 수 있습니다. 이 컴포넌트는 내부 URL에 현재 언어를 자동으로 접두사로 붙여줍니다. 예를 들어, 프랑스어 사용자가 "About" 페이지로 가는 링크를 클릭하면 /about 대신 /fr/about로 리디렉션됩니다.

    이 동작은 여러 가지 이유로 유용합니다:

    • SEO 및 사용자 경험: 로컬라이즈된 URL은 검색 엔진이 언어별 페이지를 올바르게 색인하도록 도와주며, 사용자에게 선호하는 언어로 된 콘텐츠를 제공합니다.
    • 일관성: 애플리케이션 전반에 걸쳐 로컬라이즈된 링크를 사용함으로써 내비게이션이 현재 로케일 내에서 유지되어 예상치 못한 언어 전환을 방지합니다.
    • 유지보수성: 로컬라이제이션 로직을 단일 컴포넌트에 중앙 집중화하면 URL 관리를 단순화하여 애플리케이션이 성장함에 따라 코드베이스를 더 쉽게 유지보수하고 확장할 수 있습니다.

    아래는 TypeScript로 구현한 로컬라이즈된 Link 컴포넌트입니다:

    src/components/Link.tsx

    콘텐츠 복사

    코드 복사

    코드를 클립보드에 복사

    "use client";
    
    import { getLocalizedUrl } from "intlayer";
    import NextLink, { type LinkProps as NextLinkProps } from "next/link";
    import { useLocale } from "next-intlayer";
    import type { PropsWithChildren, FC } from "react";
    
    /**
     * 주어진 URL이 외부 링크인지 확인하는 유틸리티 함수입니다.
     * URL이 http:// 또는 https://로 시작하면 외부 링크로 간주합니다.
     */
    export const checkIsExternalLink = (href?: string): boolean =>
      /^https?:\/\//.test(href ?? "");
    
    /**
     * 현재 로케일에 따라 href 속성을 조정하는 커스텀 Link 컴포넌트입니다.
     * 내부 링크의 경우, `getLocalizedUrl`을 사용하여 URL 앞에 로케일을 붙입니다 (예: /fr/about).
     * 이를 통해 내비게이션이 동일한 로케일 컨텍스트 내에서 이루어지도록 보장합니다.
     */
    export const Link: FC<PropsWithChildren<NextLinkProps>> = ({
      href,
      children,
      ...props
    }) => {
      const { locale } = useLocale();
      const isExternalLink = checkIsExternalLink(href.toString());
    
      // 만약 링크가 내부 링크이고 유효한 href가 제공되었다면, 지역화된 URL을 가져옵니다.
      const hrefI18n: NextLinkProps["href"] =
        href && !isExternalLink ? getLocalizedUrl(href.toString(), locale) : href;
    
      return (
        <NextLink href={hrefI18n} {...props}>
          {children}
        </NextLink>
      );
    };
    

    작동 원리

    • 외부 링크 감지:
      유틸리티 함수 checkIsExternalLink는 URL이 외부 링크인지 확인합니다. 외부 링크는 현지화가 필요하지 않으므로 변경되지 않은 상태로 유지됩니다.

    • 현재 로케일 가져오기:
      useLocale 훅은 현재 로케일(예: 프랑스어의 경우 fr)을 제공합니다.

    • URL 현지화:
      내부 링크(즉, 외부 링크가 아닌 링크)의 경우, getLocalizedUrl을 사용하여 URL 앞에 현재 로케일을 자동으로 붙입니다. 즉, 사용자가 프랑스어 환경에 있는 경우, href로 /about을 전달하면 /fr/about으로 변환됩니다.

    • 링크 반환:
      컴포넌트는 현지화된 URL을 가진 <a> 요소를 반환하여 내비게이션이 로케일과 일치하도록 보장합니다.

    이 Link 컴포넌트를 애플리케이션 전반에 통합함으로써, 일관성 있고 언어를 인식하는 사용자 경험을 유지하는 동시에 향상된 SEO 및 사용성 이점을 누릴 수 있습니다.

12. 12

    Server Actions에서 현재 로케일 가져오기

    선택사항

    Server Action 내부에서 활성 로케일이 필요한 경우(예: 이메일 현지화 또는 로케일 인식 로직 실행), next-intlayer/server에서 getLocale을 호출하십시오:

    src/app/actions/getLocale.ts

    콘텐츠 복사

    코드 복사

    코드를 클립보드에 복사

    "use server";
    
    import { getLocale } from "next-intlayer/server";
    
    export const myServerAction = async () => {
      const locale = await getLocale();
    
      // 로케일을 사용한 작업 수행
    };
    

    getLocale 함수는 사용자의 로케일을 결정하기 위해 계단식 전략을 따릅니다:

    1. 먼저, 프록시에 의해 설정되었을 수 있는 로케일 값을 요청 헤더에서 확인합니다
    2. 헤더에서 로케일을 찾을 수 없으면 쿠키에 저장된 로케일을 찾습니다
    3. 쿠키가 발견되지 않으면 브라우저 설정에서 사용자가 선호하는 언어 감지를 시도합니다
    4. 마지막 수단으로 애플리케이션의 구성된 기본 로케일로 대체됩니다

    이는 사용 가능한 컨텍스트를 기반으로 가장 적절한 로케일이 선택되도록 합니다.

13. 13

    번들 크기 최적화

    선택사항

    next-intlayer를 사용할 때, 사전(dictionary)은 기본적으로 모든 페이지의 번들에 포함됩니다. 번들 크기를 최적화하기 위해 Intlayer는 매크로를 사용하여 useIntlayer 호출을 지능적으로 대체하는 선택적 SWC 플러그인을 제공합니다. 이를 통해 사전은 실제로 사용하는 페이지의 번들에만 포함됩니다.

    이 최적화를 활성화하려면 @intlayer/swc 패키지를 설치하세요. 설치가 완료되면 next-intlayer가 자동으로 플러그인을 감지하고 사용합니다:

    bash

    콘텐츠 복사

    코드 복사

    코드를 클립보드에 복사

    npm install @intlayer/swc --save-dev
    

    참고: 이 최적화는 Next.js 13 이상에서만 사용할 수 있습니다.

    참고: 이 패키지는 SWC 플러그인이 Next.js에서 아직 실험적이기 때문에 기본적으로 설치되지 않습니다. 향후 변경될 수 있습니다.

    참고: dictionary 설정에서 옵션을 importMode: 'dynamic' 또는 importMode: 'fetch'로 설정하면 Suspense에 의존하게 되므로, useIntlayer 호출을 Suspense 경계로 감싸야 합니다. 즉, Page / Layout 컴포넌트의 최상위 레벨에서 useIntlayer를 직접 사용할 수 없습니다.

14. 14

    컴포넌트 콘텐츠 추출

    선택사항

    기존 코드베이스가 있는 경우 수천 개의 파일을 변환하는 데 시간이 많이 걸릴 수 있습니다.

    이 프로세스를 용이하게 하기 위해 Intlayer는 컴포넌트를 변환하고 콘텐츠를 추출하기 위한 컴파일러 / 추출기를 제안합니다.

    컴파일러

    추출기

    설정하려면 intlayer.config.ts 파일에 compiler 섹션을 추가할 수 있습니다.

    intlayer.config.ts

    콘텐츠 복사

    코드 복사

    코드를 클립보드에 복사

    import { type IntlayerConfig } from "intlayer";
    
    const config: IntlayerConfig = {
      // ... 나머지 구성
      compiler: {
        /**
         * 컴파일러 활성화 여부를 나타냅니다.
         */
        enabled: true,
    
        /**
         * 출력 파일 경로를 정의합니다.
         */
        output: ({ fileName, extension }) => `./${fileName}${extension}`,
    
        /**
         * 변환 후 컴포넌트를 저장할지 여부를 나타냅니다. 그렇게 하면 컴파일러를 한 번만 실행하여 앱을 변환한 다음 제거할 수 있습니다.
         */
        saveComponents: false,
    
        /**
         * 사전 키 접두사
         */
        dictionaryKeyPrefix: "",
      },
    };
    
    export default config;
    

    추출 명령Babel 컴파일러

    컴포넌트를 변환하고 콘텐츠를 추출하기 위해 추출기를 실행합니다

    bash

    콘텐츠 복사

    코드 복사

    코드를 클립보드에 복사

    npx intlayer extract
    

    bash

    콘텐츠 복사

    코드 복사

    코드를 클립보드에 복사

    npm install @intlayer/babel --save-dev
    

    babel.config.js

    콘텐츠 복사

    코드 복사

    코드를 클립보드에 복사

    const {
      intlayerExtractBabelPlugin,
      getExtractPluginOptions,
    } = require("@intlayer/babel");
    
    module.exports = {
      presets: ["next/babel"],
      plugins: [
        // 컴포넌트에서 콘텐츠를 사전으로 추출
        [intlayerExtractBabelPlugin, getExtractPluginOptions()],
      ],
    };
    

    bash

    콘텐츠 복사

    코드 복사

    코드를 클립보드에 복사

    npm run build # 또는 npm run dev
    

Turbopack에서 사전 변경 사항 감시

{
  // ... 기존 package.json 구성
  "scripts": {
    // ... 기존 스크립트 구성
    "dev": "intlayer watch --with 'next dev'",
  },
}

TypeScript 구성

Intlayer는 모듈 증강(module augmentation)을 사용하여 TypeScript의 이점을 활용하고 코드베이스를 더욱 견고하게 만듭니다.

TypeScript 구성에 자동 생성된 타입이 포함되어 있는지 확인하세요.

{
  // ... 기존 TypeScript 구성
  "include": [
    // ... 기존 TypeScript 설정
    ".intlayer/**/*.ts", // 자동 생성된 타입 포함
  ],
}

Git 설정

Intlayer가 생성한 파일들은 Git 저장소에 커밋하지 않도록 무시하는 것이 권장됩니다.

이를 위해 .gitignore 파일에 다음 지시문을 추가할 수 있습니다:

# Intlayer가 생성한 파일 무시
.intlayer

VS Code 확장

Intlayer와 함께 개발 경험을 향상시키기 위해 공식 Intlayer VS Code 확장을 설치할 수 있습니다.

이 확장은 다음 기능을 제공합니다:

• 번역 키에 대한 자동 완성.
• 실시간 오류 감지로 누락된 번역을 확인할 수 있습니다.
• 인라인 미리보기로 번역된 내용을 바로 확인할 수 있습니다.
• 빠른 작업으로 번역을 쉽게 생성하고 업데이트할 수 있습니다.

확장 기능 사용 방법에 대한 자세한 내용은 Intlayer VS Code 확장 문서를 참조하세요.

더 나아가기

더 나아가려면 비주얼 에디터를 구현하거나 CMS를 사용하여 콘텐츠를 외부화할 수 있습니다.

자주 묻는 질문