关于node.js和macOS之间的故事-js教程-PHP中文网

首页

web前端

js教程

关于node.js和macOS之间的故事

小云云

Dec 18, 2017 am 11:22 AM

javascriptmacosnode.js

本文由一个小故事来和大家分享关于node.js和macOS之间的故事，希望能帮助到大家。

乔治G在他的电脑上做了一个小测试，但结果和预期的大不相同。

那么我们先来看看这个小测试都写了什么：

一共三个文件，代码总计不超过15行

parent.js

<span style="font-size: 14px;">class Parent {}<br><br>module.exports = Parent<br></span>

son.js

<span style="font-size: 14px;">//加载时把模块文件名首字母大写了(不正确的)<br/>const Parent = require(&#39;./Parent&#39;)<br/><br/>class Son extends Parent {}<br/><br/>module.exports = Son<br/></span>

test.js

<span style="font-size: 14px;">//加载时把模块名首字母大写(不正确的)<br/>const ParentIncorrect = require(&#39;./Parent&#39;)<br/>//通过正确的模块文件名加载(正确)<br/>const Parent = require(&#39;./parent&#39;)<br/><br/>const Son = require(&#39;./son&#39;)<br/><br/>const ss = new Son()<br/><br/>//测试结果<br/>console.log(ss instanceof Parent) // false<br/>console.log(ss instanceof ParentIncorrect) // true<br/></span>

乔治G同学有以下疑问：

son.js 和 test.js 里都有错误的文件名(大小写问题)引用，为什么不报错？
测试结果，为什么 ss instanceof ParentIncorrect === true ？不报错我忍了，为什么还认贼作父，说自己是那个通过不正确名字加载出来的模块的instance？

如果同学你对上述问题已经了然于胸，恭喜你，文能提笔安天，武能上马定乾坤；上炕认识娘们，下炕认识鞋！

但如果你也不是很清楚为什么？那么好了，我有的说，你有的看。

其实断症(装逼范儿的debug)之法和中医看病也有相似指出，望、闻、问、切四招可以按需选取一二来寻求答案。

望

代码不多，看了一会，即便没有我的注释，相信仔细的同学也都发现真正的文件名和代码中引入时有出入的，那么这里肯定是有问题的，问题记住，我们继续

闻

这个就算了，代码我也闻不出个什么鬼来

问

来吧，软件工程里很重要的一环，就是沟通，不见得是和遇到bug的同事，可能是自己，可能是QA，当然也可能是PM或者你的老板。你没问出自己想知道的问题；他没说清楚自己要回答的；都完蛋。。。。

那么我想知道什么呢？下面两件事作为debug的入口比较合理：

操作系统
运行环境 + 版本
你怎么测试的，命令行还是其他什么手段

答曰：macOS； node.js > 8.0 ；命令行 node test.js

切

激动人心的深刻到来了，我要动手了。（为了完整的描述 debug 过程，我会假装这下面的所有事情我事先都是不知道的）

准备电脑，完毕

准备运行环境 node.js > 9.3.0 ，完毕

复刻代码，完毕

运行，日了狗，果然没报错，而且运行结果就是乔治G说的那样。

为了证明我没瞎，我又尝试在 test.js 里 require 了一个压根不存在的文件 require('./nidayede') ，运行代码。

还好这次报错了 Error: Cannot find module './nidayede' ，所以我没疯。这点真令人高兴。

于是有了第一个问题

为什么狗日的模块名大小写都错了，还能加载？

会不会和操作系统有关系？来我们再找台 windows 试试，果然，到了 windows 上，大小写问题就是个问题了， Error: Cannot find module './Parent' 。

那么 macOS 到底在干什么？连个大小写都分不出来么？于是赶紧 google （别问我为什么不baidu）

关于node.js和macOS之间的故事

原来人家牛逼的 OS X 默认用了 case-insensitive 的文件系统( 详细文档 )。

but why？这么反人类的设计到底是为了什么？

关于node.js和macOS之间的故事

更多解释，来，走你

所以，这就是你不报错的理由？(对 node.js 指责道)，但这就是全部真相了。

但事情没完

那认贼作父又是个什么鬼？

依稀有听过 node.js 里有什么缓存，是那个东西引起的么？于是抱着试试看的心情，我把 const ParentIncorrect = require('./Parent') 和 const Parent = require('./parent') 换了下位置，心想，这样最先按照正确的名字加载，会不会就对了呢？

果然， 还是不对 。靠猜和装逼是不能够真正解决问题的

那比比 ParentIncorrect 和 Parent 呢？于是我写了 console.log(ParentIncorrect === Parent) ，结果为 false 。所以他俩还真的不是同一个东西，那么说明问题可能在引入的部分喽？

于是一个装逼看 node.js 源码的想法诞生了(其实不看，问题最终也能想明白)。日了狗，怀着忐忑的心情，终于 clone 了一把 node.js 源码(花了好久，真tm慢)

来，我们一起进入神秘的 node.js 源码世界。既然我们的问题是有关 require 的，那就从她开始吧，不过找到 require 定义的过程需要点耐心，这里不详述，只说查找的顺序吧

src/node_main.cc => src/node.cc => lib/internal/bootstrap_node.js => lib/module.js

找到咯，就是这个 lib/module.js ，进入正题：

lib/module.js => require

<span style="font-size: 14px;">Module.prototype.require = function(path) {<br/>  assert(path, &#39;missing path&#39;);<br/>  assert(typeof path === &#39;string&#39;, &#39;path must be a string&#39;);<br/>  return Module._load(path, this, /* isMain */ false);<br/>};<br/></span>

好像没什么卵用，对不对？她就调用了另一个方法 _load ，永不放弃，继续

lib/module.js => _load

<span style="font-size: 14px;">Module._load = function(request, parent, isMain) {<br/>  //debug代码，么卵用，跳过<br/>  if (parent) {<br/>    debug(&#39;Module._load REQUEST %s parent: %s&#39;, request, parent.id);<br/>  }<br/><br/>  if (isMain && experimentalModules) {<br/>    //...<br/>    //...<br/>    //这段是给ES module用的，不看了啊<br/>  }<br/><br/>  //获取模块的完整路径<br/>  var filename = Module._resolveFilename(request, parent, isMain);<br/><br/>  //缓存在这里啊？好激动有没有？！？终于见到她老人家了<br/>  //原来这是这样的，简单的一批，毫无神秘感啊有木有<br/>  var cachedModule = Module._cache[filename];<br/>  if (cachedModule) {<br/>    updateChildren(parent, cachedModule, true);<br/>    return cachedModule.exports;<br/>  }<br/><br/>  //加载native但非内部module的，不看<br/>  if (NativeModule.nonInternalExists(filename)) {<br/>    debug(&#39;load native module %s&#39;, request);<br/>    return NativeModule.require(filename);<br/>  }<br/><br/>  //构造全新Module实例了<br/>  var module = new Module(filename, parent);<br/><br/>  if (isMain) {<br/>    process.mainModule = module;<br/>    module.id = &#39;.&#39;;<br/>  }<br/><br/>  //先把实例引用加缓存里<br/>  Module._cache[filename] = module;<br/><br/>  //尝试加载模块了<br/>  tryModuleLoad(module, filename);<br/><br/>  return module.exports;<br/>};<br/></span>

似乎到这里差不多了，不过我们再深入看看 tryModuleLoad

lib/module.js => tryModuleLoad

<span style="font-size: 14px;">function tryModuleLoad(module, filename) {<br/>  var threw = true;<br/>  try {<br/>    //加载模块<br/>    module.load(filename);<br/>    threw = false;<br/>  } finally {<br/>    //要是加载失败，从缓存里删除<br/>    if (threw) {<br/>      delete Module._cache[filename];<br/>    }<br/>  }<br/>}<br/></span>

接下来就是真正的 load 了，要不我们先停一停？

好了，分析问题的关键在于不忘初心，虽然到目前为止我们前进的比较顺利，也很爽对不对？。但我们的此行的目的并不是爽，好像是有个什么疑惑哦！于是，我们再次梳理下问题：

son.js 里用首字母大写(不正确)的模块名引用了 parent.js
test.js 里，引用了两次 parent.js ，一次用完全一致的模块名；一次用首字母大写的模块名。结果发现 son instanceof require('./parent') === false

既然没报错的问题前面已经解决了，那么，现在看起来就是加载模块这个部分可能出问题了，那么问题到底是什么？我们怎么验证呢？

这个时候我看到了这么一句话 var cachedModule = Module._cache[filename]; ，文件名是作为缓存的 key ，来吧，是时候看看 Module._cache 里存的模块 key 都是什么牛鬼蛇神了，打出来看看吧，于是我在 test.js 里最后面加了一句 console.log(Object.keys(require.cache)) ，我们看看打出了什么结果

<span style="font-size: 14px;">false<br/>true<br/>[ &#39;/Users/admin/codes/test/index.js&#39;,<br/>  &#39;/Users/admin/codes/test/Parent.js&#39;,<br/>  &#39;/Users/admin/codes/test/parent.js&#39;,<br/>  &#39;/Users/admin/codes/test/son.js&#39; ]<br/></span>

真相已经呼之欲出了， Module._cache 里真的出现了两个 [p|P]arent （ macOS 默认不区分大小写，所以她找到的其实是同一个文件；但 node.js 当真了，一看文件名不一样，就当成不同模块了），所以最后问题的关键就在于 son.js 里到底引用时用了哪个名字（上面我们用了首字母大写的 require('./Parent.js') ），这才导致了 test.js 认贼作父的梗。

如果我们改改 son.js ，把引用换成 require('./parEND.js') ，再次执行下 test.js 看看结果如何呢？

<span style="font-size: 14px;">false<br/>false<br/>[ &#39;/Users/haozuo/codes/test/index.js&#39;,<br/>  &#39;/Users/haozuo/codes/test/Parent.js&#39;,<br/>  &#39;/Users/haozuo/codes/test/parent.js&#39;,<br/>  &#39;/Users/haozuo/codes/test/son.js&#39;,<br/>  &#39;/Users/haozuo/codes/test/parENT.js&#39; ]<br/></span>

没有认贼作父了对不对？再看 Module._cache 里，原来是 parENT.js 也被当成一个单独的模块了。

所以，假设你的模块文件名有 n 个字符，理论上，在 macOS 大小写不敏感的文件系统里，你能让 node.js 将其弄出最大 2 的 n 次方个缓存来

是不是很惨！？还好 macOS 还是可以改成大小写敏感的，格盘重装系统；新建分区都行。

问题虽然不难，但探究问题的决心和思路还是重要的。