Node 学习中一些小知识的集合:require是什么?
Node中没搞明白require和import,你会被坑的很惨
ES6标准发布后,module
成为标准,标准的使用是以export
指令导出接口,以import
引入模块,但是在我们一贯的node
模块中,我们采用的是CommonJS规范
,使用require
引入模块,使用module.exports
导出接口。
不把require
和import
整清楚,会在未来的标准编程中死的很难看。
require时代的模块
node
编程中最重要的思想之一就是模块,而正是这个思想,让JavaScript
的大规模工程成为可能。模块化编程在js
界流行,也是基于此,随后在浏览器端,requirejs
和seajs
之类的工具包也出现了,可以说在对应规范下,require
统治了ES6
之前的所有模块化编程,即使现在,在ES6 module
被完全实现之前,还是这样。node
的module
遵循CommonJS规范
,requirejs
遵循AMD
,seajs
遵循CMD
,虽各有不同,但总之还是希望保持较为统一的代码风格。
1 | // a.js |
可以看出,为了保持风格的高度统一,除了在浏览器端的模块中要使用一个define函数来提供模块的闭包以外,其他代码可以完全一致。
1 | // b.js |
在使用上,也非常相似。虽然AMD
or CMD
提供了更加丰富的风格,但是我们本文主要是讨论node环境下,所以不做扩展。
ES6中的module
ES6
发布的module
并没有直接采用CommonJS
,甚至连require
都没有采用,也就是说require
仍然只是node
的一个私有的全局方法,module.exports
也只是node
私有的一个全局变量属性,跟标准半毛钱关系都没有。
export导出模块接口
export
的用法挺复杂的,具体有哪些可以看这里。这里举几个例子:
1 | // a.js |
在要导出的接口前面,加入export指令
。
在export
之后,b
还可以被修改,这和CommonJS
有着巨大不同,关于内部机理的东西,本文就无耻的省略了。
注意,下面的语法有严重错误:
1 | // 错误演示 |
export在导出接口的时候,必须与模块内部的变量具有一一对应的关系。直接导出1没有任何意义,也不可能在import的时候有一个变量与之对应。export a
虽然看上去成立,但是a
的值是一个数字,根本无法完成解构,因此必须写成export {a}
的形式。即使a
被赋值为一个function
,也是不允许的。而且,大部分风格都建议,模块中最好在末尾用一个export
导出所有的接口,例如:
1 | export {fun as default,a,b,c}; |
import导入模块
import
的语法跟require
不同,而且import
必须放在文件的最开始,且前面不允许有其他逻辑代码,这和其他所有编程语言风格一致。
import
的使用和export
一样,也挺复杂,可以在这里大致了解。举几个例子:
1 | import $ from 'jquery'; |
这里有一些坑,暂时不透露,下面会讲到。import
后面跟上花括号的形式是最基本的用法,花括号里面的变量与export
后面的变量一一对应。这里,你必须了解对象的解构赋值的知识,没这知识,你根本没法在这里装逼。了解了解构赋值,这里的“一一对应”的关系就能具体理解了。
as关键字
编程的同学对as
都容易理解,简单的说就是取一个别名。export
中可以用,import
中其实可以用:
1 | // a.js |
上面这段代码,export
的时候,对外提供的接口是fun
,它是a.js
内部a
这个函数的别名,但是在模块外面,认不到a
,只能认到fun
。import
中的as
就很简单,就是你在使用模块里面的方法的时候,给这个方法取一个别名,好在当前的文件里面使用。之所以是这样,是因为有的时候不同的两个模块可能通过相同的接口,比如有一个c.js
也通过了fun
这个接口:
1 | // c.js |
如果在b.js
中同时使用a
和c
这两个模块,就必须想办法解决接口重名的问题,as
就解决了。
default关键字
其他人写教程什么的,都把default
放到export
那个部分,我觉得不利于理解。在export
的时候,可能会用到default
,说白了,它其实是别名的语法糖:
1 | // d.js |
在import的时候,可以这样用:
1 | import a from './d'; |
这个语法糖的好处就是import
的时候,可以省去花括号{}
。简单的说,如果import的时候,你发现某个变量没有花括号括起来(没有*号),那么你在脑海中应该把它还原成有花括号的as
语法。
所以,下面这种写法你也应该理解了吧:
1 | import $,{each,map} from 'jquery'; |
import后面第一个$
是{defalut as $}
的替代写法。
*
符号
*
就是代表所有,只用在import中,我们看下两个例子:
1 | import * as _ from '_'; |
在意义上和import _ from '_'
;是不同的,虽然实际上后面的使用方法是一样的。它表示的是把’_’模块中的所有接口挂载到_这个对象上,所以可以用_.each
调用某个接口。
另外还可以通过*号直接继承某一个模块的接口:
1 | export * from '_'; |
*
符号尽可能少用,它实际上是使用所有export的接口,但是很有可能你的当前模块并不会用到所有接口,可能仅仅是一个,所以最好的建议是使用花括号,用一个加一个。
该用require还是import?
require
的使用非常简单,它相当于module.exports
的传送门,module.exports
后面的内容是什么,require
的结果就是什么,对象、数字、字符串、函数……再把require
的结果赋值给某个变量,相当于把require
和module.exports
进行平行空间的位置重叠。
而且require
理论上可以运用在代码的任何地方,甚至不需要赋值给某个变量之后再使用,比如:
1 | require('./a')(); // a模块是一个函数,立即执行a模块函数 |
你在使用时,完全可以忽略模块化这个概念来使用require,仅仅把它当做一个node内置的全局函数,它的参数甚至可以是表达式:
1 | require(process.cwd() + '/a'); |
但是import
则不同,它是编译时的(require
是运行时的),它必须放在文件开头,而且使用格式也是确定的,不容置疑。它不会将整个模块运行后赋值给某个变量,而是只选择import的接口进行编译,这样在性能上比require
好很多。
从理解上,require
是赋值过程,import
是解构过程,当然,require
也可以将结果解构赋值给一组变量,但是import
在遇到default
时,和require
则完全不同:var $ = require('jquery');
和import $ from 'jquery'
是完全不同的两种概念。
上面完全没有回答“改用require
还是import
?”这个问题,因为这个问题就目前而言,根本没法回答,因为目前所有的引擎都还没有实现import,我们在node
中使用babel
支持ES6
,也仅仅是将ES6转码为ES5再执行,import
语法会被转码为require
。这也是为什么在模块导出时使用module.exports
,在引入模块时使用import
仍然起效,因为本质上,import
会被转码为require
去执行。
但是,我们要知道这样一个道理,ES7
很快也会发布,js引擎
们会尽快实现ES6标准
的规定,如果一个引擎连标准都实现不了,就会被淘汰,ES6
是迟早的事。如果你现在仍然在代码中部署require
,那么等到ES6被引擎支持时,你必须升级你的代码,而如果现在开始部署import
,那么未来可能只需要做很少的改动。
本节说明
本文搜集自网络,作者:IMWeb 否子戈,原文出处:IMWeb社区 ,搜集至此只为方便日后阅读学习。