nodejs的路徑問題

最近公司的一個開發項目,後端用的是nodejs。這兩天需要打包給客戶演示,就讓公司一個小夥把之前3D機房的打包工具移植過來。打包之後,發現原本在開發環境下的跑的好好的項目,不能訪問了。出現項目的首頁不能訪問的問題:

can not get file index.html

#express.static
問題出在哪兒?
nodejs後端的用了express,index.html是一個靜態文件。我們知道,通過 Express 內置的 express.static 可以方便地託管靜態文件,例如圖片、CSS、JavaScript 文件等。
將靜態資源文件所在的目錄作爲參數傳遞給 express.static 中間件就可以提供靜態資源文件的訪問了。例如,假設在 public 目錄放置了圖片、CSS 和 JavaScript 文件,可以使用如下代碼:

app.use(express.static('public'));

所以,找到項目中的代碼,查看static調用的地方,和上面一行代碼很一樣:

app.use(express.static('public'));

到此,我已經發現了問題,我告訴小夥伴,這個地方不用相對路徑可以解決這個問題。由於打包時間限制,我讓小夥伴先簡單處理下,打完包之後,在來整理下思路:

app.use(express.static('resource/public'));

當然最重要的是,這個問題其實不難,自己多鑽研下,很容易發現問題,也就不會出這個問題,所以小夥伴自己打手心吧。

恩,你沒看錯,這個地方還是相對目錄。後續產品中會改成比較好的一種情況。

#express.static方法解析
事實上,express.static方法如果傳入的是相對路徑,express會自己把他轉換爲絕對路徑,我們可以查看下源代碼,在express.js找到如下代碼:

exports.static = require('serve-static');

說明static 調用了serve-static這個包,直接找到這個包,查看index.js, 可以看到代碼,下面列出重要的兩行

...
var resolve = require('path').resolve
...
opts.root = resolve(root)
...

這兩行就是,express把相對目錄轉換成絕對目錄的代碼,可以看出,最終使用的path這個內置對象的resolve方法,繼續往下看。

#path對象的resolve方法
直接查看這個方法的api文檔,如下:
https://nodejs.org/api/path.html#path_path_resolve_paths
下面是這個方法的解釋:
The path.resolve() method resolves a sequence of paths or path segments into an absolute path.
啥意思呢? 就是這個方法把一系列的paths或者path segments 組織成一個絕對路徑,比如

path.resolve('/foo','bar');
// return /foo/bar

詳細的說明請自行參考文檔,這個地方有一句話需要特別注意:
If after processing all given path segments an absolute path has not yet been generated, the current working directory is used.
啥意思,就是如果處理完了所有的path segments,也沒有生成一個絕對路徑, 就要使用 當前工作目錄(current working directory)。比如:

path.resolve('bar');
// 加上 /Users/terry 是當前工作目錄, return /Users/terry/bar

api文檔中一個比較複雜的示例(此處注意resolve的時候,從右到左,參考文檔瞭解詳情):

path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif');
// if the current working directory is /home/myself/node,
// this returns '/home/myself/node/wwwroot/static_files/gif/image.gif'

現在的問題是,啥是當前工作目錄。

nodejs 當前工作目錄 current working directory

nodejs 當前工作目錄是啓動Node的目錄。也就是說,從哪個目錄進去啓動node,就返回哪個目錄。

注意,這個目錄不是指js文件所在的目錄
通過process.cwd()方法可以獲取當前工作目錄。

下面通過一個示例來介紹這個當前工作目錄,假如在/Users/terry/Documents/JSWorkspace目錄下寫一個js文件,test.js,代碼只有一行:

console.log(process.cwd());

此時如果,在目錄/Users/terry/Documents/JSWorkspace下面執行命令 :node test.js 輸出如下:

/Users/terry/Documents/JSWorkspace

但是如果在在目錄/Users/terry/Documents/下面執行命令:node ./JSWorkspace/test.js,輸出的結果是:

 /Users/terry/Documents

因此可以看出你在那個目錄執行node命令,當前目錄就是那個目錄。

回到之前的打包的問題,由於在開發階段,一般都是直接在js文件所在目錄執行node命令,所以相對目錄寫的是相對於當前js文件的目錄沒有問題。
可是打包之後,node的執行放到了js目錄的上一層去了。此時相對目錄“public”不在是相對於js文件的相對目錄,而是相對於上一層的,自然就找不到這個文件夾了,從而也找不到該文件夾下的index.html文件。

#如何解決
解決的方法:

  1. 在前面已經說過了,改這個相對目錄。但這種方法很蹩腳。因爲,啓動node命令的目錄可能會變;而是如果這應該,開發階段的node命令執行也需要跟着改。 總之不是兼容性很好的方法。
  2. 直接使用絕對路徑。 但是這個絕對路徑在不同的機器上又不一樣,該如何解決呢?可以考慮使用全局變量dirname.
    #全局變量
    dirname
    查看api文檔 https://nodejs.org/api/modules.html#modules_dirname
    看到解釋如下:
    The directory name of the current module. This is the same as the path.dirname() of the __filename
    啥意思呢,及時返回nodejs 的js文件的所在目錄。
    有了這個變量之後,我們就可以用如下代碼解決這個問題。
    app.use(express.static(__dirname + '/public'));

    本文在公衆號好同步發佈,讀者也可以關注公衆號:
    ITman彪叔公衆號

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章