# gt-react: General Translation React SDK: useMessages
URL: https://generaltranslation.com/zh/docs/react/api/strings/use-messages.mdx
---
title: useMessages
description: useMessages() 字符串翻译函数 API 参考
---

{/* 自动生成：请勿直接编辑。请改为编辑 content/docs-templates/ 中的模板。 */}


## 概述

`useMessages` 函数是一个钩子，用于在构建阶段翻译由 `msg` 编码的字符串。

```jsx
const m = useMessages();

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

<Callout>
  **构建时翻译：** `useMessages` 的翻译发生在构建阶段，
  也就是在应用部署之前。你可以传入由 `msg` 编码的字符串，它们会
  被翻译为用户的首选语言。
</Callout>


## 参考

### 参数

无

### 返回值

回调函数 `m`，用于翻译由 `msg` 提供的已编码内容。

```jsx
(encodedContent: string, options?: Record<string, any>) => string
```

| 名称               | 类型                    | 描述                       |
| ---------------- | --------------------- | ------------------------ |
| `encodedContent` | `string`              | 来自 `msg` 的、待翻译的已编码字符串内容。 |
| `options?`       | `Record<string, any>` | 用于向已编码字符串传递变量的可选参数。      |

***


## 行为

### 生产环境

在 CD 过程中，`msg` 函数中的任何内容都会在应用部署前完成翻译。
这样可以确保所有区域设置都有更快的加载速度，但它只能翻译在构建时已知的内容。

翻译生成后，会根据你的配置： (1) 存储在 CDN 中，或 (2) 存储在应用的构建产物中。
随后，这些翻译内容会被提供给用户。
如果找不到对应的翻译，则会回退为原始内容。

请务必遵循[此处的部署指南](/docs/react/tutorials/quickdeploy)。

### 开发

在开发过程中，`m` 函数会按需翻译内容。
这很适合用来快速了解应用在不同语言下的呈现效果。
请记得在环境中添加 Dev API 密钥，以启用此行为。

在开发环境中按需翻译时，你会感觉到一些延迟。
除非内容被明确配置为按需翻译，否则生产构建中不会出现这种情况。

***

## 示例

### 基本用法

你可以使用 `useMessages` 翻译由 `msg` 编码的字符串。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedGreeting = msg('Hello, Alice!');

export default function TranslateGreeting() {
  const m = useMessages();

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

注意：&quot;Alice&quot; 会被翻译成用户的首选语言。


### 使用变量 [#variables]

你可以向已编码的字符串传入变量。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedGreeting = msg('Hello, {name}!');

export default function TranslateGreeting() {
  const m = useMessages();

  return (
    <p>
      {m(encodedGreeting, { name: 'Bob' })}{' '}
      {/* 这将显示 "Hello, Bob!" */}
    </p>
  );
}
```


### `msg` 变量会覆盖 `m` 变量

当你同时向 `msg` 和 `m` 传入变量时，传给 `msg` 的变量会覆盖传给 `m` 的变量。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedGreeting = msg('Hello, {name}!', { name: 'Alice' });

export default function TranslateGreeting() {
  const m = useMessages();
  return <p>{m(encodedGreeting, { name: 'Bob' })}</p>;
}
```

注意：这将显示 &quot;Hello, Alice!&quot;——渲染时不会覆盖该变量。


### 使用 ICU 消息格式

`gt-react` 支持 ICU 消息格式，因此你也可以对变量进行格式化。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedMessage = msg(
  'There are {count, plural, =0 {no items} =1 {one item} other {{count} items}} in the cart',
  { count: 10 }
);

export default function TranslateGreeting() {
  const m = useMessages();
  return <p>{m(encodedMessage)}</p>;
}
```

<Callout>
  ICU 消息格式是一种功能强大的变量格式化方式。更多信息请参阅 [ICU 消息格式
  文档](https://unicode-org.github.io/icu/userguide/format_parse/messages/)。
</Callout>


### 从 `gt-react` 导入

如果使用 `"use client"` 指令，应从 `gt-react` 导入，而不是从 `gt-react` 导入。

```jsx copy
'use client';
import { msg, useMessages } from 'gt-react';

const encodedGreeting = msg('Hello, Alice!');

export default function TranslateGreeting() {
  const m = useMessages();

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

***


## 说明

* `useMessages` 函数是一个 钩子，用于翻译由 `msg` 编码的字符串。
* 通过 `useMessages` 进行的字符串翻译会在 runtime 之前的构建阶段完成 (开发环境除外) 。

## 后续步骤

* 关于如何对字符串进行编码以供翻译，请参阅 [`msg`](/docs/react/api/strings/msg)。