1.如何使用 GitHub 上 Vue 最新的源码
描述: GitHub 仓库的 /dist
文件夹只有在新版本发布时才会提交。如果想要使用 GitHub 上 Vue 最新的源码,你需要自己构建!
git clone https://github.com/vuejs/vue.git node_modules/vue
cd node_modules/vue
npm install
npm run build
这里无需密码,直接就可以下载
2.Vue.js 是什么
Vue (读音 /vjuː/,类似于 view) 是一套用于构建用户界面的渐进式框架.与其它大型框架不同的是,Vue 被设计为可以自底向上逐层应用。Vue 的核心库只关注视图层,不仅易于上手,还便于与第三方库或既有项目整合。
3.Vue风格指南:vue书写要求,详读可规避许多错误哦
- 这块是优先级最高的别的不看这个总该看了吧
优先级:必要的 > 强烈推荐 > 推荐 >谨慎使用 >
1.组件名为多个单词(必要)
组件名应该始终是多个单词的,(采用驼峰写法或者帕斯卡写法单词(后者)首字母大写)
根组件 App 以及 <transition>、<component> 之类的 Vue 内置组件除外。
反例:Vue.component('todo', {// ...})
正确的例子:Vue.component('todo-item', {// ... }) export default { name: 'TodoItem'}
2.组件的 data 必须是一个函数。(必要)
当在组件中使用 data 属性的时候 (除了 new Vue 外的任何地方),
它的值必须是返回一个对象的函数。
官方解释:(后期得再看,没理解~_~)
当 data 的值是一个对象时,它会在这个组件的所有实例之间共享。想象一下,假如一个 TodoList 组件的数据是这样的:
data: {
listTitle: '',
todos: []
}
我们可能希望重用这个组件,允许用户维护多个列表 (比如分为购物、心愿单、日常事务等)。这时就会产生问题。因为每个组件的实例都引用了相同的数据对象,更改其中一个列表的标题就会改变其它每一个列表的标题。增删改一个待办事项的时候也是如此。
取而代之的是,我们希望每个组件实例都管理其自己的数据。为了做到这一点,每个实例必须生成一个独立的数据对象。在 JavaScript 中,在一个函数中返回这个对象就可以了:
data: function () {
return {
listTitle: '',
todos: []
}
}
(个人理解:根组件的话就是根组件的话有特定的表示el,整个项目仅仅一个,所以return不强求,但对于写过项目的人来说,一般全部加上,会更好。其他的组件互相引入他们之间没有特定的标识,当只用对象包裹数据,尤其是当两个组件使用的变量名字相同,可能就会冲突,稍后问完老师再来更正自己的见解)
3.Prop 定义 (必要)Prop 定义应该尽量详细。
最低要求:在你提交的代码中,prop 的定义应该尽量详细,至少需要指定其类型。
详解:细致Props定义的好处
~ 它们写明了组件的 API,所以很容易看懂组件的用法;
~ 在开发环境下,如果向一个组件提供格式不正确的 prop,Vue 将会告警,以帮助你捕获潜在的错误来源。
反例:// 这样做只有开发原型系统时可以接受
props: ['status']
正例:
props: {
status: String
}
// 更好的做法!
props: {
status: {
type: String,
default:'200'
required: true,
validator: function (value) {
return [
'syncing',
'synced',
'version-conflict',
'error'
].indexOf(value) !== -1
}
}
}
4.为 v-for 设置键值 (必要)
总是用 key 配合 v-for。
详解:在组件上总是必须用 key 配合 v-for,以便维护内部组件及其子树的状态。甚至在元素上维护可预测的行为,比如动画中的对象固化 (object constancy),也是一种好的做法。
根据我们的经验,最好始终添加一个唯一的键值,以便你和你的团队永远不必担心这些极端情况。也在少数对性能有严格要求的情况下,避免对象固化
反例:
<ul>
<li v-for="todo in todos">
{{ todo.text }}
</li>
</ul>
正例:
<ul>
<li
v-for="todo in todos"
:key="todo.id"
>
{{ todo.text }}
</li>
</ul>
5.避免 v-if 和 v-for 用在一起(必要)
[
https://cn.vuejs.org/v2/style-guide/#%E9%81%BF%E5%85%8D-v-if-%E5%92%8C-v-for-%E7%94%A8%E5%9C%A8%E4%B8%80%E8%B5%B7-%E5%BF%85%E8%A6%81
]
永远不要把 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)。
6.为组件样式设置作用域 (必要)
原因:对于应用来说,顶级 App 组件和布局组件中的样式可以是全局的,但是其它所有组件都应该是有作用域的。
官方解释:这条规则只和单文件组件有关。你不一定要使用 scoped 特性。设置作用域也可以通过 CSS Modules。那是一个基于 class 的类似 BEM 的策略,当然你也可以使用其它的库或约定。
不管怎样,对于组件库,我们应该更倾向于选用基于 class 的策略而不是 scoped 特性。
正例:(三种解决方案)
写module写法来获取类名
<template>
<button :class="[$style.button, $style.buttonClose]">X</button>
</template>
<!-- 使用 CSS Modules -->
<style module>
.button {
border: none;
border-radius: 2px;
}
.buttonClose {
background-color: red;
}
</style>
|||||
约定都带什么前缀
<template>
<button class="c-Button c-Button--close">X</button>
</template>
<!-- 使用 BEM 约定 -->
<style>
.c-Button {
border: none;
border-radius: 2px;
}
.c-Button--close {
background-color: red;
}
</style>
||||||
使用scoped
<template>
<button class="button button-close">X</button>
</template>
<!-- 使用 `scoped` 特性 -->
<style scoped>
.button {
border: none;
border-radius: 2px;
}
.button-close {
background-color: red;
}
</style>
7.私有属性名 (必要) (推荐将 $ 和 _ 结合,就会避免冲突)
说明:使用模块作用域保持不允许外部访问的函数的私有性。如果无法做到这一点,就始终为插件、混入等不考虑作为对外公共 API 的自定义私有属性使用 $_ 前缀。并附带一个命名空间以回避和其它作者的冲突 (比如 $_yourPluginName_)。
简单解释就是:使用$_属性功能名_方法名 这样的写法可以避免和vue组件内部的方法名冲突!!!
(因为vue中使用 _ 前缀来定义其自身的私有属性;vue使用$目的是暴露给用户的一个特殊的实例属性,所以把它用于私有属性并不合适。)
反例:(三种写法都不妥当)
var myGreatMixin = {
// ...
methods: {
update: function () {
// ...
},
_update: function () {
// ...
},
$update: function () {
// ...
}
}
}
正例:
var myGreatMixin = {
// ...
methods: {
$_myGreatMixin_update: function () {
// ...
}
}
}
使用混入的写法:
// 甚至更好!
var myGreatMixin = {
// ...
methods: {
publicMethod() {
// ...
myPrivateFunction()
}
}
}
function myPrivateFunction() {
// ...
}
export default myGreatMixin // 导出
- 这里官方优先级为B级(强烈推荐)
1.组件文件(强烈推荐)
当你需要编辑一个组件或查阅一个组件的用法时,可以更快速的找到它
反例(就是在一个组件中使用全局注册组件,组件过多时不宜查看和维护)
Vue.component('TodoList', {
// ...
})
Vue.component('TodoItem', {
// ...
})
正例:(可以分出来的就分出成单个组件最好)
components/
|- TodoList.vue
|- TodoItem.vue
2.单文件组件文件的大小写(强烈推荐)
要求:单文件组件的文件名应该要么始终是单词大写开头 (PascalCase),要么始终是横线连接 (kebab-case)。
单词大写开头对于代码编辑器的自动补全最为友好;
混用文件命名方式有的时候会导致大小写不敏感的文件系统的问题,可采取横线连接
反例:
components/
|- mycomponent.vue
components/
|- myComponent.vue
正例:好例子
components/
|- MyComponent.vue // 对于组件名要么采用 KxxCxx 要么采用 kxx-cxx
components/
|- my-component.vue
3.基础组件名(强烈推荐) 采用特定的前缀开头(某个主功能单词为前缀)
应用特定样式和约定的基础组件 (也就是展示类的、无逻辑的或无状态的组件) 应该全部以一个特定的前缀开头,比如 Base、App 或 V。
反例:(这里不是说起名不对,而是本身基础组件起的名字,没有规律,查找很难)
components/
|- MyButton.vue
|- VueTable.vue
|- Icon.vue
正例:
components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue
components/
|- AppButton.vue
|- AppTable.vue
|- AppIcon.vue
components/
|- VButton.vue
|- VTable.vue
|- VIcon.vue
4.单例组件名(强烈推荐)(简单说就是项目中仅引用一次,且无props与其他组件关联)
只应该拥有单个活跃实例的组件应该以 The 前缀命名,以示其唯一性。
解释:这不意味着组件只可用于一个单页面,而是每个页面只使用一次。这些组件永远不接受任何 prop,因为它们是为你的应用定制的,而不是它们在你的应用中的上下文。如果你发现有必要添加 prop,那就表明这实际上是一个可复用的组件,只是目前在每个页面里只使用一次。
就好比全项目最终的几个主题页面的组件,其实就是属于单例组件
反例
components/
|- Heading.vue
|- MySidebar.vue
正例:
components/
|- TheHeading.vue
|- TheSidebar.vue
5.紧密耦合的组件名 (强烈推荐)(和父组件紧密耦合的子组件应该以父组件名作为前缀命名。)
编辑器通常会按字母顺序组织文件,所以这样做可以把相关联的文件排在一起。
反例:(名字没有说明关联性)
components/
|- TodoList.vue
|- TodoItem.vue
|- TodoButton.vue
components/
|- SearchSidebar.vue
|- NavigationForSearchSidebar.vue
正例:(名字的名称一目了然)
components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue
components/
|- SearchSidebar.vue
|- SearchSidebarNavigation.vue
6.组件名中的单词顺序(强烈推荐)
组件名应该以高级别的 (通常是一般化描述的) 单词开头,以描述性的修饰词结尾。
解释:你可能想换成多级目录的方式,把所有的搜索组件放到“search”目录,把所有的设置组件放到“settings”目录。我们只推荐在非常大型 (如有 100+ 个组件) 的应用下才考虑这么做,因为:
在多级目录间找来找去,要比在单个 components 目录下滚动查找要花费更多的精力。
存在组件重名 (比如存在多个 ButtonDelete 组件) 的时候在编辑器里更难快速定位。
让重构变得更难,因为为一个移动了的组件更新相关引用时,查找/替换通常并不高效。
正例:(清晰明了)
components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputQuery.vue
|- SearchInputExcludeGlob.vue
|- SettingsCheckboxTerms.vue
|- SettingsCheckboxLaunchOnStartup.vue
反例:(不宜区别)
components/
|- ClearSearchButton.vue
|- ExcludeFromSearchInput.vue
|- LaunchOnStartupCheckbox.vue
|- RunSearchButton.vue
|- SearchInput.vue
|- TermsCheckbox.vue
7.自闭合组件(强烈推荐)
反例
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent></MyComponent> // 这种写法要分开写单词,中间连字符连接
<!-- 在 DOM 模板中 -->
<my-component/> // 自闭合组件使用不分开
正例:
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent/>
<!-- 在 DOM 模板中 -->
<my-component></my-component>
8.模板中的组件名大小写(强烈推荐)
PascalCase 相比 kebab-case :
首字母均大写和连字符连接 两者来说vue中,前者编辑器可以在模板里自动补全组件名,因为 PascalCase 同样适用于 JavaScript;
不幸的是,由于 HTML 是大小写不敏感的,在 DOM 模板中必须仍使用 kebab-case。
总体来说就是 可以再vue 中 引入、命名、注册组件时采用大驼峰(首字母大写),但是在写入dom中是,记得尽量采用连字符的方式; 或者可以<MyComponent/>,很少这样,不过也可。
9.JS/JSX 中的组件名大小写(强烈推荐)
JS/JSX 中的组件名应该始终是 PascalCase 的,尽管在较为简单的应用中只使用 Vue.component 进行全局组件注册时,可以使用 kebab-case 字符串。
对于只通过 Vue.component 定义全局组件的应用来说,我们推荐 kebab-case 作为替代。
原因是:
1.全局组件很少被 JavaScript 引用,所以遵守 JavaScript 的命名约定意义不大。
2.这些应用往往包含许多 DOM 内的模板,这种情况下是必须使用 kebab-case 的。
总之,在单文件组件中,js中的组件推荐采用大驼峰(KeCa)
反例
Vue.component('myComponent', {
// ...
})
import myComponent from './MyComponent.vue'
export default {
name: 'myComponent',
// ...
}
export default {
name: 'my-component',
// ...
}
好例子
Vue.component('MyComponent', {
// ...
})
Vue.component('my-component', {
// ...
})
import MyComponent from './MyComponent.vue'
export default {
name: 'MyComponent',
// ...
}
10.完整单词的组件名(强烈推荐) :组件名应该倾向于完整单词而不是缩写。
反例
components/
|- SdSettings.vue
|- UProfOpts.vue
好例子
components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue
11.Prop 名大小写(强烈推荐)
在声明 prop 的时候,其命名应该始终使用 camelCase,而在模板和 JSX 中应该始终使用 kebab-case。
单纯的约定 js中采用camelCase,在模板中采用camel-case
反例:
props: {
'greeting-text': String
}
<WelcomeMessage greetingText="hi"/>
好例子:
props: {
greetingText: String
}
<WelcomeMessage greeting-text="hi"/>
12.多个特性的元素(强烈推荐)
多个特性的元素应该分多行撰写,每个特性一行。
好例子:
<img
src="https://vuejs.org/images/logo.png"
alt="Vue Logo"
>
<MyComponent
foo="a"
bar="b"
baz="c"
/>
13.模板中简单的表达式(强烈推荐):将运算的结构放在computed或者methods中运算
组件模板应该只包含简单的表达式,复杂的表达式则应该重构为计算属性或方法。
反例:模板中
{{
fullName.split(' ').map(function (word) {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}}
正例:
<!-- 在模板中 -->
{{ normalizedFullName }}
// 复杂表达式已经移入一个计算属性(这里就保证了dom模板中表达式的简洁性了)
computed: {
normalizedFullName: function () {
return this.fullName.split(' ').map(function (word) {
return word[0].toUpperCase() + word.slice(1)
}).join(' ')
}
}
14.简单的计算属性(强烈推荐):应该把复杂计算属性分割为尽可能多的更简单的属性
解释:更简单、命名得当的计算属性是这样的:
易于测试、易于阅读、更好的“拥抱变化”
反例
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
}
}
15.带引号的特性值(强烈推荐)
非空 HTML 特性值应该始终带引号 (单引号或双引号,选你 JS 里不用的那个)。
在 HTML 中不带空格的特性值是可以没有引号的,但这鼓励了大家在特征值里不写空格,导致可读性变差。
反例
<input type=text>
<AppSidebar :style={width:sidebarWidth+'px'}>
好例子
<input type="text">
<AppSidebar :style="{ width: sidebarWidth + 'px' }">
16.指令缩写(强烈推荐) 这条最常用,注意多多使用哦
: 表示 v-bind: 、用 @ 表示 v-on: 和用 # 表示 v-slot:
特别注意:要么都用缩写,要么都不用缩写。注意这一点。
好例子
<input
:value="newTodoText"
:placeholder="newTodoInstructions"
>
<input
v-bind:value="newTodoText"
v-bind:placeholder="newTodoInstructions"
>
<input
@input="onInput"
@focus="onFocus"
>