仪表板
Inline Translations

getMessages

getMessages() 字符串翻译函数的 API 参考

概述

getMessages 是一个异步函数，用于在构建时翻译由 msg 生成的 encoded string。

const m = await getMessages();

<p>{  m(encodedString)  }</p>;

构建时翻译： getMessages 的翻译在构建阶段进行，也就是在你的应用部署之前。 你可以传入来自 msg 的 encoded string，它们将被翻译为用户的首选语言。

参考资料

参数

无

返回

一个回调函数 m 的 Promise，用于将来自 msg 的已编码内容进行翻译。

Promise<(encodedContent: string, options?: Record<string, any>) => string>
名称类型描述
encodedContentstring来自 msg 的 encoded string 内容，待翻译。
options?Record<string, any>可选参数，用于覆盖 encoded string 中的变量。

行为

生产环境

在持续交付（CD）流程中，任何位于 msg 函数中的内容都会在应用部署前完成翻译。 这可确保所有 locale 的加载速度更快，但只能翻译构建时已知的内容。

生成后，翻译会根据你的配置（1）存储在 CDN（内容分发网络）中，或（2）存储在应用的构建产物中。 随后，这些翻译内容将被提供给你的用户。 如果未找到对应的翻译，则会回退（fallback）到原始内容。

请务必遵循部署指南。

开发环境

在开发阶段，m 函数会按需翻译内容。 这有助于快速预览你的应用在不同语言下的呈现效果。 请记得在环境中添加 Dev API key 以启用此功能。

在开发环境中进行按需翻译时，你可能会看到一定延迟。 在生产构建中不会出现这种情况，除非内容被显式地按需翻译， 例如使用 tx 或 <Tx>。

示例

基本用法

你可以使用 getMessages 来翻译由 msg 生成的 encoded string。

import { msg, getMessages } from 'gt-next/server';

const encodedGreeting = msg('你好，Alice！');

export default async function TranslateGreeting() {
  const m = await getMessages();

  return (
    <p>
      {m(encodedGreeting)}
    </p>
  );
}

注意：“Alice”将被翻译为用户的首选语言。

使用变量

你可以在 encoded string 中重写 variables。

import { msg, getMessages } from 'gt-next/server';

const encodedGreeting = msg('你好，{name}！', { name: 'Alice' });

export default async function TranslateGreeting() {
  const m = await getMessages();

  return (
    <p>
      {m(encodedGreeting, { name: 'Bob' })}
    </p>
  );
}

注意：这将显示 "Hello, Bob!"——变量会在渲染时被重写。

使用 ICU 消息格式

gt-next 支持 ICU 消息格式，可用于格式化变量。

import { msg, getMessages } from 'gt-next/server';

const encodedMessage = msg('购物车中{count, plural, =0 {没有商品} =1 {有1件商品} other {有{count}件商品}}', { count: 10 });

export default async function TranslateGreeting() {
  const m = await getMessages();
  return (
    <p>
      {m(encodedMessage)}
    </p>
  );
}

ICU 消息格式是一种强大的方式，用于格式化变量。 如需了解更多，请参阅 ICU 消息格式文档。

注意

  • getMessages 是一个在服务器端运行的函数，用于将 msg 产生的 encoded strings 转换为译文。
  • 使用 getMessages 的翻译会在运行时之前、于构建阶段完成（开发环境除外）。

后续步骤

  • 请参阅 useMessages，在构建时从 encoded string 执行客户端字符串翻译。
  • 请参阅 msg 以对字符串进行编码以供翻译。
  • 如需运行时翻译，请参阅 tx 和 <Tx>。

这份指南怎么样？

useMessages

useMessages() 字符串翻译函数的 API 参考

tx

tx 字符串翻译函数的 API 参考

本页内容

概述
参考资料
参数
返回
行为
生产环境
开发环境
示例
基本用法
使用变量
使用 ICU 消息格式
注意
后续步骤
getMessages