如何設計一個JavaScript插件係統？

WordPress有插件、 jQuery有插件、Gatsby、Eleventy和Vue也是如此。插件是庫和框架的常見功能，並且有一個很好的理由：它們允許開發人員以安全，可擴展的方式添加功能。這使核心項目更具價值，並建立了一個社區——所有這些都不會增加額外的維護負擔。那麼如何設計一個JavaScript插件係統呢？

讓我們從一個名為BetaCalc的示例項目開始。BetaCalc的目標是成為一個簡約的JavaScript計算器，其他開發人員可以在其中添加“按鈕”。以下是一些基本的入門代碼：

我們將計算器定義為一種客觀事物，以使事情變得簡單，計算器通過 console.log 打印結果來工作。

目前功能確實很有限。我們有一個 setValue 方法，該方法接受一個數字並將其顯示在“屏幕”上。我們還有加法（plus）和減法（minus）方法，它們將對當前顯示的值執行一個運算。

現在該添加更多功能了。首先創建一個插件係統。

世界上最小的插件係統

我們將從創建一個注冊（register）方法開始，其他開發人員可以使用該方法向BetaCalc注冊插件。該方法的工作很簡單：獲取外部插件，獲取其 exec 函數，並將其作為新方法附加到我們的計算器上：

這是一個示例插件，為我們的計算器提供了一個“平方（squared）”按鈕：

在許多插件係統中，插件通常分為兩個部分：

要執行的代碼

元數據（例如名稱，描述，版本號，依賴項等）

在我們的插件中，exec 函數包含我們的代碼，name 是我們的元數據。注冊插件後，exec 函數將作為一種方法直接附加到我們的 betaCalc 對象，從而可以訪問BetaCalc的 this。

現在，BetaCalc有一個新的“平方”按鈕，可以直接調用：

這個係統有很多優點。該插件是一種簡單的對象字麵量，可以傳遞給我們的函數。這意味著插件可以通過npm下載並作為ES6模塊導入。易於分發是超級重要的！

但是我們的係統有一些缺陷。

通過為插件提供訪問BetaCalc的 this 權限，他們可以對所有BetaCalc的代碼進行讀/寫訪問。雖然這對於獲取和設置 currentValue 很有用，但也很危險。如果插件要重新定義內部函數（如 setValue），則它可能會為BetaCalc和其他插件產生意外的結果。這違反了開放-封閉原則，即一個軟件實體應該是開放的擴展，但封閉修改。

另外，“squared”函數通過產生副作用發揮作用。這在JavaScript中並不少見，但感覺並不好——特別是當其他插件可能處在同一內部狀態的情況下。一種更實用的方法將大大有助於使我們的係統更安全、更可預測。

更好的插件架構

讓我們再來看看一個更好的插件架構。下一個例子同時改變了計算器和它的插件API：

我們在這裏做了一些值得注意的更改。

首先，我們將插件與“核心（core）”計算器方法（如plus和minus）分開，方法是將其放入自己的插件對象中。將我們的插件存儲在plugins 對象中可使我們的係統更安全。現在，訪問此plugins的插件將看不到BetaCalc屬性，而隻能看到 betaCalc.plugins 的屬性。

其次，我們實現了一個 press 方法，該方法按名稱查找按鈕的功能，然後調用它。現在，當我們調用插件的 exec 函數時，我們將當前的計算器值（currentValue ）傳遞給該函數，並期望它返回新的計算器值。

本質上，這個新的 press 方法將我們所有的計算器按鈕轉換為純函數。他們獲取一個值，執行一個操作，然後返回結果。這有很多好處：

它簡化了API。

它使測試更加容易（對於BetaCalc和插件本身）。

它減少了我們係統的依賴性，使其更鬆散地耦合在一起。

這種新架構比第一個示例受到更多限製，但效果很好。我們基本上為插件作者設置了護欄，限製他們隻能做我們希望他們做的改動。

實際上，它可能太嚴格了！現在，我們的計算器插件隻能對 currentValue 進行操作。如果插件作者想要添加高級功能（例如“記憶”按鈕或跟蹤曆史記錄的方式），那麼他們將無能為力。

也許這就是好的。你給插件作者的能力是一種微妙的平衡。給他們太多的權力可能會影響你項目的穩定性。但給它們的權力太小，它們就很難解決自己的問題——在這種情況下，你還不如不要插件。

我們還能做什麼？

我們還有很多工作可以改善我們的係統。

如果插件作者忘記定義名稱或返回值，我們可以添加錯誤處理以通知插件作者。像QA開發人員一樣思考並想象一下我們的係統如何崩潰，以便我們能夠主動處理這些情況，這是很好的。

我們可以擴展插件的功能範圍。當前，一個BetaCalc插件可以添加一個按鈕。但是，如果它還可以注冊某些生命周期事件的回調（例如當計算器將要顯示值時）怎麼辦？或者說，如果有一個專門的地方讓它在多個交互中存儲一段狀態呢？這會不會開辟一些新的用例？

我們還可以擴展插件注冊的功能。如果一個插件可以通過一些初始設置來注冊呢？這是否能使插件更加靈活？如果一個插件作者想注冊一整套按鈕，而不是一個單一的按鈕——比如“BetaCalc統計包”？需要做哪些改動來支持呢？

你的插件係統

BetaCalc及其插件係統都非常簡單。如果你的項目較大，則需要探索其他一些插件架構。

一個很好的起點是查看現有項目，以獲取成功的插件係統的示例。對於JavaScript，這可能意味著jQuery，Gatsby，D3，CKEditor或其他。你可能還想熟悉各種JavaScript設計模式，每種模式都提供了不同的接口和耦合程度，這給你提供了很多好的插件架構選擇。了解這些選項有助於你更好地平衡使用你的項目的每個人的需求。

除了模式本身之外，你還可以借鑒許多好的軟件開發原則來做出此類決策。我已經提到了一些方法（例如開閉原則和鬆散耦合），但是其他一些相關的方法包括Demeter定律和依賴注入。

我知道這聽起來很多，但你必須進行研究。沒有什麼比讓每個人都重寫他們的插件更痛苦的了，因為你需要更改插件架構。這是一種快速失去信任的方式，讓人們失去對未來貢獻的信心。

總結

從頭開始編寫好的插件架構是困難的！你必須平衡很多考慮因素，才能建立一個滿足大家需求的係統。它是否足夠簡單？功能夠強大嗎？它是否能長期工作？

不過這也是值得的，有一個好的插件係統對大家都有幫助，開發者可以自由地解決他們的問題。最終用戶可以從中選擇大量可選擇的特性。你可以圍繞你的項目建立一個生態係統和社區。這是一個三贏的局麵。

以上就是如何設計一個JavaScript插件係統。