第四阶段:Vue 进阶与生态整合(第 47 天)(Vue 项目目录结构解析:每个文件夹的作用与规范)

Vue 项目目录结构解析

标准 Vue 项目目录结构示例

以下是一个符合规范的 Vue 项目目录结构,常见于 Vue CLI 或 Vite 生成的项目中:

复制代码
src/
├── assets/               # 静态资源(图片、字体等)
├── components/           # 公共组件(大驼峰命名,如 UserCard.vue)
├── composables/          # Vue 3 组合式函数(小驼峰命名)
├── router/               # 路由配置(index.js)
├── store/                # Vuex/Pinia 状态管理
├── utils/                # 工具函数(小驼峰命名,如 formatDate.js)
├── views/                # 页面级组件(大驼峰命名,如 HomeView.vue)
├── api/                  # 接口封装(模块化拆分,如 userApi.js)
├── styles/               # 全局样式(SCSS/CSS)
├── App.vue               # 根组件
└── main.js               # 应用入口文件

核心文件夹与文件作用

assets

存放静态资源(图片、图标、字体等),通常通过相对路径引用。

components

复用性高的 UI 组件,命名采用大驼峰(PascalCase),例如:

vue 复制代码
<!-- components/UserCard.vue -->
<template>
  <div class="user-card">{{ userName }}</div>
</template>

views

页面级组件,与路由直接关联。命名规范同组件,例如 HomeView.vue。

api

接口封装模块化,按功能拆分文件:

javascript 复制代码
// api/userApi.js
export const login = (data) => axios.post('/api/login', data);
export const getUser = (id) => axios.get(`/api/user/${id}`);

utils

工具函数库,命名采用小驼峰(camelCase),例如:

javascript 复制代码
// utils/formatDate.js
export const formatDate = (timestamp) => new Date(timestamp).toLocaleString();

router

路由配置集中管理,通常导出 createRouter 实例:

javascript 复制代码
// router/index.js
const routes = [{ path: '/', component: HomeView }];
export default createRouter({ history: createWebHistory(), routes });

编码规范与分层原则

命名规范

  • 组件:大驼峰(MyComponent.vue)
  • 工具函数/组合式函数:小驼峰(useFetchData.js)
  • 接口文件:功能前缀 + Api(userApi.js)

目录分层

  • 横向按功能划分(如 api、components)
  • 纵向按模块划分(如 user 相关接口、组件、状态集中管理)

示例:接口封装规范

模块化接口文件

javascript 复制代码
// api/userApi.js
import axios from '@/utils/request';

export default {
  login: (data) => axios.post('/login', data),
  getProfile: (id) => axios.get(`/user/${id}`),
};

调用示例

javascript 复制代码
import userApi from '@/api/userApi';

userApi.login({ username: 'admin', password: '123' });

关键总结

职责边界明确

  • components:纯 UI 展示
  • views:路由关联页面
  • api:接口逻辑隔离
  • utils:纯函数工具

可维护性提升

  • 命名一致性强
  • 功能模块高内聚
  • 避免多层嵌套目录

通过规范化的目录结构和编码约定,可显著降低团队协作成本,增强代码可读性和可扩展性。

相关推荐
前端双越老师16 分钟前
程序员 1v1 访谈系列第十六期:裸辞后失业半年了
前端·ai编程·全栈
Highcharts.js19 分钟前
Workbuddy + Highcharts Orbit:工作区数据自动建模与可视化分析实践
前端·javascript·信息可视化·数据可视化·highcharts·可视化图表·workbuddy
徐小夕24 分钟前
MedDoc AI:把临床书写、协作、质控、知识问答装进一个工作台
前端·vue.js·github
艾莉丝努力练剑24 分钟前
【QT】系统相关:TCP的API介绍
开发语言·前端·c++·人工智能·qt·学习·tcp/ip
cong_1 小时前
🐟 我把摸鱼岛重写了!现在群聊还能装进一张表格
前端·后端·github
恋猫de小郭1 小时前
iOS for Web ,把原生 iOS App 跑到进浏览器里面,倒反天罡
android·前端·ios
Mh11 小时前
我是如何设计品牌站组件库的?
前端·css·设计模式
程序员大阳11 小时前
副队长Vue3教程(2)--Vite 搭建 Vue 项目,认识目录结构
前端·javascript·vue.js·vite·创建项目·目录结构·项目结构
濮水大叔12 小时前
Cabloy/Zova 与 Next.js 的 SSR 水合差异
前端·typescript·next.js