VUE風(fēng)格指南

title: 風(fēng)格指南
type: style-guide

這里是官方的 Vue 特有代碼的風(fēng)格指南。如果在工程中使用 Vue，為了回避錯(cuò)誤、小糾結(jié)和反模式，該指南是份不錯(cuò)的參考。不過(guò)我們也不確信風(fēng)格指南的所有內(nèi)容對(duì)于所有的團(tuán)隊(duì)或工程都是理想的。所以根據(jù)過(guò)去的經(jīng)驗(yàn)、周圍的技術(shù)棧、個(gè)人價(jià)值觀做出有意義的偏差是可取的。

對(duì)于其絕大部分，我們也總體上避免就 JavaScript 或 HTML 的本身提出建議。我們不介意你是否使用分號(hào)或結(jié)尾的逗號(hào)。我們不介意你在 HTML 特性中使用單引號(hào)還是雙引號(hào)。不過(guò)當(dāng)我們發(fā)現(xiàn)在 Vue 的情景下有幫助的特定模式時(shí)，也會(huì)存在例外。

不久之后，我們還會(huì)提供操作層面的技巧。有的時(shí)候你只需要遵守規(guī)則，而我們會(huì)盡可能向你展示如何使用 ESLint 及其它自動(dòng)化程序把操作層面弄得更簡(jiǎn)單。

最終，我們把所有的規(guī)則歸為了四個(gè)大類：

規(guī)則歸類

優(yōu)先級(jí) A：必要的

這些規(guī)則會(huì)幫你規(guī)避錯(cuò)誤，所以學(xué)習(xí)并接受它們帶來(lái)的全部代價(jià)吧。這里面可能存在例外，但應(yīng)該非常少，且只有你同時(shí)精通 JavaScript 和 Vue 才可以這樣做。

優(yōu)先級(jí) B：強(qiáng)烈推薦

這些規(guī)則能夠在絕大多數(shù)工程中改善可讀性和開發(fā)體驗(yàn)。即使你違反了，代碼還是能照常運(yùn)行，但例外應(yīng)該盡可能少且有合理的理由。

優(yōu)先級(jí) C：推薦

當(dāng)存在多個(gè)同樣好的選項(xiàng)，選任意一個(gè)都可以確保一致性。在這些規(guī)則里，我們描述了每個(gè)選項(xiàng)并建議一個(gè)默認(rèn)的選擇。也就是說(shuō)只要保持一致且理由充分，你可以隨意在你的代碼庫(kù)中做出不同的選擇。請(qǐng)務(wù)必給出一個(gè)好的理由！通過(guò)接受社區(qū)的標(biāo)準(zhǔn)，你將會(huì)：

  1. 訓(xùn)練你的大腦，以便更容易的處理你在社區(qū)遇到的代碼；
  2. 不做修改就可以直接復(fù)制粘貼社區(qū)的代碼示例；
  3. 能夠經(jīng)常招聘到和你編碼習(xí)慣相同的新人，至少跟 Vue 相關(guān)的東西是這樣的。

優(yōu)先級(jí) D：謹(jǐn)慎使用

有些 Vue 特性的存在是為了照顧極端情況或幫助老代碼的平穩(wěn)遷移。當(dāng)被過(guò)度使用時(shí)，這些特性會(huì)讓你的代碼難于維護(hù)甚至變成 bug 的來(lái)源。這些規(guī)則是為了給有潛在風(fēng)險(xiǎn)的特性敲個(gè)警鐘，并說(shuō)明它們什么時(shí)候不應(yīng)該使用以及為什么。

優(yōu)先級(jí) A 的規(guī)則：必要的 (規(guī)避錯(cuò)誤)

組件名為多個(gè)單詞 <sup data-p="a">必要

組件名應(yīng)該始終是多個(gè)單詞的，根組件 App 除外。

這樣做可以避免跟現(xiàn)有的以及未來(lái)的 HTML 元素相沖突，因?yàn)樗械?HTML 元素名稱都是單個(gè)單詞的。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

Vue.component('todo', {
  // ...
})

export default {
  name: 'Todo',
  // ...
}

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

Vue.component('todo-item', {
  // ...
})

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

{% raw %}</div>{% endraw %}

組件數(shù)據(jù) <sup data-p="a">必要

組件的 data 必須是一個(gè)函數(shù)。

當(dāng)在組件中使用 data 屬性的時(shí)候 (除了 new Vue 外的任何地方)，它的值必須是返回一個(gè)對(duì)象的函數(shù)。

此處：返回一個(gè)唯一的對(duì)象，不要和其他組件共用一個(gè)對(duì)象進(jìn)行返回（這樣就不會(huì)處理同一個(gè)對(duì)象）

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

當(dāng) data 的值是一個(gè)對(duì)象時(shí)，它會(huì)在這個(gè)組件的所有實(shí)例之間共享。想象一下，假如一個(gè) TodoList 組件的數(shù)據(jù)是這樣的：

data: {
  listTitle: '',
  todos: []
}

我們可能希望重用這個(gè)組件，允許用戶維護(hù)多個(gè)列表 (比如分為購(gòu)物、心愿單、日常事務(wù)等)。這時(shí)就會(huì)產(chǎn)生問(wèn)題。因?yàn)槊總€(gè)組件的實(shí)例都引用了相同的數(shù)據(jù)對(duì)象，更改其中一個(gè)列表的標(biāo)題就會(huì)改變其它每一個(gè)列表的標(biāo)題。增刪改一個(gè)待辦事項(xiàng)的時(shí)候也是如此。

取而代之的是，我們希望每個(gè)組件實(shí)例都管理其自己的數(shù)據(jù)。為了做到這一點(diǎn)，每個(gè)實(shí)例必須生成一個(gè)獨(dú)立的數(shù)據(jù)對(duì)象。在 JavaScript 中，在一個(gè)函數(shù)中返回這個(gè)對(duì)象就可以了：

data: function () {
  return {
    listTitle: '',
    todos: []
  }
}

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

Vue.component('some-comp', {
  data: {
    foo: 'bar'
  }
})

export default {
  data: {
    foo: 'bar'
  }
}

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

Vue.component('some-comp', {
  data: function () {
    return {
      foo: 'bar'
    }
  }
})

// In a .vue file
export default {
  data () {
    return {
      foo: 'bar'
    }
  }
}

// 在一個(gè) Vue 的根實(shí)例上直接使用對(duì)象是可以的，
// 因?yàn)橹淮嬖谝粋€(gè)這樣的實(shí)例。
new Vue({
  data: {
    foo: 'bar'
  }
})

{% raw %}</div>{% endraw %}

Prop 定義 <sup data-p="a">必要

Prop 定義應(yīng)該盡量詳細(xì)。

在你提交的代碼中，prop 的定義應(yīng)該盡量詳細(xì)，至少需要指定其類型。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

細(xì)致的 prop 定義有兩個(gè)好處：

  • 它們寫明了組件的 API，所以很容易看懂組件的用法；
  • 在開發(fā)環(huán)境下，如果向一個(gè)組件提供格式不正確的 prop，Vue 將會(huì)告警，以幫助你捕獲潛在的錯(cuò)誤來(lái)源。

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

// 這樣做只有開發(fā)原型系統(tǒng)時(shí)可以接受
props: ['status']

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

props: {
  status: String
}

// 更好的做法！
props: {
  status: {
    type: String,
    required: true,
    validator: function (value) {
      return [
        'syncing',
        'synced',
        'version-conflict',
        'error'
      ].indexOf(value) !== -1
    }
  }
}

{% raw %}</div>{% endraw %}

為 v-for 設(shè)置鍵值 <sup data-p="a">必要

總是用 key 配合 v-for。

在組件上總是必須用 key 配合 v-for，以便維護(hù)內(nèi)部組件及其子樹的狀態(tài)。甚至在元素上維護(hù)可預(yù)測(cè)的行為，比如動(dòng)畫中的對(duì)象固化 (object constancy)，也是一種好的做法。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

假設(shè)你有一個(gè)待辦事項(xiàng)列表：

data: function () {
  return {
    todos: [
      {
        id: 1,
        text: '學(xué)習(xí)使用 v-for'
      },
      {
        id: 2,
        text: '學(xué)習(xí)使用 key'
      }
    ]
  }
}

然后你把它們按照字母順序排序。在更新 DOM 的時(shí)候，Vue 將會(huì)優(yōu)化渲染把可能的 DOM 變動(dòng)降到最低。即可能刪掉第一個(gè)待辦事項(xiàng)元素，然后把它重新加回到列表的最末尾。

這里的問(wèn)題在于，不要?jiǎng)h除仍然會(huì)留在 DOM 中的元素。比如你想使用 <transition-group> 給列表加過(guò)渡動(dòng)畫，或想在被渲染元素是 <input> 時(shí)保持聚焦。在這些情況下，為每一個(gè)項(xiàng)目添加一個(gè)唯一的鍵值 (比如 :key="todo.id") 將會(huì)讓 Vue 知道如何使行為更容易預(yù)測(cè)。

根據(jù)我們的經(jīng)驗(yàn)，最好始終添加一個(gè)唯一的鍵值，以便你和你的團(tuán)隊(duì)永遠(yuǎn)不必?fù)?dān)心這些極端情況。也在少數(shù)對(duì)性能有嚴(yán)格要求的情況下，為了避免對(duì)象固化，你可以刻意做一些非常規(guī)的處理。

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

<ul>
  <li v-for="todo in todos">
    {{ todo.text }}
  </li>
</ul>

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<ul>
  <li
    v-for="todo in todos"
    :key="todo.id"
  >
    {{ todo.text }}
  </li>
</ul>

{% raw %}</div>{% endraw %}

避免 v-if 和 v-for 用在一起 <sup data-p="a">必要

永遠(yuǎn)不要把 v-if 和 v-for 同時(shí)用在同一個(gè)元素上。

一般我們?cè)趦煞N常見的情況下會(huì)傾向于這樣做：

  • 為了過(guò)濾一個(gè)列表中的項(xiàng)目 (比如 v-for="user in users" v-if="user.isActive")。在這種情形下，請(qǐng)將 users 替換為一個(gè)計(jì)算屬性 (比如 activeUsers)，讓其返回過(guò)濾后的列表。

  • 為了避免渲染本應(yīng)該被隱藏的列表 (比如 v-for="user in users" v-if="shouldShowUsers")。這種情形下，請(qǐng)將 v-if 移動(dòng)至容器元素上 (比如 ul, ol)。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

當(dāng) Vue 處理指令時(shí)，v-for 比 v-if 具有更高的優(yōu)先級(jí)，所以這個(gè)模板：

<ul>
  <li
    v-for="user in users"
    v-if="user.isActive"
    :key="user.id"
  >
    {{ user.name }}
  </li>
</ul>

將會(huì)經(jīng)過(guò)如下運(yùn)算：

this.users.map(function (user) {
  if (user.isActive) {
    return user.name
  }
})

因此哪怕我們只渲染出一小部分用戶的元素，也得在每次重渲染的時(shí)候遍歷整個(gè)列表，不論活躍用戶是否發(fā)生了變化。

通過(guò)將其更換為在如下的一個(gè)計(jì)算屬性上遍歷：

computed: {
  activeUsers: function () {
    return this.users.filter(function (user) {
      return user.isActive
    })
  }
}

<ul>
  <li
    v-for="user in activeUsers"
    :key="user.id"
  >
    {{ user.name }}
  </li>
</ul>

我們將會(huì)獲得如下好處：

  • 過(guò)濾后的列表只會(huì)在 users 數(shù)組發(fā)生相關(guān)變化時(shí)才被重新運(yùn)算，過(guò)濾更高效。
  • 使用 v-for="user in activeUsers" 之后，我們?cè)阡秩镜臅r(shí)候只遍歷活躍用戶，渲染更高效。
  • 解藕渲染層的邏輯，可維護(hù)性 (對(duì)邏輯的更改和擴(kuò)展) 更強(qiáng)。

為了獲得同樣的好處，我們也可以把：

<ul>
  <li
    v-for="user in users"
    v-if="shouldShowUsers"
    :key="user.id"
  >
    {{ user.name }}
  </li>
</ul>

更新為：

<ul v-if="shouldShowUsers">
  <li
    v-for="user in users"
    :key="user.id"
  >
    {{ user.name }}
  </li>
</ul>

通過(guò)將 v-if 移動(dòng)到容器元素，我們不會(huì)再對(duì)列表中的每個(gè)用戶檢查 shouldShowUsers。取而代之的是，我們只檢查它一次，且不會(huì)在 shouldShowUsers 為否的時(shí)候運(yùn)算 v-for。

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

<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>

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<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>

{% raw %}</div>{% endraw %}

為組件樣式設(shè)置作用域 <sup data-p="a">必要

對(duì)于應(yīng)用來(lái)說(shuō)，頂級(jí) App 組件和布局組件中的樣式可以是全局的，但是其它所有組件都應(yīng)該是有作用域的。

這條規(guī)則只和單文件組件有關(guān)。你不一定要使用 scoped 特性。設(shè)置作用域也可以通過(guò) CSS Modules，那是一個(gè)基于 class 的類似 BEM 的策略，當(dāng)然你也可以使用其它的庫(kù)或約定。

不管怎樣，對(duì)于組件庫(kù)，我們應(yīng)該更傾向于選用基于 class 的策略而不是 scoped 特性。

這讓覆寫內(nèi)部樣式更容易：使用了常人可理解的 class 名稱且沒(méi)有太高的選擇器優(yōu)先級(jí)，而且不太會(huì)導(dǎo)致沖突。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

如果你和其他開發(fā)者一起開發(fā)一個(gè)大型工程，或有時(shí)引入三方 HTML/CSS (比如來(lái)自 Auth0)，設(shè)置一致的作用域會(huì)確保你的樣式只會(huì)運(yùn)用在它們想要作用的組件上。

不止要使用 scoped 特性，使用唯一的 class 名可以幫你確保那些三方庫(kù)的 CSS 不會(huì)運(yùn)用在你自己的 HTML 上。比如許多工程都使用了 button、btn 或 icon class 名，所以即便你不使用類似 BEM 的策略，添加一個(gè) app 專屬或組件專屬的前綴 (比如 ButtonClose-icon) 也可以提供很多保護(hù)。

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

<template>
  <button class="btn btn-close">X</button>
</template>

<style>
.btn-close {
  background-color: red;
}
</style>

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<template>
  <button class="button button-close">X</button>
</template>

<!-- 使用 `scoped` 特性 -->
<style scoped>
.button {
  border: none;
  border-radius: 2px;
}

.button-close {
  background-color: red;
}
</style>

<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>

{% raw %}</div>{% endraw %}

私有屬性名 <sup data-p="a">必要

在插件、混入等擴(kuò)展中始終為自定義的私有屬性使用 $_ 前綴。并附帶一個(gè)命名空間以回避和其它作者的沖突 (比如 $_yourPluginName_)。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

Vue 使用 _ 前綴來(lái)定義其自身的私有屬性，所以使用相同的前綴 (比如 _update) 有覆寫實(shí)例屬性的風(fēng)險(xiǎn)。即便你檢查確認(rèn) Vue 當(dāng)前版本沒(méi)有用到這個(gè)屬性名，也不能保證和將來(lái)的版本沒(méi)有沖突。

對(duì)于 $ 前綴來(lái)說(shuō)，其在 Vue 生態(tài)系統(tǒng)中的目的是暴露給用戶的一個(gè)特殊的實(shí)例屬性，所以把它用于私有屬性并不合適。

不過(guò)，我們推薦把這兩個(gè)前綴結(jié)合為 $_，作為一個(gè)用戶定義的私有屬性的約定，以確保不會(huì)和 Vue 自身相沖突。

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

var myGreatMixin = {
  // ...
  methods: {
    update: function () {
      // ...
    }
  }
}

var myGreatMixin = {
  // ...
  methods: {
    _update: function () {
      // ...
    }
  }
}

var myGreatMixin = {
  // ...
  methods: {
    $update: function () {
      // ...
    }
  }
}

var myGreatMixin = {
  // ...
  methods: {
    $_update: function () {
      // ...
    }
  }
}

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

var myGreatMixin = {
  // ...
  methods: {
    $_myGreatMixin_update: function () {
      // ...
    }
  }
}

{% raw %}</div>{% endraw %}

優(yōu)先級(jí) B 的規(guī)則：強(qiáng)烈推薦 (增強(qiáng)可讀性)

組件文件 <sup data-p="b">強(qiáng)烈推薦

只要有能夠拼接文件的構(gòu)建系統(tǒng)，就把每個(gè)組件單獨(dú)分成文件。

當(dāng)你需要編輯一個(gè)組件或查閱一個(gè)組件的用法時(shí)，可以更快速的找到它。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

Vue.component('TodoList', {
  // ...
})

Vue.component('TodoItem', {
  // ...
})

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

components/
|- TodoList.js
|- TodoItem.js

components/
|- TodoList.vue
|- TodoItem.vue

{% raw %}</div>{% endraw %}

單文件組件文件的大小寫 <sup data-p="b">強(qiáng)烈推薦

單文件組件的文件名應(yīng)該要么始終是單詞大寫開頭 (PascalCase)，要么始終是橫線連接 (kebab-case)。

單詞大寫開頭對(duì)于代碼編輯器的自動(dòng)補(bǔ)全最為友好，因?yàn)檫@使得我們?cè)?JS(X) 和模板中引用組件的方式盡可能的一致。然而，混用文件命名方式有的時(shí)候會(huì)導(dǎo)致大小寫不敏感的文件系統(tǒng)的問(wèn)題，這也是橫線連接命名同樣完全可取的原因。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

components/
|- mycomponent.vue

components/
|- myComponent.vue

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

components/
|- MyComponent.vue

components/
|- my-component.vue

{% raw %}</div>{% endraw %}

基礎(chǔ)組件名 <sup data-p="b">強(qiáng)烈推薦

應(yīng)用特定樣式和約定的基礎(chǔ)組件 (也就是展示類的、無(wú)邏輯的或無(wú)狀態(tài)的組件) 應(yīng)該全部以一個(gè)特定的前綴開頭，比如 Base、App 或 V。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

這些組件為你的應(yīng)用奠定了一致的基礎(chǔ)樣式和行為。它們可能只包括：

  • HTML 元素
  • 其它帶 Base 前綴的組件
  • 第三方 UI 組件庫(kù)

但是它們絕不會(huì)包括全局狀態(tài) (比如來(lái)自 Vuex store)。

它們的名字通常包含所包裹元素的名字 (比如 BaseButton、BaseTable)，除非沒(méi)有現(xiàn)成的對(duì)應(yīng)功能的元素 (比如 BaseIcon)。如果你為特定的上下文構(gòu)建類似的組件，那它們幾乎總會(huì)消費(fèi)這些組件 (比如 BaseButton 可能會(huì)用在 ButtonSubmit 上)。

這樣做的幾個(gè)好處：

  • 當(dāng)你在編輯器中以字母順序排序時(shí)，你的應(yīng)用的基礎(chǔ)組件會(huì)全部列在一起，這樣更容易識(shí)別。

  • 因?yàn)榻M件名應(yīng)該始終是多個(gè)單詞，所以這樣做可以避免你在包裹簡(jiǎn)單組件時(shí)隨意選擇前綴 (比如 MyButton、VueButton)。

  • 因?yàn)檫@些組件會(huì)被頻繁使用，所以你可能想把它們放到全局而不是在各處分別導(dǎo)入它們。使用相同的前綴可以讓 webpack 這樣工作：

    var requireComponent = require.context("./src", true, /^Base[A-Z]/)
requireComponent.keys().forEach(function (fileName) {
  var baseComponentConfig = requireComponent(fileName)
  baseComponentConfig = baseComponentConfig.default || baseComponentConfig
  var baseComponentName = baseComponentConfig.name || (
    fileName
      .replace(/^.+\//, '')
      .replace(/\.\w+$/, '')
  )
  Vue.component(baseComponentName, baseComponentConfig)
})

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

components/
|- MyButton.vue
|- VueTable.vue
|- Icon.vue

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue

components/
|- AppButton.vue
|- AppTable.vue
|- AppIcon.vue

components/
|- VButton.vue
|- VTable.vue
|- VIcon.vue

{% raw %}</div>{% endraw %}

單例組件名 <sup data-p="b">強(qiáng)烈推薦

只應(yīng)該擁有單個(gè)活躍實(shí)例的組件應(yīng)該以 The 前綴命名，以示其唯一性。

這不意味著組件只可用于一個(gè)單頁(yè)面，而是每個(gè)頁(yè)面只使用一次。這些組件永遠(yuǎn)不接受任何 prop，因?yàn)樗鼈兪菫槟愕膽?yīng)用定制的，而不是它們?cè)谀愕膽?yīng)用中的上下文。如果你發(fā)現(xiàn)有必要添加 prop，那就表明這實(shí)際上是一個(gè)可復(fù)用的組件，只是目前在每個(gè)頁(yè)面里只使用一次。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

components/
|- Heading.vue
|- MySidebar.vue

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

components/
|- TheHeading.vue
|- TheSidebar.vue

{% raw %}</div>{% endraw %}

緊密耦合的組件名 <sup data-p="b">強(qiáng)烈推薦

和父組件緊密耦合的子組件應(yīng)該以父組件名作為前綴命名。

如果一個(gè)組件只在某個(gè)父組件的場(chǎng)景下有意義，這層關(guān)系應(yīng)該體現(xiàn)在其名字上。因?yàn)榫庉嬈魍ǔ?huì)按字母順序組織文件，所以這樣做可以把相關(guān)聯(lián)的文件排在一起。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

你可以試著通過(guò)在其父組件命名的目錄中嵌套子組件以解決這個(gè)問(wèn)題。比如：

components/
|- TodoList/
   |- Item/
      |- index.vue
      |- Button.vue
   |- index.vue

或：

components/
|- TodoList/
   |- Item/
      |- Button.vue
   |- Item.vue
|- TodoList.vue

但是這種方式并不推薦，因?yàn)檫@會(huì)導(dǎo)致：

  • 許多文件的名字相同，使得在編輯器中快速切換文件變得困難。
  • 過(guò)多嵌套的子目錄增加了在編輯器側(cè)邊欄中瀏覽組件所花的時(shí)間。

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

components/
|- TodoList.vue
|- TodoItem.vue
|- TodoButton.vue

components/
|- SearchSidebar.vue
|- NavigationForSearchSidebar.vue

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

components/
|- TodoList.vue
|- TodoListItem.vue
|- TodoListItemButton.vue

components/
|- SearchSidebar.vue
|- SearchSidebarNavigation.vue

{% raw %}</div>{% endraw %}

組件名中的單詞順序 <sup data-p="b">強(qiáng)烈推薦

組件名應(yīng)該以高級(jí)別的 (通常是一般化描述的) 單詞開頭，以描述性的修飾詞結(jié)尾。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

你可能會(huì)疑惑：

“為什么我們給組件命名時(shí)不多遵從自然語(yǔ)言呢？”

在自然的英文里，形容詞和其它描述語(yǔ)通常都出現(xiàn)在名詞之前，否則需要使用連接詞。比如：

  • Coffee with milk
  • Soup of the day
  • Visitor to the museum

如果你愿意，你完全可以在組件名里包含這些連接詞，但是單詞的順序很重要。

同樣要注意在你的應(yīng)用中所謂的“高級(jí)別”是跟語(yǔ)境有關(guān)的。比如對(duì)于一個(gè)帶搜索表單的應(yīng)用來(lái)說(shuō)，它可能包含這樣的組件：

components/
|- ClearSearchButton.vue
|- ExcludeFromSearchInput.vue
|- LaunchOnStartupCheckbox.vue
|- RunSearchButton.vue
|- SearchInput.vue
|- TermsCheckbox.vue

你可能注意到了，我們很難看出來(lái)哪些組件是針對(duì)搜索的?，F(xiàn)在我們來(lái)根據(jù)規(guī)則給組件重新命名：

components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputExcludeGlob.vue
|- SearchInputQuery.vue
|- SettingsCheckboxLaunchOnStartup.vue
|- SettingsCheckboxTerms.vue

因?yàn)榫庉嬈魍ǔ?huì)按字母順序組織文件，所以現(xiàn)在組件之間的重要關(guān)系一目了然。

你可能想換成多級(jí)目錄的方式，把所有的搜索組件放到“search”目錄，把所有的設(shè)置組件放到“settings”目錄。我們只推薦在非常大型 (如有 100+ 個(gè)組件) 的應(yīng)用下才考慮這么做，因?yàn)椋?/p>

  • 在多級(jí)目錄間找來(lái)找去，要比在單個(gè) components 目錄下滾動(dòng)查找要花費(fèi)更多的精力。
  • 存在組件重名 (比如存在多個(gè) ButtonDelete 組件) 的時(shí)候在編輯器里更難快速定位。
  • 讓重構(gòu)變得更難，因?yàn)闉橐粋€(gè)移動(dòng)了的組件更新相關(guān)引用時(shí)，查找/替換通常并不高效。

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

components/
|- ClearSearchButton.vue
|- ExcludeFromSearchInput.vue
|- LaunchOnStartupCheckbox.vue
|- RunSearchButton.vue
|- SearchInput.vue
|- TermsCheckbox.vue

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

components/
|- SearchButtonClear.vue
|- SearchButtonRun.vue
|- SearchInputQuery.vue
|- SearchInputExcludeGlob.vue
|- SettingsCheckboxTerms.vue
|- SettingsCheckboxLaunchOnStartup.vue

{% raw %}</div>{% endraw %}

自閉合組件 <sup data-p="b">強(qiáng)烈推薦

在單文件組件、字符串模板和 JSX 中沒(méi)有內(nèi)容的組件應(yīng)該是自閉合的——但在 DOM 模板里永遠(yuǎn)不要這樣做。

自閉合組件表示它們不僅沒(méi)有內(nèi)容，而且刻意沒(méi)有內(nèi)容。其不同之處就好像書上的一頁(yè)白紙對(duì)比貼有“本頁(yè)有意留白”標(biāo)簽的白紙。而且沒(méi)有了額外的閉合標(biāo)簽，你的代碼也更簡(jiǎn)潔。

不幸的是，HTML 并不支持自閉合的自定義元素——只有官方的“空”元素。所以上述策略僅適用于進(jìn)入 DOM 之前 Vue 的模板編譯器能夠觸達(dá)的地方，然后再產(chǎn)出符合 DOM 規(guī)范的 HTML。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

<!-- 在單文件組件、字符串模板和 JSX 中 -->
<MyComponent></MyComponent>

<!-- 在 DOM 模板中 -->
<my-component/>

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<!-- 在單文件組件、字符串模板和 JSX 中 -->
<MyComponent/>

<!-- 在 DOM 模板中 -->
<my-component></my-component>

{% raw %}</div>{% endraw %}

模板中的組件名大小寫 <sup data-p="b">強(qiáng)烈推薦

對(duì)于絕大多數(shù)項(xiàng)目來(lái)說(shuō)，在單文件組件和字符串模板中組件名應(yīng)該總是 PascalCase 的——但是在 DOM 模板中總是 kebab-case 的。

PascalCase 相比 kebab-case 有一些優(yōu)勢(shì)：

  • 編輯器可以在模板里自動(dòng)補(bǔ)全組件名，因?yàn)?PascalCase 同樣適用于 JavaScript。
  • <MyComponent> 視覺(jué)上比 <my-component> 更能夠和單個(gè)單詞的 HTML 元素區(qū)別開來(lái)，因?yàn)榍罢叩牟煌幱袃蓚€(gè)大寫字母，后者只有一個(gè)橫線。
  • 如果你在模板中使用任何非 Vue 的自定義元素，比如一個(gè) Web Component，PascalCase 確保了你的 Vue 組件在視覺(jué)上仍然是易識(shí)別的。

不幸的是，由于 HTML 是大小寫不敏感的，在 DOM 模板中必須仍使用 kebab-case。

還請(qǐng)注意，如果你已經(jīng)是 kebab-case 的重度用戶，那么與 HTML 保持一致的命名約定且在多個(gè)項(xiàng)目中保持相同的大小寫規(guī)則就可能比上述優(yōu)勢(shì)更為重要了。在這些情況下，在所有的地方都使用 kebab-case 同樣是可以接受的。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

<!-- 在單文件組件和字符串模板中 -->
<mycomponent/>

<!-- 在單文件組件和字符串模板中 -->
<myComponent/>

<!-- 在 DOM 模板中 -->
<MyComponent></MyComponent>

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<!-- 在單文件組件和字符串模板中 -->
<MyComponent/>

<!-- 在 DOM 模板中 -->
<my-component></my-component>

或者

<!-- 在所有地方 -->
<my-component></my-component>

{% raw %}</div>{% endraw %}

JS/JSX 中的組件名大小寫 <sup data-p="b">強(qiáng)烈推薦

JS/JSX 中的組件名應(yīng)該始終是 PascalCase 的，盡管在較為簡(jiǎn)單的應(yīng)用中只使用 Vue.component 進(jìn)行全局組件注冊(cè)時(shí)，可以使用 kebab-case 字符串。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

在 JavaScript 中，PascalCase 是類和構(gòu)造函數(shù) (本質(zhì)上任何可以產(chǎn)生多份不同實(shí)例的東西) 的命名約定。Vue 組件也有多份實(shí)例，所以同樣使用 PascalCase 是有意義的。額外的好處是，在 JSX (和模板) 里使用 PascalCase 使得代碼的讀者更容易分辨 Vue 組件和 HTML 元素。

然而，對(duì)于只通過(guò) Vue.component 定義全局組件的應(yīng)用來(lái)說(shuō)，我們推薦 kebab-case 作為替代。原因是：

  • 全局組件很少被 JavaScript 引用，所以遵守 JavaScript 的命名約定意義不大。
  • 這些應(yīng)用往往包含許多 DOM 內(nèi)的模板，這種情況下是必須使用 kebab-case 的。
    {% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

Vue.component('myComponent', {
  // ...
})

import myComponent from './MyComponent.vue'

export default {
  name: 'myComponent',
  // ...
}

export default {
  name: 'my-component',
  // ...
}

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

Vue.component('MyComponent', {
  // ...
})

Vue.component('my-component', {
  // ...
})

import MyComponent from './MyComponent.vue'

export default {
  name: 'MyComponent',
  // ...
}

{% raw %}</div>{% endraw %}

完整單詞的組件名 <sup data-p="b">強(qiáng)烈推薦

組件名應(yīng)該傾向于完整單詞而不是縮寫。

編輯器中的自動(dòng)補(bǔ)全已經(jīng)讓書寫長(zhǎng)命名的代價(jià)非常之低了，而其帶來(lái)的明確性卻是非常寶貴的。不常用的縮寫尤其應(yīng)該避免。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

components/
|- SdSettings.vue
|- UProfOpts.vue

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

components/
|- StudentDashboardSettings.vue
|- UserProfileOptions.vue

{% raw %}</div>{% endraw %}

Prop 名大小寫 <sup data-p="b">強(qiáng)烈推薦

在聲明 prop 的時(shí)候，其命名應(yīng)該始終使用 camelCase，而在模板和 JSX 中應(yīng)該始終使用 kebab-case。

我們單純的遵循每個(gè)語(yǔ)言的約定。在 JavaScript 中更自然的是 camelCase。而在 HTML 中則是 kebab-case。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

props: {
  'greeting-text': String
}

<WelcomeMessage greetingText="hi"/>

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

props: {
  greetingText: String
}

<WelcomeMessage greeting-text="hi"/>

{% raw %}</div>{% endraw %}

多個(gè)特性的元素 <sup data-p="b">強(qiáng)烈推薦

多個(gè)特性的元素應(yīng)該分多行撰寫，每個(gè)特性一行。

在 JavaScript 中，用多行分隔對(duì)象的多個(gè)屬性是很常見的最佳實(shí)踐，因?yàn)檫@樣更易讀。模板和 JSX 值得我們做相同的考慮。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

<img src="https://vuejs.org/images/logo.png" alt="Vue Logo">

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

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<img
  src="https://vuejs.org/images/logo.png"
  alt="Vue Logo"
>

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

{% raw %}</div>{% endraw %}

模板中簡(jiǎn)單的表達(dá)式 <sup data-p="b">強(qiáng)烈推薦

組件模板應(yīng)該只包含簡(jiǎn)單的表達(dá)式，復(fù)雜的表達(dá)式則應(yīng)該重構(gòu)為計(jì)算屬性或方法。

復(fù)雜表達(dá)式會(huì)讓你的模板變得不那么聲明式。我們應(yīng)該盡量描述應(yīng)該出現(xiàn)的是什么，而非如何計(jì)算那個(gè)值。而且計(jì)算屬性和方法使得代碼可以重用。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

{{
  fullName.split(' ').map(function (word) {
    return word[0].toUpperCase() + word.slice(1)
  }).join(' ')
}}

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<!-- 在模板中 -->
{{ normalizedFullName }}

// 復(fù)雜表達(dá)式已經(jīng)移入一個(gè)計(jì)算屬性
computed: {
  normalizedFullName: function () {
    return this.fullName.split(' ').map(function (word) {
      return word[0].toUpperCase() + word.slice(1)
    }).join(' ')
  }
}

{% raw %}</div>{% endraw %}

簡(jiǎn)單的計(jì)算屬性 <sup data-p="b">強(qiáng)烈推薦

應(yīng)該把復(fù)雜計(jì)算屬性分割為盡可能多的更簡(jiǎn)單的屬性。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

更簡(jiǎn)單、命名得當(dāng)?shù)挠?jì)算屬性是這樣的：

  • 易于測(cè)試

    當(dāng)每個(gè)計(jì)算屬性都包含一個(gè)非常簡(jiǎn)單且很少依賴的表達(dá)式時(shí)，撰寫測(cè)試以確保其正確工作就會(huì)更加容易。

  • 易于閱讀

    簡(jiǎn)化計(jì)算屬性要求你為每一個(gè)值都起一個(gè)描述性的名稱，即便它不可復(fù)用。這使得其他開發(fā)者 (以及未來(lái)的你) 更容易專注在他們關(guān)心的代碼上并搞清楚發(fā)生了什么。

  • 更好的“擁抱變化”

    任何能夠命名的值都可能用在視圖上。舉個(gè)例子，我們可能打算展示一個(gè)信息，告訴用戶他們存了多少錢；也可能打算計(jì)算稅費(fèi)，但是可能會(huì)分開展現(xiàn)，而不是作為總價(jià)的一部分。

    小的、專注的計(jì)算屬性減少了信息使用時(shí)的假設(shè)性限制，所以需求變更時(shí)也用不著那么多重構(gòu)了。

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

computed: {
  price: function () {
    var basePrice = this.manufactureCost / (1 - this.profitMargin)
    return (
      basePrice -
      basePrice * (this.discountPercent || 0)
    )
  }
}

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

computed: {
  basePrice: function () {
    return this.manufactureCost / (1 - this.profitMargin)
  },
  discount: function () {
    return this.basePrice * (this.discountPercent || 0)
  },
  finalPrice: function () {
    return this.basePrice - this.discount
  }
}

{% raw %}</div>{% endraw %}

帶引號(hào)的特性值 <sup data-p="b">強(qiáng)烈推薦

非空 HTML 特性值應(yīng)該始終帶引號(hào) (單引號(hào)或雙引號(hào)，選你 JS 里不用的那個(gè))。

在 HTML 中不帶空格的特性值是可以沒(méi)有引號(hào)的，但這樣做常常導(dǎo)致帶空格的特征值被回避，導(dǎo)致其可讀性變差。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

<input type=text>

<AppSidebar :style={width:sidebarWidth+'px'}>

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<input type="text">

<AppSidebar :style="{ width: sidebarWidth + 'px' }">

{% raw %}</div>{% endraw %}

指令縮寫 <sup data-p="b">強(qiáng)烈推薦

指令縮寫 (用 : 表示 v-bind: 和用 @ 表示 v-on:) 應(yīng)該要么都用要么都不用。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

<input
  v-bind:value="newTodoText"
  :placeholder="newTodoInstructions"
>

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

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<input
  :value="newTodoText"
  :placeholder="newTodoInstructions"
>

<input
  v-bind:value="newTodoText"
  v-bind:placeholder="newTodoInstructions"
>

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

<input
  v-on:input="onInput"
  v-on:focus="onFocus"
>

{% raw %}</div>{% endraw %}

優(yōu)先級(jí) C 的規(guī)則：推薦 (將選擇和認(rèn)知成本最小化)

組件/實(shí)例的選項(xiàng)的順序 <sup data-p="c">推薦

組件/實(shí)例的選項(xiàng)應(yīng)該有統(tǒng)一的順序。

這是我們推薦的組件選項(xiàng)默認(rèn)順序。它們被劃分為幾大類，所以你也能知道從插件里添加的新屬性應(yīng)該放到哪里。

  1. 副作用 (觸發(fā)組件外的影響)
  • el
  1. 全局感知 (要求組件以外的知識(shí))
  • name
  • parent
  1. 組件類型 (更改組件的類型)
  • functional
  1. 模板修改器 (改變模板的編譯方式)
  • delimiters
  • comments
  1. 模板依賴 (模板內(nèi)使用的資源)
  • components
  • directives
  • filters
  1. 組合 (向選項(xiàng)里合并屬性)
  • extends
  • mixins
  1. 接口 (組件的接口)
  • inheritAttrs
  • model
  • props/propsData
  1. 本地狀態(tài) (本地的響應(yīng)式屬性)
  • data
  • computed
  1. 事件 (通過(guò)響應(yīng)式事件觸發(fā)的回調(diào))
  • watch
  • 生命周期鉤子 (按照它們被調(diào)用的順序)
  1. 非響應(yīng)式的屬性 (不依賴響應(yīng)系統(tǒng)的實(shí)例屬性)
  • methods
  1. 渲染 (組件輸出的聲明式描述)
  • template/render
  • renderError

元素特性的順序 <sup data-p="c">推薦

元素 (包括組件) 的特性應(yīng)該有統(tǒng)一的順序。

這是我們?yōu)榻M件選項(xiàng)推薦的默認(rèn)順序。它們被劃分為幾大類，所以你也能知道新添加的自定義特性和指令應(yīng)該放到哪里。

  1. 定義 (提供組件的選項(xiàng))
  • is
  1. 列表渲染 (創(chuàng)建多個(gè)變化的相同元素)
  • v-for
  1. 條件渲染 (元素是否渲染/顯示)
  • v-if
  • v-else-if
  • v-else
  • v-show
  • v-cloak
  1. 渲染方式 (改變?cè)氐匿秩痉绞?
  • v-pre
  • v-once
  1. 全局感知 (需要超越組件的知識(shí))
  • id
  1. 唯一的特性 (需要唯一值的特性)
  • ref
  • key
  • slot
  1. 雙向綁定 (把綁定和事件結(jié)合起來(lái))
  • v-model

  1. 其它特性 (所有普通的綁定或未綁定的特性)

  2. 事件 (組件事件監(jiān)聽器)

  • v-on
  1. 內(nèi)容 (覆寫元素的內(nèi)容)
  • v-html
  • v-text

組件/實(shí)例選項(xiàng)中的空行 <sup data-p="c">推薦

你可能想在多個(gè)屬性之間增加一個(gè)空行，特別是在這些選項(xiàng)一屏放不下，需要滾動(dòng)才能都看到的時(shí)候。

當(dāng)你的組件開始覺(jué)得密集或難以閱讀時(shí)，在多個(gè)屬性之間添加空行可以讓其變得容易。在一些諸如 Vim 的編輯器里，這樣格式化后的選項(xiàng)還能通過(guò)鍵盤被快速導(dǎo)航。

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

props: {
  value: {
    type: String,
    required: true
  },

  focused: {
    type: Boolean,
    default: false
  },

  label: String,
  icon: String
},

computed: {
  formattedValue: function () {
    // ...
  },

  inputClasses: function () {
    // ...
  }
}

// 沒(méi)有空行在組件易于閱讀和導(dǎo)航時(shí)也沒(méi)問(wèn)題。
props: {
  value: {
    type: String,
    required: true
  },
  focused: {
    type: Boolean,
    default: false
  },
  label: String,
  icon: String
},
computed: {
  formattedValue: function () {
    // ...
  },
  inputClasses: function () {
    // ...
  }
}

{% raw %}</div>{% endraw %}

單文件組件的頂級(jí)元素的順序 <sup data-p="c">推薦

單文件組件應(yīng)該總是讓 <script>、<template> 和 <style> 標(biāo)簽的順序保持一致。且 <style> 要放在最后，因?yàn)榱硗鈨蓚€(gè)標(biāo)簽至少要有一個(gè)。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

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

<!-- ComponentA.vue -->
<script>/* ... */</script>
<template>...</template>
<style>/* ... */</style>

<!-- ComponentB.vue -->
<template>...</template>
<script>/* ... */</script>
<style>/* ... */</style>

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<!-- ComponentA.vue -->
<script>/* ... */</script>
<template>...</template>
<style>/* ... */</style>

<!-- ComponentB.vue -->
<script>/* ... */</script>
<template>...</template>
<style>/* ... */</style>

<!-- ComponentA.vue -->
<template>...</template>
<script>/* ... */</script>
<style>/* ... */</style>

<!-- ComponentB.vue -->
<template>...</template>
<script>/* ... */</script>
<style>/* ... */</style>

{% raw %}</div>{% endraw %}

優(yōu)先級(jí) D 的規(guī)則：謹(jǐn)慎使用 (有潛在危險(xiǎn)的模式)

沒(méi)有在 v-if/v-if-else/v-else 中使用 key <sup data-p="d">謹(jǐn)慎使用

如果一組 v-if + v-else 的元素類型相同，最好使用 key (比如兩個(gè) <div> 元素)。

默認(rèn)情況下，Vue 會(huì)盡可能高效的更新 DOM。這意味著其在相同類型的元素之間切換時(shí)，會(huì)修補(bǔ)已存在的元素，而不是將舊的元素移除然后在同一位置添加一個(gè)新元素。如果本不相同的元素被識(shí)別為相同，則會(huì)出現(xiàn)意料之外的副作用。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

<div v-if="error">
  錯(cuò)誤：{{ error }}
</div>
<div v-else>
  {{ results }}
</div>

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<div
  v-if="error"
  key="search-status"
>
  錯(cuò)誤：{{ error }}
</div>
<div
  v-else
  key="search-results"
>
  {{ results }}
</div>

<p v-if="error">
  錯(cuò)誤：{{ error }}
</p>
<div v-else>
  {{ results }}
</div>

{% raw %}</div>{% endraw %}

scoped 中的元素選擇器 <sup data-p="d">謹(jǐn)慎使用

元素選擇器應(yīng)該避免在 scoped 中出現(xiàn)。

在 scoped 樣式中，類選擇器比元素選擇器更好，因?yàn)榇罅渴褂迷剡x擇器是很慢的。

{% raw %}
<details>
<summary>
<h4>詳解</h4>
</summary>
{% endraw %}

為了給樣式設(shè)置作用域，Vue 會(huì)為元素添加一個(gè)獨(dú)一無(wú)二的特性，例如 data-v-f3f3eg9。然后修改選擇器，使得在匹配選擇器的元素中，只有帶這個(gè)特性才會(huì)真正生效 (比如 button[data-v-f3f3eg9])。

問(wèn)題在于大量的元素和特性組合的選擇器 (比如 button[data-v-f3f3eg9]) 會(huì)比類和特性組合的選擇器 慢，所以應(yīng)該盡可能選用類選擇器。

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

<template>
  <button>X</button>
</template>

<style scoped>
button {
  background-color: red;
}
</style>

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

<template>
  <button class="btn btn-close">X</button>
</template>

<style scoped>
.btn-close {
  background-color: red;
}
</style>

{% raw %}</div>{% endraw %}

隱性的父子組件通信 <sup data-p="d">謹(jǐn)慎使用

應(yīng)該優(yōu)先通過(guò) prop 和事件進(jìn)行父子組件之間的通信，而不是 this.$parent 或改變 prop。

一個(gè)理想的 Vue 應(yīng)用是 prop 向下傳遞，事件向上傳遞的。遵循這一約定會(huì)讓你的組件更易于理解。然而，在一些邊界情況下 prop 的變更或 this.$parent 能夠簡(jiǎn)化兩個(gè)深度耦合的組件。

問(wèn)題在于，這種做法在很多簡(jiǎn)單的場(chǎng)景下可能會(huì)更方便。但請(qǐng)當(dāng)心，不要為了一時(shí)方便 (少寫代碼) 而犧牲數(shù)據(jù)流向的簡(jiǎn)潔性 (易于理解)。

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

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>
  `
})

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

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>
  `
})

{% raw %}</div>{% endraw %}

非 Flux 的全局狀態(tài)管理 <sup data-p="d">謹(jǐn)慎使用

應(yīng)該優(yōu)先通過(guò) Vuex 管理全局狀態(tài)，而不是通過(guò) this.$root 或一個(gè)全局事件總線。

通過(guò) this.$root 和/或全局事件總線管理狀態(tài)在很多簡(jiǎn)單的情況下都是很方便的，但是并不適用于絕大多數(shù)的應(yīng)用。Vuex 提供的不僅是一個(gè)管理狀態(tài)的中心區(qū)域，還是組織、追蹤和調(diào)試狀態(tài)變更的好工具。

{% raw %}</details>{% endraw %}

{% raw %}<div class="style-example example-bad">{% endraw %}

反例

// main.js
new Vue({
  data: {
    todos: []
  },
  created: function () {
    this.$on('remove-todo', this.removeTodo)
  },
  methods: {
    removeTodo: function (todo) {
      var todoIdToRemove = todo.id
      this.todos = this.todos.filter(function (todo) {
        return todo.id !== todoIdToRemove
      })
    }
  }
})

{% raw %}</div>{% endraw %}

{% raw %}<div class="style-example example-good">{% endraw %}

好例子

// store/modules/todos.js
export default {
  state: {
    list: []
  },
  mutations: {
    REMOVE_TODO (state, todoId) {
      state.list = state.list.filter(todo => todo.id !== todoId)
    }
  },
  actions: {
    removeTodo ({ commit, state }, todo) {
      commit('REMOVE_TODO', todo.id)
    }
  }
}

<!-- TodoItem.vue -->
<template>
  <span>
    {{ todo.text }}
    <button @click="removeTodo(todo)">
      X
    </button>
  </span>
</template>

<script>
import { mapActions } from 'vuex'

export default {
  props: {
    todo: {
      type: Object,
      required: true
    }
  },
  methods: mapActions(['removeTodo'])
}
</script>

{% raw %}</div>{% endraw %}

{% raw %}
<script>
(function () {
var enforcementTypes = {
none: '<span title="這一規(guī)則無(wú)法強(qiáng)制執(zhí)行">自律</span>',
runtime: '運(yùn)行時(shí)錯(cuò)誤',
linter: '<a target="_blank">plugin:vue/recommended</a>'
}
Vue.component('sg-enforcement', {
template: '
<span>
<strong>強(qiáng)制執(zhí)行</strong>:
<span class="style-rule-tag" v-html="humanType"/>
</span>
',
props: {
type: {
type: String,
required: true,
validate: function (value) {
Object.keys(enforcementTypes).indexOf(value) !== -1
}
}
},
computed: {
humanType: function () {
return enforcementTypes[this.type]
}
}
})

// new Vue({
// el: '#main'
// })
})()
</script>
{% endraw %}

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Vue 官方在最近發(fā)布了代碼風(fēng)格指南的BETA版本，旨在引導(dǎo)開發(fā)者以正確的方式來(lái)書寫代碼，避免因?yàn)椴灰?guī)范而導(dǎo)致的問(wèn)...
    白色鵜鶘鳥閱讀 1,057評(píng)論 0贊 4
  • 這篇筆記主要包含 Vue 2 不同于 Vue 1 或者特有的內(nèi)容，還有我對(duì)于 Vue 1.0 印象不深的內(nèi)容。關(guān)于...
    云之外閱讀 5,168評(píng)論 0贊 29
  • a.優(yōu)先級(jí)A -- 私有屬性名 在插件、混入等擴(kuò)展中始終為自定義的私有屬性使用 $_ 前綴。并附帶一個(gè)命名空間以回...
    Ivy_study閱讀 421評(píng)論 0贊 0
  • 組件名為多個(gè)單詞必要組件名應(yīng)該始終是多個(gè)單詞的，根組件 App 除外。 組件數(shù)據(jù)必要組件的 data必須是一個(gè)函數(shù)...
    梁小七閱讀 281評(píng)論 0贊 0
  • 幾個(gè)小時(shí)前，還是風(fēng)（diao）流（si）倜（nan）儻（shi）的關(guān)先生，還對(duì)我侃侃而談，在夜市告訴我這個(gè)可以吃，...
    有你的夢(mèng)就像夏天的風(fēng)閱讀 799評(píng)論 0贊 1

友情鏈接更多精彩內(nèi)容