# gt-next: General Translation Next.js SDK: getLocale
URL: https://generaltranslation.com/zh/docs/next/api/helpers/get-locale.mdx
---
title: getLocale
description: getLocale 服务器端方法的 API 参考
---

## 概述

`getLocale` 函数用于在服务器端渲染期间获取当前用户的区域设置。
返回的区域设置采用 BCP 47 [区域设置代码](/docs/core/locales)，例如 `'en-US'`。

<Callout>
  `getLocale` 是一个服务器端方法，只能在服务器端
  组件中使用。
</Callout>

如需在客户端使用，请参阅 [`useLocale`](/docs/next/api/helpers/use-locale)。

## 参考

### 返回值

一个 Promise，解析结果为表示用户当前区域设置的字符串，例如 `'en-US'`。

***

## 回退行为

当请求的区域设置不受支持时，系统会选择一个回退区域设置。

例如，遇到不受支持的区域设置时，
如果 (1) 用户在浏览器设置中配置了多个首选区域设置，
并且 (2) 其中一个区域设置受你的应用支持，
则会回退到最匹配的语言。

此外，如果没有可用的回退区域设置，
但两个区域设置属于同一种语言 (例如 `en-US` 和 `en-GB`) ，
则会回退到共享该语言的受支持区域设置。

如果这两个条件都不满足，则将使用默认区域设置。

有关如何配置受支持区域设置 的信息，请参阅 [`gt.config.json`](/docs/next/api/config/gt-config-json) 文档。

***

## 示例

### 基本用法

在服务器端渲染时获取用户的区域设置。

```javascript title="GetUserLocale.jsx" copy
import { getLocale } from 'gt-next/server';

export default async function GetUserLocale() {
  const locale = await getLocale(); // [!code highlight]
  return <p>User locale: {locale}</p>;
}
```

***


## 说明

* `getLocale` 函数是异步函数，必须使用 `await` 等待后才能获取区域设置。
* 它专为服务器端使用而设计。对于客户端组件，请参阅 [`useLocale`](/docs/next/api/helpers/use-locale)。
* 返回的区域设置符合[区域设置代码](/docs/core/locales)格式。

## 后续步骤

* 了解如何使用 [withGTConfig()](/docs/next/api/config/with-gt-config) 配置受支持区域设置。