首頁 > 文章 > web前端 > 關於node.js和macOS之間的故事

關於node.js和macOS之間的故事

小云云原創: 2017-12-18 11:22:141343瀏覽

本文由一個小故事來和大家分享關於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 還是可以改成大小寫敏感的，格盤重裝系統；新分割區都行。

問題雖然不難，但探究問題的決心和想法還是重要的。

關於node.js和macOS之間的故事

<span style="font-size: 14px;">parent.js</span>

<span style="font-size: 14px;">son.js</span>

<span style="font-size: 14px;">test.js</span>

望

<span style="font-size: 14px;"></span>

問

<span style="font-size: 14px;"></span>

為什麼狗日的模組名稱大小寫都錯了，還能載入？

<span style="font-size: 14px;"></span>

相關文章