import和require如何在项目中混用

2020-04-15 12:32:49

参考地址 干货:import和require如何在项目中混用

虽然我们很清晰的了解了import和require使用上的规范和原则。但是我们去发现我们即使没有遵循规则,我们一样能正常使用。

其实这并不是两套规则能通用,不严谨。

出现这样的问题,要归结与我们的好朋友babel,他在中间做了转换的桥梁,所以我们才能无拘无束的混用他们。


前言

自从js出了es6之后,小伙伴们都在项目中愉快的用起了import,export default,但是,当我们用import方式引入npm第三方模块的时候,却会发现,npm包导出的方式大多是采用了commonjs规范的require,module.exports。这中间babel究竟是如何处理的呢?相信很多小伙伴都有很多问好!那么接下来,我们就来看看这里面的奥秘吧!

module.exports转译

module.exports的使用方法不做过多的说明;来看一下babel编译前和编译后的代码有什么区别。

源文件test.js内容:

1
2
exports.name = "test";
复制代码

经过babel编译后的test.js内容:

1
2
3
"use strict";
exports.name = "test";
复制代码

编译前和编译后,代码并没有多大区别,还是遵循了commonjs规范。

export default转译

关于es6中如何使用export导出模块,这里就不展开叙述了。来看下面一个例子,看看es6export在经过babel转译之后,会变成什么样子:

源文件test.js内容:

1
2
3
4
5
export var a = "test";
export default function(){
    console.log(1)
}
复制代码

经过babel编译后的test.js内容:

1
2
3
4
5
6
7
8
9
10
11
12
"use strict";
 
Object.defineProperty(exports, "__esModule", {
    value: true
});
 
exports.default = function () {
    console.log(1);
};
 
var a = exports.a = "test";
复制代码

从结果可以看出,babel直接把es6规范的export编译成了commonjs规范的module.exports,并且会给exports对象添加一个__esModule的标记,来表明此对象是从es6import转过来的(具体有什么作用,接下来会说明)。

import和require

上面两个例子讲了exportmodule.exports在经过babel编译之后,都变为了commonjs规范的module.exports。接下来我们来说下,在不同场景下,用importrequire导入的时候babel是怎么工作的!

场景一:require导入module.exports模块

这个场景是最简单的,因为两者都遵循了commonjs规范。来看下面一个例子: test.js

1
2
3
4
module.exports = {
    name:"西瓜"
}
复制代码

a.js

1
2
3
var a = require("./test");
console.log(a);
复制代码

babel编译以后的a.js

1
2
3
4
5
6
"use strict";
var a = require("./test");
console.log(a);
 
console.log的值:{ name: '西瓜' }
复制代码

该场景不做过多说明。

场景二:require导入export default模块

该场景就是es6commonjs的混用场景之一了。话不多说,直接上案例。 test.js

1
2
3
4
5
6
export var a = "西瓜";
 
export default function(){
    console.log(1)
}
复制代码

a.js

1
2
3
var a = require("./test");
console.log(a);
复制代码

babel编译以后的a.js

1
2
3
4
5
6
"use strict";
var a = require("./test");
console.log(a);
 
console.log的值:{ default: [Function], a: '西瓜' }
复制代码

为啥是这样的结果呢,上文案例中说了,es6export模块在被babel编译了以后,就转变成了commonjsmodule.exports,所以说,这里require导入export default模块,到后面还是变为require导入module.exports模块了,和场景一一样。

场景三:import导入module.exports模块

这是混用最多的场景了,一般情况下,作为前端人员,写业务代码的时候,更喜欢使用es6自带的export default模块,而发布到npm的第三方包,都是经过编译的,大多遵循了commonjs规范。来看下这种情况下,babel是怎么处理的。

test.js

1
2
3
4
5
module.exports={
    name:"西瓜",
    age:"20"
}
复制代码

a.js

1
2
3
import test from "./test";
console.log(test)
复制代码

babel编译以后的a.js

1
2
3
4
5
6
7
8
9
10
11
12
"use strict";
 
var _test = require("./test");
 
var _test2 = _interopRequireDefault(_test);
 
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
console.log(_test2.default);
 
console.log的值:{ name: '西瓜', age: '20' }
复制代码

可以看到,在这种场景下,多了一个_interopRequireDefault方法包装了一层,该方法内容也很简单,判断了传入的对象中是否存在__esModule属性,如果存在则返回原对象;如果不存在则赋值给新对象的default属性;并且console.log中的值变为了default属性;

那这个地方为什么要这么处理呢?
1.:为什么console.log的值会变为_test2.default?
:对于es6import来说,用import xxx from 'xxx'这种方式引入的值就是目标文件所导出的default值,所以这里编译之后console.log的值变成了_test2.default
2.:为什么要判断是否存在__esModule
:在文章的最前面说过,用export default导出的模块,在经过babel编译后,会给exports加上一个__esModule属性,来证明是es6规范导出的模块。当这里__esModuletrue时,说明的该对象由es6规范的export 导出,由于es6export可以用export default导出默认属性,所以_interopRequireDefault方法直接返回了原对象。当__esModulefalse时,说明的该对象由commonjs规范的module.exports导出,在这种情况下,为了遵循es6import的引入规则,babel在编译时做的一种策略,就是在传入对象的外层做一层default的赋值包装。这样,既保证了import的引入规则,也导出了module.exports的值。

结论
在该场景下,最后console.log的值就是module.exports的值。

场景四:import导入export default模块

这场景就不做过多的解释了,两者都遵循es6规范,直接看文档即可。想要理解这两者在经过babel编译后的引用关系,直接看场景三即可,相信看懂了场景三,结合全文,应该能理解这个过程是怎么一回事了。

拓展

这里说一种场景,就是使用import * as xxx from xxx这种方式去导出所有模块; test.js

1
2
3
4
5
module.exports={
    name:"西瓜",
    age:"20"
}
复制代码

a.js

1
2
3
import * as test from "./test";
console.log(test)
复制代码

babel编译以后的a.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
"use strict";
 
var _test = require("./test");
 
var test = _interopRequireWildcard(_test);
 
function _interopRequireWildcard(obj) {
    if (obj && obj.__esModule) {
        return obj;
    } else {
        var newObj = {};
        if (obj != null) {
            for (var key in obj) {
                if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key];
            }
        }
        newObj.default = obj; return newObj;
    }
}
 
console.log(test);
console.log的值:{ name: '西瓜', age: '20', default: { name: '西瓜', age: '20' } }
复制代码

当采用这种方式去引入module.exports模块时,会用_interopRequireWildcard这个方法去处理。给对象多加了一个default属性挂载了obj,作用和场景三中的_interopRequireDefault方法类似,就不做过多解释啦!

总结

对于es6规范和commonjs规范来说,经过babel编译以后,都会转化成commonjs规范,然后在此基础上,用__esModule区分了是属于es6模块还是commonjs模块。并切为了保证es6规范用import导入值的正确性和统一性,babel还做了一些策略去处理这两者之前的差异。


  • 2019-04-01 22:48:25

    如何用 Java 对 PDF 文件进行电子签章

    印章是我国特有的历史文化产物,古代主要用作身份凭证和行驶职权的工具。它的起源是由于社会生活的实际需要。早在商周时代,印章就已经产生。如今的印章已成为一种独特的,融实用性和艺术性为一体的艺术瑰宝。传统的印章容易被坏人、小人私刻;从而新闻鲜有报道某某私刻公章,侵吞国家财产。随着计算机技术、加密技术及图像处理技术的发展,出现了电子签章。电子签章是电子签名的一种表现形式,利用图像处理技术、数字加密技术将电子签名操作转化为与纸质文件盖章操作相同的可视效果,同时利用电子签名技术保障电子信息的真实性和完整性以及签名人的不可否认性

  • 2019-04-01 22:59:22

    Android Studio 3.0 利用cmake搭建jni环境(很详细哦)

    我用的Android Studio是3.0的版本,然后想搭建一下jni的环境。这里把自己遇到的问题和注意点都记录下。 首先是需要在android studio里面安装最基本的环境。 打开Default Preference里面查看SDK Tool选项。

  • 2019-04-01 23:20:58

    隐藏在图片中的密钥

    在客户端开发的时候,有时需要把密钥保存在本地。这时就会遇到密钥安全性的问题。要保证密钥安全性,无非就是混淆、隐藏、白盒等手段。本文以隐藏在图片中来阐述密钥的安全保存。

  • 2019-04-01 23:22:33

    验证数字签名

    应预先设置验证首选项。在打开 PDF 后显示包含签名的验证详细信息时,这有助于确保数字签名有效。有关详细信息,请参阅设置签名验证首选项。

  • 2019-04-01 23:23:27

    图像隐写之使用PHP隐藏图像中的文本

    隐写术是一门研究隐藏信息的科学艺术,通过隐写术,可以只让发送者和接收者知道隐藏的信息。 图像隐写术则是研究将数据隐藏在图像中,通过该技术可以防止无关用户发现这些隐藏的信息或数据。

  • 2019-04-08 16:01:57

    Window 设置pm2开机自启动服务

    下面用 pm2 来启动我们自己的服务程序 app.js, 然后告诉 pm2 开机后自动运行我 app.js 继续在管理员命令行下, cd 到 app.js 所在目录