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.rhkb.cn/news/365020.html

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

相关文章

【2024-热-办公软件】ONLYOFFICE8.1版本桌面编辑器测评

【2024-热-办公软件】ONLYOFFICE8.1版本桌面编辑器测评

在今日快速发展的数字化办公环境中&#xff0c;选择一个功能全面且高效的办公软件是至关重要的。最近&#xff0c;我有幸体验了ONLYOFFICE 8.1版本的桌面编辑器&#xff0c;这款软件不仅提供了强大的编辑功能&#xff0c;还拥有众多改进&#xff0c;让办公更加流畅和高效。在本…
阅读更多...
【Linux】进程优先级 | 环境变量

【Linux】进程优先级 | 环境变量

目录 Ⅰ. 进程优先级&#xff08;Process Priority&#xff09; 1. 什么是进程优先级&#xff1f; 2. 查看系统进程 3. 修改进程优先级 4.优先级调度原理 Ⅱ. 进程的切换&#xff08;Process Switch&#xff09; 1. 竞争与独立 2. 并行与并发 3. 进程抢占 4.实现切换…
阅读更多...
Python技术笔记汇总（含语法、工具库、数科、爬虫等）

Python技术笔记汇总（含语法、工具库、数科、爬虫等）

对Python学习方法及入门、语法、数据处理、数据可视化、空间地理信息、爬虫、自动化办公和数据科学的相关内容可以归纳如下&#xff1a; 一、Python学习方法 分解自己的学习目标&#xff1a;可以将学习目标分基础知识&#xff0c;进阶知识&#xff0c;高级应用&#xff0c;实…
阅读更多...
医院管理系统带万字文档医院预约挂号管理系统基于spingboot和vue的前后端分离java项目java课程设计java毕业设计

医院管理系统带万字文档医院预约挂号管理系统基于spingboot和vue的前后端分离java项目java课程设计java毕业设计

文章目录 仓库管理系统一、项目演示二、项目介绍三、万字项目文档四、部分功能截图五、部分代码展示六、底部获取项目源码带万字文档&#xff08;9.9&#xffe5;带走&#xff09; 仓库管理系统 一、项目演示 医院管理系统 二、项目介绍 基于springbootvue的前后端分离医院管…
阅读更多...
LabVIEW遇到无法控制国外设备时怎么办

LabVIEW遇到无法控制国外设备时怎么办

当使用LabVIEW遇到无法控制国外产品的问题时&#xff0c;解决此类问题需要系统化的分析和处理方法。以下是详细的解决思路和具体办法&#xff0c;以及不同方法的分析和比较&#xff0c;包括寻求代理、国外技术支持、国内用过的人请教等内容。 1. 了解产品的通信接口和协议 思路…
阅读更多...
如何利用python画出AHP-SWOT的战略四边形（四象限图）

如何利用python画出AHP-SWOT的战略四边形（四象限图）

在企业或产业发展的相关论文分析中&#xff0c;常用到AHP-SWOT法进行定量分析&#xff0c;形成判断矩阵后&#xff0c;如何构造整洁的战略四边形是分析的最后一个环节&#xff0c;本文现将相关代码发布如下&#xff1a; import mpl_toolkits.axisartist as axisartist import …
阅读更多...
基于FPGA的温湿度检测

基于FPGA的温湿度检测

初始化部分就不过多赘述&#xff0c;我会给出对应的文件&#xff0c;我只说明这部分里面涉及到使用的代码部分 1、数据的读取和校验 数据的读取和检验代码如下 always (posedge clk_us)if (data_temp[7:0] data_temp[39:32] data_temp[31:24] data_temp[23:16] data_te…
阅读更多...
centos7 xtrabackup mysql 基本测试（5）mysql 建立 测试 数据库及内容

centos7 xtrabackup mysql 基本测试（5）mysql 建立 测试 数据库及内容

centos7 xtrabackup mysql 基本测试&#xff08;5&#xff09;mysql 建立 测试 数据库及内容 登录 mysql -u etc -p 1234aA~1创建数据库 名字是company show databases ; create database company;在 company里面 创建表employee use company; DROP TABLE IF EXISTS employ…
阅读更多...
vue+canvas画布实现网页签名效果

vue+canvas画布实现网页签名效果

1、签名自定义组件代码示例&#xff1a; qianMing.vue <template><!-- 容器&#xff0c;包含画布和清除按钮 --><div class"signature-pad-container"><!-- 画布元素&#xff0c;用于用户签名 --><canvasref"canvas" <!--…
阅读更多...
C++旋转点坐标计算

C++旋转点坐标计算

/// 获取A点绕B点旋转P度后的新坐标/// </summary>/// <param name"Angle">角度</param>/// <param name"CirPoint">圆心坐标</param>/// <param name"MovePoint">移动点的坐标</param>/// <param…
阅读更多...
成为画图大师，用图表讲故事

成为画图大师，用图表讲故事

这些问题你是否遇到过: 项目总结会上&#xff0c;如果用数据呈现你做的价值&#xff1f; 完善详尽的数据分析得出了让人信服的结论&#xff0c;如何呈现在BOSS面前? 我们要的不是数据&#xff0c;而是数据告诉我们的事实 数据很重要&#xff0c;但只是原料&#xff0c;所以…
阅读更多...
微服务之服务保护策略【持续更新】

微服务之服务保护策略【持续更新】

文章目录 线程隔离一、滑动窗口算法二、漏桶算法三、令牌桶算法 面试题1、Sentinel 限流和Gateway限流的区别 线程隔离 两种实现方式 线程池隔离&#xff08;Hystix隔离&#xff09;&#xff0c;每个被隔离的业务都要创建一个独立的线程池&#xff0c;线程过多会带来额外的CPU…
阅读更多...
大模型笔记1: Longformer环境配置

大模型笔记1: Longformer环境配置

论文: https://arxiv.org/abs/2004.05150 首先保证电脑上配置了git. git环境配置: https://blog.csdn.net/Andone_hsx/article/details/87937329 3.1、找到git安装路径中bin的位置&#xff0c;如&#xff1a;D:\Program Files\Git\bin 找到git安装路径中git-core的…
阅读更多...
Windows应急响应靶机 - Web3

Windows应急响应靶机 - Web3

一、靶机介绍 应急响应靶机训练-Web3 前景需要&#xff1a;小苕在省护值守中&#xff0c;在灵机一动情况下把设备停掉了&#xff0c;甲方问&#xff1a;为什么要停设备&#xff1f;小苕说&#xff1a;我第六感告诉我&#xff0c;这机器可能被黑了。 这是他的服务器&#xff…
阅读更多...
Java 并发编程常见问题

Java 并发编程常见问题

1、线程状态它们之间是如何扭转的&#xff1f; 1、谈谈对于多线程的理解&#xff1f; 1、对于多核CPU&#xff0c;多线程可以提升CPU的利用率&#xff1b; 2、对于多IO操作的程序&#xff0c;多线程可以提升系统的整体性能及吞吐量&#xff1b; 3、使用多线程在一些场景下可…
阅读更多...
浅谈区块链

浅谈区块链

区块链是一种分布式数据库技术&#xff0c;也被称为分布式账本技术。它的本质是一个去中心化的数据库&#xff0c;使用密码学相关联产生的数据块串连而成&#xff0c;用于验证其信息的有效性&#xff08;防伪&#xff09;和生成下一个区块。区块链具有“不可伪造”“全程留痕”…
阅读更多...
模板方法模式在金融业务中的应用及其框架实现

模板方法模式在金融业务中的应用及其框架实现

引言 模板方法模式&#xff08;Template Method Pattern&#xff09;是一种行为设计模式&#xff0c;它在一个方法中定义一个算法的框架&#xff0c;而将一些步骤的实现延迟到子类中。模板方法允许子类在不改变算法结构的情况下重新定义算法的某些步骤。在金融业务中&#xff…
阅读更多...
DataV大屏组件库

DataV大屏组件库

DataV官方文档 DataV组件库基于Vue &#xff08;React版 (opens new window)&#xff09; &#xff0c;主要用于构建大屏&#xff08;全屏&#xff09;数据展示页面即数据可视化&#xff0c;具有多种类型组件可供使用&#xff1a; 源码下载
阅读更多...
一文带你了解乐观锁和悲观锁的本质区别！

一文带你了解乐观锁和悲观锁的本质区别！

文章目录 悲观锁是什么&#xff1f;乐观锁是什么&#xff1f;如何实现乐观锁&#xff1f;什么是CAS应用局限性ABA问题是什么&#xff1f; 悲观锁是什么&#xff1f; 悲观锁它总是假设最坏的情况&#xff0c;它会认为共享资源在每次被访问的时候就会出现线程安全问题&#xff0…
阅读更多...
AI陪伴产品的情感设计：从孤独感到恋爱感评分：9/10

AI陪伴产品的情感设计：从孤独感到恋爱感评分：9/10

本文主要阐述三个话题&#xff1a; 1. 市面上有哪些AI陪伴产品&#xff1f; 2. 我们团队要怎么做&#xff1f; 3. 为什么要做&#xff1f; 市面上有哪些陪伴类产品&#xff1f; Role-play&#xff08;角色扮演&#xff09; 在当前市场上&#xff0c;有不少以角色扮演为核心的…
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023