JS 中 import 与 require 的小坑

前几天写测试代码的时候遇到了一个 Bug 苦思不得其解。最后才发现尽然是用新的 ES6 中的 import 代替老的 require 引起的。所以下来花了一点时间来研究一下两者的区别。

神奇的 Bug

先来看一看这个神奇的 Bug。在example.js 文件中用 CommonJS 的 require 方式引用了一个 helper 文件,而这个文件中封装了 window 等对象:

//helper 中封装了 window 等对象 
const {window} = require('src/helpers');

而在测试文件exampleSpecs.js中有这样一个测试,它在 beforeEach 中修改了 helper 中的 window 对象:

...
describe('example', () => {
      beforeEach(() => {
        const helpers = require('src/helpers');
        helpers.window = {navigator: {onLine: true}};
      });

      it('description...', () => {
        //testCode
      });

然后我在重构代码的时候用 ES6 语法 import 代替 CommonJS 语法 require

import {window, location} from 'src/helpers';

此时测试报错:Cannot read property 'state' of undefined。 错误中的statewindow对象下的一个属性。

现在可以进入正题了。在上述的代码中我仅仅是用 import 代替了 require 难道它们两的功能不是一样的吗?如果是,这里的错从何来?

babel 对 import 和 require 的解析

import 是 ES6 的语法,而我们项目在开始使用 ES6 语法时大多数浏览器并不支持,所以我们用 babel 将 ES6 的语法解析成 CommonJS 的语法。想到这里,那问题是不是出自 babel 呢?下面就来看看这两行 code 在 babel 中的编译结果。

//编译前
const {window} = require('src/helpers');
//编译后
var _require = require('src/helpers'),
    window = _require.window;
//编译前
import {window} from 'src/helpers';
//编译后
var _helpers = require('src/helpers');

可以发现使用 require 引用的情况下,helper 中的 window 对象被赋值给了一个叫 window 的变量。而在使用 import 引用的情况下,helper 中的 window 对象没有被赋值,此时,当我们要访问 window 对象时,则通过_helpers.window来访问。其实这就是造成我们上述 Bug 的真正原因。

回到之前的 Bug,在example.js中如果用 require 进行引用的话那么其实引用的 window 对象是通过 helper.window 赋值的对象(称之为 W1),而用 import 进行引用的话那么其实是引用了整个 helper 对象。所以当测试文件中修改了 helpers.window 的值时 W1 是不会改变的而 helpers 对象中的 window 已经改变。结果就是在我把 require 改成 import 之后,导致代码里面的 window 实际上是引用的 helpers.window 并且它的值被修改了(改变后的值没有 state 这个属性),所以 error Cannot read property 'state' of undefined 就理所当然的发生了。

为了方便理解,可以参考下面的简图👇。

改变 helpers.window 前

从 require 来的 window 直接指向了 Value 1,而从 import 来的 window 则是通过拷贝 helpers 然后通过 helpers.window 得到的。所以当我们改变 helpers.window 的值时就会发生如下改变:


改变 helpers.window 后

如图所示,此时 import 中最终指向的值为 Value2 而 require 则指向 Value1。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,258评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,335评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,225评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,126评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,140评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,098评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,018评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,857评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,298评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,518评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,400评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,993评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,638评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,661评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352

推荐阅读更多精彩内容