下面是我在開發(fā)大型 Vue 項目時的最佳實踐。這些技巧將幫助你開發(fā)更高效、更易于維護(hù)和共享的代碼。

今年做自由職業(yè)的時候，我有機(jī)會開發(fā)了一些大型 Vue 應(yīng)用程序。我所說的這些項目，Vuex store 超過十個，包含大量的組件（有時候幾百個）和視圖頁面。對我來說這是個很有益的經(jīng)驗，因為我發(fā)現(xiàn)了很多有意思的模式，可以讓代碼擁有更好的伸縮性。我還必須修正一些導(dǎo)致著名的意大利面條式代碼困境的錯誤實踐。

因此，今天我將與你分享10個最佳實踐，如果你正在處理大型代碼庫，我建議你參考這些方法。

1. 使用 slot, 讓組件更強(qiáng)大，也更容易理解

最近我寫了篇關(guān)于 Vue.js slot 的文章，它強(qiáng)調(diào)了 slot 如何使組件更易于重用和維護(hù)，以及為什么應(yīng)該使用它們。

但是這與 Vue.js 大型項目有什么關(guān)系呢？一張圖片通常勝過千言萬語，所以我要給你描繪一幅關(guān)于我第一次后悔沒有使用它們的畫面。

有一天，我要創(chuàng)建一個 popup。乍一看并沒有什么復(fù)雜的東西，只是包含了一個標(biāo)題，一個描述和一些按鈕。所以我所做的就是把一切配置一股腦當(dāng)做 props 傳進(jìn)去。最終我定義了三個 prop，用于自定義組件，當(dāng)用戶單擊按鈕時將發(fā)送一個事件。So easy !

但是，隨著項目的發(fā)展，團(tuán)隊要求我們在其中展示更多其他的新內(nèi)容：表單字段、不同的按鈕(取決于它顯示在哪個頁面上)、卡片、頁腳，以及列表。我以為，如果繼續(xù)使用 prop 來迭代這個組件也沒啥問題。但是我滴個神哪，我是大錯特錯！組件很快變得非常復(fù)雜，難以理解，因為它包含了無數(shù)的子組件，用了太多的 prop，并發(fā)送了一堆的事件。我開始體驗到了可怕的情況，當(dāng)你做出一點改動，其他頁面的某個地方就會崩潰！我仿佛造了一個 Frankenstein 怪人，而不是一個可維護(hù)的組件!🤖

然而，如果我從一開始就依賴 slot，情況可能會好多了。最后我重構(gòu)了所有東西，得到了這個小組件：更容易維護(hù)，理解起來更快，更好擴(kuò)展！

<template>
 <div class="c-base-popup">
 <div v-if="$slot.header" class="c-base-popup__header">
 <slot name="header">
 </div>
 <div v-if="$slot.subheader" class="c-base-popup__subheader">
 <slot name="subheader">
 </div>
 <div class="c-base-popup__body">
 <h1>{{ title }}</h1>
 <p v-if="description">{{ description }}</p>
 </div>
 <div v-if="$slot.actions" class="c-base-popup__actions">
 <slot name="actions">
 </div>
 <div v-if="$slot.footer" class="c-base-popup__footer">
 <slot name="footer">
 </div>
 </div>
</template>

<script>
export default {
 props: {
 description: {
 type: String,
 default: null
 },
 title: {
 type: String,
 required: true
 }
 }
}
</script>

我的觀點是，從經(jīng)驗來看，那些知道何時使用 slot 的開發(fā)人員所構(gòu)建的項目確實會對其未來的可維護(hù)性產(chǎn)生很大的影響。由于發(fā)送的事件更少，代碼更容易理解，而且提供了更大的靈活性，可以在其中顯示任何組件。

敲黑板：根據(jù)經(jīng)驗，當(dāng)你開始在父組件中復(fù)制子組件的 prop 時，你就應(yīng)該考慮使用 slot 了。

2. 合理組織 Vuex Store

通常，Vue.js 新手開始了解Vuex，因為他們剛好碰到了這兩個問題：

• 組件樹結(jié)構(gòu)中相隔太遠(yuǎn)的組件之間訪問數(shù)據(jù)
• 組件銷毀后需要持久化數(shù)據(jù)

這個時候他們就會創(chuàng)建第一個 Vuex store，學(xué)習(xí)模塊并開始在應(yīng)用程序中組織它們。
問題在于，創(chuàng)建模塊時沒有單一的模式可以遵循。然而，我強(qiáng)烈建議你仔細(xì)考慮如何組織它們。據(jù)我所見，大多數(shù)開發(fā)人員更喜歡根據(jù)功能來組織它們。例如:

• Auth.
• Blog.
• Inbox.
• Settings.

就我來說，我發(fā)現(xiàn)根據(jù)從 API 獲取的數(shù)據(jù)模型來組織它們更容易理解。例如:

• Users
• Teams
• Messages
• Widgets
• Articles

如何選擇取決于你自己。唯一需要記住的是，從長遠(yuǎn)來看，一個組織良好的 Vuex store 會造就一個更高效的團(tuán)隊。它還將使新人在加入團(tuán)隊時更容易將他們的想法圍繞在你的代碼基礎(chǔ)上。

3. 使用 action 發(fā)起 API 調(diào)用和提交數(shù)據(jù)

我的大部分 API 調(diào)用（如果不是全部）是在Vuex action 里面完成的。你可能會問：為什么要這么做？ 🤨

♀️ 簡單來說，它們中的大多數(shù)獲取的數(shù)據(jù)需要提交到 store里去。另外，它們還提供了一層封裝和可重用性，我很喜歡用。還有一些原因如下：

• 如果我需要在兩個地方（假設(shè)是博客頁面和首頁）獲取文章的第一頁，我只需要用正確的參數(shù)調(diào)用合適的 dispatcher 就行了。除了 dispatcher 調(diào)用，無需重復(fù)代碼就可以完成數(shù)據(jù)的獲取，commit 到 store 和返回。
• 如果我需要寫一些避免重復(fù)獲取第一頁的邏輯，我就可以在一個地方完成。這樣做除了會減輕服務(wù)器負(fù)載，還會增強(qiáng)我對代碼的信心。
• 我可以跟蹤這些操作中的大多數(shù) Mixpanel（一個網(wǎng)站用戶行為分析工具） 事件，這使得分析代碼非常容易維護(hù)。我確實有一些應(yīng)用程序，其中所有的 Mixpanel 調(diào)用都是只在 action 中完成的。我不需要了解哪些數(shù)據(jù)被跟蹤，哪些沒有，以及什么時候發(fā)送這些信息。以這種工作方式的樂趣簡直無法言說。

4. 用 mapState，mapGetters，mapMutations 和 mapActions 簡化代碼

通常不需要創(chuàng)建多個計算屬性或方法，只需在組件內(nèi)部訪問 state/getters 或者調(diào)用 actions/mutations 。使用mapState，mapGetters，mapMutations 和 mapActions 
可以幫助你簡化代碼，把來自 store 模塊的數(shù)據(jù)分組到一起，讓代碼更容易理解。

// NPM
import { mapState, mapGetters, mapActions, mapMutations } from "vuex";

export default {
 computed: {
 // Accessing root properties
 ...mapState("my_module", ["property"]),
 // Accessing getters
 ...mapGetters("my_module", ["property"]),
 // Accessing non-root properties
 ...mapState("my_module", {
 property: state => state.object.nested.property
 })
 },

 methods: {
 // Accessing actions
 ...mapActions("my_module", ["myAction"]),
 // Accessing mutations
 ...mapMutations("my_module", ["myMutation"])
 }
};

有關(guān)以上工具方法的所有信息都在  Vuex 官方文檔。

5. 使用 API 工廠

我通常喜歡寫一個this.$api 助手，以便在任何地方調(diào)用，獲取后臺 API 資源。在我的項目根目錄有一個api 文件夾，包含了所有相關(guān)的類。如下所示（僅部分）：

api
├── auth.js
├── notifications.js
└── teams.js

每個文件都將其類別下的所有 API 資源分組。下面是我在 Nuxt 應(yīng)用中使用插件初始化這個模式的方法（在標(biāo)準(zhǔn)的 Vue 應(yīng)用中的過程也類似）。

// PROJECT: API
import Auth from "@/api/auth";
import Teams from "@/api/teams";
import Notifications from "@/api/notifications";

export default (context, inject) => {
 if (process.client) {
 const token = localStorage.getItem("token");
 // Set token when defined
 if (token) {
 context.$axios.setToken(token, "Bearer");
 }
 }
 // Initialize API repositories
 const repositories = {
 auth: Auth(context.$axios),
 teams: Teams(context.$axios),
 notifications: Notifications(context.$axios)
 };
 inject("api", repositories);
};

export default $axios => ({
 forgotPassword(email) {
 return $axios.$post("/auth/password/forgot", { email });
 },

 login(email, password) {
 return $axios.$post("/auth/login", { email, password });
 },

 logout() {
 return $axios.$get("/auth/logout");
 },

 register(payload) {
 return $axios.$post("/auth/register", payload);
 }
});

現(xiàn)在，我可以簡單地在我的組件或 Vuex action 里像這樣調(diào)用它們：

export default {
 methods: {
 onSubmit() {
 try {
 this.$api.auth.login(this.email, this.password);
 } catch (error) {
 console.error(error);
 }
 }
 }
};

6. 使用 $config 訪問環(huán)境變量（在模板里特別有用）

你的項目可能在一些文件中定義了一些全局配置變量：

config
├── development.json
└── production.json

我喜歡通過 this.$config 助手快速訪問它們，特別是在模板里。像往常一樣，擴(kuò)展 Vue 對象非常容易：

// NPM
import Vue from "vue";

// PROJECT: COMMONS
import development from "@/config/development.json";
import production from "@/config/production.json";

if (process.env.NODE_ENV === "production") {
 Vue.prototype.$config = Object.freeze(production);
} else {
 Vue.prototype.$config = Object.freeze(development);
}

7.  按照某個約定來給代碼提交命名

隨著項目的增長，你可能需要定期瀏覽組件的歷史記錄。如果你的團(tuán)隊沒有遵循相同的約定來命名他們的提交，那么理解每個提交將會變得更加困難。

我一直推薦使用 Angular 提交信息指南。我在每個項目中都遵循它，在很多情況下，其他團(tuán)隊成員很快就會發(fā)現(xiàn)遵循它帶來的好處。

遵循這些指導(dǎo)原則可以得到更具可讀性的信息，這使得在查看項目歷史記錄時更容易跟蹤提交。簡而言之，它是這樣工作的：

git commit -am "<type>(<scope>): <subject>"

# 舉例
git commit -am "docs(changelog): update changelog to beta.5"
git commit -am "fix(release): need to depend on latest rxjs and zone.js"

看下他們的 README 文件 了解更多了解更多關(guān)于它和相關(guān)約定。

8. 項目上線后固定 package 版本

我知道，所有 package 都應(yīng)該遵循語義化版本規(guī)則。但現(xiàn)實情況是，有些根本沒有遵守。

為了避免因為某個依賴項破壞了整個項目而不得不在半夜醒來，鎖定所有 package 版本可以讓你的早晨工作壓力更小。

它的意思很簡單：避免使用帶 ^ 前綴的版本號：

{
 "name": "my project",

 "version": "1.0.0",

 "private": true,

 "dependencies": {
 "axios": "0.19.0",
 "imagemin-mozjpeg": "8.0.0",
 "imagemin-pngquant": "8.0.0",
 "imagemin-svgo": "7.0.0",
 "nuxt": "2.8.1",
 },

 "devDependencies": {
 "autoprefixer": "9.6.1",
 "babel-eslint": "10.0.2",
 "eslint": "6.1.0",
 "eslint-friendly-formatter": "4.0.1",
 "eslint-loader": "2.2.1",
 "eslint-plugin-vue": "5.2.3"
 }
}

9. 在顯示大量數(shù)據(jù)時使用 Vue Virtual Scroller

當(dāng)你需要在某個頁面中顯示大量的行，或者需要循環(huán)大量的數(shù)據(jù)時，你可能已經(jīng)注意到頁面可能會很快變得非常慢。要解決這個問題，你可以使用vue-virtual-scoller。

npm install vue-virtual-scroller

它將只渲染列表中可見的項，并重用組件和 dom 元素，效率高，性能好。它真的很容易使用，如絲般順滑！✨

<template>
 <RecycleScroller
 class="scroller"
 :items="list"
 :item-size="32"
 key-field="id"
 v-slot="{ item }"
 >
 <div class="user">
 {{ item.name }}
 </div>
 </RecycleScroller>
</template>

10. 跟蹤第三方包的大小

當(dāng)很多人在同一個項目中工作時，如果沒人關(guān)注安裝包的數(shù)量，那么很快就會越來越多。為了避免應(yīng)用程序變慢(特別是在移動網(wǎng)絡(luò)變慢的情況下)，我在 VS Code 中使用了 import cost 插件。這樣，我就可以從我的編輯器中看到導(dǎo)入的模塊庫有多大，并且可以在它變得太大時檢查出問題。

例如，在最近的一個項目中，整個 lodash 庫被導(dǎo)入(大約有24kB的gzipped)。結(jié)果只使用了 cloneDeep 方法。通過 import cost 插件定位到這個問題，我們是這樣解決的：

npm remove lodash
npm install lodash.clonedeep

cloneDeep 函數(shù)可以在需要的地方引入：

import cloneDeep from "lodash.clonedeep";

要進(jìn)一步優(yōu)化，你可以使用 Webpack Bundle Analyzer  ，用交互式的可縮放地圖可視化文件大小。

關(guān)于處理大型 Vue 代碼庫，你還有其他最佳實踐可以分享的嗎？歡迎在評論區(qū)留言。

原文

喜歡的朋友可以加作者二維碼

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評論