Creation:2024-12-02Last update:2025-06-29

将此文档参考到您的 AI 助手ChatGPT Claude DeepSeek Google AI mode Gemini Perplexity Mistral Grok

使用您最喜欢的AI助手总结文档，并引用此页面和AI提供商

版本历史

"初始化历史"
v5.5.102025/6/29

此页面的内容已使用 AI 翻译。

查看英文原文的最新版本

编辑此文档

如果您有改善此文档的想法，请随时通过在GitHub上提交拉取请求来贡献。

文档的 GitHub 链接

Copy

复制文档 Markdown 到剪贴板

文档：`express-intlayer` 中的 `t` 函数

Name: Intlayer
Author: 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 中间件处理传入请求，根据请求头、Cookie 或其他配置的方法检测用户偏好的语言环境。
翻译上下文：为 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!",
    })
  );
});

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

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 函数以强制严格遵守声明的语言环境：

显示表格的所有内容

在弹窗中打开表格以清晰地查看所有数据

模式	行为
`strict`	所有声明的语言环境必须提供翻译。缺少的语言环境将抛出错误。
`inclusive`	声明的语言必须有对应的翻译。缺失的语言会触发警告，但仍被接受。
`loose`	接受任何存在的语言，即使未声明。

配置示例：

import { type IntlayerConfig } from "intlayer";

const config = {
  // ... 您现有的配置
  internationalization: {
    // ... 您现有的国际化配置
    strictMode: "strict", // 强制严格模式
  },
} satisfies IntlayerConfig;

export default config;

TypeScript 集成

当与 TypeScript 一起使用时，t 函数是类型安全的。定义一个类型安全的翻译对象：

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));
});

常见错误与故障排除