前端实现多文件编译

简介: 在前端工程中,有时我们需要在浏览器编译并执行一些代码,这种需求常见于低代码场景中。例如我们在搭建时需自定义一部分代码,这些代码需要在渲染时执行。为了方便起见,我们写的代码一定是 ES6 语法,如果要在浏览器执行,那么就必须经过编译。下面是前端编译 JS 代码的一些实践。

概要

在前端工程中,有时我们需要在浏览器编译并执行一些代码,这种需求常见于低代码场景中。例如我们在搭建时需自定义一部分代码,这些代码需要在渲染时执行。为了方便起见,我们写的代码一定是 ES6 语法,如果要在浏览器执行,那么就必须经过编译。下面是前端编译 JS 代码的一些实践。

需求描述

  1. 低码搭建时需要自定义一部分代码
  2. 希望代码是以多文件形式组织的
  3. 可以使用 ESModule 形式导入/导出

需求分析

  1. 在浏览器编译代码必然需要使用 babel 完成
  2. 如果只有一个 JS 文件,那么可以直接使用 babel 的 transform 函数编译
  3. 如果存在多文件,则文件内的变量必须相互隔离,且文件之间能够通过某种形式相互引用,并且需要考虑文件之间的依赖关系

核心设计

流程

变量隔离

由于我们的需求是多文件编辑,各个文件内的变量应该相互隔离。最简单的办法是将每个文的内容转成一个闭包,再通过固定的接口将每个文件连接起来。

假设有 a.js,内容如下:

consta=1;
constb=2;
functionsum () {
returna+b'}
sum();


可以将其转为如下形式:

(function() {
consta=1;
constb=2;
functionsum () {
returna+b'  }
sum();
})();


转成这种形式之后,每个文件内的变量就只会存在于各自的闭包之内,互不影响。

文件引用

文件之间的相互引用可以通过定义一种接口规则实现:

  1. 所有文件的引用都将通过全局变量 module 进行;
  2. 每个文件都将对应到 module 上的一个对象,key 根据文件名而定

导出

原文件:


// a.jsexportconsta=1;

编译后:


(function() {
__filename='a.js';
consta=1;
varmod= {};
mod.a=a;
module[__filename] =mod;
})()

导入

源文件

// b.jsimport { hello } from'./a'hello();

编译后

(function() {
__filename='b.js';
var$$a=module['a.js'];
$$a.hello();
varmod= {};
module[__filename] =mod;
})()

依赖树解析

假设有一堆文件,我们通过解析(babel 或正则)后得到他们之间的关系如下:

他们之间存在循环依赖

根据这个依赖图可以梳理出几条依赖路线:

A -> B -> D -> C -> F -> 循环依赖B

A -> B -> E -> F -> 循环依赖 B

A -> C -> F -> B -> E  -> 循环依赖 F

A -> C -> G

从开始出现的第一个循环依赖截断依赖路线,分别统计统计每个节点的深度,按深度依次放入队列中。

如果两个节点深度相同,则分析两个节点的依赖关系,被依赖的先进队列,故最终形成的队列如下:

F  E  B  C  D  G  A

为什么要得到一个编译顺序呢?

以上得出的编译顺序是为了尽可能解决如下的引用情况,但也不能解决所有(可以参考node的require方法):

// a.jsexportconsta=2// b.jsimport { a } from'a.js';
console.log(a+2);

这时候,假设执行 b 的时候,a 还没被执行,那么 b 内部拿到的 a 实际上是 undefined,显然不是我们所希望的。所以此时必须保证 a 先于 b 执行。

但这种使用方式在存在循环引用时无法解决,只能调整文件组织形式。

事实上,假设存在循环依赖时,下面的在函数内或在类内引用方式是没有问题的,有问题的只是直接使用:

// a.jsexportconsta=2// b.jsimport { a } from'a.js';
exportfunctiontest () {
returna+1;
}

这样,即使 b 🈶️依赖 a,test 只要不是立即执行函数也不会产生影响。

编译

ESModule 转换

此过程可以通过自定义一个 Babel 插件完成,在语法编译时将文件编译成一个闭包,同时处理好 ESModule 语法。

该 Babel 插件很简单,在此就不展开去写了。

文件队列编译

对单个文件的编译可封装成一个方法,假设函数名为: compileFile

按照上面解析到的文件队列按照顺序逐个调用 compileFile 进行编译,并将结果直接拼接起来,形成一个巨大的字符串,该字符串的样子应该是如下的格式:

(function() {
__filename='b.js';
var$$a=module['a.js'];
// ...varmod= {};
module[__filename] =mod;
})();
(function() {
__filename='a.js';
var$$b=module['b.js'];
// ...varmod= {};
module[__filename] =mod;
})();
// ...

JS 执行

最后一步,执行上面得到的编译结果即可,此步骤可直接使用 new Function 的方式完成,例如:

(假设以上的字符串内容保存在 compiledScript 中)

constexec=newFunctioon(`var module = {};${compiledScript};return module;`);
constmodule=exec();
module['a.js'] // a.js 的导出内容module['b.js'] // b.js 的导出内容

总结

至此,一个前端可执行的小型打包工具就已实现,可以直接在前端进行多文件的编辑和执行。

实时上,此过程仅适用于不方便借助服务器的场景,如果有条件允许可以借助服务器,那么编译过程最好在服务端完成,甚至还可以借助 webpack 或 rollup 等打包工具实现更好的编译效果。


参考

目前我们在 ali-lowcode-engine 之上的源码插件(@ali/lowcode-plugin-code-editor)内部实现了多文件的支持,目前仅做了最简单的实现:模块引用直接采用了 UMD 规范,暂时也没有考虑循环依赖和执行顺序。

后续会严格按照以上步骤进行优化。

目录
相关文章
|
3月前
|
前端开发 JavaScript Java
前端限制打包文件数量
前端限制打包文件数量
182 65
|
3月前
|
前端开发
前端引入字体文件
文章介绍了如何在前端项目中引入字体文件,并展示了具体的HTML和CSS代码示例,包括如何使用`@font-face`规则来定义字体和在页面中应用自定义字体。
78 1
前端引入字体文件
|
3月前
|
前端开发 JavaScript API
前端JS读取文件内容并展示到页面上
前端JavaScript使用FileReader API读取文件内容,支持文本类型文件。在文件读取成功后,可以通过onload事件处理函数获取文件内容,然后展示到页面上。
108 2
前端JS读取文件内容并展示到页面上
|
3月前
|
前端开发
前端diff文件对比使用worker进行优化
如何使用Web Worker在React项目中优化文件对比差异功能的实现。
47 5
|
2月前
|
JavaScript 前端开发 应用服务中间件
vue前端开发中,通过vue.config.js配置和nginx配置,实现多个入口文件的实现方法
vue前端开发中,通过vue.config.js配置和nginx配置,实现多个入口文件的实现方法
176 0
|
2月前
|
前端开发 JavaScript API
前端基于XLSX实现数据导出到Excel表格,以及提示“文件已经被损坏,无法打开”的解决方法
前端基于XLSX实现数据导出到Excel表格,以及提示“文件已经被损坏,无法打开”的解决方法
182 0
|
3月前
|
前端开发 JavaScript
node接收前端上传的图片,单文件、多文件同name、多文件不同name
本文介绍了在Node.js中使用multer模块接收前端上传的图片,包括单文件上传、多文件上传(同name和不同name)以及任意类型文件上传的方法。
86 0
|
4月前
|
资源调度 前端开发 JavaScript
前端 nodejs 命令行自动调用编译 inno setup 的.iss文件
前端 nodejs 命令行自动调用编译 inno setup 的.iss文件
|
5月前
|
Web App开发 开发框架 编解码
在基于ABP框架的前端项目Vue&Element项目中采用电子签章处理文件和打印处理
在基于ABP框架的前端项目Vue&Element项目中采用电子签章处理文件和打印处理
|
5月前
|
缓存 前端开发 JavaScript
前端优化之路:打包文件拆包、增加哈希值
前面对项目打包做了优化处理,但是还不够完美,有两点可继续优化。