# gt-react: General Translation React SDK: React 快速入门
URL: https://generaltranslation.com/zh/docs/react.mdx
---
title: React 快速入门
description: 在 10 分钟内为你的服务器端渲染 React 应用添加多语言支持
---

完成本指南后，你的服务器端渲染 React 应用将能够以多种语言显示内容，并提供用户可操作的语言切换器。

**前提条件：**

* 一个服务器端渲染 React 应用 (React Router 或自定义 SSR 设置)
* Node.js 18+

<Callout type="info">
  **纯客户端应用？** 如果你的应用完全在浏览器中通过 Vite 渲染，请改为参考 [SPA 快速入门](/docs/react/tutorials/quickstart-spa)——它会完全跳过 provider 组件。
</Callout>

***

## 第 1 步：安装软件包

`gt-react` 是为应用提供翻译功能的库。`gt` 是用于为生产环境准备翻译内容的 CLI 工具。

<Tabs items={['npm', 'yarn', 'bun', 'pnpm']}>
  <Tab value="npm">
    ```bash
    npm i gt-react
    npm i -D gt
    ```
  </Tab>

  <Tab value="yarn">
    ```bash
    yarn add gt-react
    yarn add --dev gt
    ```
  </Tab>

  <Tab value="bun">
    ```bash
    bun add gt-react
    bun add --dev gt
    ```
  </Tab>

  <Tab value="pnpm">
    ```bash
    pnpm add gt-react
    pnpm add --save-dev gt
    ```
  </Tab>
</Tabs>

***

## 第 2 步：创建翻译配置文件

在项目根目录下创建一个 **`gt.config.json`** 文件。该文件用于告诉库你支持哪些语言：

```json title="gt.config.json"
{
  "defaultLocale": "en",
  "locales": ["es", "fr", "ja"],
  "files": {
    "gt": {
      "output": "src/_gt/[locale].json"
    }
  }
}
```

* **`defaultLocale`** — 你的应用所使用的语言 (即源语言) 。
* **`locales`** — 你要翻译成的目标语言。可从[支持的区域设置列表](/docs/platform/supported-locales)中任选。
* **`files`** — 指定 CLI 将翻译文件保存到哪里。`output` 路径应与 `loadTranslations` 函数 (步骤 3) 中的导入路径保持一致。

***

## 第 3 步：创建翻译加载器

创建一个 `loadTranslations` 函数，用于加载某个区域设置的翻译文件。在服务端，它会在渲染时运行；运行 `npx gt translate` 时，CLI 会生成这些文件：

```ts title="src/loadTranslations.ts"
export default async function loadTranslations(locale: string) {
  try {
    const translations = await import(`./_gt/${locale}.json`);
    return translations.default;
  } catch (error) {
    return {};
  }
}
```

***

## 第 4 步：初始化库

在一个会同时由服务端和客户端加载的文件中，在模块作用域调用 **`initializeGT`**——通常放在 root 路由或布局中最合适。这样会一次性注册你的配置和翻译加载器；该配置在应用的整个生命周期内保持不可变：

```tsx title="src/routes/root.tsx"
import { initializeGT } from 'gt-react';
import gtConfig from '../../gt.config.json';
import loadTranslations from '../loadTranslations';

initializeGT({
  defaultLocale: gtConfig.defaultLocale,
  locales: gtConfig.locales,
  loadTranslations,
});
```

***

## 第 5 步：在服务器端加载翻译

在 root 路由的加载器 (或等效的服务器端 handler) 中，确定请求的区域设置，并使用 **`getTranslationsSnapshot`** 获取翻译快照，然后将这两项都传递给 **`<GTProvider>`**：

```tsx title="src/routes/root.tsx"
import {
  GTProvider,
  getTranslationsSnapshot,
  parseLocale,
} from 'gt-react';

// 在路由加载器中（具体 API 取决于你使用的框架）
export async function loader({ request }) {
  const locale = parseLocale(request); // [!code highlight]
  return {
    locale,
    translations: await getTranslationsSnapshot(locale), // [!code highlight]
  };
}

export default function Root({ children }) {
  const { locale, translations } = useLoaderData();
  return (
    <GTProvider locale={locale} translations={translations}>
      {children}
    </GTProvider>
  );
}
```

***

## 第 6 步：标记要翻译的内容

将所有需要翻译的文本都用 **`<T>`** 组件包裹起来。`<T>` 表示“translate”：

```tsx title="src/components/Welcome.tsx"
import { T } from 'gt-react';

export default function Welcome() {
  return (
    <main>
      <T>
        <h1>Welcome to my app</h1>
        <p>This content will be translated automatically.</p>
      </T>
    </main>
  );
}
```

对于普通字符串——例如 `placeholder` 属性或 `aria-label` 值——请使用 **`useGT`** 钩子：

```tsx title="src/components/ContactForm.tsx"
import { useGT } from 'gt-react';

export default function ContactForm() {
  const gt = useGT();
  return <input placeholder={gt('Enter your email')} />;
}
```

***

## 第 7 步：添加语言切换器

加入 **`<LocaleSelector>`**，让用户可以切换语言：

```tsx title="src/components/Header.tsx"
import { LocaleSelector } from 'gt-react';

export default function Header() {
  return <LocaleSelector />;
}
```

当用户选择一种语言时，`gt-react` 会将该选择保存到 `generaltranslation.locale` cookie 中，并重新加载页面，以便服务器使用新的区域设置重新渲染所有内容。

***

## 第 8 步：设置环境变量 (可选)

如果你想在开发环境中看到翻译结果，需要使用 General Translation 提供的 API 密钥。它们会启用**按需翻译**——这样你在开发过程中，应用就能实时翻译内容。

如果你的框架使用 Vite 构建，`gt-react` 会在初始化时自动读取这些变量：

```bash title=".env.local"
VITE_GT_PROJECT_ID="your-project-id"
VITE_GT_DEV_API_KEY="your-dev-api-key"
```

否则，请自行向 `initializeGT` 传入凭据：

```ts
initializeGT({
  defaultLocale: gtConfig.defaultLocale,
  locales: gtConfig.locales,
  loadTranslations,
  projectId: process.env.GT_PROJECT_ID,
  devApiKey:
    process.env.NODE_ENV === 'development'
      ? process.env.GT_DEV_API_KEY
      : undefined,
});
```

前往 [dash.generaltranslation.com](https://dash.generaltranslation.com/signup) 免费获取密钥，或运行：

```bash
npx gt auth
```

<Callout type="warn">
  在开发环境中，请使用以 `gtx-dev-` 开头的密钥。生产密钥 (`gtx-api-`) 仅限用于 CI/CD。
</Callout>

***

## 第 9 步：部署到生产环境

在生产环境中，翻译会在构建阶段预先生成 (不会发起实时 API 调用) 。将 `translate` 命令添加到构建脚本中：

```json title="package.json"
{
  "scripts": {
    "build": "npx gt translate && <YOUR_BUILD_COMMAND>"
  }
}
```

在托管服务提供商中设置 **production** 环境变量：

```bash
GT_PROJECT_ID=your-project-id
GT_API_KEY=gtx-api-your-production-key
```

<Callout type="warn">
  生产密钥以 `gtx-api-` 开头 (不是 `gtx-dev-`) 。请前往 [dash.generaltranslation.com](https://dash.generaltranslation.com) 获取。切勿公开暴露你的 `GT_API_KEY`。
</Callout>

就是这样——你的应用现在已经是多语言应用了。🎉

***

## 故障排查

<Accordions>
  <Accordion title="使用下拉菜单时，语言没有切换">
    `gt-react` 会将用户的语言偏好存储在名为 `generaltranslation.locale` 的 Cookie 中。如果你之前测试过其他语言，这个 Cookie 可能会覆盖你的当前选择。请清除 Cookie 后重试。

    * [Chrome](https://support.google.com/chrome/answer/95647)
    * [Firefox](https://support.mozilla.org/en-US/kb/delete-cookies-remove-info-websites-stored)
    * [Safari](https://support.apple.com/en-mn/guide/safari/sfri11471/16.0/mac/11.0)
  </Accordion>

  <Accordion title="开发环境中的翻译速度较慢">
    这是正常现象。在开发环境中，翻译是按需进行的 (你的内容会通过 API 实时翻译) 。**生产环境中不会有这种延迟**——所有翻译都会由 `npx gt translate` 预先生成。
  </Accordion>

  <Accordion title="某些翻译不够准确">
    有歧义的文本可能会导致翻译不准确。例如，“apple” 既可能指水果，也可能指公司。添加 `$context` 属性可以帮助消除歧义：

    ```jsx
    <T $context="the technology company">Apple</T>
    ```

    `<T>` 和 `useGT()` 都支持 `$context` 选项。
  </Accordion>
</Accordions>

***

## 下一步

* [**`<GTProvider>` API**](/docs/react/api/components/gtprovider) — `GTProvider` 属性的完整参考
* [**`<T>` 组件指南**](/docs/react/guides/t) — 了解变量、复数形式和高级翻译用法
* [**字符串翻译指南**](/docs/react/guides/strings) — 深入了解 `useGT`
* [**部署到生产环境**](/docs/react/tutorials/quickdeploy) — CI/CD 设置、缓存和性能优化