---
title: "defineNuxtRouteMiddleware"
description: "使用 defineNuxtRouteMiddleware 辅助函数创建命名路由中间件。"
canonical_url: "https://nuxt.zhcndoc.com/docs/3.x/api/utils/define-nuxt-route-middleware"
---
# defineNuxtRouteMiddleware

> 使用 defineNuxtRouteMiddleware 辅助函数创建命名路由中间件。

路由中间件存储在 Nuxt 应用的 [`middleware/`](https://nuxt.zhcndoc.com/docs/3.x/directory-structure/middleware) 目录中（除非[另有设置](https://nuxt.zhcndoc.com/docs/3.x/api/nuxt-config#middleware)）。

## 类型

```ts [Signature]
export function defineNuxtRouteMiddleware (middleware: RouteMiddleware): RouteMiddleware

interface RouteMiddleware {
  (to: RouteLocationNormalized, from: RouteLocationNormalized): ReturnType<NavigationGuard>
}
```

## 参数

### `middleware`

- **类型**：`RouteMiddleware`

一个函数，接受两个 Vue Router 的路由位置对象作为参数：第一个是目标路由 `to`，第二个是当前路由 `from`。

关于 `RouteLocationNormalized` 可用属性的更多信息，请参阅 **[Vue Router 文档](https://router.vuejs.org/api/type-aliases/RouteLocationNormalized.html)**。

## 示例

### 显示错误页面

你可以使用路由中间件抛出错误并显示有用的错误信息：

```ts [middleware/error.ts]
export default defineNuxtRouteMiddleware((to) => {
  if (to.params.id === '1') {
    throw createError({ statusCode: 404, statusMessage: '页面未找到' })
  }
})
```

上述路由中间件会将用户重定向到在 `~/error.vue` 文件中定义的自定义错误页面，并暴露从中间件传递的错误信息和代码。

### 重定向

在路由中间件中，将 [`useState`](https://nuxt.zhcndoc.com/docs/3.x/api/composables/use-state) 与 `navigateTo` 辅助函数结合使用，可根据用户的身份验证状态将其重定向到不同路由：

```ts [middleware/auth.ts]
export default defineNuxtRouteMiddleware((to, from) => {
  const auth = useState('auth')

  if (!auth.value.isAuthenticated) {
    return navigateTo('/login')
  }

  if (to.path !== '/dashboard') {
    return navigateTo('/dashboard')
  }
})
```

[navigateTo](https://nuxt.zhcndoc.com/docs/3.x/api/utils/navigate-to) 和 [abortNavigation](https://nuxt.zhcndoc.com/docs/3.x/api/utils/abort-navigation) 都是全局可用的辅助函数，你可以在 `defineNuxtRouteMiddleware` 中使用。

---

- [源码](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/router.ts)


## Sitemap

See the full [sitemap](https://nuxt.zhcndoc.com/sitemap.md) for all pages.