自定义路由

在 Nuxt 中，路由由 pages 目录中的文件结构定义。然而，由于它底层使用 vue-router，Nuxt 为你提供了几种在项目中添加自定义路由的方法。

添加自定义路由

在 Nuxt 中，路由由 app/pages 目录中的文件结构定义。然而，由于它底层使用Vue RouterNuxt 为你提供了几种在项目中添加自定义路由的方法。

路由器配置

使用路由器选项，你可以选择使用一个函数来覆盖或扩展你的路由，该函数接受扫描到的路由并返回自定义路由。

如果它返回 null 或 undefined，Nuxt 将回退到默认路由（这对于修改输入数组很有用）。

router.options.ts
import type { RouterConfig } from '@nuxt/schema'

export default {
  // https://router.vuejs.ac.cn/api/interfaces/routeroptions.html#routes
  routes: _routes => [
    {
      name: 'home',
      path: '/',
      component: () => import('~/pages/home.vue'),
    },
  ],
} satisfies RouterConfig
Nuxt 不会使用你在 definePageMeta 中定义的元数据来增强你从 routes 函数返回的任何新路由。如果你希望这样做，你应该使用 pages:extend 钩子，它在构建时调用。

页面钩子

你可以使用 pages:extend Nuxt 钩子从扫描的路由中添加、更改或删除页面。

例如，阻止为任何 .ts 文件创建路由

nuxt.config.ts
import type { NuxtPage } from '@nuxt/schema'

export default defineNuxtConfig({
  hooks: {
    'pages:extend' (pages) {
      // add a route
      pages.push({
        name: 'profile',
        path: '/profile',
        file: '~/extra-pages/profile.vue',
      })

      // remove routes
      function removePagesMatching (pattern: RegExp, pages: NuxtPage[] = []) {
        const pagesToRemove: NuxtPage[] = []
        for (const page of pages) {
          if (page.file && pattern.test(page.file)) {
            pagesToRemove.push(page)
          } else {
            removePagesMatching(pattern, page.children)
          }
        }
        for (const page of pagesToRemove) {
          pages.splice(pages.indexOf(page), 1)
        }
      }
      removePagesMatching(/\.ts$/, pages)
    },
  },
})

Nuxt 模块

如果你计划添加一整套与特定功能相关的页面，你可能需要使用 Nuxt 模块。

Nuxt kit 提供了几种添加路由的方式

路由器选项

除了自定义Vue Router的选项之外，Nuxt 还提供附加选项来自定义路由器。

使用 router.options

这是指定路由器选项的推荐方式。

router.options.ts
import type { RouterConfig } from '@nuxt/schema'

export default {
} satisfies RouterConfig

可以通过在 pages:routerOptions 钩子中添加文件来添加更多路由器选项文件。数组中靠后的项目会覆盖靠前的项目。

在此钩子中添加路由器选项文件将启用基于页面的路由，除非设置了 optional，在这种情况下，它只在基于页面的路由已经启用时才适用。
nuxt.config.ts
import { createResolver } from '@nuxt/kit'

export default defineNuxtConfig({
  hooks: {
    'pages:routerOptions' ({ files }) {
      const resolver = createResolver(import.meta.url)
      // add a route
      files.push({
        path: resolver.resolve('./runtime/router-options'),
        optional: true,
      })
    },
  },
})

使用 nuxt.config

注意：只有 JSON 可序列化的选项才能配置

  • linkActiveClass
  • linkExactActiveClass
  • end
  • sensitive
  • strict
  • hashMode
  • scrollBehaviorType
nuxt.config
export default defineNuxtConfig({
  router: {
    options: {},
  },
})

哈希模式 (SPA)

你可以在 SPA 模式下使用 hashMode 配置启用哈希历史记录。在这种模式下，路由器在实际 URL 前使用一个哈希字符 (#)，该字符在内部传递。启用后，URL 永远不会发送到服务器，并且不支持 SSR。

nuxt.config.ts
export default defineNuxtConfig({
  ssr: false,
  router: {
    options: {
      hashMode: true,
    },
  },
})

哈希链接的滚动行为

你可以选择自定义哈希链接的滚动行为。当你将配置设置为 smooth，并且加载带有哈希链接的页面（例如 https://example.com/blog/my-article#comments），你会看到浏览器平滑地滚动到这个锚点。

nuxt.config.ts
export default defineNuxtConfig({
  router: {
    options: {
      scrollBehaviorType: 'smooth',
    },
  },
})

自定义历史记录（高级）

你可以选择使用一个函数来覆盖历史记录模式，该函数接受基本 URL 并返回历史记录模式。如果它返回 null 或 undefined，Nuxt 将回退到默认历史记录。

router.options.ts
import type { RouterConfig } from '@nuxt/schema'
import { createMemoryHistory } from 'vue-router'

export default {
  // https://router.vuejs.ac.cn/api/interfaces/routeroptions.html
  history: base => import.meta.client ? createMemoryHistory(base) : null, /* default */
} satisfies RouterConfig