命名规范
文件夹/文件名/自定义组件标签和属性命名使用kebab-case风格
JavaScript中的变量名使用camelCase风格,除了组件名定义和import时使用PascalCase风格
组件名为多个单词
组件名应该始终是多个单词的,根组件 App 除外。
这样做可以避免跟现有的以及未来的 HTML 元素相冲突,因为所有的 HTML 元素名称都是单个单词的。
bad
Vue.component('todo', {
// ...
})
export default {
'name': 'Todo'
// ...
}
good
Vue.component('TodoItem', {
// ...
})
export default {
'name': 'TodoItem'
// ...
}
views 下的 vue 目录和文件命名
文件夹命令
views 下面的文件夹代表着模块的名字
- 名词组成(car、order、cart)
- 全小写(good: car)(bad: Car)
- 尽量只有一个单词(good: car、order、cart)(bad: carInfo、carpage)
- 多个单词用 “-” 隔开(good:agent-host)(bad: agentHost、agent_host)
- 如果一个模块只有一个文件,就不需要创建文件夹,直接创建以模块名开头的“.vue”文件:(agent-host-list.vue)
文件命令
views 下面的 vue 文件代表着页面的名字
- 放在模块文件夹之下
- 只有一个文件的情况下不会出现文件夹,而是直接放在 views 目录下面,如 login.vue home.vue
- 尽量是名词
- 名字至少两个单词(good: car-detail)(bad: car)
- 全小写,采用kebab-case风格,多个单词用“-”隔开,开头的单词就是所属模块名字(car-detail、car-edit、car-list)
- 常用结尾单词有(detail、edit、list、info、report)
紧密耦合的组件名
和父组件紧密耦合的子组件应该以父组件名作为前缀命名。
如果一个组件只在某个父组件的场景下有意义,这层关系应该体现在其名字上。因为编辑器通常会按字母顺序组织文件,所以这样做可以把相关联的文件排在一起。
Bad
components
|- todo-list.vue
|- todo-item.vue
|- todo-button.vue
components
|- SearchSidebar.vue
|- NavigationForSearchSidebar.vue
good
components
|- todo-list.vue
|- todo-list-item.vue
|- todo-list-item-button.vue
components
|- search-sidebar.vue
|- search-sidebar-navigation-item.vue
模板中的组件名大小写
对于绝大多数项目来说,在单文件组件和字符串模板中组件名应该总是 PascalCase 的——但是在 DOM 模板中总是 kebab-case 的是,为了保持风格一致,统一使用kebab-case
bad
<!-- 在单文件组件和字符串模板中 -->
<mycomponent/>
<!-- 在单文件组件和字符串模板中 -->
<myComponent/>
<!-- 在 DOM 模板中 -->
<MyComponent></MyComponent>
good
<!-- 在所有地方 -->
<my-component></my-component>
JS/JSX 中的组件名大小写
JS/JSX 中的组件名应该始终是 PascalCase 的,尽管在较为简单的应用中只使用 Vue.component 进行全局组件注册时,可以使用 kebab-case 字符串。
Bad
Vue.component('myComponent', {
// ...
})
import 'myComponent' from './MyComponent.vue'
export default {
'name': 'myComponent',
// ...
}
export default {'name': 'my-component',
// ...
}
good
Vue.component('MyComponent', {
// ...
})
import 'MyComponent' from './MyComponent.vue'
export default{
'name':'MyComponent',
// ...
}
完整单词的组件名
组件名应该倾向于完整单词而不是缩写。
编辑器中的自动补全已经让书写长命名的代价非常之低了,而其带来的明确性却是非常宝贵的。不常用的缩写尤其应该避免。
bad
components
|- SdSettings.vue
|- UProfOpts.vue
good
components
|- student-dashboard-settings.vue
|- user-profile-options.vue
Prop 名大小写
在声明 prop 的时候,其命名应该始终使用 camelCase,而在模板和 JSX 中应该始终使用 kebab-case。
我们单纯的遵循每个语言的约定。在 JavaScript 中更自然的是 camelCase。而在 HTML 中则是 kebab-case。
bad
props: {
'greeting-text': String
}
<WelcomeMessage greetingText="hi"/>
good
props: {
'greetingText: String
}
<welcome-message :greeting-text="hi"/>
指令统一采用缩写形式
指令缩写,用 : 表示 v-bind: ,用 @ 表示 v-on:
bad
<input v-bind:value="value" v-on:input="onInput">
good
<input :value="value" @input = "onInput">
Method 自定义方法命名
- 动宾短语(good:jumpPage、openCarInfoDialog)(bad:go、nextPage、show、open、login)
- 事件方法以 on 开头(onTypeChange、onUsernameInput)
- 尽量使用常用单词开头(set、get、open、close、jump)
- camelCase命名(good: getListData)(bad: get_list_data、getlistData)
API接口import的方法名要明确
如果import的方法是比较通用的操作名,需要给方法取一个明确的别名,并且所有别名增加Api结尾,用来区分普通函数。
bad
import { getPackages , remove } from '@/api/package'
good
import { getPackages as getPackagesApi, remove as removePackageApi } from '@/api/package'
数据定义
组件里的data定义
data 必须是一个函数。
当在组件中使用 data 属性的时候 (除了 new Vue 外的任何地方),它的值必须是返回一个对象的函数。因为如果直接把data定义成一个对象,会导致每个组件的实例都引用了相同的数据对象,更改其中一个列表的标题就会改变其它每一个列表的标题。增删改一个待办事项的时候也是如此。
bad
Vue.component('some-comp', {
data: { foo: 'bar' }
})
export default {
data: { foo: 'bar' }
}
good
Vue.component('some-comp',{
data: function () {
return { foo: 'bar' }
}
})
// In a.vue file
export default {
data () {
return { foo: 'bar' }
}
// 在一个 Vue 的根实例上直接使用对象是可以的
// 因为只存在一个这样的实例。
new Vue({
data: { foo: 'bar' }
})
data 里的变量时请先在 data 里面初始化
Vue.component('some-comp', {
data: function () {
return { foo: 'bar', loading: true }
}
})
表单数据请包裹一层 form
Vue.component('some-comp', {
data: function () {
return {
form: { name: 'bar'}
}
}
})
ajax 请求数据用上 loading变量
<el-table v-loading="listLoading">
...
export default{
name: 'exportZip',
data() {
return { listLoading: true,
...
}
},
created() {
this.fetchData()
},
methods: {
fetchData() {
this.listLoading = true
fetchListApi().then(response => {
...
this.listLoading = false
})
}
}
组件Props
props定义应该尽量详细。
在你提交的代码中,prop 的定义应该尽量详细,至少需要指定其类型。
细致的 prop 定义有两个好处:
- 它们写明了组件的 API,所以很容易看懂组件的用法;
- 在开发环境下,如果向一个组件提供格式不正确的 prop,Vue 将会告警,以帮助你捕获潜在的错误来源。
bad
// 这样做只有开发原型系统时可以接受
props: ['status']
good
props: { status: String}
// 更好的做法!
props: {
status: {
type: String,
required: true,
validator: function (value) {
return ['syncing','synced','version-conflict', 'error'].indexOf(value) !== -1
}
}
}
props 改变父组件数据 基础类型用 $emit ,复杂类型直接改
Vue文件方法声明顺序
export default {
name: '',
components: {},
props: {},
data() {},
computed: {},
watch: {},
created() {},
mounted() {},
activated(){},
methods: {},
destroyed() {}
}
标签属性使用
为 v-for 设置键值
总是用 key 配合 v-for。
在组件上总是必须用 key 配合 v-for,以便维护内部组件及其子树的状态,避免Vue优化渲染的时候,复用组件导致一些极端异常。
bad
<ul>
<li v-for="todo in todos">{{ todo.text }} </li>
</ul>
good
<ul>
<li v-for="todo in todos" :key="todo.id">
{{ todo.text }}
</li>
</ul>
3.2 避免 v-if 和 v-for 用在一起
慎用 v-if 和 v-for 同时用在同一个元素上,因为当 Vue 处理指令时,v-for 比 v-if 具有更高的优先级,所以这个模板:
<ul>
<li v-for="user in users" v-if="user.isActive" :key="user.id" >
{{ user.name }}
</li>
</ul>
将会经过如下运算:
this.users.map(function (user) {
if(user.isActive) {
returnuser.name
}
})
因此哪怕我们只渲染出一小部分用户的元素,也得在每次重渲染的时候遍历整个列表,不论活跃用户是否发生了变化。
一般我们在两种常见的情况下会倾向于这样做:
- 为了过滤一个列表中的项目 (比如 v-for=“user in users” v-if=“user.isActive”)。在这种情形下,请将 users 替换为一个计算属性 (比如 activeUsers),让其返回过滤后的列表。
- 为了避免渲染本应该被隐藏的列表 (比如 v-for=“user in users” v-if=“shouldShowUsers”)。这种情形下,请将 v-if 移动至容器元素上 (比如 ul, ol)。
bad
<ul>
<li v-for="user in users" v-if="user.isActive" :key="user.id">
{{ user.name }}
</li>
</ul>
<ul>
<li v-for="user in users" v-if="shouldShowUsers" :key="user.id">
{{ user.name }}
</li>
</ul>
good
<ul>
<li v-for="user in activeUsers" :key="user.id" >
{{ user.name }}
</li>
</ul>
<ul v-if="shouldShowUsers">
<li v-for="user in users" :key="user.id" >
{{ user.name }}
</li>
</ul>
单文件组件顶级标签顺序
<template>
...
</template>
<script>
/* ... */
</script>
<!--声明语言,并且添加scoped-->
<style lang="less"scoped>
/* ... */
</style>
3.4 Props 顺序
标签的 Props 应该有统一的顺序,依次为指令、属性和事件。
<my-component
v-if="if"
v-show="show"
v-model="value"
ref="ref"
:key="key"
:text="text"
@input="onInput"@change="onChange"/>
v-if / v-else-if / v-else
若同一组 v-if 逻辑控制中的元素逻辑相同,Vue 为了更高效的元素切换,会复用相同的部分,例如:value。为了避免复用带来的不合理效果,应该在同种元素上加上 key 做标识。
bad
<div v-if="hasData">
<span>{{ mazeyData }}</span>
</div>
<div v-else>
<span>无数据</span>
</div>
good
<div v-if="hasData"key="mazey-data">
<span>{{ mazeyData }}</span>
</div>
<div v-elsekey="mazey-none">
<span>无数据</span>
</div>
css样式定义
css定义尽量使用scoped方式
<!--声明语言,并且添加scoped-->
<style lang="less"scoped>
/* ... */
</style>
4.2 class尽量使用层级定义
scoped方式定义的css常常无法覆盖控件原生定义的class,例如:<button type=“button” class=“el-button el-button–primary”>中的class :el-button。
这时候只能使用全局定义方式,建议在页面的根元素上设置一个全局的class名,把该页面下的其他样式都定义在该class之下,避免class冲突
<template>
<div class="project-list">
<label>IT是门艺术</label>
<el-button type="primary">
element ui按钮
</el-button>
<button class="btn btn-close">X</button>
</div>
</template>
<style lang="less">
.project-list {
.btn-close {
background-color: red;
}
// 覆盖el-button原生的样式
.el-button {
background-color: red;
}}
</style>
避免scoped 中的直接使用元素选择器
元素选择器应该避免在 scoped 中出现。
在 scoped 样式中,类选择器比元素选择器更好,因为大量使用元素选择器是很慢的。
bad
<template>
<button>X</button>
</template>
<style scoped>
button {
background-color: red;
}
</style>
good
<template>
<button class="btn btn-close">X</button>
</template>
<style scoped>
.btn-close {
background-color: red;
}
</style>
其他
调试信息console.log() debugger 使用完及时删除
package-lock.json需要提交到git仓库
package-lock.json 是在 npm install时候生成一份文件,用以记录当前状态下实际安装的各个npm package的具体来源和版本号。
npm是一个用于管理package之间依赖关系的管理器,它允许开发者在pacakge.json中间标出自己项目对npm各库包的依赖。你可以选择以如下方式来标明自己所需要库包的版本
这里举个例子:
"dependencies": {
"@types/node": "^8.0.33",
}
^是定义了向后(新)兼容依赖,指如果 types/node的版本是超过8.0.33,并在大版本号(8)上相同,就允许下载最新版本的 types/node库包,例如实际上可能运行npm install时候下载的具体版本是8.0.35
如果项目中没有package-lock.json,就可能出现每个环境npm install的时候,拉取的依赖版本不一样,导致生成的包不一样的问题。
备注:
kebab-case :短横线分隔命名
camelCase :驼峰式命名
PascalCase :帕斯卡命名法。单词首字母大写命名,也有人称之为“大驼峰式命名法”(Upper Camel Case),为驼峰式大小写的子集。
按钮是跳转路由,不要在el-button包router-link标签
如果el-button包router-link标签, 这样写会出现需要点击按钮正中间才能有效,如果点到按钮,但是点到的是按钮边缘就会没反应,并且在火狐浏览器中无法使用 bad
<el-buttontype="text"size="mini">
<router-link:to="{ name: 'task-detail', query: { buildId: scope.row.Id }}">
<i class="el-icon-fw-eye"></i>
</router-link>
</el-button>
good
<el-button type="text"
size="mini"
@click="$router.push({ name: 'page-detail', query: { id: scope.row.Id }, params: { orgId: id }})"
icon="el-icon-fw-eye">
</el-button>
or
<router-link :to="{ name: 'opage-detail', query: { id: scope.row.Id }}">
<el-button type="text"size="mini">
<i class="el-icon-fw-eye"></i>
</el-button>
</router-link>
另外,路由跳转用name定位路由:$router.push({ name: xx, ….}),不要用path:$router.push({ path: ‘/xxx/xx’, ….}),因为name一般不去变,path会比较容易调整