如何不基于構(gòu)建工具優(yōu)雅的實(shí)現(xiàn)模塊導(dǎo)入?
當(dāng) ES Module? 最開始作為一種新的 JavaScript? 模塊化方案在 ES6? 中被引入的候,其實(shí)是通過在 import 語句中強(qiáng)制指定相對(duì)路徑或絕對(duì)路徑來實(shí)現(xiàn)的。
import dayjs from "https://cdn.skypack.dev/dayjs@1.10.7"; // ES modules
console.log(dayjs("2022-08-12").format("YYYY-MM-DD"));
這和其他常見的模塊化系統(tǒng)(例如 CommonJS?)的工作方式略有不同,并且在使用像 webpack 這樣的模塊打包工具的時(shí)候會(huì)使用更簡單的語法:
const dayjs = require('dayjs') // CommonJS
import dayjs from 'dayjs'; // webpack
在這些系統(tǒng)里,模塊導(dǎo)入語句通過 Node.js? 運(yùn)行時(shí)或相關(guān)構(gòu)建工具映射到特定(版本)的文件。用戶只需要在 import 語句中直接編寫模塊說明符(通常是包名),模塊就可以自動(dòng)處理。
由于開發(fā)人員已經(jīng)熟悉了這種從 npm 導(dǎo)入包的方式,因此必須要先經(jīng)過一個(gè)的構(gòu)建步驟才能確保以這種方式編寫的代碼可以在瀏覽器中運(yùn)行。
Import maps 就可以解決這個(gè)問題,它可以將模塊說明符(包名)自動(dòng)映射到它的相對(duì)或絕對(duì)路徑。從而讓我們不使用構(gòu)建工具也能使用簡潔的模塊導(dǎo)入語法。
如何使用 Import maps
我們可以通過 HTML? 中的 <script type="importmap">? 標(biāo)簽來指定一個(gè) Import maps。
<script type="importmap">
{
"imports": {
"dayjs": "https://cdn.skypack.dev/dayjs@1.10.7",
}
}
</script>
為了成功的在模塊解析之前對(duì)其進(jìn)行解析。這個(gè) script? 標(biāo)簽必須放在文檔中第一個(gè) <script type="module">? 標(biāo)簽之前(最好放在 <head>?中),另外,目前每個(gè) HTML? 只允許編寫一個(gè) Import maps 。
<script type="module">
import dayjs from 'dayjs';
console.log(dayjs("2022-08-12").format("YYYY-MM-DD"));
</script>
在 script? 標(biāo)簽內(nèi),我們可以通過一個(gè) JSON? 對(duì)象來為文檔中的腳本所需導(dǎo)入的模塊指定所有必要的映射。一個(gè)典型的 importmap 結(jié)構(gòu)如下所示:
<script type="importmap">
{
"imports": {
"react": "https://cdn.jsdelivr.net/npm/react/umd/react.production.min.js",
"react-dom": "https://cdn.jsdelivr.net/npm/react-dom/umd/react-dom.production.min.js"
"square": "./modules/square.js",
"lodash": "/node_modules/lodash-es/lodash.js"
}
}
</script>
在上面的 import? 對(duì)象中,每個(gè)屬性對(duì)應(yīng)一個(gè)映射。映射的左側(cè)是導(dǎo)入說明符的名稱(一般是包名),而右側(cè)是說明符需要映射到的相對(duì)或絕對(duì)路徑。在映射中指定相對(duì)路徑時(shí),必須要確保它們始終以 /、../或 ./ 開頭。
另外,importmap? 中聲明的包并不一定意味著它一定會(huì)被瀏覽器加載。頁面上的腳本沒有使用到的任何模塊都不會(huì)被瀏覽器加載,即便你在 importmap 中聲明了它。
編寫好 importmap? 之后,你就可以在后面的腳本中直接使用 ES Module 語法了。
<script type="module">
import { cloneDeep } from 'lodash';
const objects = [{ a: 1 }, { b: 2 }];
const deep = cloneDeep(objects);
console.log(deep[0] === objects[0]);
</script>
外部映射
你還可以在外部文件中指定你的映射,然后使用 script? 的 src? 屬性鏈接到這個(gè)文件(Content-Type Header? 必須要設(shè)置為 application/importmap+json 才能正常加載)。
<script type="importmap" src="importmap.json"></script>
不過盡量不要使用這種方式,因?yàn)樗男阅鼙戎苯觾?nèi)聯(lián)編寫要差。
映射整個(gè)包
除了將一個(gè)說明符映射到模塊之外,你還可以將一個(gè)說明符映射到包含多個(gè)模塊的包:
<script type="importmap">
{
"imports": {
"lodash/": "/node_modules/lodash-es/"
}
}
</script>
這種編寫方式可以讓你直接導(dǎo)入指定路徑中的任何模塊,相應(yīng)的,瀏覽器也會(huì)把所有組件模塊下載下來。
<script type="module">
import toUpper from 'lodash/toUpper.js';
import toLower from 'lodash/toLower.js';
console.log(toUpper('ConardLi'));
console.log(toLower('ConardLi'));
</script>
動(dòng)態(tài)映射
你也可以基于一些條件在 script 中添加一個(gè)動(dòng)態(tài)映射,比如,在下面的示例中我們通過判斷是否存在 IntersectionObserver API 來導(dǎo)入不同文件:
<script>
const importMap = {
imports: {
lazyload: 'IntersectionObserver' in window
? './lazyload.js'
: './lazyload-fallback.js',
},
};
const im = document.createElement('script');
im.type = 'importmap';
im.textContent = JSON.stringify(importMap);
document.currentScript.after(im);
</script>
使用同一模塊的不同版本
使用 importmap 我們可以將不同的版本的模塊映射到不同的包名中:
<script type="importmap">
{
"imports": {
"lodash@3/": "https://unpkg.com/lodash-es@3.10.1/",
"lodash@4/": "https://unpkg.com/lodash-es@4.17.21/"
}
}
</script>
另外你還可以通過 scopes 來實(shí)現(xiàn)同一個(gè)包不同模塊的更細(xì)粒度的版本控制:
<script type="importmap">
{
"imports": {
"lodash/": "https://unpkg.com/lodash-es@4.17.21/"
},
"scopes": {
"/static/js": {
"lodash/": "https://unpkg.com/lodash-es@3.10.1/"
}
}
}
</script>
/static/js? 下的模塊會(huì)使用 3.10.1? 版本,而其他模塊會(huì)使用 4.17.21 版本。
兼容性
這項(xiàng)技術(shù)目前在 Chrome? 和 Edge? 瀏覽器 89? 及更高版本提供了全面支持,但 Firefox、Safari 和一些移動(dòng)瀏覽器還沒有支持。我們可以通過下面的代碼來判斷瀏覽器的支持情況:
if (HTMLScriptElement.supports && HTMLScriptElement.supports('importmap')) {
// import maps is supported
}
對(duì)于沒有提供支持的瀏覽器,我們可以使用下面這個(gè) polyfill:https://github.com/guybedford/es-module-shims
另外官方也推薦了一些其他 importmap? 相關(guān)的 polyfill 和工具:
https://github.com/WICG/import-maps#community-polyfills-and-tooling