Vue 3 项目初始化怎么规范团队目录与公共组件开发标准

夜宇君_7381

夜宇君_7381

2026-10-10

570人浏览

原创

vue 3项目应按业务模块组织src目录,如src/views/user/包含页面、api、类型和组合式函数;公共组件仅限跨模块复用且需明确定义用途、typescript声明props、规范插槽与事件;组合式函数替代工具函数,命名与路径需语义清晰。

vue 3 项目初始化怎么规范团队目录与公共组件开发标准

Vue 3 项目初始化阶段,目录结构和公共组件标准不是“搭完架子就完事”的一步操作,而是团队协作的起点。规范做得早,后期改起来成本低;拖到多人并行、功能堆积后再重构,往往要重写接口调用、迁移状态逻辑、统一命名风格,反而更耗时。

按业务模块组织 src 目录,不按文件类型堆砌

避免把所有页面塞进 views/、所有组件扔进 components/、所有请求塞进 api/——这种纯技术分层会让开发者每次改一个功能都要跨 4–5 个目录找文件。

推荐结构(可直接落地):

  • src/views/user/:包含 UserList.vue、UserProfile.vue、user.api.ts、user.types.ts、useUserSearch.ts
  • src/views/order/:同理,自有页面、API、类型、组合式函数全在本目录下
  • src/components/ 只放真正跨模块复用的组件,比如 BaseTable.vue、ConfirmDialog.vue,不放“用户头像”“订单状态标签”这类业务强耦合组件
  • 业务组件优先放在对应 view 目录内,如 src/views/user/UserAvatar.vue,需要复用时再向上提取

公共组件开发必须带明确边界与契约

团队里最容易变成“黑盒垃圾场”的就是 components/。一个叫 Card.vue 的组件,可能在用户页渲染头像+昵称,在订单页显示金额+时间,在商品页又变成折叠面板——表面复用,实则隐式耦合。

规范做法:

vue-component-analyzer
vue-component-analyzer

递归分析 Vue 项目组件依赖,从入口文件生成组件层级图,支持 Vue 2/3,输出组件名、文件路径和属性。适用于分析组件结构、排查依赖或了解项目架构。

下载
  • 每个公共组件必须有清晰的用途定义,写在组件顶部注释里,例如:// BaseCard:仅用于展示标题+描述+操作按钮,不支持嵌套表单或异步加载
  • Props 必须用 TypeScript 显式声明,禁止 any 或 Object;可选 props 加 ?,必填项不加默认值
  • 不接受“万能插槽”设计。如有 #header、#footer 插槽,需在文档中说明适用场景和约束(比如 footer 插槽只允许放按钮,不支持文字或复杂布局)
  • 对外暴露的事件名用 kebab-case(如 @item-click),内部 emit 统一用 camelCase,通过 defineEmits 做类型校验

组合式函数(composables)代替工具函数,提升可测试性

别再往 utils/ 里塞一堆静态函数。像日期格式化、权限判断、表单校验这些逻辑,一旦和响应式、生命周期、Pinia store 打交道,纯工具函数就失效了。

正确姿势:

  • 拆出 src/composables/ 目录,每个文件专注一个能力域,如 useAuth.ts、useTablePagination.ts、useFileUpload.ts
  • 函数名统一前缀 use,返回值必须是响应式对象或解构后的 ref/ref-like 值
  • 内部可调用 onMounted、watch、useStore 等,但不直接操作 DOM 或发起副作用请求;请求应封装在 api/modules/ 下,由 composables 调用
  • 对外提供明确的输入输出契约,比如 useTablePagination({ api: fetchList }),而不是让使用者传一堆参数去拼接 URL

命名与导入路径要“一眼懂用途”

命名不是审美问题,是协作效率问题。路径太长、名字太泛,新人花半小时都找不到“用户搜索框”在哪。

执行细则:

  • 组件文件名用 PascalCase:UserSearchForm.vue,不叫 search.vue 或 user-search.vue
  • 组合式函数用 useXxx,TS 工具函数用 xxxHelper.ts 或 xxxUtils.ts,区分语义
  • 配置类文件统一后缀,如 router.config.ts、pinia.plugins.ts
  • Vite 配置路径别名 @/ 指向 src/,@api 指向 src/api/modules,@comp 指向 src/components,减少相对路径出错

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

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

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2363

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

5103

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6170

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

5718

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

803

5

vue2.0和3.0区别
vue2.0和3.0区别

vue2.0和3.0区别:vue2的响应式原理是利⽤“Object.defineProperty()”对数据进⾏劫持结合发布订阅模式的⽅式来实现,vue3中使⽤了es6的proxy API对数据代理,实现对数据的监控。本专题为大家提供vue2.0和3.0区别的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.17

1654

5

vue3的生命周期有哪些
vue3的生命周期有哪些

vue3的生命周期:1、beforecreate;2、created;3、beforemount;4、mounted;5、beforeupdate;6、updated;7、beforedestroy;8、destroyed;9、activated;10、deactivated等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

11962

5

Vue3组合式API与组件开发实战
Vue3组合式API与组件开发实战

本专题讲解 Vue 3 组合式 API 的核心概念与应用技巧,深入分析响应式系统、生命周期管理、组件设计与复用策略。通过完整项目案例,指导前端开发者实现高性能、结构清晰的 Vue 应用,提升开发效率与代码可维护性。

2026.02.10

316

23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 17万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.7万人学习