Vue前端開發有哪些規範

這次帶給大家Vue前端開發有哪些規範，Vue前端開發規範的注意事項有哪些，下面就是實戰案例，一起來看一下。

基於Vue官方風格指南整理

一、強制

1. 元件名為多個單字

元件名稱應該永遠是多個單字的，根元件App 除外。

正例：

export default {
 name: 'TodoItem',
 // ...
}
反例：
export default {
 name: 'Todo',
 // ...
}

2. 元件資料

元件的 data 必須是一個函數。

當在元件中使用 data 屬性的時候 (除了 new Vue 外的任何地方)，它的值必須是傳回一個物件的函數。

正例：

// In a .vue file
export default {
 data () {
 return {
 foo: 'bar'
 }
 }
}
// 在一个 Vue 的根实例上直接使用对象是可以的，
// 因为只存在一个这样的实例。
new Vue({
 data: {
 foo: 'bar'
 }
})

反例：

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

3. Prop定義

#Prop 定義應該盡量詳細。

在你提交的程式碼中，prop 的定義應該盡量詳細，至少需要指定其類型。

正例：

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

反例：

// 这样做只有开发原型系统时可以接受
props: ['status']

4. 為v-for設定鍵值

總是用 key 配合 v-for。

在元件上_總是_必須用 key 配合 v-for，以便維護內部元件及其子樹的狀態。甚至在元素上維護可預測的行為，例如動畫中的物件固化 (object constancy)，也是一種好的做法。

正例：

 
•  {{ todo.text }}  

反例：

 
•  {{ todo.text }}  

5.避免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)。

正例：

 
•  {{ user.name }}  

反例：

 
•  {{ user.name }}  

6. 為元件樣式設定作用域

對於應用程式來說，頂層App 元件和佈局元件中的樣式可以是全域的，但是其它所有元件都應該是有作用域的。

這條規則只和單一檔案元件有關。你不一定要使用 scoped 特性。設定作用域也可以透過 CSS Modules，那是一個基於 class 的類似 BEM 的策略，當然你也可以使用其它的函式庫或約定。

不管怎樣，對於元件庫，我們應該更傾向於選用基於 class 的策略而不是 scoped 特性。 

這讓覆寫內部樣式更容易：使用了常人可理解的 class 名稱且沒有太高的選擇器優先級，而且不太會導致衝突。

正例：

<template>
 <button>X</button>
</template>
<!-- 使用 BEM 约定 -->
<style>
.c-Button {
 border: none;
 border-radius: 2px;
}
.c-Button--close {
 background-color: red;
}
</style>

反例：

<template>
 <button>X</button>
</template>
<style>
.btn-close {
 background-color: red;
}
</style>
<template>
 <button>X</button>
</template>
<!-- 使用 `scoped` 特性 -->
<style>
.button {
 border: none;
 border-radius: 2px;
}
.button-close {
 background-color: red;
}
</style>

#二、強烈推薦（增強可讀性）

##1. 元件檔案

只要有能夠拼接檔案的建置系統，就把每個元件單獨分成檔案。

當你需要編輯一個元件或查閱一個元件的用法時，可以更快速的找到它。

正例：

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

反例：

V
ue.component('TodoList', {
 // ...
})
Vue.component('TodoItem', {
 // ...
})

2. 單一檔案元件檔案的大小寫

單一檔案元件的檔案名稱應該永遠是單字大寫開頭(PascalCase)

正例：

components/
|- MyComponent.vue

反例：

components/
|- myComponent.vue
|- mycomponent.vue

3. 基礎元件名稱

套用特定樣式和約定的基礎元件(也就是展示類別的、無邏輯的或無狀態的元件) 應該全部以一個特定的前綴開頭，例如Base、App 或V。

正例：

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

反例：

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

4. 單例元件名稱

只應該擁有單一活躍實例的元件應該以The 前綴命名，以示其唯一性。

这不意味着组件只可用于一个单页面，而是每个页面只使用一次。这些组件永远不接受任何 prop，因为它们是为你的应用定制的，而不是它们在你的应用中的上下文。如果你发现有必要添加 prop，那就表明这实际上是一个可复用的组件，只是目前在每个页面里只使用一次。

正例：

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

反例：

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

5. 紧密耦合的组件名

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

如果一个组件只在某个父组件的场景下有意义，这层关系应该体现在其名字上。因为编辑器通常会按字母顺序组织文件，所以这样做可以把相关联的文件排在一起。

正例：

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

反例：

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

6. 组件名中的单词顺序

组件名应该以高级别的 (通常是一般化描述的) 单词开头，以描述性的修饰词结尾。

正例：

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. 模板中的组件名大小写

总是 PascalCase 的

正例：

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

反例：

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

8. 完整单词的组件名

组件名应该倾向于完整单词而不是缩写。

正例：

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

反例：

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

9. 多个特性的元素

多个特性的元素应该分多行撰写，每个特性一行。

正例：

<img  src="/static/imghwm/default1.png" data-src="https://vuejs.org/images/logo.png" class="lazy" alt="Vue前端開發有哪些規範" >
<mycomponent></mycomponent>

反例：

<img  src="/static/imghwm/default1.png" data-src="https://vuejs.org/images/logo.png" class="lazy" alt="Vue前端開發有哪些規範" >
<mycomponent></mycomponent>

10. 模板中简单的表达式

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

正例：

<!-- 在模板中 -->
{{ normalizedFullName }}
// 复杂表达式已经移入一个计算属性
computed: {
 normalizedFullName: function () {
 return this.fullName.split(' ').map(function (word) {
 return word[0].toUpperCase() + word.slice(1)
 }).join(' ')
 }
}

反例：

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

11. 简单的计算属性

正例：

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

反例：

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

12. 带引号的特性值

非空 HTML 特性值应该始终带引号 (单引号或双引号，选你 JS 里不用的那个)。
在 HTML 中不带空格的特性值是可以没有引号的，但这样做常常导致带空格的特征值被回避，导致其可读性变差。

正例：

<appsidebar></appsidebar>

反例：

<appsidebar></appsidebar>

13. 指令缩写

都用指令缩写 (用 : 表示 v-bind: 和用 @ 表示 v-on:)

正例：

<input>

反例：

<input>

三、推荐

1. 单文件组件的顶级元素的顺序

单文件组件应该总是让<script>、<template> 和 <style> 标签的顺序保持一致。且 <style> 要放在最后，因为另外两个标签至少要有一个。</script>

正例：

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

四、谨慎使用 (有潜在危险的模式)

1. 没有在 v-if/v-if-else/v-else 中使用 key

如果一组 v-if + v-else 的元素类型相同，最好使用 key (比如两个

元素)。

正例：

<p>
 错误：{{ error }}
</p>
<p>
 {{ results }}
</p>
反例：
<p>
 错误：{{ error }}
</p>
<p>
 {{ results }}
</p>

2. scoped 中的元素选择器

元素选择器应该避免在 scoped 中出现。

在 scoped 样式中，类选择器比元素选择器更好，因为大量使用元素选择器是很慢的。

正例：

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

反例：

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

3. 隐性的父子组件通信

应该优先通过 prop 和事件进行父子组件之间的通信，而不是 this.$parent 或改变 prop。

正例：

Vue.component('TodoItem', {
 props: {
 todo: {
 type: Object,
 required: true
 }
 },
 template: `
 <input>
 `
})

反例：

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>
 X
 </button>
 </span>
 `
})

4. 非 Flux 的全局状态管理

应该优先通过 Vuex 管理全局状态，而不是通过 this.$root 或一个全局事件总线。

正例：

// 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>
 X
 </button>
 </span>
</template>
<script>
import { mapActions } from &#39;vuex&#39;
export default {
 props: {
 todo: {
 type: Object,
 required: true
 }
 },
 methods: mapActions([&#39;removeTodo&#39;])
}
</script>

反例：

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

附录

1. 推荐使用vs code进行前端编码，规定Tab大小为2个空格

vs code配置

{
 "editor.tabSize": 2,
 "workbench.startupEditor": "newUntitledFile",
 "workbench.iconTheme": "vscode-icons",
 // 以下为stylus配置
 "stylusSupremacy.insertColons": false, // 是否插入冒号
 "stylusSupremacy.insertSemicolons": false, // 是否插入分好
 "stylusSupremacy.insertBraces": false, // 是否插入大括号
 "stylusSupremacy.insertNewLineAroundImports": false, // import之后是否换行
 "stylusSupremacy.insertNewLineAroundBlocks": false, // 两个选择器中是否换行
 "vetur.format.defaultFormatter.html": "js-beautify-html",
 "eslint.autoFixOnSave": true,
 "eslint.validate": [
 "javascript",
 {
 "language": "html",
 "autoFix": true
 },
 {
 "language": "vue",
 "autoFix": true
 },
 "javascriptreact",
 "html",
 "vue"
 ],
 "eslint.options": { "plugins": ["html"] },
 "prettier.singleQuote": true,
 "prettier.semi": false,
 "javascript.format.insertSpaceBeforeFunctionParenthesis": false,
 "vetur.format.js.InsertSpaceBeforeFunctionParenthesis": false,
 "vetur.format.defaultFormatter.js": "prettier",
 // "prettier.eslintIntegration": true
}

相信看了本文案例你已经掌握了方法，更多精彩请关注php中文网其它相关文章！

推荐阅读：

如何使用react配合antd组件实现管理系统

Vue怎样实现beforeEnter钩子函数

以上是Vue前端開發有哪些規範的詳細內容。更多資訊請關注PHP中文網其他相關文章！