Vue项目命名规范指南分享

 更新时间:2025年07月31日 15:51:24   作者:SanMu三木  
本文提供Vue3+Pinia+VueRouter项目命名规范,涵盖组件、路由、状态等命名风格,推荐使用ESLint和Prettier工具,统一风格提升协作效率

Vue项目命名规范指南(适用于 Vue 3 + Pinia + Vue Router)

目的:统一命名风格,提升可读性、可维护性和团队协作效率。

一、通用原则

类型命名风格示例
变量camelCaseuserName, isLoading
常量UPPER_SNAKE_CASEMAX_RETRY_COUNT, DEFAULT_TIMEOUT
函数/方法camelCasefetchData, validateForm
类 / 组件 / 枚举 / 路由 namePascalCaseUserProfile, ErrorBoundary
自定义指令(Vue)kebab-casev-focus, v-tooltip
URL 路径kebab-case/user-profile, /settings/account

二、组件相关命名规范

1. 组件文件名

  • 使用 PascalCaseKebabCase
  • 推荐使用 PascalCase,便于在 JS 中直接引用。
components/
  UserProfile.vue        ✅ 推荐
  userProfile.vue        ❌ 不推荐(容易与变量混淆)
  user-profile.vue       ✅ 在模板中使用时推荐

2. 组件注册与使用

  • 注册时使用 PascalCase:
import UserProfile from './components/UserProfile.vue'
  • 模板中使用 kebab-case:
<template>
  <user-profile :user="user" />
</template>

3. Props 命名(组件间传参)

  • 使用 camelCase(JS 中),模板中用 kebab-case。
  • 避免缩写(除非是通用缩写如 id, url)。
props: {
  userName: String,
  isActive: Boolean,
  userId: Number
}
<template>
  <UserCard :user-name="name" :is-active="true" />
</template>

三、Vue Router 相关命名规范

1. 路由路径(URL)

  • 使用 kebab-case,清晰表达资源结构。
{
  path: '/user-profile',
  name: 'UserProfile',
  component: () => import('../views/UserProfile.vue')
}

2. 路由名称(name)

  • 使用 PascalCase,与组件名保持一致。
name: 'UserProfile'

3. 动态参数命名

  • 参数名使用 kebab-case(URL),JS 中访问使用 camelCase。
path: '/user/:user_id' // URL 中使用
$route.params.userId    // JS 中自动转为 camelCase

四、Pinia 状态管理命名规范

1. Store 文件名

  • 使用小驼峰命名,以 .store.js.store.ts 结尾。
stores/
  userStore.js
  cartStore.js

2. State 属性命名

  • 使用 camelCase,语义明确。
state: () => ({
  user: null,
  isLoading: false,
  activeTab: 'dashboard'
})

3. Actions 命名

  • 动词开头 + 名词,表示动作。
actions: {
  async fetchUser(userId) {},
  updateUser(userData) {}
}

4. Getters 命名

  • 名词或形容词为主,表示派生状态。
getters: {
  isLoggedIn: (state) => !!state.user,
  fullName: (state) => `${state.firstName} ${state.lastName}`
}

五、变量与函数命名规范

1. 变量命名

  • 使用 camelCase。
  • 避免模糊命名(如 data, info),应具体说明用途。
let currentUser = null;
let loadingCount = 0;

2. 函数命名

  • 动词开头,描述行为。
function validateForm() {}
function submitData(data) {}

3. 布尔类型变量命名

  • is, has, should 开头。
let isActive = false;
let hasPermission = true;

六、常量命名规范

  • 使用全大写 + 下划线分隔。
  • 通常用于配置项、枚举、固定值等。
const MAX_RETRY_COUNT = 3;
const USER_ROLES = ['admin', 'editor', 'viewer'];

七、事件命名规范(Vue 组件通信)

  • 使用 kebab-case,在子组件中 $emit 时使用:
this.$emit('update:loading', false);
  • 在父组件中监听:
<template>
  <ChildComponent @update:loading="handleLoadingChange" />
</template>

八、自定义指令命名规范

  • 使用 kebab-case,符合 HTML 规范。
app.directive('focus', {
  mounted(el) {
    el.focus();
  }
});

使用方式:

<input v-focus />

九、样式类命名建议(可选)

  • 推荐使用 BEM 风格或 CSS-in-JS 工具。
  • 如果使用 SCSS/CSS,建议命名清晰:
.user-card {}
.user-card__header {}
.user-card--active {}

十、模块化命名建议

如果你的项目采用模块化结构(如多个 store、路由模块、功能模块),建议在命名中加入上下文前缀。

示例:

类型示例
StoreuserStore.js, productStore.js
路由模块userRoutes.js, orderRoutes.js
组件UserList.vue, UserDetail.vue

十一、附录:命名风格总结表

类型命名风格示例
组件名PascalCaseUserProfile.vue
模板标签kebab-case<user-profile />
PropscamelCase(JS) / kebab-case(模板)userName, user-name
路由 namePascalCase'UserProfile'
路由路径kebab-case/user-profile
动态路由参数kebab-case(URL) / camelCase(JS):user_id → params.userId
变量camelCaseuserName, isLoading
常量UPPER_SNAKE_CASEMAX_RETRY_COUNT
函数camelCasefetchData, submitForm
布尔变量is/has/should + 描述isActive, hasPermission
Pinia statecamelCaseuser, cartItems
Pinia actions动词 + 名词fetchUser, addToCart
Pinia getters名词/形容词isLoggedIn, totalPrice
自定义指令kebab-casev-focus

十二、工具建议(可选)

总结

一个良好的命名规范能显著提升代码质量与团队协作效率。建议将此文档纳入项目初期的技术规范文档,并结合 ESLint/Prettier 工具进行自动化检查。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Vue路由组件传递参数的六种场景

    Vue路由组件传递参数的六种场景

    在Vue应用程序中,路由组件是构建单页应用的关键部分,传递参数给路由组件可以让我们动态地展示内容,处理用户输入,以及实现各种交互功能,本文就给大家介绍了六种Vue路由组件传递参数场景,需要的朋友可以参考下
    2023-09-09
  • 使用vue制作FullPage页面滚动效果

    使用vue制作FullPage页面滚动效果

    本篇文章主要介绍了使用vue制作FullPage页面滚动效果,详细的介绍了FullPage页面的思路和实现,有兴趣的可以了解一下
    2017-08-08
  • vue插槽slot的简单理解与用法实例分析

    vue插槽slot的简单理解与用法实例分析

    这篇文章主要介绍了vue插槽slot的简单理解与用法,结合实例形式分析了vue插槽slot的功能、原理、相关使用技巧与操作注意事项,需要的朋友可以参考下
    2020-03-03
  • Vue实现点击箭头上下移动效果

    Vue实现点击箭头上下移动效果

    这篇文章主要介绍了Vue实现点击箭头上下移动效果,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-06-06
  • vue项目中input输入框输入不了值问题及解决

    vue项目中input输入框输入不了值问题及解决

    这篇文章主要介绍了vue项目中input输入框输入不了值问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • vue3中如何使用iframe嵌入vue2页面

    vue3中如何使用iframe嵌入vue2页面

    这篇文章主要介绍了vue3中如何使用iframe嵌入vue2页面问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-10-10
  • Vuei18n 在数组中的使用方式

    Vuei18n 在数组中的使用方式

    这篇文章主要介绍了Vuei18n 在数组中的使用方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-08-08
  • Vue如何实现iframe的上一步、下一步操作

    Vue如何实现iframe的上一步、下一步操作

    这篇文章主要介绍了Vue如何实现iframe的上一步、下一步操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • 17个vue常用的数组方法总结与实例演示

    17个vue常用的数组方法总结与实例演示

    这篇文章主要介绍了vue中常用的数组方法,包括:VUE数组转换字符串,VUE数组遍历,VUE数组过滤,VUE数组查询,VUE数组排序等功能,需要的朋友可以参考下
    2022-12-12
  • Vue3使用Proxy构建高效响应式数据的示例代码

    Vue3使用Proxy构建高效响应式数据的示例代码

    在 Vue 3 中,Proxy 主要用于 拦截对象的基本操作,包括 属性读取(get)、修改(set)、删除(deleteProperty) 等,本文给大家介绍了Vue3使用Proxy构建高效响应式数据的操作教程,需要的朋友可以参考下
    2025-03-03

最新评论