前端开发规范

# vue 代码规范

front-end-develop-standard06.jpg

# vue编码基础

vue 项目规范以 Vue 官方规范 中的 A 规范为基础，在其上面进行项目开发，故所有代码均遵守该规范。

[强调] 请仔仔细细阅读 Vue 官方规范，切记，此为第一步。

# 组件规范

# 1、组件名为多个单词

组件名应该始终是多个单词组成（大于等于 2），且命名规范为PascalCase格式。

这样做可以避免跟现有的以及未来的 HTML 元素相冲突，因为所有的 HTML 元素名称都是单个单词的。

// good
export default {
  name: 'TodoItem'
  // ...
}
 
// bad
export default {
  name: 'Todo',
  // ...
}
export default {
  name: 'todo-item',
  // ...
}

# 2、组件文件名为 PascalBase 格式

// good
components/
|- MyComponent.vue
 
// bad
components/
|- myComponent.vue
|- my-component.vue

# 3、和父组件紧密耦合的子组件应该以父组件名作为前缀命名

// good
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
views/
|- todo-list
|- todo-list-item
|- todo-list-item-button

# 4、在 Template 模版中使用组件，应使用 PascalCase 模式，并且使用自闭合组件

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

# 5、组件的 data 必须是一个函数

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

// good
export default {
  data () {
    return {
      name: 'Jack'
    }
  }
}
 
// bad
export default {
  data: {
    name: 'jack'
  }
}

# 6、Prop 定义应该尽量详细

  • 必须使用 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
   }
}

# 7、为组件样式设置作用域

<!-- good -->
<template>
  <button class="btn btn-close">X</button>
</template>
<!-- 使用 `scoped` 特性 -->
<style scoped>
  .btn-close {
    background-color: red
  }
</style>
 
<!-- bad -->
<template>
  <button class="btn btn-close">X</button>
</template>
<!-- 没有使用 `scoped` 特性 -->
<style>
  .btn-close {
    background-color: red
  }
</style>

# 8、多个特性的元素应该分多行撰写，每个特性一行【建议】

<!-- good -->
<MyComponent 
  foo="a"
  bar="b"
  baz="c"
  foo="a"
  bar="b"
  baz="c"
  foo="a"
  bar="b"
  baz="c"
 />
 
<!-- bad -->
<MyComponent foo="a" bar="b" baz="c" foo="a" bar="b" baz="c" foo="a" bar="b" baz="c" foo="a" bar="b" baz="c"/>

# 9、模板中使用简单的表达式

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

<!-- good -->
<template>
  <p>{{ normalizedFullName }}</p>
</template>
// 复杂表达式已经移入一个计算属性

// good
computed: {
  normalizedFullName() {
    return this.fullName.split(' ').map(function (word) {
      return word[0].toUpperCase() + word.slice(1)
    }).join(' ')
  }
}

<!-- bad -->
<template>
  <p>
       {{
          fullName.split(' ').map(function (word) {
             return word[0].toUpperCase() + word.slice(1)
           }).join(' ')
        }}
  </p>
</template>

# 10、指令都使用缩写形式

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

<!-- good -->
<input
  @input="onInput"
  @focus="onFocus"
>
 
<!-- bad -->
<input
  v-on:input="onInput"
  @focus="onFocus"
>

# 11、标签顺序保持一致

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

<!-- good -->
<template>...</template>
<script>...</script>
<style>...</style>
 
/* bad */
<template>...</template>
<style>...</style>
<script>...</script>

# 12、必须为 v-for 设置键值 key

# 13、 v-show 与 v-if 选择

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

# 14、script 标签内部结构顺序

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

# 15、Vue Router 规范

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

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

let id = ' 123'
this.$router.push({ name: 'userCenter', query: { id: id } })
  • 使用路由懒加载（延迟加载）机制
{
    path: '/uploadAttachment',
    name: 'uploadAttachment',
    meta: {
        title: '上传附件'
    },
    component: () => import('@/view/components/uploadAttachment/index.vue')
},
  • router 中的命名规范

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

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

// 动态加载
export const reload = [
  {
    path: '/reload',
    name: 'reload',
    component: Main,
    meta: {
      title: '动态加载',
      icon: 'icon iconfont'
    },
    children: [
      {
        path: '/reload/smart-reload-list',
        name: 'SmartReloadList',
        meta: {
          title: 'SmartReload',
          childrenPoints: [
            {
              title: '查询',
              name: 'smart-reload-search'
            },
            {
              title: '执行reload',
              name: 'smart-reload-update'
            },
            {
              title: '查看执行结果',
              name: 'smart-reload-result'
            }
          ]
        },
        component: () =>
          import('@/views/reload/smart-reload/smart-reload-list.vue')
      }
    ]
  }
]
  • 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')
      }
    ]
  }

# 16、避免 v-if 和 v-for 用在一起

永远不要把 v-if 和 v-for 同时用在同一个元素上。 一般我们在两种常见的情况下会倾向于这样做：

为了过滤一个列表中的项目 (比如 v-for="user in users" v-if="user.isActive")。在这种情形下，请将 users 替换为一个计算属性 (比如 activeUsers)，让其返回过滤后的列表。 为了避免渲染本应该被隐藏的列表 (比如 v-for="user in users" v-if="shouldShowUsers")。这种情形下，请将 v-if 移动至容器元素上 (比如 ul, ol)。

# Vue 项目目录规范

# 1、基础

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

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

# 2、使用 wat3 脚手架

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

安装使用指南：wat3脚手架

# 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模块

# api目录

  • 文件、变量命名要与后端保持一致。
  • 此目录对应后端 API 接口，按照后端一个 controller 一个 api js 文件。若项目较大时，可以按照业务划分子目录，并与后端保持一致。
  • api 中的方法名字要与后端 api url 尽量保持语义高度一致性。
  • 对于 api 中的每个方法要添加注释，注释与后端 swagger 文档保持一致。
// good
 
后端 url： EmployeeController.java
/employee/add
/employee/delete/{id}
/employee/update
 
前端： employee.js
// 添加员工
  addEmployee: (data) => {
    return postAxios('/employee/add', data)
  },
  // 更新员工信息
  updateEmployee: (data) => {
    return postAxios('/employee/update', data)
  },
    // 删除员工
  deleteEmployee: (employeeId) => {
    return postAxios('/employee/delete/' + employeeId)
   },

# assets 目录

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

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

# components 目录

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

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

# constants 目录

此目录存放项目所有常量，如果常量在 vue 中使用，请使用 vue-enum 插件

目录结构：
|constants
|-- index.js
|-- role.js
|-- employee.js
 
例子： employee.js
export const EMPLOYEE_STATUS = {
  NORMAL: {
    value: 1,
    desc: '正常'
  },
  DISABLED: {
    value: 1,
    desc: '禁用'
  },
  DELETED: {
    value: 2,
    desc: '已删除'
  }
}
export const EMPLOYEE_ACCOUNT_TYPE = {
  QQ: {
    value: 1,
    desc: 'QQ登录'
  },
  WECHAT: {
    value: 2,
    desc: '微信登录'
  },
  DINGDING: {
    value: 3,
    desc: '钉钉登录'
  },
  USERNAME: {
    value: 4,
    desc: '用户名密码登录'
  }
}
export default {
  EMPLOYEE_STATUS,
  EMPLOYEE_ACCOUNT_TYPE
}

# router 与 store 目录

这两个目录一定要将业务进行拆分，不能放到一个 js 文件里。 router 尽量按照 views 中的结构保持一致 store 按照业务进行拆分不同的 js 文件

# views 目录

命名要与后端、router、api 等保持一致 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                    代码生成器模块

# 4、注释说明

整理必须加注释的地方

  • 公共组件使用说明

  • api 目录的接口 js 文件必须加注释

  • store 中的 state, mutation, action 等必须加注释

  • vue 文件中的 template 必须加注释，若文件较大添加 start end 注释

  • vue 文件的 methods，每个 method 必须添加注释

  • vue 文件的 data, 非常见单词要加注释

    # 写在最后

    # 1、尽量不要手动操作 DOM

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

    # 2、删除无用代码

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

上次更新: 5/5/2022, 12:02:17 PM

← react 代码规范 →