Dịch trang web Astro + Vanilla JS của bạn với Intlayer | Đa ngôn ngữ (i18n)

Mục lục

Intlayer là gì?

Intlayer là một thư viện đa ngôn ngữ (i18n) mã nguồn mở sáng tạo được thiết kế để đơn giản hóa việc hỗ trợ nhiều ngôn ngữ trong các ứng dụng web hiện đại.

Với Intlayer, bạn có thể:

• Quản lý bản dịch dễ dàng: Sử dụng các từ điển khai báo ở cấp độ thành phần.
• Bản địa hóa động các metadata, route và nội dung.
• Đảm bảo hỗ trợ TypeScript: Với các kiểu dữ liệu được tạo tự động để tự động hoàn thành và phát hiện lỗi tốt hơn.
• Tận dụng các tính năng nâng cao: Như phát hiện ngôn ngữ động và chuyển đổi ngôn ngữ.

Hướng dẫn từng bước để cấu hình Intlayer trong Astro + Vanilla JS

Xem mẫu ứng dụng trên GitHub.

Bước 1: Cài đặt các phụ thuộc

Cài đặt các gói cần thiết bằng trình quản lý gói ưa thích của bạn:

npm install intlayer astro-intlayer vanilla-intlayernpx intlayer init

• intlayer Gói cốt lõi cung cấp các công cụ i18n để quản lý cấu hình, bản dịch, khai báo nội dung, chuyển mã và các lệnh CLI.

• astro-intlayer Plugin tích hợp Astro để kết nối Intlayer với trình đóng gói Vite; nó cũng bao gồm middleware để phát hiện ngôn ngữ ưa thích của người dùng, quản lý cookie và xử lý chuyển hướng URL.

• vanilla-intlayer Gói để tích hợp Intlayer vào các ứng dụng Vanilla JavaScript / TypeScript. Nó cung cấp singleton Pub/Sub (IntlayerClient) và các hàm hỗ trợ dựa trên callback (useIntlayer, useLocale, v.v.) để bất kỳ phần nào trong <script> Astro của bạn cũng có thể phản ứng với các thay đổi ngôn ngữ mà không cần framework UI.

Bước 2: Cấu hình dự án của bạn

Tạo một file cấu hình để xác định các ngôn ngữ của ứng dụng:

import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [      Locales.ENGLISH,      Locales.FRENCH,      Locales.SPANISH,      Locales.VIETNAMESE,      // Các ngôn ngữ khác của bạn    ],    defaultLocale: Locales.ENGLISH,  },};export default config;

Thông qua file cấu hình này, bạn có thể thiết lập các URL bản địa hóa, chuyển hướng middleware, tên cookie, vị trí và phần mở rộng của các khai báo nội dung, tắt log Intlayer trong console, v.v. Để biết danh sách đầy đủ các tham số có sẵn, hãy xem tài liệu cấu hình.

Bước 3: Tích hợp Intlayer vào cấu hình Astro của bạn

Thêm plugin intlayer vào cấu hình Astro của bạn. Không cần tích hợp thêm framework UI nào cho Vanilla JS.

// @ts-checkimport { intlayer } from "astro-intlayer";import { defineConfig } from "astro/config";// https://astro.build/configexport default defineConfig({  integrations: [intlayer()],});

Plugin tích hợp intlayer() được sử dụng để tích hợp Intlayer với Astro. Nó đảm bảo việc tạo các file khai báo nội dung và theo dõi chúng trong chế độ phát triển. Nó xác định các biến môi trường Intlayer bên trong ứng dụng Astro và cung cấp các alias để tối ưu hóa hiệu suất.

Bước 4: Khai báo nội dung của bạn

Tạo và quản lý các khai báo nội dung của bạn để lưu trữ các bản dịch:

import { t, type Dictionary } from "intlayer";const appContent = {  key: "app",  content: {    greeting: t({      en: "Hello World",      fr: "Bonjour le monde",      es: "Hola mundo",      vi: "Xin chào thế giới",    }),    description: t({      en: "Welcome to my multilingual Astro site.",      fr: "Bienvenue sur mon site Astro multilingue.",      es: "Bienvenido a mi sitio Astro multilingüe.",      vi: "Chào mừng bạn đến với trang web Astro đa ngôn ngữ của tôi.",    }),    switchLocale: t({      en: "Switch language:",      fr: "Changer de langue :",      es: "Cambiar idioma:",      vi: "Thay đổi ngôn ngữ:",    }),  },} satisfies Dictionary;export default appContent;

Các khai báo nội dung có thể được định nghĩa ở bất kỳ đâu trong ứng dụng của bạn, miễn là chúng nằm trong contentDir (mặc định là ./src) và khớp với phần mở rộng của file khai báo nội dung (mặc định là .content.{json,ts,tsx,js,jsx,mjs,cjs}).

Để biết thêm thông tin, hãy xem tài liệu khai báo nội dung.

Bước 5: Sử dụng nội dung trong Astro

Với Vanilla JS, tất cả các quá trình render phía máy chủ (SSR) diễn ra trực tiếp trong các file .astro bằng cách sử dụng getIntlayer. Sau đó, ở phía client, khối <script> khởi tạo thư viện vanilla-intlayer để cho phép chuyển đổi ngôn ngữ.

---import {  getIntlayer,  getLocaleFromPath,  getLocalizedUrl,  getPrefix,  getLocaleName,  localeMap,  locales,  defaultLocale,  getPathWithoutLocale,  type LocalesValues,} from "intlayer";export const getStaticPaths = () => {  return localeMap(({ locale }) => ({    params: { locale: getPrefix(locale).localePrefix },  }));};const locale = getLocaleFromPath(Astro.url.pathname) as LocalesValues;const pathWithoutLocale = getPathWithoutLocale(Astro.url.pathname);const { greeting, description, switchLocale } = getIntlayer("app", locale);---<!doctype html><html lang={locale} dir={getHTMLTextDir(locale)}>  <head>    <meta charset="utf-8" />    <meta name="viewport" content="width=device-width" />    <link rel="icon" type="image/svg+xml" href="/favicon.svg" />    <title>{greeting}</title>    <!-- Liên kết Canonical -->    <link      rel="canonical"      href={new URL(getLocalizedUrl(Astro.url.pathname, locale), Astro.site)}    />    <!-- Liên kết Hreflang -->    {      localeMap(({ locale: mapLocale }) => (        <link          rel="alternate"          hreflang={mapLocale}          href={new URL(            getLocalizedUrl(Astro.url.pathname, mapLocale),            Astro.site          )}        />      ))    }    <link      rel="alternate"      hreflang="x-default"      href={new URL(        getLocalizedUrl(Astro.url.pathname, defaultLocale),        Astro.site      )}    />  </head>  <body>    <main>      <h1 id="greeting">{greeting}</h1>      <p id="description">{description}</p>      <div class="locale-switcher">        <span class="switcher-label">{switchLocale}</span>        <div class="locale-buttons">          {            locales.map((localeItem) => (              <a                href={localeItem === locale ? undefined : getLocalizedUrl(pathWithoutLocale, localeItem)}                class={`locale-btn ${localeItem === locale ? "active" : ""}`}                data-locale={localeItem}                aria-disabled={localeItem === locale}              >                {getLocaleName(localeItem)}              </a>            ))          }        </div>      </div>    </main>  </body></html>

Nếu bạn muốn sử dụng nội dung của mình trong một thuộc tính chuỗi, chẳng hạn như alt, title, href, aria-label, v. b., bạn có thể sử dụng giá trị của hàm, như:

html

Sao chép nội dung

Sao chép mã

Sao chép đoạn mã vào khay nhớ tạm (clipboard)

<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)}" />

Lưu ý về thiết lập định tuyến: Cấu trúc thư mục bạn sử dụng phụ thuộc vào cài đặt middleware.routing trong intlayer.config.ts:

• prefix-no-default (mặc định): Giữ ngôn ngữ mặc định ở root (không có tiền tố) và thêm tiền tố cho các ngôn ngữ khác. Sử dụng [...locale] để bao gồm tất cả các trường hợp.
• prefix-all: Tất cả các URL đều có tiền tố ngôn ngữ. Bạn có thể sử dụng [locale] tiêu chuẩn nếu không cần xử lý root riêng biệt.
• search-param hoặc no-prefix: Không yêu cầu các thư mục ngôn ngữ. Ngôn ngữ được quản lý qua tham số truy vấn hoặc cookie.

Bước 6: Thêm bộ chuyển đổi ngôn ngữ

Trong Astro với Vanilla JS, bộ chuyển đổi ngôn ngữ được tạo trên máy chủ dưới dạng các liên kết thông thường và được kích hoạt ở phía client thông qua khối <script>. Khi người dùng nhấp vào liên kết ngôn ngữ, vanilla-intlayer sẽ thiết lập cookie ngôn ngữ thông qua setLocale trước khi điều hướng đến URL bản địa hóa.

<!-- Bao gồm mã nguồn phía máy chủ từ Bước 5 tại đây --><script>  import { installIntlayer, useLocale } from "vanilla-intlayer";  import { getLocaleFromPath, getLocalizedUrl, type LocalesValues } from "intlayer";  // Khởi tạo Intlayer ở client với ngôn ngữ lấy từ đường dẫn hiện tại  const locale = getLocaleFromPath(window.location.pathname);  installIntlayer({ locale: locale as LocalesValues });  const { setLocale } = useLocale({    onLocaleChange: (newLocale: LocalesValues) => {      window.location.href = getLocalizedUrl(window.location.pathname, newLocale);    },  });  // Gắn sự kiện nhấp chuột cho các liên kết chuyển đổi ngôn ngữ  const localeLinks = document.querySelectorAll("[data-locale]");  localeLinks.forEach((link) => {    link.addEventListener("click", (e) => {      const localeValue = link.getAttribute("data-locale") as LocalesValues;      if (localeValue && localeValue !== locale) {        e.preventDefault();        setLocale(localeValue);      }    });  });</script>

Lưu ý về tính bền vững: installIntlayer khởi tạo singleton Intlayer với ngôn ngữ được định nghĩa bởi máy chủ. useLocale cùng với onLocaleChange đảm bảo cookie ngôn ngữ được thiết lập trước khi chuyển hướng thông qua middleware, cho phép ghi nhớ tùy chọn ngôn ngữ của người dùng cho các lần truy cập sau.

Lưu ý về Progressive Enhancement: Các liên kết trong bộ chuyển đổi ngôn ngữ sẽ hoạt động như mã <a> tiêu chuẩn ngay cả khi không có JavaScript. Khi có JavaScript, lệnh gọi setLocale sẽ cập nhật cookie trước khi chuyển hướng, đảm bảo middleware xử lý đúng lựa chọn ngôn ngữ.

Bước 7: Sitemap và Robots.txt

Intlayer cung cấp các tiện ích để tự động tạo sơ đồ trang web (sitemap) bản địa hóa và file robots.txt của bạn.

Sitemap

Intlayer comes with a built-in sitemap generator to help you create a sitemap for your application easily. It handles localized routes and adds the necessary metadata for search engines.

The Intlayer generated sitemap supports the xhtml:link namespace (Hreflang XML Extensions). Unlike the default sitemap generators that only list raw URLs, Intlayer automatically creates the required bidirectional links between all language versions of a page (e.g., /about, /about?lang=fr, and /about?lang=es). This ensures search engines correctly index and serve the right language version to the right audience.

Tạo src/pages/sitemap.xml.ts để tạo sơ đồ trang web bao gồm tất cả các route bản địa hóa của bạn.

import type { APIRoute } from "astro";import { generateSitemap, type SitemapUrlEntry } from "intlayer";const pathList: SitemapUrlEntry[] = [  { path: "/", changefreq: "daily", priority: 1.0 },  { path: "/about", changefreq: "monthly", priority: 0.7 },];const SITE_URL = import.meta.env.SITE ?? "http://localhost:4321";export const GET: APIRoute = async ({ site }) => {  const xmlOutput = generateSitemap(pathList, { siteUrl: SITE_URL });  return new Response(xmlOutput, {    headers: { "Content-Type": "application/xml" },  });};

Robots.txt

Tạo src/pages/robots.txt.ts để kiểm soát hoạt động thu thập thông tin của các công cụ tìm kiếm.

import type { APIRoute } from "astro";import { getMultilingualUrls } from "intlayer";const getAllMultilingualUrls = (urls: string[]) =>  urls.flatMap((url) => Object.values(getMultilingualUrls(url)) as string[]);const disallowedPaths = getAllMultilingualUrls(["/admin", "/private"]);export const GET: APIRoute = ({ site }) => {  const robotsTxt = [    "User-agent: *",    "Allow: /",    ...disallowedPaths.map((path) => `Disallow: ${path}`),    "",    `Sitemap: ${new URL("/sitemap.xml", site).href}`,  ].join("\n");  return new Response(robotsTxt, {    headers: { "Content-Type": "text/plain" },  });};

Cấu hình TypeScript

Intlayer sử dụng cơ chế mở rộng module (module augmentation) để tận dụng TypeScript, làm cho cơ sở mã của bạn mạnh mẽ hơn.

Đảm bảo cấu hình TypeScript của bạn bao gồm các kiểu dữ liệu được tạo tự động.

{  // ... cấu hình TypeScript hiện tại của bạn  "include": [    // ... cấu hình TypeScript hiện tại của bạn    ".intlayer/**/*.ts", // Bao gồm các kiểu dữ liệu được tạo tự động  ],}

Cấu hình Git

Khuyên bạn nên bỏ qua các file được tạo bởi Intlayer. Điều này ngăn chúng được commit vào kho lưu trữ Git của bạn.

Để làm điều đó, hãy thêm các hướng dẫn sau vào file .gitignore của bạn:

# Bỏ qua các file được tạo bởi Intlayer.intlayer

Tiện ích mở rộng VS Code

Để cải thiện trải nghiệm phát triển của bạn với Intlayer, bạn có thể cài đặt tiện ích mở rộng Intlayer chính thức cho VS Code.

Cài đặt từ VS Code Marketplace

Tiện ích này sẽ cung cấp:

• Tự động hoàn thành cho các khóa dịch.
• Phát hiện lỗi thời gian thực cho các bản dịch còn thiếu.
• Xem trước trực tiếp nội dung đã dịch.
• Các hành động nhanh để tạo và cập nhật bản dịch dễ dàng.

Để biết thêm thông tin về cách sử dụng tiện ích này, hãy xem tài liệu tiện ích VS Code.

(Tùy chọn) Bước 1 : Trích xuất nội dung các thành phần của bạn

Nếu bạn có một cơ sở mã hiện có, việc chuyển đổi hàng nghìn tệp có thể tốn nhiều thời gian.

Để đơn giản hóa quy trình này, Intlayer đề xuất một trình biên dịch / trình trích xuất để chuyển đổi các thành phần của bạn và trích xuất nội dung.

Để thiết lập, bạn có thể thêm phần compiler vào tệp intlayer.config.ts của mình:

import { type IntlayerConfig } from "intlayer";

const config: IntlayerConfig = {
  // ... Phần còn lại của cấu hình
  compiler: {
    /**
     * Cho biết trình biên dịch có nên được bật hay không.
     */
    enabled: true,

    /**
     * Xác định đường dẫn các tệp đầu ra
     */
    output: ({ fileName, extension }) => `./${fileName}${extension}`,

    /**
     * Cho biết các thành phần có nên được lưu sau khi chuyển đổi hay không. Bằng cách đó, trình biên dịch có thể được chạy chỉ một lần để chuyển đổi ứng dụng, sau đó có thể được gỡ bỏ.
     */
    saveComponents: false,

    /**
     * Tiền tố khóa từ điển
     */
    dictionaryKeyPrefix: "",
  },
};

export default config;

npx intlayer extract

import { defineConfig } from "vite";import { intlayer, intlayerCompiler } from "vite-intlayer";export default defineConfig({ plugins: [   intlayer(),   intlayerCompiler(), // Thêm plugin trình biên dịch ],});

npm run build # Hoặc npm run dev

Tìm hiểu sâu hơn

Nếu bạn muốn tìm hiểu thêm, bạn cũng có thể triển khai Visual Editor hoặc sử dụng CMS để quản lý nội dung bên ngoài.