Vite: 高阶特性 Pure ESM

概述

  • ESM 已经逐步得到各大浏览器厂商以及 Node.js 的原生支持，正在成为主流前端模块化方案。
    而 Vite 本身就是借助浏览器原生的 ESM 解析能力( type=“module” )实现了开发阶段的 no-bundle ，即不用打包也可以构建 Web 应用。不过我们对于原生 ESM 的理解仅仅停留在 type=“module” 这个特性上面未免有些狭隘了，一方面浏览器和 Node.js 各自提供了不同的 ESM 使用特性，如 import maps 、package.json 的 imports 和exports 属性等等，另一方面前端社区开始逐渐向 ESM 过渡，有的包甚至仅留下 ESM产物， Pure ESM 的概念随之席卷前端圈，而与此同时，基于 ESM 的 CDN 基础设施也如雨后春笋般不断涌现，诸如 esm.sh 、 skypack 、 jspm 等等。
  • 因此你可以看到，ESM 已经不仅仅局限于一个模块规范的概念，它代表了前端社区生态的走向以及各项前端基础设施的未来，不管是浏览器、Node.js 还是 npm 上第三方包生态的发展，无一不在印证这一点。那么，作为一名 2022 年的前端，我觉得深入地了解ESM 的高级特性、社区生态都是有必要的，一方面弥补自己对于 ESM 认知上的不足，另一方面也能享受到社区生态带给我们的红利。在接下来的内容中，我将给你详细介绍浏览器和 Node.js 中基于 ESM 实现的一些 高级特性 ，然后分析什么是 Pure ESM 模式，这种模式下存在哪些痛点，以及我们作为开发者，如何去拥抱 Pure ESM 的趋势。

高阶特性


1 ）import map

  • 在浏览器中我们可以使用包含 type=“module” 属性的 script 标签来加载 ES 模块，而模块路径主要包含三种:
    • 绝对路径，如 https://cdn.skypack.dev/react
    • 相对路径，如 ./module-a
    • bare import 即直接写一个第三方包名，如 react 、 lodash
  • 对于前两种模块路径浏览器是原生支持的，而对于 bare import ，在 Node.js 能直接执行，因为 Node.js 的路径解析算法会从项目的 node_modules 找到第三方包的模块路径，但是放在浏览器中无法直接执行。而这种写法在日常开发的过程又极为常见，除了将bare import 手动替换为一个绝对路径，还有其它的解决方案吗？
  • 答案是有的。现代浏览器内置的 import map 就是为了解决上述的问题，我们可以用一个简单的例子来使用这个特性
    <!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Document</title>
</head>
<body><div id="root"></div><script type="importmap">{"imports": {"react": "https://cdn.skypack.dev/react"}}</script><script type="module">import React from 'react';console.log(React)</script>
</body>
</html>
  • 在浏览器中执行这个 HTML，如果正常执行，那么你可以看到浏览器已经从网络中获取
    了 react 的内容，如下图所示
  • 注意: importmap 可能存在浏览器兼容性问题，这里出现浏览器报错也属于正常情况，后文会介绍解决方案。

在这里插入图片描述

  • 在支持 import map 的浏览器中，在遇到 type=“importmap” 的 script 标签时，浏览器会记录下第三方包的路径映射表，在遇到 bare import 时会根据这张表拉取远程的依赖代码。如上述的例子中，我们使用 skypack 这个第三方的 ESM CDN 服务，通过 https://cdn.skypack.dev/react 这个地址我们可以拿到 React 的 ESM 格式产物。import map 特性虽然简洁方便，但浏览器的兼容性却是个大问题，在 CanIUse 上的兼容性数据如下:

请添加图片描述

  • 它只能兼容市面上 68% 左右的浏览器份额，而反观 type=“module” 的兼容性(兼容 95%
    以上的浏览器)， import map 的兼容性实属不太乐观。但幸运的是，社区已经有了对应的
    Polyfill 解决方案——es-module-shims，完整地实现了包含 import map 在内的各大ESM 特性，还包括:

    • dynamic import 。即动态导入，部分老版本的 Firefox 和 Edge 不支持

    • import.meta 和 import.meta.url 。当前模块的元信息，类似 Node.js 中的 __dirname 、 __filename

    • modulepreload 。以前我们会在 link 标签中加上 rel=“preload” 来进行资源预加载，即在浏览器解析 HTML 之前就开始加载资源，现在对于 ESM 也有对应的modulepreload 来支持这个行为

    • JSON Modules 和 CSS Modules ，即通过如下方式来引入 json 或者 css :

      <script type="module">
// 获取 json 对象
import json from 'https://site.com/data.json' assert { type: 'json' };
// 获取 CSS Modules 对象
import sheet from 'https://site.com/sheet.css' assert { type: 'css' };
</script>
  • 值得一提的是， es-module-shims 基于 wasm 实现，性能并不差，相比浏览器原生的行
    为没有明显的性能下降, 可以去这个地址查看具体的 benchmark 结果
  • 由此可见， import map 虽然并没有得到广泛浏览器的原生支持，但是我们仍然可以通过Polyfill 的方式在支持 type=“module” 的浏览器中使用 import map

2 ) Nodejs 包导入导出策略

  • 在 Node.js 中( >=12.20 版本 )有一般如下几种方式可以使用原生 ES Module:

    • 文件以 .mjs 结尾；
    • package.json 中声明 type: “module” 。

  • 那么，Nodejs 在处理 ES Module 导入导出的时候，如果是处理 npm 包级别的情况，其中的细节可能比你想象中更加复杂。

  • 首先来看看如何导出一个包，你有两种方式可以选择: main 和 exports 属性。这两个属性均来自于 package.json ，并且根据 Node 官方的 resolve 算法，exports 的优先级 main 更高，也就是说如果你同时设置了这两个属性，那么 exports 会优先生效。

  • main 的使用比较简单，设置包的入口文件路径即可，如: "main": "./dist/index.js"

  • 需要重点梳理的是 exports 属性，它包含了多种导出形式: 默认导出 、 子路径导出 和 条件导出 ，这些导出形式如以下的代码所示:

    // package.json
{"name": "package-a","type": "module","exports": {// 默认导出，使用方式: import a from 'package-a'".": "./dist/index.js",// 子路径导出，使用方式: import d from 'package-a/dist'"./dist": "./dist/index.js","./dist/*": "./dist/*", // 这里可以使用 `*` 导出目录下所有的文件// 条件导出，区分 ESM 和 CommonJS 引入的情况"./main": {"import": "./main.js","require": "./main.cjs"},}
}

  • 其中，条件导出可以包括如下常见的属性:

    • node : 在 Node.js 环境下适用，可以定义为嵌套条件导出，如:
      {"exports": {{".": {"node": {"import": "./main.js","require": "./main.cjs"}     }}},
}
    • import : 用于 import 方式导入的情况，如 import(“package-a”) ;
    • require : 用于 require 方式导入的情况，如 require(“package-a”) ;
    • default ，兜底方案，如果前面的条件都没命中，则使用 default 导出的路径

  • 当然，条件导出还包含 types 、 browser 、 develoment 、 production 等属性，大家可以参考 Node.js 的详情文档，这里就不一一赘述了。

  • 在介绍完"导出"之后，我们再来看看 “导入” ，也就是 package.json 中的 imports 字段，一般是这样声明的:

    {"imports": {// key 一般以 # 开头// 也可以直接赋值为一个字符串: "#dep": "lodash-es""#dep": {"node": "lodash-es","default": "./dep-polyfill.js"},},"dependencies": {"lodash-es": "^4.17.21"}
}

  • 这样你可以在自己的包中使用下面的 import 语句:

    // index.js
import { cloneDeep } from "#dep";
const obj = { a: 1 };
// { a: 1 }
console.log(cloneDeep(obj));

  • Node.js 在执行的时候会将 #dep 定位到 lodash-es 这个第三方包，当然，你也可以将其定位到某个内部文件。这样相当于实现了 路径别名 的功能，不过与构建工具中的 alias 功能不同的是，“imports” 中声明的别名必须全量匹配，否则 Node.js 会直接抛错。

Pure ESM


首先，什么是 Pure ESM ? Pure ESM 最初是在 Github 上的一个帖子中被提出来的，其中有两层含义，一个是让 npm 包都提供 ESM 格式的产物，另一个是仅留下 ESM 产物，抛弃 CommonJS 等其它格式产物


1 ) 对 Pure ESM 的态度

  • 当这个概念被提出来之后社区当中出现了很多不同的声音，有人赞成，也有人不满。但不
    管怎么样，社区中的很多 npm 包已经出现了 ESM First 的趋势，可以预见的是越来越多的包会提供 ESM 的版本，来拥抱社区 ESM 大一统的趋势，同时也有一部分的 npm包做得更加激进，直接采取 Pure ESM 模式，如大名鼎鼎的 chalk 和 imagemin ，最新版本中只提供 ESM 产物，而不再提供 CommonJS 产物。对于 Pure ESM，我们到底应该支持还是反对呢？

  • 首先抛出结论:

    • 对于没有上层封装需求的大型框架，如 Nuxt、Umi，在保证能上 Pure ESM 的情况下，直接上不会有什么问题
    • 但如果是一个底层基础库，最好提供好 ESM 和 CommonJS 两种格式的产物

  • 接下来，我们就来分析这个结论是怎么得出来的, 在 ESM 中，我们可以直接导入 CommonJS 模块，如

    // react 仅有 CommonJS 产物
import React from 'react';
console.log(React)

  • Node.js 执行以上的原生 ESM 代码并没有问题，但反过来，如果你想在 CommonJS 中
    require 一个 ES 模块，就行不通了:
    在这里插入图片描述

  • 其根本原因在于 require 是同步加载的，而 ES 模块本身具有异步加载的特性，因此两者
    天然互斥，即我们无法 require 一个 ES 模块

  • 那是不是在 CommonJS 中无法引入 ES 模块了呢? 也不尽然，我们可以通过 dynamic import 来引入:
    在这里插入图片描述

  • 不知道你注意到没有，为了引入一个 ES 模块，我们必须要将原来同步的执行环境改为 异步 的，这就带来如下的几个问题:

    • 如果执行环境不支持异步，CommonJS 将无法导入 ES 模块；
    • jest 中不支持导入 ES 模块，测试会比较困难；
    • 在 tsc 中，对于 await import() 语法会强制编译成 require 的语法(详情)，只能靠 eval(‘await import()’) 绕过去。

  • 总而言之，CommonJS 中导入 ES 模块比较困难。因此，如果一个基础底层库使用 Pure ESM ，那么潜台词相当于你依赖这个库时(可能是直接依赖，也有可能是间接依赖)，你自己的库/应用的产物最好为 ESM 格式。也就是说， Pure ESM 是具有传染性的，底层的库出现了 Pure ESM 产物，那么上层的使用方也最好是 Pure ESM，否则会有上述的种种限制。

  • 但从另一个角度来看，对于大型框架(如 Nuxt)而言，基本没有二次封装的需求，框架本身如果能够使用 Pure ESM ，那么也能带动社区更多的包(比如框架插件)走向 Pure ESM，同时也没有上游调用方的限制，反而对社区 ESM 规范的推动是一件好事情。

  • 当然，上述的结论也带来了一个潜在的问题: 大型框架毕竟很有限，npm 上大部分的包还是属于基础库的范畴，那对于大部分包，我们采用导出 ESM/CommonJS 两种产物的方案，会不会对项目的语法产生限制呢？

  • 我们知道，在 ESM 中无法使用 CommonJS 中的 __dirname 、 __filename 、require.resolve 等全局变量和方法，同样的，在 CommonJS 中我们也没办法使用ESM 专有的 import.meta 对象，那么如果要提供两种产物格式，这些模块规范相关的语法怎么处理呢？在传统的编译构建工具中，我们很难逃开这个问题，但新一代的基础库打包器 tsup 给了我们解决方案

2 ) 新一代的基础库打包器

  • tsup 是一个基于 Esbuild 的基础库打包器，主打无配置(no config)打包。借助它我们可以轻易地打出 ESM 和 CommonJS 双格式的产物，并且可以任意使用与模块格式强相关的一些全局变量或者 API，比如某个库的源码如下:
    export interface Options {data: string;
}
export function init(options: Options) {console.log(options);console.log(import.meta.url);
}
  • 由于代码中使用了 import.meta 对象，这是仅在 ESM 下存在的变量，而经过 tsup 打包后的 CommonJS 版本却被转换成了下面这样:
    var getImportMetaUrl = () =>typeof document === "undefined" ?new URL("file:" + __filename).href :(document.currentScript && document.currentScript.src) ||new URL("main.js", document.baseURI).href;
var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
// src/index.ts
function init(options) {console.log(options);console.log(importMetaUrl);
}
  • 可以看到，ESM 中的 API 被转换为 CommonJS 对应的格式，反之也是同理。最后，我们可以借助之前提到的条件导出，将 ESM、CommonJS 的产物分别进行导出，如下所示
    {"scripts": {"watch": "npm run build -- --watch src","build": "tsup ./src/index.ts --format cjs,esm --dts --clean"},"exports": {".": {"import": "./dist/index.mjs","require": "./dist/index.js",// 导出类型"types": "./dist/index.d.ts"}}
}
  • tsup 在解决了双格式产物问题的同时，本身利用 Esbuild 进行打包，性能非常强悍，也能生成类型文件，同时也弥补了 Esbuild 没有类型系统的缺点，还是非常推荐大家使用的
  • 当然，回到 Pure ESM 本身，我觉得这是一个未来可以预见的趋势，但对于基础库来说，现在并不适合切到 Pure ESM ，如今作为过渡时期，还是发 ESM/CommonJS 双格式的包较为靠谱，而 tsup 这种工具能降低基础库构建上的成本。当所有的库都有 ESM 产物的时候，我们再来落地 Pure ESM 就轻而易举了

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

综合评价类模型——突变级数法

综合评价类模型——突变级数法

含义 首先&#xff1a;对评价目标进行多层次矛盾分解其次&#xff1a;利用突变理论和模糊数学相结合产生突变模糊隶属函数再次&#xff1a;由归一公式进行综合量化运算最终&#xff1a;归一为一个参数&#xff0c;即求出总的隶属函数&#xff0c;从而对评价目标进行排序分析特点…
阅读更多...
成都市水资源公报（2000-2022年）

成都市水资源公报（2000-2022年）

数据年限&#xff1a;2000-2022年&#xff0c;无2009年 数据格式&#xff1a;pdf、word、jpg 数据内容&#xff1a;降水量、地表水资源量、地下水资源量、水资源总量、蓄水状况、平原区浅层地下水动态、水资源情况分析、供水量、用水量、污水处理、洪涝干旱等
阅读更多...
类似李跳跳的软件有什么，强烈推荐所有安卓手机安装！！！

类似李跳跳的软件有什么，强烈推荐所有安卓手机安装！！！

今天阿星分享一款让安卓手机更顺滑的神器——智慧岛。你问我李跳跳&#xff1f;由于大家都知道的原因&#xff0c;那是个曾经让广告无处遁形的神兵利器&#xff0c;可惜现在它已经退休了。不过别担心&#xff0c;智慧岛接过了接力棒&#xff0c;继续为我们的安卓体验保驾护航。…
阅读更多...
Raccon：更好防侧信道攻击的后量子签名方案

Raccon：更好防侧信道攻击的后量子签名方案

1. 引言 安全社区已经开发出了一些出色的加密算法&#xff0c;这些算法非常安全&#xff0c;但最终&#xff0c;所有的数据都会被存储在硅和金属中&#xff0c;而入侵者越来越多地会在那里放置监视器来破解密钥。 破解加密密钥通常涉及暴力破解方法或利用实施过程中的缺陷。然…
阅读更多...
2029年AI服务器出货量将突破450万台，AI推理服务器即将爆发式增长

2029年AI服务器出货量将突破450万台，AI推理服务器即将爆发式增长

在2020年&#xff0c;新冠疫情与远程办公模式的兴起推动了所有类型服务器的出货量达到峰值&#xff0c;随后几年里&#xff0c;除了AI服务器之外的所有类别都回归到了正常水平。 根据Omdia的研究数据&#xff0c;AI服务器的出货量在2020年急剧上升&#xff0c;并且至今未显示出…
阅读更多...
日志的介绍

日志的介绍

知识铺垫&#xff1a;在我们日常开发中&#xff0c;其实日志是和我们息息相关的。但可能平常都没怎么注意到日志相关的知识点&#xff0c;也不怎么关注日志&#xff0c;然后&#xff0c;在生产环境中&#xff0c;日志是必不可少的存在&#xff0c;项目出现问题了都是通过日志来…
阅读更多...
cesium 添加 Echarts 图层（空气质量点图）

cesium 添加 Echarts 图层（空气质量点图）

cesium 添加 Echarts 图层（下面附有源码） 1、实现思路 1、在scene上面新增一个canvas画布 2、通坐标转换，将经纬度坐标转为屏幕坐标来实现 3、将ecarts 中每个series数组中元素都加 coordinateSystem: ‘cesiumEcharts’ 2、示例代码 <!DOCTYPE html> <html lan…
阅读更多...
Excel 数据筛选难题解决

Excel 数据筛选难题解决

人不走空 &#x1f308;个人主页&#xff1a;人不走空 &#x1f496;系列专栏&#xff1a;算法专题 ⏰诗词歌赋&#xff1a;斯是陋室&#xff0c;惟吾德馨 目录 &#x1f308;个人主页&#xff1a;人不走空 &#x1f496;系列专栏&#xff1a;算法专题 ⏰诗词歌…
阅读更多...
图形化用户界面-java头歌实训

图形化用户界面-java头歌实训

图形化用户界面 import java.awt.*; import javax.swing.*; public class GraphicsTester extends JFrame { public GraphicsTester() { super("Graphics Demo"); setSize(480, 300); setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); } public void paint…
阅读更多...
服务器raid5坏盘-换盘-修复阵列过程

服务器raid5坏盘-换盘-修复阵列过程

目录 背景原因分析解决步骤名词解释进入raid管理界面换回旧4号&#xff0c;进行import再次更换4号盘 总结 背景 服务器除尘之后文件服务器部分文件不能访问了,部分文件夹内容为空&#xff0c;起初以为是新配置的权限的问题&#xff0c;排查之后发现不仅仅是权限问题 jumpserv…
阅读更多...
VTK学习日志：基于VTK9.3.0+Visual Studio c++实现DICOM影像MPR多平面重建+V R体绘制4个视图展示功能的实现(二)

VTK学习日志：基于VTK9.3.0+Visual Studio c++实现DICOM影像MPR多平面重建+V R体绘制4个视图展示功能的实现(二)

前段时间对VTK9.3.0进行了编译&#xff0c;开发了MPRVR实现的demo,显示效果不是很理想&#xff0c;正好趁着周末有时间&#xff0c;再度对之前的程序进行优化和完善&#xff0c;先展示下效果&#xff1a; VTK实现MPRVR四视图 再次讲解下基于VTK的MPRVR实现的简单项目创建过程&a…
阅读更多...
Linux安装Node-RED并实现后台运行及开机启动

Linux安装Node-RED并实现后台运行及开机启动

首先确保系统中已近成功安装Node.js&#xff0c;并保证需要的合适版本&#xff1a; 关于node.js的安装可以参考我的另一篇博文:《AliyunOS安装Node.js》。 然后就可以使用npm工具安装Node-RED了&#xff0c;很简单使用如下命令&#xff1a; sudo npm install -g --unsafe-per…
阅读更多...
MATLAB使用系统辨识工具箱建立PID水温的传递函数系数

MATLAB使用系统辨识工具箱建立PID水温的传递函数系数

概述 利用PID控制水温&#xff0c;由于实际在工程项目中&#xff0c;手动调节PID参数比较耗费时间&#xff0c;所以可以先利用MATLAB中的Simulink软件建立模型&#xff0c;先在仿真软件上调节大概的PID参数&#xff0c;再利用此PID参数为基础在实际的工程项目中手动调节PID参数…
阅读更多...
这些并发编程技术你都知道吗？

这些并发编程技术你都知道吗？

与其碌碌无为&#xff0c;不如兴风作浪。 虽然不是所有的系统都需要很多的并发编程技术&#xff0c;但是掌握常见的高并发秘籍&#xff0c;便能让我们的系统快起来&#xff0c;面对访问量的剧增从容应对。 接下来&#xff0c;为我们一起来看看常见的高并发技术有哪些。总结起来…
阅读更多...
SSH版本升级-openssh-9.7p1

SSH版本升级-openssh-9.7p1

SSH版本升级-openssh-9.7p1 1、查看当前版本2、安装openssl2.1、编译安装ssl 3、下载新版本SSH4、备份原有的SSH配置5、上传文件并解压6、卸载原有的openssh包7、编译安装openssh7.1、在解压后的目录&#xff0c;初始化openssh7.2、将文件拷回7.3、修改配置文件 最终实现&#…
阅读更多...
DDD学习笔记五

DDD学习笔记五

模型引力场&#xff1a;聚合 强作用力体现&#xff1a; 某个领域模型是另一些模型存在的前提&#xff0c;没有前者&#xff0c;后者就失去了生存的意义。 一组领域模型之间存在关联的领域逻辑&#xff0c;任何时候都不能违反。 一组领域模型必须以一个完整的、一致的状态呈现给…
阅读更多...
CSDN写文章时需要上、下标字号怎么输？

CSDN写文章时需要上、下标字号怎么输？

上标&#xff1a;​^^&#xff0c;符号中间加字 下标&#xff1a;~~&#xff0c;符号中间加字 前题是用MD编辑器&#xff0c;不然白搭&#xff1a; 我是感觉CSDN这个文本编辑比较拉&#xff0c;非常想吐槽。
阅读更多...
dB分贝入门

dB分贝入门

主要参考资料&#xff1a; dB&#xff08;分贝&#xff09;定义及其应用: https://blog.csdn.net/u014162133/article/details/110388145 目录 dB的应用一、声音的大小二、信号强度三、增益 dB的应用 一、声音的大小 在日常生活中&#xff0c;住宅小区告知牌上面标示噪音要低…
阅读更多...
vue2 element ui 表单 动态增加表单项 表单项值不可重复 select多选

vue2 element ui 表单 动态增加表单项 表单项值不可重复 select多选

案例 <template><el-form :model"form" ref"form" label-width"70px"><el-form-item><el-button icon"el-icon-plus" type"primary" plain click"add">新增</el-button><el-b…
阅读更多...
VUE3-Elementplus-form表单-笔记

VUE3-Elementplus-form表单-笔记

1. 结构相关 el-row表示一行&#xff0c;一行分成24份 el-col表示列 (1) :span"12" 代表在一行中&#xff0c;占12份 (50%) (2) :span"6" 表示在一行中&#xff0c;占6份 (25%) (3) :offset"3" 代表在一行中&#xff0c;左侧margin份数 el…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023