原生ES-Module在浏览器中的尝试
其实浏览器原生模块相关的支持也已经出了一两年了(我第一次知道这个事情实在2016年下半年的时候)
可以抛开webpack
直接使用import
之类的语法
但因为算是一个比较新的东西,所以现在基本只能自己闹着玩 :p
但这并不能成为不去了解它的借口,还是要体验一下的。
首先是各大浏览器从何时开始支持module
的:
- Safari 10.1
- Chrome 61
- Firefox 54 (有可能需要你在
about:config
页面设置启用dom.moduleScripts.enabled
) - Edge 16
使用方式
首先在使用上,唯一的区别就是需要在script
标签上添加一个type="module"
的属性来表示这个文件是作为module
的方式来运行的。
<script type="module">
import message from './message.js'
console.log(message) // hello world
</script>
然后在对应的module
文件中就是经常会在webpack
中用到的那样。
语法上并没有什么区别(本来webpack
也就是为了让你提前用上新的语法:) )
message.js
export default 'hello world'
优雅降级
这里有一个类似于noscript
标签的存在。
可以在script
标签上添加nomodule
属性来实现一个回退方案。
<script type="module">
import module from './module.js'
</script>
<script nomodule>
alert('your browsers can not supports es modules! please upgrade it.')
</script>
nomodule
的处理方案是这样的:
支持type="module"
的浏览器会忽略包含nomodule
属性的script
脚本执行。
而不支持type="module"
的浏览器则会忽略type="module"
脚本的执行。
这是因为浏览器默认只解析type="text/javascript"
的脚本,而如果不填写type
属性则默认为text/javascript
。
也就是说在浏览器不支持module
的情况下,nomodule
对应的脚本文件就会被执行。
一些要注意的细节
但毕竟是浏览器原生提供的,在使用方法上与webpack
的版本肯定还是会有一些区别的。
(至少一个是运行时解析的、一个是本地编译)
有效的module路径定义
因为是在浏览器端的实现,不会像在node
中,有全局module
一说(全局对象都在window
里了)。
所以说,from 'XXX'
这个路径的定义会与之前你所熟悉的稍微有些出入。
// 被支持的几种路径写法
import module from 'http://XXX/module.js'
import module from '/XXX/module.js'
import module from './XXX/module.js'
import module from '../XXX/module.js'
// 不被支持的写法
import module from 'XXX'
import module from 'XXX/module.js'
在webpack
打包的文件中,引用全局包是通过import module from 'XXX'
来实现的。
这个实际是一个简写,webpack
会根据这个路径去node_modules
中找到对应的module
并引入进来。
但是原生支持的module
是不存在node_modules
一说的。
所以,在使用原生module
的时候一定要切记,from
后边的路径一定要是一个有效的URL
,以及一定不能省略文件后缀(是的,即使是远端文件也是可以使用的,而不像webpack
需要将本地文件打包到一起)。
module的文件默认为defer
这是script
的另一个属性,用来将文件标识为不会阻塞页面渲染的文件,并且会在页面加载完成后按照文档的顺序进行执行。
<script type="module" src="./defer/module.js"></script>
<script src="./defer/simple.js"></script>
<script defer src="./defer/defer.js"></script>
为了测试上边的观点,在页面中引入了这样三个JS
文件,三个文件都会输出一个字符串,在Console
面板上看到的顺序是这样的:
行内script也会默认添加defer特性
因为在普通的脚本中,defer
关键字是只指针对脚本文件的,如果是inline-script
,添加属性是不生效的。
但是在type="module"
的情况下,不管是文件还是行内脚本,都会具有defer
的特性。
可以对module类型的脚本添加async属性
async
可以作用于所有的module
类型的脚本,无论是行内还是文件形式的。
但是添加了async
关键字以后并不意味着浏览器在解析到这个脚本文件时就会执行,而是会等到这段脚本所依赖的所有module
加载完毕后再执行。
import的约定,必须在一段代码内的起始位置进行声明,且不能够在函数内部进行
也就是说下边的log
输出顺序完全取决于module.js
加载的时长。
<script async type="module" >
import * from './module.js'
console.log('module')
</script>
<script async src="./defer/async.js"></script>
一个module只会加载一次
这个module
是否唯一的定义是资源对应的完整路径是否一致。
如果当前页面路径为https://www.baidu.com/a/b/c.html
,则文件中的/module.js
、../../module.js
与https://www.baidu.com/module.js
都会被认为是同一个module
。
但是像这个例子中的module1.js
与module1.js?a=1
就被认定为两个module
,所以这个代码执行的结果就是会加载两次module1.js
。
<script type="module" src="https://blog.jiasm.org/module-usage/example/modules/module1.js"></script>
<script type="module" src="/examples/modules/module1.js"></script>
<script type="module" src="./modules/module1.js"></script>
<script type="module" src="./modules/module1.js?a=1"></script>
<script type="module">
import * as module1 from './modules/module1.js'
</script>
import和export在使用的一些小提示
不管是浏览器原生提供的版本,亦或者webpack
打包的版本。import
和export
基本上还是共通的,语法上基本没有什么差别。
下边列出了一些可能会帮到你更好的去使用modules
的一些技巧。
export的重命名
在导出某些模块时,也是可以像import
时使用as
关键字来重命名你要导出的某个值。
// info.js
let name = 'Niko'
let age = 18
export {
name as firstName,
age
}
// import
import {firstName, age} from './info.js'
Tips: export的调用不像node中的module.exports = {}
可以进行多次调用,而且不会覆盖(key重名除外)。
export { name as firstName }
export { age }
这样的写法两个key都会被导出。
export导出的属性均为可读的
也就是说export
导出的属性是不能够修改的,如果试图修改则会得到一个异常。
但是,类似const
的效果,如果某一个导出的值是引用类型的,对象或者数组之类的。
你可以操作该对象的一些属性,例如对数组进行push
之类的操作。
export {
firstName: 'Niko',
packs: [1, 2]
}
import * as results from './export-editable.js'
results.firstName = 'Bellic' // error
results.packs.push(3) // success
这样的修改会导致其他引用该模块都会受到影响,因为使用的是一个地址。
export在代码中的顺序并不影响最终导出的结果
export const name = 'Niko'
export let age = 18
age = 20
const 或者 let 对于 调用方来说没有任何区别
import {name, age} from './module'
console.log(name, age) // Niko 20
import获取default模块的几种姿势
获取default
有以下几种方式都可以实现:
import defaultItem from './import/module.js'
import { default as defaultItem2 } from './import/module.js'
import _, { default as defaultItem3 } from './import/module.js'
console.log(defaultItem === defaultItem2) // true
console.log(defaultItem === defaultItem3) // true
默认的规则是第一个为default
对应的别名,但如果第一个参数是一个解构的话,就会被解析为针对所有导出项的一个匹配了。
P.S. 同时存在两个参数表示第一个为default,第二个为全部模块
导出全部的语法如下:
import * as allThings from './iport/module.js'
类似index的export文件编写
如果你碰到了类似这样的需求,在某些地方会用到十个module
,如果每次都import
十个,肯定是一种浪费,视觉上也会给人一个不好的感觉。
所以你可能会写一个类似index.js
的文件,在这个文件中将其引入到一块,然后使用时import index
即可。
一般来说可能会这么写:
import module1 from './module1.js'
import module2 from './module2.js'
export default {
module1,
module2
}
将所有的module
引入,并导出为一个Object
,这样确实在使用时已经很方便了。
但是这个索引文件依然是很丑陋,所以可以用下面的语法来实现类似的功能:
export {default as module1} from './module1.js'
export {default as module2} from './module2.js'
然后在调用时修改为如下格式即可:
import * as modules from './index.js'
小记
想到了最近爆红的deno
,其中有一条特性也是提到了,没有node_modules
,依赖的第三方库直接通过网络请求的方式来获取。
然后浏览器中原生提供的module
也是类似的实现,都是朝着更灵活的方向在走。
祝愿抛弃webpack
来进行开发的那一天早日到来 :)
参考资料
文中示例代码的GitHub仓库:传送阵