Vue项目规范 | 青训营笔记

kevinLee
173 阅读7分钟

这是我参与「第四届青训营 」笔记创作活动的第5天

1 Vue项目规范

1.1 Vue编写

1.1.1 组件规范

  1. 组件名为多个单词

    组件名应该始终是多个单词组成（大于等于 2），且命名规范为KebabCase格式。 这样做可以避免跟现有的以及未来的 HTML 元素相冲突，因为所有的 HTML 元素名称都是单个单词的。

    export default {
  name: 'TodoItem'
  // ...
};

  2. 组件文件名为 pascal-case 格式

    components/
|- my-component.vue

  3. 基础组件文件名为 base 开头,使用完整单词而不是缩写

    components/
|- base-button.vue
|- base-table.vue
|- base-icon.vue

  4. 和父组件紧密耦合的子组件应该以父组件名作为前缀命名

    components/
|- todo-list.vue
|- todo-list-item.vue
|- todo-list-item-button.vue
|- user-profile-options.vue （完整单词）

  5. 在 Template 模版中使用组件，应使用 PascalCase 模式，并且使用自闭合组件。

    <!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent />
<Row><table :column="data"/></Row>

  6. 组件的 data 必须是一个函数

    当在组件中使用 data 属性的时候 (除了 new Vue 外的任何地方)，它的值必须是返回一个对象的函数。 因为如果直接是一个对象的话，子组件之间的属性值会互相影响。

    export default {
  data () {
    return {
      name: 'jack'
    }
  }
}

  7. Props 定义应该尽量详细

    • 必须使用 camelCase 驼峰命名
    • 必须指定类型
    • 必须加上注释,表面其含义
    • 必须加上 required 或者 default，两者二选其一
    • 如果有业务需要，必须加上 validator 验证
    props: {
  // 组件状态，用于控制组件的颜色
   status: {
     type: String,
     required: true,
     validator: function (value) {
       return [
         'succ',
         'info',
         'error'
       ].indexOf(value) !== -1
     }
   },
    // 用户级别，用于显示皇冠个数
   userLevel：{
      type: String,
      required: true
   }
}

  8. 为组件样式设置作用域

    <!-- 使用 `scoped` 特性 -->
<style scoped>
  .btn-close {
    background-color: red;
  }
</style>

  9. 如果特性元素较多,应该主动换行

    <MyComponent foo="a" bar="b" baz="c"
    foo="a" bar="b" baz="c"
    foo="a" bar="b" baz="c"
 />

1.2.2 模板中使用简单的表达式

组件模板应该只包含简单的表达式，复杂的表达式则应该重构为计算属性或方法。复杂表达式会让你的模板变得不那么声明式。我们应该尽量描述应该出现的是什么，而非如何计算那个值。而且计算属性和方法使得代码可以重用。

<template>
  <p>{{ normalizedFullName }}</p>
</template>

// 复杂表达式已经移入一个计算属性
computed: {
  normalizedFullName: function () {
    return this.fullName.split(' ').map(function (word) {
      return word[0].toUpperCase() + word.slice(1)
    }).join(' ')
  }
}

1.2.3 指定都使用缩写形式

指令推荐都使用缩写形式，(用 : 表示 v-bind: 、用 @ 表示 v-on: 和用 # 表示 v-slot:)

<input
  @input="onInput"
  @focus="onFocus"
>

1.2.4 标签顺序保持一致

单文件组件应该总是让标签顺序保持为

<template>...</template>
<script>...</script>
<style>...</style>

1.2.5 必须为 v-for 设置 key

1.2.6 v-show 和 v-if 选择

如果运行时，需要非常频繁地切换，使用 v-show ；如果在运行时，条件很少改变，使用 v-if。

1.2.7 script 标签内部结构顺序

components > props > data > computed > watch > filter > 钩子函数（钩子函数按其执行顺序） > methods

1.2.8 Vue Router 规范

  1. 页面跳转数据传递使用路由参数

    页面跳转，例如 A 页面跳转到 B 页面，需要将 A 页面的数据传递到 B 页面，推荐使用 路由参数进行传参，而不是将需要传递的数据保存 vuex，然后在 B 页面取出 vuex 的数据，因为如果在 B 页面刷新会导致 vuex 数据丢失，导致 B 页面无法正常显示数据。

    let id = ' 123';
this.$router.push({ name: 'userCenter', query: { id: id } });

  2. 使用路由懒加载机制

    {
	path: '/uploadAttachment',
	name: 'uploadAttachment',
	meta: {
		title: '上传附件'
	},
	component: () => import('@/view/components/uploadAttachment/index.vue')
},

  3. router 中的命名规范

    • path、childrenPoints 命名规范采用kebab-case命名规范（尽量vue文件的目录结构保持一致，因为目录、文件名都是kebab-case，这样很方便找到对应的文件）

    • name 命名规范采用KebabCase命名规范且和component组件名保持一致！（因为要保持keep-alive特性，keep-alive按照component的name进行缓存，所以两者必须高度保持一致）

  4. router 中的 path 命名规范

    • path除了采用kebab-case命名规范以外，必须以 / 开头，即使是children里的path也要以 / 开头-

    • 经常有这样的场景：某个页面有问题，要立刻找到这个vue文件，如果不用以/开头，path为parent和children组成的，可能经常需要在router文件里搜索多次才能找到，而如果以/开头，则能立刻搜索到对应的组件

    {
    path: '/file',
    name: 'File',
    component: Main,
    meta: {
      title: '文件服务',
      icon: 'ios-cloud-upload'
    },
    children: [
      {
        path: '/file/file-list',
        name: 'FileList',
        component: () => import('@/views/file/file-list.vue')
      },
      {
        path: '/file/file-add',
        name: 'FileAdd',
        component: () => import('@/views/file/file-add.vue')
      },
      {
        path: '/file/file-update',
        name: 'FileUpdate',
        component: () => import('@/views/file/file-update.vue')
      }
    ]
  }

1.2 Vue项目目录规范

1.2.1 基础

vue 项目中的所有命名一定要与后端命名统一。

比如权限：后端 privilege, 前端无论 router , store, api 等都必须使用 privielege 单词！

1.2.2 使用 Vue-cli 脚手架

使用 vue-cli3 来初始化项目，项目名按照上面的命名规范。

1.2.3 目录说明

目录名按照上面的命名规范，其中 components 组件用大写驼峰，其余除 components 组件目录外的所有目录均使用 kebab-case 命名。

src                               源码目录
|-- api                              所有api接口
|-- assets                           静态资源，images, icons, styles等
|-- components                       公用组件
|-- config                           配置信息
|-- constants                        常量信息，项目所有Enum, 全局常量等
|-- directives                       自定义指令
|-- filters                          过滤器，全局工具
|-- datas                            模拟数据，临时存放
|-- lib                              外部引用的插件存放及修改文件
|-- mock                             模拟接口，临时存放
|-- plugins                          插件，全局使用
|-- router                           路由，统一管理
|-- store                            vuex, 统一管理
|-- themes                           自定义样式主题
|-- views                            视图目录
|   |-- role                             role模块名
|   |-- |-- role-list.vue                    role列表页面
|   |-- |-- role-add.vue                     role新建页面
|   |-- |-- role-update.vue                  role更新页面
|   |-- |-- index.less                      role模块样式
|   |-- |-- components                      role模块通用组件文件夹
|   |-- employee                         employee模块

  1. api目录

    • 文件、变量命名要与后端保持一致。
    • 此目录对应后端 API 接口，按照后端一个 controller 一个 api js 文件。若项目较大时，可以按照业务划分子目录，并与后端保持一致。
    • api 中的方法名字要与后端 api url 尽量保持语义高度一致性。
    • 对于 api 中的每个方法要添加注释，注释与后端 swagger 文档保持一致。
    /employee/add
/employee/delete/{id}
/employee/update

    // 添加员工
addEmployee: (data) => {
	return postAxios('/employee/add', data)
},
  // 更新员工信息
updateEmployee: (data) => {
    return postAxios('/employee/update', data)
},
    // 删除员工
deleteEmployee: (employeeId) => {
    return postAxios('/employee/delete/' + employeeId)
},

  2. assets 目录

    assets 为静态资源，里面存放 images, styles, icons 等静态资源，静态资源命名格式为 kebab-case

    |assets
|-- icons
|-- images
|   |-- background-color.png
|   |-- upload-header.png
|-- styles

  3. components 目录

    此目录应按照组件进行目录划分，目录命名为 KebabCase，组件命名规则也为 KebabCase

    |components
|-- error-log
|   |-- index.vue
|   |-- index.less
|-- markdown-editor
|   |-- index.vue
|   |-- index.js
|-- kebab-case

  4. constants 目录

    此目录存放项目所有常量，如果常量在 vue 中使用，请使用 vue-enum 插件(www.npmjs.com/package/vue…)

    |constants
|-- index.js
|-- role.js
|-- employee.js

  5. router 和 store 目录

    这两个目录一定要将业务进行拆分，不能放到一个 js 文件里

    • router 尽量按照 views 中的结构保持一致

    • store 按照业务进行拆分不同的 js 文件

  6. view 目录

    • store 按照业务进行拆分不同的 js 文件

    • components 中组件要使用 PascalCase 规则

    |-- views                            视图目录
|   |-- role                             role模块名
|   |   |-- role-list.vue                    role列表页面
|   |   |-- role-add.vue                     role新建页面
|   |   |-- role-update.vue                  role更新页面
|   |   |-- index.less                      role模块样式
|   |   |-- components                      role模块通用组件文件夹
|   |   |   |-- role-header.vue                        role头部组件
|   |   |   |-- role-modal.vue                         role弹出框组件
|   |-- employee                         employee模块
|   |-- behavior-log                      行为日志log模块
|   |-- code-generator                    代码生成器模块

1.2.4 注释说明

整理必须加注释的地方

  • 公共组件使用说明
  • api 目录的接口 js 文件必须加注释
  • store 中的 state, mutation, action 等必须加注释
  • vue 文件中的 template 必须加注释，若文件较大添加 start end 注释
  • vue 文件的 methods，每个 method 必须添加注释
  • vue 文件的 data, 非常见单词要加注释

1.2.5 其他

  1. 尽量不要手动操作 DOM

    因使用 vue 框架，所以在项目开发中尽量使用 vue 的数据驱动更新 DOM，尽量（不到万不得已）不要手动操作 DOM，包括：增删改 dom 元素、以及更改样式、添加事件等。

  2. 删除无用代码

    因使用了 git/svn 等代码版本工具，对于无用代码必须及时删除，例如：一些调试的 console 语句、无用的弃用功能代码。

avatar
文章
阅读
粉丝