unplugin-vue-router文件路由实操

unplugin-vue-router 会根据你的文件结构自动生成路由配置。虽然路由是自动生成的,但你仍然可以通过 路由元信息(meta) 来对组件做一些特殊处理。

yaml 复制代码
<route lang="yaml">
    name: login
    meta:
      whiteList: true
      title: 登录跳转
      constant: true
      layout: index
</route>
javascript 复制代码
安装
pnpm i unplugin-vue-router -D

配置// vite.config.js
import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
import VueRouter from "unplugin-vue-router/vite";

export default defineConfig({
  plugins: [
    VueRouter({ routesFolder: "src/views" }),
    vue(),
  ]
});

使用
import { routes } from "vue-router/auto/routes" // 引入文件路由表
import { createRouter, createWebHistory } from "vue-router"

const router = createRouter({
  routes: routes, // 注册文件路由表
  history: createWebHistory(),
})

运行项目打印routes就会看到生成好的路由

一般搭配vite-plugin-vue-meta-layouts使用

javascript 复制代码
安装
pnpm i vite-plugin-vue-meta-layouts -D

配置// vite.config.js
import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
import VueRouter from "unplugin-vue-router/vite";
import MetaLayouts from "vite-plugin-vue-meta-layouts"

export default defineConfig({
  plugins: [
    VueRouter({ routesFolder: "src/views" }),
    Layouts({
      target: "src/layouts", // 布局目录,默认 src/layouts
      defaultLayout: "index", // 默认布局,默认为 default
      skipTopLevelRouteLayout: true, 
    }),
    vue(),
  ]
});

使用
import { routes } from "vue-router/auto/routes" // 引入文件路由表
import { setupLayouts } from "virtual:meta-layouts"
import { createRouter, createWebHistory } from "vue-router"

const router = createRouter({
  routes: setupLayouts(routes), // 注册文件路由表
  history: createWebHistory(),
})

如果你是 `ts` 项目,还可以在 `tsconfig.json` 中配置以下声明
{
  "compilerOptions": {
    "types": ["vite-plugin-vue-meta-layouts/client"]
  }
}

在layouts文件夹创建不同的的布局文件

在页面组件中通过路由元信息配置layout的值来让页面使用哪种布局,一般在vite.config.ts配置默认使用的布局

ini 复制代码
<route lang="yaml">
    meta:
      layout: empty 
</route>

然后可以通过createGetRoutes查看生成的路由

javascript 复制代码
import { createGetRoutes } from "virtual:meta-layouts"

const getRoutes = createGetRoutes(router)

// 获取路由表但是不包含布局路由
console.log(getRoutes())

文件路由使用路由query 传参跳转页面需要为 router-view 添加唯一 key 不然就会出现多次跳转同一页面,如果只是参数不同,页面不会重新执行生命周期方法

ini 复制代码
<router-view v-slot="{ Component, route }">
   <keep-alive :include="cachedComponents">
      <component :is="Component" :key="route.fullPath" />
   </keep-alive>
</router-view>

当然,如果是使用动态路由就不会有这个问题

  • src/views/users/[id].vue → /users/:id
  • src/views/posts/[...slug].vue → /posts/:slug(.*)*
相关推荐
feixing_fx3 小时前
第一个 JS 程序:在浏览器控制台和 Node 中分别运行
开发语言·前端·javascript·前端框架·ecmascript
feixing_fx4 小时前
变量与声明:let、const、var 的选择边界
开发语言·前端·javascript·前端框架
JavaGuide7 小时前
Cloudflare 开源的这套神级安全审计 Skill 太好用了!
前端·后端
孟健8 小时前
用 unslop 拯救 AI 生成网页的塑料感,7 分钟重构落地实测
前端·人工智能·ai编程
feixing_fx8 小时前
JavaScript 是什么:从浏览器脚本到通用编程语言
开发语言·前端·javascript·前端框架·ecmascript
丘山望岳8 小时前
【开发工具】 cluade code常用快捷键
前端
小巫编程室8 小时前
我造了一个 Java 能力包:让 AI 直接调用你的业务代码
java·前端·后端
小y的笔记9 小时前
JavaScript URL 状态同步
前端·javascript
十有八七9 小时前
手搓 Agent(五):学会翻书——RAG,先查资料再回答
前端·人工智能·后端
Swot9 小时前
产品 RAG 知识库与 AI 顾问 设计与实现
前端·后端