JavaScript插件系统设计：架构演进与安全扩展指南

本文译自 https://css-tricks.com/designing-a-javascript-plugin-system/

插件系统的核心价值

插件是库和框架中常见的功能，其核心价值在于允许开发人员以安全且可扩展的方式添加新功能。这种开放的设计不仅提升了核心项目的价值，还有助于建立开发者社区，同时不会给核心维护者带来额外的负担。

本文将演示如何使用 JavaScript 构建一个自定义的插件系统。

文中使用“pluginn”一词，但此类机制有时也被称为“extensions”、“add-ons”或“modules”。无论命名如何，其核心含义和带来的收益是一致的。

构建基础插件系统

接下来，我们将开始构建插件系统。

首先，我们从一个名为 BetaCalc 的示例项目入手。BetaCalc 的目标是成为一个简约的 JavaScript 计算器，允许其他开发人员添加额外的“按钮”。以下是帮助入门的基础代码：


// The Calculator
const betaCalc = {
 currentValue: 0,
 
 setValue(newValue) {
  this.currentValue = newValue;
  console.log(this.currentValue);
 },
 
 plus(addend) {
  this.setValue(this.currentValue + addend);
 },
 
 minus(subtrahend) {
  this.setValue(this.currentValue - subtrahend);
 }
};

// Using the calculator
betaCalc.setValue(3); // => 3
betaCalc.plus(3);   // => 6
betaCalc.minus(2);  // => 4

为了简化示例，我们将计算器定义为 object-literal 。该计算器通过 console.log 来打印计算结果。

目前的功能非常基础。我们有一个 setValue 方法，它接收一个数字并将其显示在“屏幕”上。此外，还有 plus 和 minus 方法，用于对当前显示的值执行相应的数学操作。

现在，我们需要增加更多功能。第一步是创建一个插件系统。

让我们先实现世界上最小的插件系统。

我们从创建一个 register 方法开始，其他开发人员可以利用它在 BetaCalc 上注册插件。该方法的原理很简单：获取外部插件，提取其 exec 功能，并将其作为新方法附加到我们的计算器对象上：


// The Calculator
const betaCalc = {
 // ...other calculator code up here
 register(plugin) {
  const { name, exec } = plugin;
  this[name] = exec;
 }
};

这是一个示例插件，为我们的计算器提供了一个 squared 按钮：


// Define the plugin
const squaredPlugin = {
 name: 'squared',
 exec: function() {
  this.setValue(this.currentValue * this.currentValue)
 }
};

// Register the plugin
betaCalc.register(squaredPlugin);

在许多现有的插件系统中，插件通常被划分为两个主要部分：

需要执行的代码逻辑
元数据（例如名称、描述、版本号、依赖项等）

在我们的插件定义中， exec 函数包含了具体的代码逻辑，而名称则作为元数据存在。当插件注册时，exec函数会直接作为方法附加到 betaCalc 对象上，从而使其能够访问 BetaCalc 的 this 。

此时，BetaCalc 拥有了一个新的 squared 按钮，可以直接进行调用：


betaCalc.setValue(3); // => 3
betaCalc.plus(2);   // => 5
betaCalc.squared();  // => 25
betaCalc.squared();  // => 625

这个系统具有诸多优点。插件是一个简单的对象字面量，可以直接传递给我们的注册函数。这意味着插件可以通过 npm 进行下载，并作为 ES6 模块导入。

基础系统的缺陷分析

然而，我们的系统也存在一些缺陷。

通过为插件提供对 BetaCalc 的 this 访问权限，插件可以对所有 BetaCalc 的代码进行读/写操作。虽然这对于获取和设置 currentValue 很有用，但这也很危险。如果某个插件重新定义了内部函数（如 setValue ），则可能会对 BetaCalc 和其他插件产生意想不到的影响。这违反了开闭原则（Open-Closed Principle），该原则规定软件实体应该对扩展开放，对修改关闭。

同样，squared 函数通过产生副作用来发挥作用。这在 JavaScript 中并不罕见，但给人的感觉并不理想——特别是当其他插件可能也在处理相同的内部状态时。采用更实用的编程方法将大大有助于使我们的系统更安全、更可预测。

优化插件架构设计

让我们探讨一种更好的插件架构。

下一个示例更改了计算器及其插件 API 的设计：


// The Calculator
const betaCalc = {
 currentValue: 0,
 
 setValue(value) {
  this.currentValue = value;
  console.log(this.currentValue);
 },
 
 core: {
  'plus': (currentVal, addend) => currentVal + addend,
  'minus': (currentVal, subtrahend) => currentVal - subtrahend
 },

 plugins: {},  

 press(buttonName, newVal) {
  const func = this.core[buttonName] || this.plugins[buttonName];
  this.setValue(func(this.currentValue, newVal));
 },

 register(plugin) {
  const { name, exec } = plugin;
  this.plugins[name] = exec;
 }
};
 
// Our Plugin
const squaredPlugin = { 
 name: 'squared',
 exec: function(currentValue) {
  return currentValue * currentValue;
 }
};

betaCalc.register(squaredPlugin);

// Using the calculator
betaCalc.setValue(3);   // => 3
betaCalc.press('plus', 2); // => 5
betaCalc.press('squared'); // => 25
betaCalc.press('squared'); // => 625

我们在设计中做了一些值得注意的更改。

首先，我们将插件与“核心”计算器方法（如 plus 和 minus ）分离，将其放置在独立的插件对象中。将插件存储在一个 plugin 对象中可以使系统更安全。现在，插件无法直接访问 BetaCalc 的属性——它们只能访问 betaCalc.plugins 的属性。

其次，我们实现了一个 press 方法，该方法根据名称查找按钮的功能，然后调用它。现在，当我们调用插件的 exec 函数时，我们将当前的计算器值（currentValue）传递给它，并期望它返回新的计算器值。

本质上，这种新的 press 方法将我们所有的计算器按钮转换为纯函数。它们获取一个值，执行一个操作，然后返回结果。这带来了诸多好处：

简化了 API 接口。
使测试变得更加容易（既适用于 BetaCalc，也适用于插件本身）。
减少了系统间的依赖关系，使其更加松散耦合。

新的架构比第一个示例有更多的限制，但这是有益的。我们为插件作者设置了“护栏”，限制他们只能进行我们允许的操作。

实际上，它可能过于严格了！现在，我们的计算器插件只能操作 currentValue 。如果插件作者想要添加高级功能，例如“记忆”按钮或跟踪历史记录的方法，则无法实现。

这或许是可以接受的。你赋予插件作者的权力是一种微妙的平衡。给予过多的权限可能会影响项目的稳定性，但给予过少的权限会使他们难以解决自己的问题。

系统扩展与改进方向

我们还可以做什么改进？

我们还有很多工作可以改进系统。

如果插件作者忘记定义名称或返回值，我们可以添加错误处理以通知插件作者。像 QA 开发人员一样思考，想象我们的系统如何崩溃，以便我们能够主动处理这些情况。

我们可以扩展插件的功能范围。目前，一个 BetaCalc 插件可以添加一个按钮。但如果它还可以注册某些生命周期事件的回调（例如当计算器即将显示值时）怎么办？或者，如果有一个专用位置来存储多个交互中的状态，该怎么办？

我们还可以扩展插件注册机制。如果可以使用一些初始设置来注册插件怎么办？能否使插件更灵活？如果插件作者希望注册整个按钮套件而不是单个按钮（如 BetaCalc Statistics Pack ），该怎么办？为了支持这一点需要进行哪些更改？

设计适合项目的插件系统

设计适合你的插件系统

BetaCalc 及其插件系统都非常简单。如果你的项目较大，则需要探索其他一些插件体系结构。

一个好的起点是查看现有项目，以获取成功插件系统的示例。对于 JavaScript，你可以查看 jQuery、Gatsby、D3、CKEditor 或其他知名库。

你可能还想熟悉各种 JavaScript 设计模式。每种模式都提供了不同的接口和耦合程度，这为你提供了许多不错的插件体系结构选项供你选择。了解这些选项可以帮助你更好地平衡使用项目的每个人的需求。

除了模式本身之外，你还可以借鉴许多好的软件开发原则来做出此类决策。我已经提到了一些方法（例如开闭原则和松散耦合），但是其他一些相关的方法包括 Demeter 定律和依赖注入。

我知道这听起来很多，但是你必须进行研究。没有什么比让每个人都重写他们的插件更痛苦的了，因为你需要更改插件架构。这是一种失去信任并阻止人们在将来做出贡献的快速方式。

总结

结论

从头开始编写优秀的插件架构很困难！你必须权衡许多考虑因素，以构建满足每个人需求的系统。它够简单吗？足够强大吗？它可以长期工作吗？

值得付出努力。拥有一个好的插件系统可以帮助所有人。开发人员可以自由解决问题，最终用户可以获得大量的选择功能。这样你就可以在项目周围发展生态系统和社区。这是一个双赢的局面。

以上就是构建一个JavaScript插件系统的详细内容，更多关于JavaScript 插件的资料请关注本站其它相关文章！

构建一个JavaScript插件系统：从基础到最佳实践