Vue3 项目目录结构最佳实践
从规范的目录结构入手,能让团队协作更高效。一个命名统一、层次分明的项目,不仅帮助新成员快速上手,也避免老成员在混乱文件中迷失方向。以下是推荐的项目骨架:
my-vue3-project/
├── src/
│ ├── assets/ # 静态资源(图片、字体等)
│ ├── components/
│ │ ├── common/ # 通用UI组件(跨项目复用,无业务逻辑)
│ │ │ └── BaseButton.vue
│ │ └── biz/ # 通用业务组件(跨页面复用,含业务逻辑)
│ │ └── BizUserCard.vue
│ ├── composables/ # 组合式函数(可复用的状态逻辑)
│ │ └── useUser.ts
│ ├── layouts/ # 布局组件(页面整体结构)
│ │ ├── default.vue
│ │ └── components/ # 布局专用组件(仅布局层使用)
│ │ └── AppHeader.vue
│ ├── pages/ # 页面组件(路由对应,kebab-case命名)
│ │ ├── user-profile.vue
│ │ └── user/ # 页面模块
│ │ ├── list.vue
│ │ └── components/ # 页面专用组件(仅当前模块使用)
│ │ └── UserFilter.vue
│ ├── router/ # 路由配置(管理页面路由)
│ │ ├── index.ts
│ │ └── user-routes.ts
│ ├── stores/ # Pinia状态管理(全局共享状态)
│ │ └── userStore.ts
│ ├── services/ # API服务层(封装后端接口调用)
│ │ └── userService.ts
│ ├── utils/ # 工具函数(纯函数,无副作用)
│ │ ├── formatDate.ts
│ │ └── validateEmail.ts
│ ├── types/ # TypeScript类型定义(接口、枚举等)
│ │ ├── User.ts
│ │ └── api.ts
│ ├── styles/ # 全局样式(变量、混入、重置样式)
│ │ └── global.scss
│ ├── App.vue
│ └── main.ts
├── tests/
│ └── unit/ # 单元测试(与src目录结构对应)
│ ├── components/
│ └── utils/
└── package.json
此处有一个关键细节:pages/user/ 下存放的是页面文件 list.vue,而该页面的专属组件则归属于 pages/user/components/。这种分层方式让每个页面的“领地”清晰分明,避免组件被埋没在深层目录中而难以查找。
Vue3 文件命名规则指南
命名看似琐碎,但一旦团队达成共识,便能消除大量“这个文件究竟是做什么的”疑惑。下面是一套经多个项目验证的命名规则,可直接采纳。
| 类型 | 规则 | 示例 | 说明 |
|---|---|---|---|
| 通用UI组件 | Base + PascalCase | BaseButton.vue | 无业务逻辑,纯UI |
| 通用业务组件 | Biz + PascalCase | BizUserCard.vue | 跨页面复用,含业务 |
| 布局组件 | App + PascalCase | AppHeader.vue | 仅布局层使用 |
| 页面文件 | kebab-case | user-profile.vue | 与路由路径一致 |
| 页面专用组件 | PascalCase | UserFilter.vue | 仅当前模块使用 |
| 组合式函数 | use + camelCase | useUser.ts | 逻辑复用 |
| Store | camelCase + Store | userStore.ts | 全局状态 |
| Service | camelCase + Service | userService.ts | API封装 |
| 工具函数 | camelCase | formatDate.ts | 纯函数 |
| 类型定义 | PascalCase | User.ts | 接口/枚举 |
| 测试文件 | 源文件名 + .spec.ts | BaseButton.spec.ts | 单元测试 |
总结一下:页面文件名采用 kebab-case 以与路由路径对齐;其余组件和类使用 PascalCase;函数、工具等纯逻辑采用 camelCase。规则并不复杂,关键在于坚持执行。
Vue3 组件编写规范
组件分类与命名
组件应该如何放置、如何命名?这是团队协作中常遇到的难题。下表基本能覆盖日常场景。
| 组件类型 | 目录 | 命名规则 | 示例 |
|---|---|---|---|
| 通用UI组件 | components/common/ | Base + PascalCase | BaseButton.vue |
| 通用业务组件 | components/biz/ | Biz + PascalCase | BizUserCard.vue |
| 布局组件 | layouts/components/ | App + PascalCase | AppHeader.vue |
| 页面专用组件 | pages/xxx/components/ | PascalCase | UserFilter.vue |
核心思路是:组件越通用,前缀越“长”(Base / Biz),目录位置越靠上;组件越专用,越应靠近对应的页面文件。
单文件组件结构(SFC)
Vue3 的 带来了更简洁的写法,但代码顺序容易混乱。以下经过多次迭代的顺序方案相当稳健。
<script setup lang="ts">
// 1. 类型导入
import type { UserInfo } from '@/types/User'// 2. 第三方库
import { ElMessage } from 'element-plus'// 3. 组件导入
import BaseButton from '@/components/common/BaseButton.vue'// 4. 工具/组合式函数
import { useUser } from '@/composables/useUser'// 5. Props
interface Props {
userId: string
title?: string
}
const props = withDefaults(defineProps<Props>(), {
title: '默认'
})// 6. Emits
const emit = defineEmits<{
(e: 'update', user: UserInfo): void
}>()// 7. 响应式数据
const loading = ref(false)// 8. 计算属性
const displayName = computed(() => user.value?.name)// 9. 方法
async function fetchUser() {}// 10. 生命周期
onMounted(() => {})// 11. 暴露
defineExpose({ refresh: fetchUser })
script><template>
<BaseButton @click="handleClick" />
<el-button type="primary" />
template><style scoped lang="scss">
// BEM命名
.user-card {
&__header {}
&--active {}
}
style>
这10步顺序源于实战经验。将类型导入放在最前面,因为它们通常无副作用,且能让团队成员迅速了解组件的依赖关系。Props紧接其后,直接定义组件的对外接口。随后依次排列响应式数据、计算属性和方法,形成清晰的逻辑链路。
模板使用规则
| 组件类型 | 模板中写法 | 示例 |
|---|---|---|
| 自定义组件 | PascalCase | |
| 第三方UI库 | kebab-case | |
| 原生HTML | 小写 | |
简而言之:自己编写的组件使用 ,Element Plus 这类第三方库使用 ,原生标签保持小写。
组合式函数模板
// composables/useCounter.ts
export function useCounter(initialValue = 0) {
const count = ref(initialValue)
const doubled = computed(() => count.value * 2) function increment() { count.value++ }
function reset() { count.value = initialValue } return { count, doubled, increment, reset }
}
组合式函数的模板与组件相似,但更为轻量——通常不需要生命周期和 emit。
状态管理与 API 服务
Store 规范(Pinia)
文件树示例

stores/
├── userStore.ts
├── cartStore.ts
└── productStore.ts
模板
// stores/userStore.ts
import { defineStore } from 'pinia'export const useUserStore = defineStore('user', {
state: () => ({
name: '',
isLoggedIn: false
}),
getters: {
displayName: (state) => state.name || '游客'
},
actions: {
async login(email: string, password: string) {
// 登录逻辑
},
logout() {
this.$reset()
}
}
})
组件中使用
<script setup>
import { storeToRefs } from 'pinia'
import { useUserStore } from '@/stores/userStore'const userStore = useUserStore()
// 状态用 storeToRefs 解构保持响应性
const { name, displayName } = storeToRefs(userStore)
// actions 直接解构
const { login, logout } = userStore
script>
在组件中使用 Store 时有一个常见陷阱:state 必须通过 storeToRefs 解构才能保持响应性;而 actions 可以直接解构。不少开发者在此踩过坑。
Service 规范
文件树示例
services/
├── userService.ts
├── productService.ts
└── api/
├── client.ts # axios实例配置
└── interceptors.ts # 拦截器
模板
// services/userService.ts
import request from './api/client'
import type { UserInfo, LoginParams } from '@/types/User'export const userService = {
async getUser(id: string): Promise<UserInfo> {
const { data } = await request.get(`/api/users/${id}`)
return data
},
async login(params: LoginParams): Promise<{ token: string }> {
const { data } = await request.post('/api/users/login', params)
return data
}
}
Service 层只承担一项职责:封装 API 调用。切忌将业务逻辑塞入其中,保持每一层的职责边界清晰。
工具函数与类型定义
工具函数规范
文件树示例
utils/
├── formatDate.ts # 日期格式化
├── formatCurrency.ts # 货币格式化
├── validateEmail.ts # 邮箱验证
└── storage.ts # 本地存储封装
模板
// utils/formatDate.ts
export function formatDate(date: Date, format = 'YYYY-MM-DD'): string {
const d = new Date(date)
const year = d.getFullYear()
const month = String(d.getMonth() + 1).padStart(2, '0')
const day = String(d.getDate()).padStart(2, '0')
return format
.replace('YYYY', String(year))
.replace('MM', month)
.replace('DD', day)
}// utils/validateEmail.ts
export function validateEmail(email: string): boolean {
const emailRegex = /^[^s@]+@([^s@.,]+.)+[^s@.,]{2,}$/
return emailRegex.test(email)
}
工具函数应遵循“纯函数、无副作用”的原则。例如 formatDate 只负责格式化日期,不应在里面偷偷发起请求或修改全局变量。
类型定义规范
文件树示例
types/
├── User.ts # 用户相关类型
├── Product.ts # 商品相关类型
├── api.ts # API通用类型
└── global.d.ts # 全局类型声明
模板
// types/User.ts
export interface UserInfo {
id: string
name: string
email: string
role: UserRole
}export enum UserRole {
Admin = 'admin',
User = 'user'
}// types/api.ts
export interface ApiResponseunknown > {
code: number
message: string
data: T
}
使用方式
// 正确:使用 type 关键字导入纯类型
import type { UserInfo } from '@/types/User'// 正确:枚举需要值导入
import { UserRole } from '@/types/User'
类型导入推荐使用 import type,这在 TypeScript 4.5+ 后愈发普及,能减少编译时的依赖。而枚举是运行时存在的值,必须使用普通的 import。
测试规范
文件树示例
tests/unit/
├── components/
│ ├── common/
│ │ └── BaseButton.spec.ts
│ └── biz/
│ └── BizUserCard.spec.ts
├── composables/
│ └── useCounter.spec.ts
├── stores/
│ └── userStore.spec.ts
├── services/
│ └── userService.spec.ts
└── utils/
└── formatDate.spec.ts
组件测试模板
// tests/unit/components/common/BaseButton.spec.ts
import { mount } from '@vue/test-utils'
import BaseButton from '@/components/common/BaseButton.vue'describe('BaseButton', () => {
it('renders correctly', () => {
const wrapper = mount(BaseButton, {
slots: { default: 'Click' }
})
expect(wrapper.text()).toBe('Click')
}) it('emits click event when clicked', async () => {
const wrapper = mount(BaseButton)
await wrapper.trigger('click')
expect(wrapper.emitted('click')).toBeTruthy()
})
})
组合式函数测试模板
// tests/unit/composables/useCounter.spec.ts
import { useCounter } from '@/composables/useCounter'describe('useCounter', () => {
it('initializes with default value', () => {
const { count } = useCounter()
expect(count.value).toBe(0)
}) it('increments count correctly', () => {
const { count, increment } = useCounter(5)
increment()
expect(count.value).toBe(6)
})
})
工具函数测试模板
// tests/unit/utils/formatDate.spec.ts
import { formatDate } from '@/utils/formatDate'describe('formatDate', () => {
it('formats date with default format', () => {
const date = new Date(2024, 0, 15)
expect(formatDate(date)).toBe('2024-01-15')
}) it('formats date with custom format', () => {
const date = new Date(2024, 0, 15)
expect(formatDate(date, 'YYYY/MM/DD')).toBe('2024/01/15')
})
})
测试文件的位置和命名应直接对应源文件,这是最直观的约定——看到 BaseButton.spec.ts,就能立即知道它测试的是哪个文件。
组件库封装范式
最后来看一个更贴近真实场景的案例:如何封装一个基于 Element Plus 的自定义组件。
基础版
<script lang="ts" setup>
import type { InputInstance, InputProps } from 'element-plus'
import { getCurrentInstance } from 'vue'
import type { ExtractPropTypes } from 'vue'// 1. 定义 Props 类型(继承 Element Plus Input 的所有属性)
export interface CustomInputProps extends ExtractPropTypes<InputProps> {
title?: string // 自定义标题
}// 2. 定义实例类型(继承原始实例 + 自定义方法)
export interface CustomInputInstance extends InputInstance {
someClick: () => void
}defineOptions({
inheritAttrs: false // 手动控制属性透传
})// 3. Props 默认值
const props = withDefaults(defineProps<CustomInputProps>(), {
title: '自定义封装的Input',
clearable: true // 覆盖默认值为 true
})// 4. 事件定义
const emit = defineEmits<{
(e: 'titleClick'): void
}>()const vm = getCurrentInstance()// 5. ref 回调:合并原始实例和自定义方法
function changeRef(inputInstance: Record | null ) {
if (vm) {
vm.exposeProxy = vm.exposed = Object.assign(inputInstance || {}, {
someClick
}) as CustomInputInstance
}
}function someClick() {
console.log('someClick')
}function handleTitleClick() {
emit('titleClick')
}// 6. 暴露合并后的实例
defineExpose((vm?.exposeProxy || {}) as CustomInputInstance)
script><template>
<div class="custom-input">
<div @click="handleTitleClick">{{ title }}div>
<el-input :ref="changeRef" v-bind="{ ...$attrs, ...props }">
<template v-for="(_, name) in $slots" :key="name" #[name]="slotProps">
<slot :name="name" v-bind="slotProps" />
template>
el-input>
div>
template>
h 函数版
<script lang="ts" setup>
import { getCurrentInstance, h } from 'vue'
import { ElInput } from 'element-plus'
import type { InputInstance, InputProps } from 'element-plus'
import type { ExtractPropTypes } from 'vue'export interface CustomInputProps extends ExtractPropTypes<InputProps> {
title?: string
}export interface CustomInputInstance extends InputInstance {
someClick: () => void
}defineOptions({
inheritAttrs: false
})const props = withDefaults(defineProps<CustomInputProps>(), {
title: '自定义封装的Input',
clearable: true
})const emit = defineEmits<{
(e: 'titleClick'): void
}>()const vm = getCurrentInstance()function changeRef(inputInstance: Record | null ) {
if (vm) {
vm.exposeProxy = vm.exposed = Object.assign(inputInstance || {}, {
someClick
})
}
}function someClick() {
console.log('someClick')
}function handleTitleClick() {
emit('titleClick')
}defineExpose((vm?.exposeProxy || {}) as CustomInputInstance)
script><template>
<div class="custom-input">
<div @click="handleTitleClick">{{ title }}div>
<component :is="h(ElInput, { ...$attrs, ...props, ref: changeRef }, $slots)" />
div>
template>
这两个版本的核心思路一致:继承第三方组件的 props 和实例类型,再扩展自己的属性、方法和事件。h 函数版更简洁,但理解门槛稍高。二者选其一即可,关键在于团队保持统一。
