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中加上key后发生什么

    一文详解Vue中加上key后发生什么

    本文主要介绍了一文详解Vue中加上key后发生什么,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04
  • Vue + OpenLayers 快速入门学习教程

    Vue + OpenLayers 快速入门学习教程

    大家都知道使用 Openlayers可以很灵活自由的做出各种地图和空间数据的展示。而且这个框架是完全免费和开源的,本文记录下 Vue 使用 OpenLayers 入门,使用 OpenLayers 创建地图组件的相关知识,需要的朋友一起学习下吧
    2021-09-09
  • Vue2.0使用嵌套路由实现页面内容切换/公用一级菜单控制页面内容切换(推荐)

    Vue2.0使用嵌套路由实现页面内容切换/公用一级菜单控制页面内容切换(推荐)

    这篇文章主要介绍了Vue2.0使用嵌套路由实现页面内容切换/公用一级菜单控制页面内容切换,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-05-05
  • Vue3 实现文件上传功能

    Vue3 实现文件上传功能

    在Vue3中实现文件上传功能,你可以使用多种方法,包括使用原生的HTML <input type="file">元素,或者使用第三方库如 axios和vue-axios来处理文件上传,本文给大家介绍Vue3 实现文件上传功能,感兴趣的朋友一起看看吧
    2025-07-07
  • el-table树形数据序号排序处理方案

    el-table树形数据序号排序处理方案

    这篇文章主要介绍了el-table树形数据序号排序处理方案,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2024-03-03
  • Vue2.x中的父组件传递数据至子组件的方法

    Vue2.x中的父组件传递数据至子组件的方法

    这篇文章主要介绍了Vue2.x中的父组件数据传递至子组件的方法,需要的朋友可以参考下
    2017-05-05
  • 详解Vue.js 可拖放文本框组件的使用

    详解Vue.js 可拖放文本框组件的使用

    这篇文章主要介绍了详解Vue.js 可拖放文本框组件的相关资料,帮助大家更好的理解和学习使用vue框架,感兴趣的朋友可以了解下
    2021-03-03
  • vue-seamless-scroll无缝滚动组件使用方法详解

    vue-seamless-scroll无缝滚动组件使用方法详解

    这篇文章主要为大家详细介绍了vue-seamless-scroll无缝滚动组件的使用方法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-04-04
  • 使用Vue与Fabric.js开发一个图片标注工具

    使用Vue与Fabric.js开发一个图片标注工具

    在现代的Web应用开发中,能够对图片进行标注是一项非常实用的功能,无论是在项目管理、图像处理还是教育领域,这种功能都能极大提升用户体验,本文将介绍如何利用Vue框架结合Fabric.js库来构建一个具有矩形框选、箭头绘制和文本添加功能的图片标注工具,需要的朋友可以参考下
    2026-02-02
  • Vue跨域请求问题解决方案过程解析

    Vue跨域请求问题解决方案过程解析

    这篇文章主要介绍了Vue跨域请求问题解决方案过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08

最新评论