如何优雅地打包非 JavaScript 静态资源

发表于 2年以前  | 总阅读数:308 次

假设你正在开发一个网络应用程序。在这种情况下,你很可能不仅要处理 JavaScript 模块,还要处理各种其他资源--Web Workers(它也是 JavaScript ,但它拥有一套独立的构建依赖图)、图片、CSS、字体、WebAssembly 模块等等。

一种可行的加载静态资源的办法是在 HTML 中直接引用它们,但通常它们在逻辑上是与其他可重用的组件耦合的。例如,自定义下拉菜单的 CSS 与它的 JavaScript 部分相联系,图标图像与工具栏组件相关,而 WebAssembly 模块与它的 JavaScript 胶水相依赖。在这些情况下,有种更加方便快捷的办法是直接从它们的 JavaScript 模块中引用资源,并在加载相应的组件时动态地加载它们。

然而,大多数大型项目的构建系统都会对内容进行额外的优化和重组--例如打包和最小化(minimize)。构建系统不能执行代码并预测执行的结果是什么,也没理由去遍历判断 JavaScript 中每一个可能的字符串是否是一个资源 URL。那么,如何才能让它们 "看到 "那些由 JavaScript 组件加载的动态资源,并将它们包含在构建产物中呢?

打包工具中的自定义导入

一种常见的方法是利用已有的静态导入语法。有些打包工具可能会通过文件扩展名来自动检测格式,而有些其他打包工具则允许插件使用自定义的 URL Scheme,比如下面的例子:

// 普通 JavaScript 导入
import { loadImg } from './utils.js';

// 特殊 "URL 导入" 的静态资源
import imageUrl from 'asset-url:./image.png';
import wasmUrl from 'asset-url:./module.wasm';
import workerUrl from 'js-url:./worker.js';

loadImg(imageUrl);
WebAssembly.instantiateStreaming(fetch(wasmUrl));
new Worker(workerUrl);

当一个打包工具插件发现一个导入项带有它所识别的扩展名或 URL Scheme(上面的例子中的asset-url:js-url:)时,它会将引用的资源添加到构建图中,将其复制到最终目的地,执行适用于资源类型的优化,并返回最终的 URL,以便在运行时使用。

这种方法的好处是:重用 JavaScript 导入语法,保证所有的 URL 都是静态的相对路径,这使得构建系统很容易定位这种依赖关系。

然而,它有一个明显的缺点:这种代码不能直接在浏览器中工作,因为浏览器不知道如何处理那些自定义的导入方案或扩展名。当然,如果你可以控制所有的代码,并且本来就要依靠打包工具进行开发,这听起来还不错。然而为了减少麻烦,直接在浏览器中使用 JavaScript 模块的情况越来越普遍(至少在开发过程中是这样)。一个小 demo 可能根本就不需要打包工具,即使在生产中也不需要。

浏览器和打包工具中通用的导入语法

如果你正在开发一个可重用的组件,你会希望它在任何环境下都能发挥作用,无论它是直接在浏览器中使用还是作为一个更大的应用程序的一部分预先构建。大多数现代的打包工具都接受下面这个JavaScript 模块导入语法:

new URL('./relative-path', import.meta.url)

它看着像是一种特殊的语法,然而它确实是一种有效的 JavaScript 表达式,可以直接在浏览器中使用,也可以被打包工具静态地检测出来并加以处理。

使用这个语法,前面的例子可以改写为:

// regular JavaScript import
import { loadImg } from './utils.js';
loadImg(new URL('./image.png', import.meta.url));
WebAssembly.instantiateStreaming(
  fetch(new URL('./module.wasm', import.meta.url)),
  { /* … */ }
);
new Worker(new URL('./worker.js', import.meta.url));

让我们分析一下它是什么原理:new URL(...)构造函数会基于第二个参数里的绝对URL,解析出第一个参数中相对 URL 所对应的 URL。在我们的例子中,第二个参数是import.meta.url[1],它是当前 JavaScript 模块的 URL ,所以第一个参数可以是相对于它的任何路径。

它的优点和劣势都类似于动态导入[2]。虽然可以使用import(...)导入内容,如import(someUrl),但打包工具会特殊处理带有静态 URL import('./some-static-url.js')的导入方式:把它作为一种在编译时预处理已知依赖关系的导入方式,把代码分块[3]并动态加载。

同样,你可以使用new URL(...),如new URL(relativeUrl, customAbsoluteBase),然而new URL('...', import.meta.url)语法可以明确地告诉打包工具预处理依赖,并将其与主 JavaScript 资源打包在一起。

模棱两可的相对URL

你可能会想,为什么打包工具不能检测到其他常见的语法--例如,没有new URL包装的fetch('./module.wasm')

原因是,与 import 关键字不同,任何动态请求都是相对于文档本身的,而不是相对于当前的JavaScript文件进行解析。比方说,你有以下结构:

  • index.html:
<script src="src/main.js" type="module"></script>
  • src/
  • main.js
  • module.wasm

如果你想从main.js中加载module.wasm,你的第一反应可能是使用fetch('./module.wasm')这样的相对路径引用。

然而,fetch不知道它所执行的 JavaScript 文件的 URL,相反,它是相对于文档来解析 URL 的。因此,fetch('./module.wasm')最终会试图加载http://example.com/module.wasm,而不是预期的http://example.com/src/module.wasm,从而造成失败(运气更不好的情况下,还可能默默地加载一个与你预期不同的资源)。

通过将相对的URL包装成new URL('...', import.meta.url),你可以避免这个问题,并保证任何提供的URL在传递给任何loader之前都是相对于 当前 JavaScript 模块的 URL(import.meta.url) 解析的。

只要用fetch(new URL('./module.wasm', import.meta.url))代替fetch('./module.wasm'),就可以成功地加载预期的 WebAssembly 模块,同时给打包工具一个在构建时找到这些相对路径的可靠方法。

工具链中的支持

打包工具

下面这些打包工具已经支持new URL语法:

  • Webpack v5[4]
  • Rollup[5] (通过插件支持:@web/rollup-plugin-import-meta-assets[6] 支持通用资源,而@surma/rollup-plugin-off-main-thread[7] 支持 Workers.)
  • Parcel v2 (beta)[8](译者注:在本译文发布时,Parcel V2已经正式发布:https://parceljs.org/blog/v2)
  • Vite[9]

WebAssembly

当使用 WebAssembly 时,你通常不会手动加载 Wasm 模块,而是导入由工具链发出的 JavaScript 胶水代码。下面的工具链可以替你生成new URL(...)语法:

通过Emscripten编译的C/C++

当使用 Emscripten 工具链时,你可以通过以下选项要求它输出 ES6 模块胶水代码,而非普通 JS 代码:

$ emcc input.cpp -o output.mjs
## 如果你不想用mjs扩展名:
$ emcc input.cpp -o output.js -s EXPORT_ES6

当使用这个选项时,输出的胶水代码将使用new URL(..., import.meta.url) 语法,这样打包工具可以自动找到相关的 Wasm 文件。

通过添加-pthread参数,这个语法也可以支持 WebAssembly[10] 线程的编译

$ emcc input.cpp -o output.mjs -pthread
## 如果你不想用mjs扩展名:
$ emcc input.cpp -o output.js -s EXPORT_ES6 -pthread

在这种情况下,生成的Web Worker将以同样的方式被引用,并且也能被打包工具和浏览器正确加载。

通过 wasm-pack / wasm-bindgen 编译的 Rust

wasm-pack[11]--WebAssembly 的主要 Rust 工具链,也有几种输出模式。

默认情况下,它将输出一个依赖于 WebAssembly ESM 集成提议[12]的 JavaScript 模块。在写这篇文章的时候,这个提议仍然是实验性的,只有在使用 Webpack 打包时,输出才会有效。

或者,你可以通过-target web参数要求 wasm-pack 通过输出一个与浏览器兼容的 ES6 模块:

$ wasm-pack build --target web

输出将使用前面所说的new URL(..., import.meta.url)语法,而且 Wasm 文件也会被打包工具自动发现。

如果你想通过 Rust 使用 WebAssembly 线程,这就有点复杂了。请查看指南的相应部分[13]以了解更多。

简而言之,你不能使用任意的线程 API,但如果你使用 Rayon[14],你可以试试wasm-bingen-rayon[15]适配器,这样它就可以生成 Web 上可以运行的 Worker 。wasm-bindgen-rayon使用的 JavaScript 胶水也包括[16]new URL(...)语法,因此 Workers 也能被打包工具发现和引入。

未来的导入方式

import.meta.resolve

有一个潜在的未来改进是专门的 import.meta.resolve(...) 语法。它将允许以一种更直接的方式解析相对于当前模块的内容,而不需要额外的参数。

// 现在的语法
new URL('...', import.meta.url)

// 未来的语法
await import.meta.resolve('...')

它还能与导入依赖图(import maps)还有自定义解析器更好地整合,因为它和import语法通过同一个模块解析系统处理。这对打包工具来说也是一个更可靠的信号,因为它是一个静态语法,不依赖于像URL这样的运行时 API 。

import.meta.resolve已经作为一个实验性功能[17]在 Node.js 中实现了,但是关于它在 Web 上应该如何工作还有一些问题没有定论[18]。

导入断言

导入断言(import assertions)是一项新功能,允许导入 ECMAScript 模块以外的类型,不过现在只支持JSON 类型。

  • foo.json
{ "answer": 42 }
  • main.mjs
import json from './foo.json' assert { type: 'json' };
console.log(json.answer); // 42

(译者注:关于这个不太符合直觉的语法选择也有点意思 https://github.com/tc39/proposal-import-assertions/issues/12)

它们也可能被打包工具使用,并取代目前由new URL语法所支持的场景,但导入断言中的类型需要一个一个被支持,目前被支持的只有 JSON,CSS 模块即将被支持,但其他类型的资源导入仍然需要一个更通用的解决方案。

要想了解更多关于这个功能的信息,请查看 v8.dev上的功能解释[19]。

小结

正如你所看到的,有各种方法可以在网络上包含非 JavaScript 资源,但它们有各自的优缺点,而且都不能同时在所有工具链中工作。一些未来的提议可能会让我们用专门的语法来导入这些资源,但我们还没有走到这一步。

在那一天到来之前,new URL(..., import.meta.url)语法是最有希望的解决方案,并且今天已经可以在浏览器、各种捆绑器和 WebAssembly 工具链中工作。

参考资料

[1]import.meta.url: https://v8.dev/features/modules#import-meta

[2]动态导入: https://v8.dev/features/dynamic-import

[3]代码分块: https://web.dev/reduce-javascript-payloads-with-code-splitting/

[4]Webpack v5: https://webpack.js.org/guides/asset-modules/#url-assets

[5]Rollup: https://rollupjs.org/

[6]@web/rollup-plugin-import-meta-assets: https://modern-web.dev/docs/building/rollup-plugin-import-meta-assets/

[7]@surma/rollup-plugin-off-main-thread: https://github.com/surma/rollup-plugin-off-main-thread

[8]Parcel v2 (beta): https://v2.parceljs.org/languages/javascript/#url-dependencies

[9]Vite: https://vitejs.dev/guide/assets.html#new-url-url-import-meta-url

[10]WebAssembly: https://web.dev/webassembly-threads/#c

[11]wasm-pack: https://github.com/rustwasm/wasm-pack

[12]WebAssembly ESM 集成提议: https://github.com/WebAssembly/esm-integration

[13]相应部分: https://web.dev/webassembly-threads/#rust

[14]Rayon: https://github.com/rayon-rs/rayon

[15]wasm-bingen-rayon: https://github.com/GoogleChromeLabs/wasm-bindgen-rayon

[16]也包括: https://github.com/GoogleChromeLabs/wasm-bindgen-rayon/blob/4cd0666d2089886d6e8731de2371e7210f848c5d/demo/index.js#L26

[17]实验性功能: https://nodejs.org/api/esm.html#esm_import_meta_resolve_specifier_parent

[18]还有一些问题没有定论: https://github.com/WICG/import-maps/issues/79

[19]v8.dev上的功能解释: https://v8.dev/features/import-assertions

本文由哈喽比特于2年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/0GUqwxWEMT9DpxeB4vegOQ

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:8月以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:8月以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:8月以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:8月以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:8月以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:8月以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:8月以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:8月以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:8月以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:8月以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:8月以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:8月以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:8月以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:8月以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:8月以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:8月以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:8月以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:8月以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:8月以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:8月以前  |  398次阅读  |  详细内容 »
 相关文章
Java 中验证时间格式的 4 种方法 1年以前  |  3361次阅读
Java经典面试题答案解析(1-80题) 4年以前  |  2686次阅读
IDEA依赖冲突分析神器—Maven Helper 4年以前  |  2466次阅读
CentOS 配置java应用开机自动启动 3年以前  |  2465次阅读
SpringBoot 控制并发登录的人数教程 4年以前  |  2175次阅读
 目录