Intlayer를 사용하여 Nuxt 및 Vue 웹사이트 번역하기 | 국제화(i18n)

목차

Intlayer란 무엇인가?

Intlayer는 현대 웹 애플리케이션에서 다국어 지원을 간소화하기 위해 설계된 혁신적인 오픈 소스 국제화(i18n) 라이브러리입니다.

Intlayer를 사용하면 다음을 할 수 있습니다:

• 컴포넌트 수준에서 선언적 사전을 사용하여 번역을 쉽게 관리할 수 있습니다.
• 메타데이터, 라우트 및 콘텐츠를 동적으로 현지화할 수 있습니다.
• 자동 생성된 타입으로 TypeScript 지원을 보장하여 자동완성 및 오류 감지를 향상시킵니다.
• 동적 로케일 감지 및 전환과 같은 고급 기능을 활용할 수 있습니다.

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

GitHub에서 애플리케이션 템플릿을 확인하세요.

1단계: 의존성 설치

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

npm install intlayer vue-intlayernpm install --save-dev nuxt-intlayer

• intlayer

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

• vue-intlayer Intlayer를 Vue 애플리케이션과 통합하는 패키지입니다. Vue 컴포넌트를 위한 컴포저블을 제공합니다.

• nuxt-intlayer Nuxt 애플리케이션과 Intlayer를 통합하는 Nuxt 모듈입니다. 자동 설정, 로케일 감지를 위한 미들웨어, 쿠키 관리 및 URL 리디렉션을 제공합니다.

2단계: 프로젝트 구성

애플리케이션의 언어를 구성하기 위한 설정 파일을 만드세요:

import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [      Locales.ENGLISH,      Locales.FRENCH,      Locales.SPANISH,      // 다른 로케일들    ],    defaultLocale: Locales.ENGLISH,  },};export default config;

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

3단계: Nuxt 구성에 Intlayer 통합하기

Nuxt 구성에 intlayer 모듈을 추가하세요:

import { defineNuxtConfig } from "nuxt/config";export default defineNuxtConfig({  // ... 기존 Nuxt 구성  modules: ["nuxt-intlayer"],});

nuxt-intlayer 모듈은 Intlayer와 Nuxt의 통합을 자동으로 처리합니다. 콘텐츠 선언 빌드를 설정하고, 개발 모드에서 파일을 모니터링하며, 로케일 감지를 위한 미들웨어를 제공하고, 지역화된 라우팅을 관리합니다.

4단계: 콘텐츠 선언하기

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

import { type Dictionary, t } from "intlayer";const content = {  key: "home-page",  content: {    title: t({      en: "Hello world",      fr: "Bonjour le monde",      es: "Hola mundo",    }),    metaTitle: t({      en: "Welcome | My Application",      fr: "Bienvenue | Mon Application",      es: "Bienvenido | Mi Aplicación",    }),    metaDescription: t({      en: "Discover your multilingual Nuxt app homepage powered by Intlayer.",      fr: "Découvrez la page d'accueil multilingue de votre application Nuxt propulsée par Intlayer.",      es: "Descubre la página de inicio multilingüe de tu aplicación Nuxt impulsada por Intlayer.",    }),  },} satisfies Dictionary;export default content;

콘텐츠 선언은 애플리케이션 내 어디서든 정의할 수 있으며, contentDir 디렉토리(기본값: ./src)에 포함되어야 합니다. 또한 콘텐츠 선언 파일 확장자(기본값: .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx})와 일치해야 합니다.

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

5단계: 코드에서 Intlayer 사용하기

useIntlayer 컴포저블을 사용하여 Nuxt 애플리케이션 전반에서 콘텐츠 사전을 접근할 수 있습니다:

<script setup lang="ts">import { ref } from "vue";import { useIntlayer } from "vue-intlayer";defineProps({  msg: String,});const {  count,  edit,  checkOut,  nuxtIntlayer,  learnMore,  nuxtDocs,  readTheDocs,} = useIntlayer("helloworld");const countRef = ref(0);</script><template>  <h1>{{ msg }}</h1>  <div class="card">    <button type="button" @click="countRef++">      <count />      {{ countRef }}    </button>    <p v-html="edit"></p>  </div>  <p>    <checkOut />    <a href="https://nuxt.com/docs/getting-started/introduction" target="_blank"      >Nuxt</a    >, <nuxtIntlayer />  </p>  <p>    <learnMore />    <a href="https://nuxt.com" target="_blank"><nuxtDocs /></a>.  </p>  <p class="read-the-docs"><readTheDocs /></p>  <p class="read-the-docs">{{ readTheDocs }}</p></template>

Intlayer에서 콘텐츠 접근하기

Intlayer는 콘텐츠에 접근할 수 있는 다양한 API를 제공합니다:

• 컴포넌트 기반 문법 (권장): <myContent /> 또는 <Component :is="myContent" /> 구문을 사용하여 콘텐츠를 Intlayer Node로 렌더링합니다. 이는 Visual Editor 및 CMS와 원활하게 통합됩니다.

• 문자열 기반 구문:
  {{ myContent }}를 사용하여 Visual Editor 지원 없이 콘텐츠를 일반 텍스트로 렌더링합니다.

• 원시 HTML 구문:
  <div v-html="myContent" />를 사용하여 Visual Editor 지원 없이 콘텐츠를 원시 HTML로 렌더링합니다.

• 구조 분해 구문:
  useIntlayer 컴포저블은 콘텐츠가 포함된 Proxy를 반환합니다. 이 Proxy는 반응성을 유지하면서 콘텐츠에 접근하기 위해 구조 분해할 수 있습니다.

  • const content = useIntlayer("myContent");를 사용하고 {{ content.myContent }} / <content.myContent />를 사용하세요.
  • 또는 const { myContent } = useIntlayer("myContent");를 사용하고 {{ myContent}} / <myContent/>를 사용하여 콘텐츠를 구조 분해 할당하세요.

(선택 사항) 6단계: 콘텐츠의 언어 변경하기

콘텐츠의 언어를 변경하려면 useLocale 컴포저블에서 제공하는 setLocale 함수를 사용할 수 있습니다. 이 함수는 애플리케이션의 로케일을 설정하고 그에 따라 콘텐츠를 업데이트할 수 있게 해줍니다.

NuxtLink를 사용하여 언어를 전환하는 컴포넌트를 만드세요. 로케일 전환에 버튼 대신 링크를 사용하는 것은 SEO 및 페이지 검색 가능성 측면에서 모범 사례입니다. 이는 검색 엔진이 모든 현지화된 페이지 버전을 크롤링하고 인덱싱할 수 있게 해주기 때문입니다.

<script setup lang="ts">import { getLocaleName, getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";// Nuxt가 useRoute를 자동으로 임포트합니다const route = useRoute();const { locale, availableLocales, setLocale } = useLocale();</script><template>  <nav class="locale-switcher">    <NuxtLink      v-for="localeEl in availableLocales"      :key="localeEl"      :to="getLocalizedUrl(route.fullPath, localeEl)"      class="locale-link"      :class="{ 'active-locale': localeEl === locale }"      @click="setLocale(localeEl)"    >      {{ getLocaleName(localeEl) }}    </NuxtLink>  </nav></template>

NuxtLink를 적절한 href 속성(getLocalizedUrl을 통해)과 함께 사용하면 검색 엔진이 페이지의 모든 언어 버전을 발견할 수 있습니다. 이는 검색 엔진 크롤러가 따라가지 못할 수 있는 JavaScript 전용 로케일 전환보다 바람직합니다.

그런 다음, app.vue를 설정하여 레이아웃을 사용합니다:

<template>  <NuxtLayout>    <NuxtPage />  </NuxtLayout></template>

(선택 사항) 6b단계: 내비게이션이 포함된 레이아웃 생성

Nuxt 레이아웃을 사용하면 페이지에 공통 구조를 정의할 수 있습니다. 로케일 스위처와 내비게이션을 포함하는 기본 레이아웃을 생성하세요:

<script setup lang="ts">import Links from "~/components/Links.vue";import LocaleSwitcher from "~/components/LocaleSwitcher.vue";</script><template>  <div>    <header>      <LocaleSwitcher />    </header>    <main>      <slot />    </main>    <Links href="/">홈</Links>    <Links href="/about">소개</Links>  </div></template>

Links 컴포넌트(아래에 표시됨)는 내부 내비게이션 링크가 자동으로 현지화되도록 보장합니다.

(선택 사항) 7단계: 애플리케이션에 현지화된 라우팅 추가하기

Nuxt는 nuxt-intlayer 모듈을 사용할 때 현지화된 라우팅을 자동으로 처리합니다. 이는 페이지 디렉토리 구조를 기반으로 각 언어별 경로를 자동으로 생성합니다.

예시:

pages/├── index.vue          → /, /fr, /es├── about.vue          → /about, /fr/about, /es/about└── contact/    └── index.vue      → /contact, /fr/contact, /es/contact

로컬라이즈된 페이지를 만들려면 pages/ 디렉토리에 Vue 파일을 생성하면 됩니다. 다음은 두 가지 예제 페이지입니다:

홈 페이지 (pages/index.vue):

<script setup lang="ts">import { useIntlayer } from "vue-intlayer";const content = useIntlayer("home-page");useHead({  title: content.metaTitle.value,  meta: [    {      name: "description",      content: content.metaDescription.value,    },  ],});</script><template>  <h1><content.title /></h1></template>

소개 페이지 (pages/about.vue):

<script setup lang="ts">import { useIntlayer } from "vue-intlayer";const content = useIntlayer("about-page");useHead({  title: content.metaTitle.raw, // 원시 문자열 접근을 위해 .raw 사용  meta: [    {      name: "description",      content: content.metaDescription.raw, // 원시 문자열 접근을 위해 .raw 사용    },  ],});</script><template>  <h1><content.title /></h1></template>

참고: useHead는 Nuxt에서 자동으로 import됩니다. 필요에 따라 .value(반응형) 또는 .raw(원시 문자열)를 사용하여 콘텐츠 값을 접근할 수 있습니다.

nuxt-intlayer 모듈은 자동으로 다음을 수행합니다:

• 사용자의 선호 로케일 감지
• URL을 통한 로케일 전환 처리
• 적절한 <html lang=""> 속성 설정
• 로케일 쿠키 관리
• 사용자를 적절한 로컬라이즈된 URL로 리디렉션

(선택 사항) 8단계: 로컬라이즈된 링크 컴포넌트 생성

애플리케이션의 내비게이션이 현재 로케일을 준수하도록 하려면, 커스텀 Links 컴포넌트를 생성할 수 있습니다. 이 컴포넌트는 내부 URL에 현재 언어를 자동으로 접두사로 붙여주며, 이는 SEO 및 페이지 발견 가능성에 필수적입니다.

<script setup lang="ts">import { getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";interface Props {  href: string;  locale?: string;}const props = defineProps<Props>();const { locale: currentLocale } = useLocale();// 최종 경로 계산const finalPath = computed(() => {  // 1. 링크가 외부 링크인지 확인  const isExternal = /^https?:\/\//.test(props.href || "");  // 2. 외부 링크라면 그대로 반환 (NuxtLink가 <a> 태그 생성을 처리함)  if (isExternal) return props.href;  // 3. 내부 링크인 경우 URL을 현지화합니다.  const targetLocale = props.locale || currentLocale.value;  return getLocalizedUrl(props.href, targetLocale);});</script><template>  <NuxtLink :to="finalPath" v-bind="$attrs">    <slot />  </NuxtLink></template>

그런 다음 애플리케이션 전체에서 이 컴포넌트를 사용하세요:

<script setup lang="ts">import Links from "~/components/Links.vue";import LocaleSwitcher from "~/components/LocaleSwitcher.vue";</script><template>  <div>    <header>      <LocaleSwitcher />    </header>    <main>      <slot />    </main>    <Links href="/">홈</Links>    <Links href="/about">소개</Links>  </div></template>

NuxtLink를 지역화된 경로와 함께 사용하면 다음을 보장할 수 있습니다:

• 검색 엔진이 모든 언어 버전의 페이지를 크롤링하고 인덱싱할 수 있습니다.
• 사용자가 지역화된 URL을 직접 공유할 수 있습니다.
• 브라우저 히스토리가 로케일 접두사가 붙은 URL에서 올바르게 작동합니다.

(선택 사항) 9단계: 메타데이터 및 SEO 처리

Nuxt는 useHead 컴포저블(자동 임포트)을 통해 뛰어난 SEO 기능을 제공합니다. Intlayer를 사용하여 .raw 또는 .value 접근자를 통해 원시 문자열 값을 얻어 지역화된 메타데이터를 처리할 수 있습니다:

<script setup lang="ts">import { useIntlayer } from "vue-intlayer";// useHead는 Nuxt에서 자동 임포트됩니다.const content = useIntlayer("about-page");useHead({  title: content.metaTitle.raw, // 원시 문자열 접근을 위해 .raw 사용  meta: [    {      name: "description",      content: content.metaDescription.raw, // 원시 문자열 접근을 위해 .raw 사용    },  ],});</script><template>  <h1><content.title /></h1></template>

또는 import { getIntlayer } from "intlayer" 함수를 사용하여 Vue 반응성 없이 콘텐츠를 가져올 수 있습니다.

콘텐츠 값 접근 방법:

• 원시 문자열 값을 얻으려면 .raw 사용 (비반응성)
• 반응성 값을 얻으려면 .value 사용
• Visual Editor 지원을 위해 <content.key /> 컴포넌트 문법 사용

해당 콘텐츠 선언을 생성하세요:

import { t, type Dictionary } from "intlayer";const aboutPageContent = {  key: "about-page",  content: {    metaTitle: t({      en: "About Us - My Company",      fr: "À Propos - Ma Société",      es: "Acerca de Nosotros - Mi Empresa",    }),    metaDescription: t({      ko: "우리 회사와 우리의 사명에 대해 자세히 알아보세요",      en: "Learn more about our company and our mission",      fr: "En savoir plus sur notre société et notre mission",      es: "Conozca más sobre nuestra empresa y nuestra misión",    }),    title: t({      ko: "회사 소개",      en: "About Us",      fr: "À Propos",      es: "Acerca de Nosotros",    }),  },} satisfies Dictionary;export default aboutPageContent;

Git 설정

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

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

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

VS Code 확장 프로그램

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

VS Code 마켓플레이스에서 설치하기

이 확장 프로그램은 다음을 제공합니다:

• 번역 키에 대한 자동 완성 기능.
• 누락된 번역에 대한 실시간 오류 감지.
• 번역된 콘텐츠의 인라인 미리보기.
• 번역을 쉽게 생성하고 업데이트할 수 있는 빠른 작업.

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

더 나아가기

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