# gt-next: General Translation Next.js SDK: createNextMiddleware
URL: https://generaltranslation.com/zh/docs/next/api/middleware/create-next-middleware.mdx
---
title: createNextMiddleware
description: createNextMiddleware() 方法的 API 参考文档
---

## 概述

`createNextMiddleware` 是一个工具函数，用于创建可在 Next.js 中使用的中间件函数。
它允许你在 Next.js 应用中为每个区域设置配置不同的路由。

例如，法语用户会被路由到 `/fr/landing`，英语用户会被路由到 `/en/landing`。

有关如何使用此中间件的更多信息，请参阅 [i18n 路由指南](/docs/next/guides/middleware)。

## 参考

### 属性

<TypeTable
  type={{
  "pathConfig": {
      type: 'PathConfig',
      optional: true,
      default: '{}',
  },
  "localeRouting": {
      type: 'boolean',
      optional: true,
      default: true,
  },
  "prefixDefaultLocale": {
      description: '用于启用或禁用是否从默认区域设置中移除区域设置前缀。',
      type: 'boolean',
      optional: true,
      default: false,
  },
  "ignoreSourceMaps": {
      description: '用于启用或禁用是否忽略 source maps。',
      type: 'boolean',
      optional: true,
      default: true,
  },
}}
/>

### 说明

| Prop                  | 说明                                                          |
| --------------------- | ----------------------------------------------------------- |
| `pathConfig`          | 用于为应用指定本地化路径的嵌套对象。                                          |
| `localeRouting`       | 用于启用或禁用 i18n 路由的标志。                                         |
| `prefixDefaultLocale` | 用于启用或禁用移除默认区域设置的区域设置前缀的标志。 (例如 `/en/about` -&gt; `/about`)  |
| `ignoreSourceMaps`    | 用于启用或禁用忽略 source map 的标志。                                   |

***

## 示例

### 基本用法

只需将此函数和路径匹配器添加到代理文件中，即可启用基于区域设置的路由。

```js title="proxy.ts" copy
import { createNextMiddleware } from 'gt-next/middleware'

export default createNextMiddleware();

export const config = {
  matcher: [
    /*
      * 匹配所有请求路径，以下开头的除外：
      * - api（API 路由）
      * - _next（内部文件）
      * - 静态文件
      */
    "/((?!api|static|.*\\..*|_next).*)",
  ],
}
```

### 本地化路径

你可以在代理文件中通过 `pathConfig` 选项指定本地化路径。

```js title="proxy.ts" copy
export default createNextMiddleware({
  pathConfig: {
    "/about": "/about",
    "/airplanes": {
      "zh": "/飞机",
    }
  },
});
```

有关其工作方式的详细说明，请参阅[i18n 路由指南](/docs/next/guides/middleware)。

### 移除默认区域设置前缀

你可以将 `prefixDefaultLocale` 选项设为 `false`，以移除默认区域设置前缀。

```js title="proxy.ts" copy
export default createNextMiddleware({
  prefixDefaultLocale: true,
});
```

当此项为 true 时，每个路径都必须带有区域设置前缀。
如果将其设为 `false` (默认值) ，则只会从路径中移除默认区域设置。

***

## 说明

* `createNextMiddleware` 函数是一个工具函数，用于创建供 Next.js 使用的代理/中间件函数。请将其放在项目 root 下的 `proxy.ts` 中。

## 后续步骤