前端领域的插件式设计

news2024/10/3 22:13:32

插件,是一个常见的概念。

例如,当我们需要把我们前端代码中的 css 样式提取打包,我们可以用 webpack 的 mini-css-extract-plugin,或者你如果用 rollup 的话,可以选择 rollup-plugin-postcss。

再比如我们可以给 babel 配置 @babel/plugin-proposal-decorators 插件来支持装饰器语法;

除了上述打包编译相关的工具,我们使用的代码编辑器也都支持各式各样的插件,动态地给软件增加各种能力,例如通过 Prettier 插件来是 VsCode 支持 Prettier 的代码格式化,或者安装主题插件来改变软件样式等。

除此之外,一些前端领域的框架也都有插件的机制,譬如 Vue,DvaJS,Eggjs 等。React 也有一些插件化开发的框架,例如 DevExtreme Reactive (以下简称 DR),React Pluggable。

认识插件

那什么是插件呢?

所谓插件(Plug-in / Plugin),是一种可以把某些能力或特性添加到某个已有主体程序的程序,它通常遵循一定的编写规范,并只能运行在特定的主体程序中。

插件的设计能带来许多好处,例如

  • 它可以极大地提升软件的可扩展性。很多工程工具都提供了插件能力给开发者,借助社区力量基于插件扩展各种原本不具备的能力,从而极大地提升了生命力;

  • 它可以让主体程序和插件代码解耦,保持主体程序的稳定。可以想象如果 webpack 不是通过插件来扩展能力,那当我们需要某个当前版本不具备的能力时,只能不断地升级 webpack,而这种升级则很容易引入不稳定因素。

  • 它可以帮助我们控制主体程序复杂度。借助插件,我们可以很好地把能力分而治之,化整为零,从而有效地控制系统整体的复杂度。

  • 它可以帮助我们控制程序体积,做到按需引用。由于插件是可以独立地动态加载,我们可以针对性地选择我们需要的插件能力。我们也可以设想,VsCode 如果是把各种能力都由自己完成,其软件大小会是怎样的规模(其实也不会是现在的形态了,比如针对各个编程领域提供一个应用包)。

虽然上面提到的软件都有支持插件,但也各有特点。

从插件的深入程度上来说

  • 一些程序插件就是其核心机制,其程序主体相对精简,大部分能力都是依赖插件来扩充的。例如 webpack 、babel 等大部分代码都是插件,主体主要是软件生命周期调配,状态流转等,以及少量核心能力的实现。再比如 https://github.com/DevExpress/devextreme-reactive 中提供的几个复杂 React 组件也基本上是一个一个插件来完成的。

  • 相比之下,另一些程序的插件更多是对其能力上的一个补充,其插件能完成的工作相对有限(主体程序暴露的给插件的能力较少),但能很好地完成某些场景的扩展。

而从插件面向的开发者来说,也有几种方式

  • 对主体程序开发和第三方开发者一视同仁,都以相同的插件机制来扩展能力。这类程序通常也具备上面提到的插件作为核心机制的特征,例如 webpack 就是典范。个人认为这种机制可以提供能力强大的插件机制,但同时也模糊了两类开发者的界限,使得上手开发插件的门槛相对较高,甚至很多时候需要了解原本系统提供的插件实现。

  • 插件机制是为了方便主体程序开发者,不对第三方开发者暴露。https://github.com/DevExpress/devextreme-reactive 的 PivotGrid 底层是基于插件化的框架,但是暴露给 PivotGrid 开发者的属性则基本没有插件的痕迹,已经做了封装。

  • 插件是为了第三方开发者扩展系统能力。这类主体程序通常不依赖插件机制来实现特定功能,插件机制只是为了提供扩展能力,通常这类插件机制提供的能力也相对特化。

插件化设计的改造案例

除了我们去使用一个一个的插件,我们也可以把插件化的设计引入到我们自己的系统中,下面抛砖引玉,按照笔者的理解介绍一些基本的设计思路,当然插件的设计方式并非固定的,我们也不应当公式化地套用模式,核心在于体会其设计思想。

当我们设计一个插件系统时,我们要考虑几个问题:

  • 程序中哪些是易变的,哪些是相对稳定的。易变的部分应暴露出相应的能力由插件来完成。

  • 插件如何影响程序。通常会以扩展行为,修改状态,变更展示的方式体现。

设想一个这样一个例子,我们有一个简易的计算器程序,支持加减法:

 class Calculator {
   construct(initial) {
     this.num = initial;
   }
   add(num) {
     this.num = this.num + num;
     return this;
   }
   subtract(num) {
     this.num = this.num - num;
     return this;
   }
   result() {
     return this.num;
   }
 }

 const myCalculator = new Calculator(5);
 myCalculator.add(5).subtract(2).result(); // 8

可以很容易想到,计算器的主要抽象是运算,即当前值和一个新值的运算过程,这部分是稳定的,而支持的运算逻辑是可扩展的,适合做成插件,因此我们可以做如下的改造:

 // 程序主体,定义程序核心逻辑是增加计算器运算能力
 class Calculator {
   plugins = [];
   construct(initial) {
     this.num = initial;
   }

   use(plugin) {
     this.plugins.push(plugin);
     this[plugin.name] = plugin.calculate.bind(this);
   }

   result() {
     return this.num;
   }
 }
 // 插件声明
 interface Plugin {
   name: string;
   calculate(num: number) => this;
 }
 // 插件实现
 class AddPlugin implements Plugin {
   name: 'add',
   calculate(num) {
     this.num = this.num + num;
     return this;
   }
 }

 class SubtractPlugin implements Plugin {
   name: 'subtract',
   calculate(num) {
     this.num = this.num - num;
     return this;
   }
 }

 const myCalculator = new Calculator(5);
 // 插件安装
 myCalculator.use(new AddPlugin());
 myCalculator.use(new SubtractPlugin());

 myCalculator.add(5).subtract(2).result(); // 8

经过这个改造,未来如果要实现乘法,我们只需要新增一个插件实现即可,无需修改程序主体:

 class MultiplicatiPlugin implements Plugin {
   name: 'multiplicati',
   calculate(num) {
     this.num = this.num * num;
     return this;
   }
 }

再比如我们要增加一个 help 来打印支持的计算也可以快速实现:

 class Calculator {
   ...
   help() {
     return `support ${this.plugins.map(plugin => plugin.name).join(',')}`;
   }
 }

通过上面的例子,从插件的角度可以分成几个部分:

  • 程序主体(Program),即上面的 Calculator;

  • 插件接口声明(Plugin Interface),即上面的 Plugin;

  • 插件实现(Plugin Implementation),即 AddPlugin,SubtractPlugin,MultiplicatiPlugin;

在一些更复杂的例子里还会有 Plugin Loader 用于加载和管理 plugin。

图片

插件设计的案例分享

我们已经对插件设计有了一个基本的认识,我们再来看看一些开源库的插件设计案例

Webpack

webpack 核心模块为 compiler 和 compilation,他们都有各自的声明周期钩子(Hook),插件开发者可以借助这些 Hook 来完成各种能力,因此 webpack 核心便是定义声明周期(或者叫事件流),并在各个声明周期中调用插件在对应声明周期注册的方法。不过在同一个生命周期注册了多个事件时,我们还需要关注几个问题:

  • 同步执行还是异步执行;

  • 并行执行还是串行;

  • 如果执行会产生结果,那么对其他 Hook 的结果会产生什么影响;

上述问题 webpack 封装了一个 Hook 的核心库 Tapable, compiler 和 compilation 都是基于 Tapable 的实现,根据上面的维度提供了不同的 Hook 类:

图片

img

网上有很多很不错的专门介绍 Tapable 文章,这里就不继续展开介绍,但我们可以对其有个感性的认识,实际上可以把它看做加强版的 EventEmitter。不仅 webpack 会面临这个问题,另一个构建工具 rollup 也能看到类似的模块来解决这类问题,在其代码中有一个 PluginDriver 模块(https://github.com/rollup/rollup/blob/master/src/utils/PluginDriver.ts)就是起类似的作用。

DevExtreme Reactive

最后再来聊一聊一个比较有意思的 React 插件化框架 DevExtreme Reactive。

DevExtreme Reactive (以下简称 DR)是 DevExpress 公司开发的一个开源 React 组件库,目前包含了 Grid / Chart / Scheduler 三个复杂组件,这三个组件都是基于一个插件化框架进行开发的。

一个插件的例子如下:

 import { PluginHost, Plugin, Template, Getter, Action } from '@devexpress/dx-react-core';

 export default function PluginRoot(props) {
   const { chidren } = props;
   return <PluginHost>{children}</PluginHost>;
 }

 export function FeatureA() {
   return (
     <Plugin name="A">
       <Template name="...">...</Template>
       <Getter name="..." />
       <Action name="..." />
     </Plugin>
   );
 }
 export function FeatureB() {
   return (
     <Plugin name="B">
       <Template>...</Template>
       <Getter name="..." />
       <Action name="..." />
     </Plugin>
   );
 }

 // App.jsx
 import PluginRoot, { FeatrueA, FeatureB, ... FeatureN } from './MyComponnent;'

 const App = () => (
   <PluginRoot>
     <FeatureA />
     <FeatureB />
     ...
     <FeatrueN />
   </PluginRoot>
 );

 ReactDOM.render(<App />, rootNode);

其中:

  • PluginHost 是主体程序入口,用于定义主体程序基本组成。

  • Plugin 是插件的根节点。

  • Getter 用于定义或复写一个状态,在程序中共享(可以用于自己,或其他插件消费)。即修改状态。

  • Action 用于定义或复写一个操作在程序中共享。即扩展行为。

  • Template 可以用来定义或复写一个展示片段,同样可以被自己,或其他插件的 Template 消费。即变更展示。需要注意的是,Template 只是定义,真正生效取决于某个 Template 引用这个具名片段。和上面介绍的构建工具不同,作为一个组件的插件化框架,展示的插件化也是一个重要的课题,而 Template 就是这个能力的核心。

插件的各个能力和注册方式都采用组件形式引用,充分契合 React 书写方式。

TodoApp

当然这些介绍还是不太直观,我们来看一个具体的例子。

例如我们要做一个 Todo 应用,我们可以如下实现

 import { PluginHost, Plugin, Template, Getter, Action } from '@devexpress/dx-react-core';

 const TodoApp = ({ children }) => {
   return (
     <PluginHost>
       <TodoCore />

       {/* ========= plugins ========= */}
       <TodoHeader />
       <TodoList />
       <TodoStore />
     </PluginHost>
   )
 }

 const TodoCore = () => {
   return (
     <Plugin>
       {/* 基本的状态管理 */}
       <TodoStore />
       <Template name="root">
         {/* 定义布局 */}
         <section className="todoapp">
           <TemplatePlaceholder name="header" />
           <TemplatePlaceholder name="main" />
         </section>
       </Template>
     </Plugin>
   );
 };

 const TodoHeader = () => {...}
 const TodoList = () => {...}

 const App = () => {
   return (
     <TodoApp />
   )
 }

 ReactDOM.render(<App />, rootNode);

图片

如果我们需要增加一个功能支持设置完成,我们可以通过编写如下的插件来支持:

 // TodoCompletable.tsx
 const TodoCompletable = () => {
   ...
   return (
     <Plugin name="completable">
       {/* 扩展 main 的布局,增加 footer,在 footer 中展示 complete 对应的操作 */}
       <Template name="main">
         <TemplatePlaceholder />
         <TemplatePlaceholder name="footer" />
       </Template>

       {/* 扩展状态和操作 */}
       <Getter name="todos" computed={getTodoWithCompletedStatus} />
       <Action name="completeTodo" action={completeTodoAction} />
       <Action name="activeTodo" action={activeTodoAction} />

       {/* 扩展 todoItem 展示,增加 checkbox */}
       <Template name="todoItem">
         {({ todo }) => (
           <TemplateConnector>
             {(getters, { completeTodo, activeTodo }) => (
               <div className="view">
                 <input
                   className="toggle"
                   type="checkbox"
                   checked={todo.completed}
                   onChange={(e) => {
                     if (e.target.checked) {
                       completeTodo(todo.id);
                     } else {
                       activeTodo(todo.id);
                     }
                   }}
                 />
                 {/* TemplatePlaceholder 表示直接使用原来 todoItem 定义的展示 */}
                 <TemplatePlaceholder />
               </div>
             )}
           </TemplateConnector>
         )}
       </Template>


       {/* Footer 的具体实现 */}
       <TodoFooter />
     </Plugin>
   );
 };

 // 引入插件
 const TodoApp = () => {
   return (
     <PluginHost>
       {...}
       {/* completable plugin */}
       <TodoCompletable />
     </PluginHost>
   );
 };

图片

可以看到,标签功能完全插件化了,原来的代码不需要做任何调整!而且相关功能完全在一个模块中实现(如果我们正常 React 的写法会在多个组件中感知逻辑,改动肯定是分散的,而目前的写法我们可以轻松增加或移除此 feature)!详细例子可以参考写的例子:https://stackblitz.com/edit/dr-todo-demo?file=App.tsx

通过上面的介绍,想必大家可以感受到插件化设计的魅力了,感谢看到这里,希望能对大家有所帮助。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1125176.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Python 数组和列表:创建、访问、添加和删除数组元素

Python 没有内置支持数组&#xff0c;但可以使用 Python 列表来代替。 数组 本页将向您展示如何使用列表作为数组&#xff0c;但要在 Python 中使用数组&#xff0c;您需要导入一个库&#xff0c;比如 NumPy 库。数组用于在一个变量中存储多个值&#xff1a; 示例&#xff0…

VSCode 开发 Vue 语法提示

一. 打开应用商店&#xff0c;搜索 vetur &#xff0c;选择第一个&#xff0c;点击安装。 二. 安装完成后&#xff0c;还可以下载 Vue Language Features 解决代码警告的问题。 最后重启 VSCode 就可以使用啦。另外输入 按回车键还可以自动生成 vue 代码格式哦。 原创作者&…

GPT-3 内幕机制可视化解析

GPT-3 内幕机制可视化解析 GPT-3是一个基于Transformer的语言模型,通过不同的层次提取语言不同层面的特性,构建整个语言的语义信息,它学习的过程跟人类正常学习的过程是类似的,开始的时候是一个无监督预训练,如图5-5所示,GPT-3模型可以将网络上的所有文档下载下来,包含 …

AD9371 官方例程HDL详解之JESD204B TX侧时钟生成 (三)

AD9371 系列快速入口 AD9371ZCU102 移植到 ZCU106 &#xff1a; AD9371 官方例程构建及单音信号收发 ad9371_tx_jesd -->util_ad9371_xcvr接口映射&#xff1a; AD9371 官方例程之 tx_jesd 与 xcvr接口映射 AD9371 官方例程 时钟间的关系与生成 &#xff1a; AD9371 官方…

Sui提供dApp Kit 助力快速构建React Apps和dApps

近日&#xff0c;Mysten Labs推出了dApp Kit&#xff0c;这是一个全新的解决方案&#xff0c;可用于在Sui上开发React应用程序和去中心化应用程序&#xff08;dApps&#xff09;。mysten/dapp-kit是专门为React定制的全新SDK&#xff0c;旨在简化诸如连接钱包、签署交易和从RPC…

Python生成词云

成品&#xff1a; 代码&#xff1a; import os# 下面的两个包大家注意别导错了 from imageio.v2 import imread from wordcloud import wordcloud# mytext文本是字符串类型的 mytext str() # os.getcwd()是获得当前目录的路径&#xff0c;好像没啥用 读取 with open(os.getcw…

35岁运维工程师到底该何去何从?

你是否经常在网上看到类似的帖子&#xff1a; “运维35岁被裁”、“35岁运维找不到工作”&#xff0c;这样的字眼频频出现在新闻中。如何度过35岁职场危机呢&#xff0c;不妨看看这篇文章&#xff0c;或许对你有启发&#xff01; 一、35岁被称为运维半衰期&#xff0c;究竟为何…

性能测试:系统架构性能优化思路

今天谈下业务系统性能问题分析诊断和性能优化方面的内容。这篇文章重点还是谈已经上线的业务系统后续出现性能问题后的问题诊断和优化重点。 系统性能问题分析流程 我们首先来分析下如果一个业务系统上线前没有性能问题&#xff0c;而在上线后出现了比较严重的性能问题&#x…

【算法练习Day26】分发饼干摆动序列 最大子数组和

​&#x1f4dd;个人主页&#xff1a;Sherry的成长之路 &#x1f3e0;学习社区&#xff1a;Sherry的成长之路&#xff08;个人社区&#xff09; &#x1f4d6;专栏链接&#xff1a;练题 &#x1f3af;长路漫漫浩浩&#xff0c;万事皆有期待 文章目录 分发饼干摆动序列最大子数组…

金蝶云星空企业版v8.0内网穿透配置详解:实现便捷的异地远程访问

文章目录 前言1. 金蝶云星空企业版v8.0安装下载1.1 登录金蝶官网下载安装包1.2 常见的安装下载问题 2. 金蝶云星空配置SQL Sever数据库2.1 创建数据管理中心2.2 创建完成后在服务器登录管理站点 3. 下载安装注册cpolar3.1 公网访问测试 4. 固定连接公网地址 前言 金蝶云星空专注…

关于AES加密输出密文不为128位的倍数的原因

今天尝试用AES-256-OFB加密一个flag结果输出的密文是43字节&#xff0c;不是128位&#xff08;16字节&#xff09;的倍数&#xff0c;代码如下&#xff1a; import os from Crypto.Cipher import AES databflag{a7ba7128-3917-4551-8260-b3499e9dd7b12} aes AES.new(os.urand…

如何用Pytest做性能测试?5个步骤轻松学会!

Pytest其实也是可以做性能测试或者基准测试的。是非常方便的。 可以考虑使用Pytest-benchmark类库进行。 安装pytest-benchmark 首先&#xff0c;确保已经安装了pytest和pytest-benchmark插件。可以使用以下命令安装插件&#xff1a; pip install pytest pytest-benchmark …

Apollo生态系统探索:更多工具与框架的介绍

前言 「作者主页」&#xff1a;雪碧有白泡泡 「个人网站」&#xff1a;雪碧的个人网站 「推荐专栏」&#xff1a; ★java一站式服务 ★ ★ React从入门到精通★ ★前端炫酷代码分享 ★ ★ 从0到英雄&#xff0c;vue成神之路★ ★ uniapp-从构建到提升★ ★ 从0到英雄&#xff…

选择合适的软件管理视频制作排期

如果你是一名专业的视频创作者&#xff0c;那么你一定知道一个清晰、高效的项目管理对于视频制作的重要性。那么如何使用Zoho Projects项目管理软件来管理的视频制作项目&#xff0c;以便更好地规划和执行每一个细节呢&#xff1f; 这款项目管理软件具有丰富的自定义字段功能&a…

【Java集合类面试十三】、HashMap如何实现线程安全?

文章底部有个人公众号&#xff1a;热爱技术的小郑。主要分享开发知识、学习资料、毕业设计指导等。有兴趣的可以关注一下。为何分享&#xff1f; 踩过的坑没必要让别人在再踩&#xff0c;自己复盘也能加深记忆。利己利人、所谓双赢。 面试官&#xff1a;HashMap如何实现线程安全…

【EtherCAT】二、下载并使用TwinCAT

下载并使用TwinCAT 引言介绍下载安装TwinCAT使用 更多精彩&#xff0c;欢迎关注 引言 TwinCAT是一款由德国Beckhoff Automation开发的工业自动化控制软件。它被广泛用于工厂自动化、过程控制、机器控制以及其他自动化领域。 而这里我们主要使用TwinCAT模拟ECAT主站。本文将介绍…

【蓝桥杯001】

个人名片&#xff1a; &#x1f43c;作者简介&#xff1a;一名大二在校生&#xff0c;喜欢编程&#x1f38b; &#x1f43b;‍❄️个人主页&#x1f947;&#xff1a;小新爱学习. &#x1f43c;个人WeChat&#xff1a;hmmwx53 &#x1f54a;️系列专栏&#xff1a;&#x1f5bc…

golang 工程组件:grpc-gateway 环境安装+默认网关测试

grpc-gateway grpc-gateway 顾名思义是专门是grpc的网关。也是一个protobuf的编译器&#xff0c;是一个proto的插件。 grpc-gateway就是将http请求处理后转发到对应grpc服务上。很多浏览器&#xff0c;或者客户端开箱不支持grpc&#xff0c;只支持传统的restful API。 grpc网关…

Tmux:终端复用器的基本使用(三)

相关阅读 Tmuxhttps://blog.csdn.net/weixin_45791458/category_12472796.html?spm1001.2014.3001.5482 在之前的两篇文章中&#xff0c;已经给出了关于tmux中会话和窗口相关的常用命令&#xff0c;在这篇文章中&#xff0c;窗格相关的命令将会被给出。 将一个窗格水平和垂直…

MECE分析法

1、前言 前段时间在对项目进行问题分析的时候&#xff0c;领导要求要符合MECE原则&#xff0c;做到逻辑完整而不能遗漏。虽然没听过这个原则&#xff0c;但是总感觉很有道理&#xff08;领导说的都对&#xff09;。于是乎&#xff0c;就找了一些资料了解了一下。 MECE分析法是…