组件名为多个单词
除了根组件App
之外,组件名应该始终是多个单词的,这样做可以避免和现有的以及未来的HTML元素冲突
组件的data
必须是一个函数
如果不是函数,那么会在组件的所有实例之间共享,导致会被随意修改,且无法维护。
Vue.component('some-comp', {
data: {
foo: 'bar'
}
})
export default {
data: {
foo: 'bar'
}
}
我们希望每个组件实例都管理自己的数据,为了做到这一点,每个实例必须生成一个独立的数据对象,用函数返回这个对象就可以了。
Vue.component('some-comp', {
data: function () {
return {
foo: 'bar'
}
}
})
export default {
data () {
return {
foo: 'bar'
}
}
Prop定义应该尽量详细
这样做的好处:
1. 充当组件API
2. 开发环境中,如果提供格式不正确的prop,Vue会警告,帮助你捕获潜在的错误来源
// 更好的做法!
props: {
status: {
type: String,
required: true,
validator: function (value) {
return [
'syncing',
'synced',
'version-conflict',
'error'
].indexOf(value) !== -1
}
}
}
v-for
设置key
组件上必须用key
配合v-for
以便维护内部组件及其子树的状态。
避免v-if
和v-for
在同一个元素上
一般我们在两种常见的情况下会倾向于这样做:
- 为了过滤一个列表中的项目 (比如
v-for="user in users" v-if="user.isActive"
)。在这种情形下,请将users
替换为一个计算属性 (比如activeUsers
),让其返回过滤后的列表。
computed: {
activeUsers: function () {
return this.users.filter(function (user) {
return user.isActive
})
}
}
- 为了避免渲染本应该被隐藏的列表 (比如
v-for="user in users" v-if="shouldShowUsers"
)。这种情形下,请将v-if
移动至容器元素上 (比如ul
,ol
)。
v-for
比v-if
具有更高的优先级
组件样式设置作用域
对于应用来说,顶级App
组件和布局组件中的样式可以是全局的,但是其它所有组件都应该是有作用域的。
对于组件库,我们应该更倾向于选用基于class的策略而不是scoped
特性。
用$_
作为私有属性前缀
在插件、混入等扩展中始终为自定义的私有属性使用$_
前缀。并附带一个命名空间以回避和其它作者的冲突 (比如$_yourPluginName_
)。
var myGreatMixin = {
// ...
methods: {
$_myGreatMixin_update: function () {
// ...
}
}
}
将每个组件分割为文件
当你需要编辑一个组件或查阅一个组件的用法时,可以更快速的找到它。
// 反例
Vue.component('TodoList', {
// ...
})
Vue.component('TodoItem', {
// ...
})
// 好例子
components/
|- TodoList.js
|- TodoItem.js
components/
|- TodoList.vue
|- TodoItem.vue
单文件组件的命名要么始终是单词大写开头,要么用横线连接
// 好例子
components/
|- MyComponent.vue
components/
|- my-component.vue
基础组件应用特定前缀标明,比如Base
、App
或V
// 好例子
components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue
components/
|- AppButton.vue
|- AppTable.vue
|- AppIcon.vue
components/
|- VButton.vue
|- VTable.vue
|- VIcon.vue
只应该拥有单个活跃实例的组件应该以The
前缀命名,以示其唯一性。
这不意味着组件只可用于一个单页面,而是每个页面只使用一次。这些组件永远不接受任何prop
,因为它们是为你的应用定制的,而不是它们在你的应用中的上下文。
如果你发现有必要添加prop
,那就表明这实际上是一个可复用的组件,只是目前在每个页面里只使用一次。
// 好例子
components/
|- TheHeading.vue
|- TheSidebar.vue
和父组件紧密耦合的子组件应该以父组件名作为前缀命名
如果一个组件只在某个父组件的场景下有意义,这层关系应该体现在其名字上。因为编辑器通常会按字母顺序组织文件,所以这样做可以把相关联的文件排在一起。
可以试着通过在其父组件命名的目录中嵌套子组件以解决这个问题。比如:
components/
|- TodoList/
|- Item/
|- index.vue
|- Button.vue
|- index.vue
但是这种方式并不推荐,因为这会导致:
- 许多文件的名字相同,使得在编辑器中快速切换文件变得困难。
- 过多嵌套的子目录增加了在编辑器侧边栏中浏览组件所花的时间。
// 好例子
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
components/
|- SearchSidebar.vue
|- SearchSidebarNavigation.vue
不要在DOM模板中使用自闭合组件
在单文件组件、字符串模板和 JSX 中没有内容的组件应该是自闭合的——但在 DOM 模板里永远不要这样做。
自闭合组件表示它们不仅没有内容,而且刻意没有内容。但HTML并不支持自闭合的自定义元素——只有官方的“空”元素。
<!--反例-->
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent></MyComponent>
<!-- 在 DOM 模板中 -->
<my-component/>
<!--好例子-->
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent/>
<!-- 在 DOM 模板中 -->
<my-component></my-component>
组件名应该倾向于完整单词而不是缩写
// 反例
components/
|- SdSettings.vue
|- UProfOpts.vue
// 好例子
components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue
在声明prop时,命名应使用camelCase,而在模板和JSX中应该始终使用kebab-case
// 好例子
props: {
greetingText: String
}
<WelcomeMessage greeting-text="hi"/>
多个特性的元素应该分多行,每个特性一行
// 反例
<img src="https://vuejs.org/images/logo.png" alt="Vue Logo">
<MyComponent foo="a" bar="b" baz="c"/>
// 好例子
<img
src="https://vuejs.org/images/logo.png"
alt="Vue Logo"
>
<MyComponent
foo="a"
bar="b"
baz="c"
/>
模板中不使用复杂表达式
组件模板应该只包含简单的表达式,复杂的表达式则应该重构为计算属性或方法。
复杂表达式会让你的模板变得不那么声明式。我们应该尽量描述应该出现的是什么,而非如何计算那个值。而且计算属性和方法使得代码可以重用。
// 反例
{{
fullName.split(' ').map(function (word) {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}}
// 好例子
<!-- 在模板中 -->
{{ normalizedFullName }}
// 复杂表达式已经移入一个计算属性
computed: {
normalizedFullName: function () {
return this.fullName.split(' ').map(function (word) {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}
}
把复杂计算属性分割为尽可能多的更简单的属性
更简单、命名得当的计算属性是这样的:
- 易于测试
当每个计算属性都包含一个非常简单且很少依赖的表达式时,撰写测试以确保其正确工作就会更加容易。 - 易于阅读
简化计算属性要求你为每一个值都起一个描述性的名称,即便它不可复用。这使得其他开发者 (以及未来的你) 更容易专注在他们关心的代码上并搞清楚发生了什么。 - 更好的“拥抱变化”
任何能够命名的值都可能用在视图上。举个例子,我们可能打算展示一个信息,告诉用户他们存了多少钱;也可能打算计算税费,但是可能会分开展现,而不是作为总价的一部分。小的、专注的计算属性减少了信息使用时的假设性限制,所以需求变更时也用不着那么多重构了。
// 反例
computed: {
price: function () {
var basePrice = this.manufactureCost / (1 - this.profitMargin)
return (
basePrice -
basePrice * (this.discountPercent || 0)
)
}
}
// 好例子
computed: {
basePrice: function () {
return this.manufactureCost / (1 - this.profitMargin)
},
discount: function () {
return this.basePrice * (this.discountPercent || 0)
},
finalPrice: function () {
return this.basePrice - this.discount
}
}
HTML特性值应该始终带引号
在HTML中不带空格的特性值是可以没有引号的,但这样做常常导致带空格的特征值被回避,导致其可读性变差。
反例
<input type=text>
<AppSidebar :style={width:sidebarWidth+'px'}>
好例子
<input type="text">
<AppSidebar :style="{ width: sidebarWidth + 'px' }">
指令缩写保证统一
指令缩写 (用:
表示v-bind:
和用@
表示v-on:
) 应该要么都用要么都不用。
避免在scoped
样式中出现元素选择器
在scoped
样式中,类选择器比元素选择器更好,因为大量使用元素选择器是很慢的。
避免隐形的父子组件通信
应该优先通过prop
和事件进行父子组件之间的通信,而不是this.$parent
或改变prop
。
一个理想的Vue应用是prop
向下传递,事件向上传递的。遵循这一约定会让你的组件更易于理解。然而,在一些边界情况下prop
的变更或this.$parent
能够简化两个深度耦合的组件。
问题在于,这种做法在很多简单的场景下可能会更方便。但请当心,不要为了一时方便 (少写代码) 而牺牲数据流向的简洁性 (易于理解)。
// 反例
Vue.component('TodoItem', {
props: {
todo: {
type: Object,
required: true
}
},
template: '<input v-model="todo.text">'
})
Vue.component('TodoItem', {
props: {
todo: {
type: Object,
required: true
}
},
methods: {
removeTodo () {
var vm = this
vm.$parent.todos = vm.$parent.todos.filter(function (todo) {
return todo.id !== vm.todo.id
})
}
},
template: `
<span>
{{ todo.text }}
<button @click="removeTodo">
X
</button>
</span>
`
})
// 好例子
Vue.component('TodoItem', {
props: {
todo: {
type: Object,
required: true
}
},
template: `
<input
:value="todo.text"
@input="$emit('input', $event.target.value)"
>
`
})
Vue.component('TodoItem', {
props: {
todo: {
type: Object,
required: true
}
},
template: `
<span>
{{ todo.text }}
<button @click="$emit('delete')">
X
</button>
</span>
`
})
优先使用Vuex管理全局状态
应该优先通过Vuex管理全局状态,而不是通过this.$root
或一个全局事件总线。
通过this.$root
和/或全局事件总线管理状态在很多简单的情况下都是很方便的,但是并不适用于绝大多数的应用。Vuex提供的不仅是一个管理状态的中心区域,还是组织、追踪和调试状态变更的好工具。