Nuxt 3 迁移指南:如何在路由中间件中替代 Nuxt 2 的 app 实例

秋辰君_5286

秋辰君_5286

2026-05-27

834人浏览

原创

本文详解如何将 Nuxt 2 中依赖 app 对象(如 app.$axios、app.$cookies、app.store)的认证中间件,安全、规范地迁移至 Nuxt 3,重点使用 useNuxtApp() 获取上下文,并适配 Composition API 风格。

本文详解如何将 nuxt 2 中依赖 `app` 对象(如 `app.$axios`、`app.$cookies`、`app.store`)的认证中间件,安全、规范地迁移至 nuxt 3,重点使用 `usenuxtapp()` 获取上下文,并适配 composition api 风格。

在 Nuxt 3 中,全局 app 实例已被移除,取而代之的是基于 Composable 的模块化设计。原 Nuxt 2 中通过 middleware/auth.js 接收 app 参数的方式不再适用;Nuxt 3 的中间件必须使用 defineNuxtRouteMiddleware 显式声明,并通过 useNuxtApp() 主动获取所需能力(如 $axios、$cookies、pinia store 等)。以下是完整迁移方案:

✅ 步骤一:重写中间件为 defineNuxtRouteMiddleware

将 middleware/auth.js 重命名为 middleware/auth.ts(推荐 TypeScript),并按 Nuxt 3 规范重构:

Skill Weave Chains — 技能链路由引擎
Skill Weave Chains — 技能链路由引擎

开箱即用的技能链路由引擎。13 条预定义链覆盖搜索、开发、审查、MLOps、法律、创意等场景,三层路由架构(触发词→SAD反馈→DAG编排),recall@10=96.97%。配置驱动(chains.yaml),零代码扩展。pip install skill-weave-chains 一键安装。

下载
// middleware/auth.ts
export default defineNuxtRouteMiddleware(async (to, from) => {
  const nuxt = useNuxtApp()
  const { $axios, $cookies } = nuxt

  // ✅ 替代 app.$axios 和 app.$cookies
  // ✅ 注意:Nuxt 3 默认不内置 Vuex,推荐使用 Pinia —— 假设你已配置 authStore
  const authStore = useAuthStore() // 来自 ~/stores/auth.ts

  try {
    console.log('Loading authentication...')

    const csrfToken = await fetchCsrfToken($axios, $cookies)
    const authResult = await checkAuth($axios, $cookies, 'accessToken', csrfToken)

    authStore.setAuthResult(authResult.res)

    if (authResult.res) {
      const userInfo = await getUserInfo($axios, $cookies, csrfToken)
      authStore.setUserInfo(userInfo.res)
      console.log('User info loaded:', userInfo.res)
    }
  } catch (error) {
    console.error('Authentication middleware error:', error)
  }
})

// ✅ 提取为独立函数(保持可测试性)
async function fetchCsrfToken($axios: any, $cookies: any) {
  try {
    const response = await $axios.$get('/getcsrf')
    const tokenInfo = response.token
    console.log('CSRF token received:', tokenInfo)
    return tokenInfo
  } catch (error) {
    console.error('Failed to fetch CSRF token:', error)
    throw error
  }
}

// ✅ 统一请求封装(推荐迁移到 ~/composables/useApi.ts)
async function ajaxRequest(
  $axios: any,
  url: string,
  method: string,
  data?: { token?: string; csrfToken?: string }
) {
  const headers: Record<string string> = {
    'Content-Type': 'application/json',
  }

  if (data?.token) headers.Authorization = `Bearer ${data.token}`
  if (data?.csrfToken) headers['X-XSRF-TOKEN'] = data.csrfToken

  try {
    const res = await $axios({
      method,
      url,
      headers,
      data: data || undefined,
    })

    if (res.status === 200) return res.data

    // 统一错误映射(可根据后端协议扩展)
    const statusText = {
      400: 'Bad Request',
      401: 'Unauthorized',
      403: 'Forbidden',
    }[res.status] || `Request failed with status ${res.status}`
    throw new Error(`${statusText}: ${JSON.stringify(res.data)}`)
  } catch (error: any) {
    throw new Error(`API request error: ${error.message || error}`)
  }
}

async function checkAuth(
  $axios: any,
  $cookies: any,
  tokenType: 'accessToken' | 'refreshToken',
  csrfToken: string
) {
  const token = tokenType === 'accessToken'
    ? $cookies.get('accessToken')
    : $cookies.get('refreshToken')

  if (!token) {
    console.warn(`Missing ${tokenType} cookie`)
    return { res: false }
  }

  try {
    console.log(`${tokenType} verification in progress...`)
    const res = await ajaxRequest($axios, '/check-auth', 'POST', {
      token,
      csrfToken,
    })

    if (tokenType === 'accessToken' && res === 'Refresh token required') {
      await checkAuth($axios, $cookies, 'refreshToken', csrfToken)
      return { res: false }
    }

    return { res }
  } catch (error) {
    console.error(`Auth check failed for ${tokenType}:`, error)
    return { res: false }
  }
}

async function getUserInfo($axios: any, $cookies: any, csrfToken: string) {
  const token = $cookies.get('accessToken')
  if (!token) throw new Error('Access token missing for user info fetch')

  try {
    const res = await ajaxRequest($axios, '/user-info', 'POST', {
      token,
      csrfToken,
    })
    return { res }
  } catch (error) {
    console.error('Failed to fetch user info:', error)
    throw error
  }
}</string>

✅ 步骤二:确保依赖项已正确安装与配置

  • Axios:使用 @nuxtjs/axios 已被弃用;推荐直接使用 Nuxt 内置的 $fetch 或集成 axios 实例(通过 runtimeConfig + create axios instance + provide 注入)。
  • Cookies:$cookies 来自 @vueuse/core 或 nuxt-cookie-control;若需服务端兼容,请使用 useCookie()(Nuxt 3 原生支持):
    const accessToken = useCookie('accessToken', { httpOnly: false, secure: true })
  • Store:务必迁移到 Pinia(Nuxt 3 官方推荐状态管理),并在 ~/stores/auth.ts 中定义:
    export const useAuthStore = defineStore('auth', {
      state: () => ({
        authResult: null as any,
        userInfo: null as any,
      }),
      actions: {
        setAuthResult(data) { this.authResult = data },
        setUserInfo(data) { this.userInfo = data },
      }
    })

⚠️ 注意事项与最佳实践

  • ❌ 不要直接在中间件中调用 useRouter() 或 navigateTo() 后不 return —— 若需重定向,请显式返回:
    if (!authStore.isAuthenticated) {
      return navigateTo('/login', { redirectCode: 302 })
    }
  • ✅ 所有异步操作必须 await,中间件默认是 async,未 await 将导致竞态或静默失败。
  • ✅ 避免在中间件中执行耗时逻辑(如多次 API 调用)—— 可考虑预加载策略(useAsyncData + #lazy)或服务端校验兜底。
  • ✅ 开发阶段启用 debug: true(在 nuxt.config.ts 中)便于排查 useNuxtApp() 作用域问题。

通过以上重构,你不仅完成了从 app 到 useNuxtApp() 的平滑过渡,更拥抱了 Nuxt 3 的响应式、类型安全与模块化哲学。迁移不是简单替换,而是借机优化架构 —— 让认证逻辑更清晰、可维护、可测试。

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

路由

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5686

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1369

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

5604

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

1040

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1996

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3905

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

5133

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3360

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

1088

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Revel 官方开发手册
Revel 官方开发手册

共0课时 | 0人学习

Buffalo框架路由开发手册
Buffalo框架路由开发手册

共0课时 | 0人学习

Buffalo框架官方文档
Buffalo框架官方文档

共0课时 | 0人学习