掃二維碼與項目經(jīng)理溝通
我們在微信上24小時期待你的聲音
解答本文疑問/技術(shù)咨詢/運營咨詢/技術(shù)建議/互聯(lián)網(wǎng)交流
node.js官方文檔對Node.js文件系統(tǒng)進行了詳細的介紹。

目前創(chuàng)新互聯(lián)已為上千余家的企業(yè)提供了網(wǎng)站建設、域名、網(wǎng)頁空間、網(wǎng)站托管、服務器租用、企業(yè)網(wǎng)站設計、金壇網(wǎng)站維護等服務,公司將堅持客戶導向、應用為本的策略,正道將秉承"和諧、參與、激情"的文化,與客戶和合作伙伴齊心協(xié)力一起成長,共同發(fā)展。
穩(wěn)定性: 3 - 穩(wěn)定Node.js文件系統(tǒng)模塊是一個封裝了標準的POSIX文件I/O操作的集合。通過require('fs')使用這個模塊,其中所有的方法都有同步和異步兩種模式。
異步方法最后一個參數(shù)都是回調(diào)函數(shù),這個回調(diào)的參數(shù)取決于方法,不過第一個參數(shù)一般都是異常。如果操作成功,那么第一個參數(shù)就是null或undefined。
當使用一個同步操作的時候,任意的異常都立即拋出,可以用try/catch來處理異常,使得程序正常運行。
以下是一個異步操作的例子:
var fs = require('fs');
fs.unlink('/tmp/hello', function (err) {
if (err) throw err;
console.log('successfully deleted /tmp/hello');
});以下是一個同步操作的例子:
var fs = require('fs');
fs.unlinkSync('/tmp/hello');
console.log('successfully deleted /tmp/hello');異步方法不能保證操作順序,因此下面的例子很容易出錯:
fs.rename('/tmp/hello', '/tmp/world', function (err) {
if (err) throw err;
console.log('renamed complete');
});
fs.stat('/tmp/world', function (err, stats) {
if (err) throw err;
console.log('stats: ' + JSON.stringify(stats));
});該例子出錯的原因很可能是因為先執(zhí)行了fs.stat方法,正確的方法如下:
fs.rename('/tmp/hello', '/tmp/world', function (err) {
if (err) throw err;
fs.stat('/tmp/world', function (err, stats) {
if (err) throw err;
console.log('stats: ' + JSON.stringify(stats));
});
});在繁忙的進程里,強烈建議使用異步方法。同步方法會阻塞整個進程,直到方法完成。
可能會用到相對路徑,路徑是相對process.cwd()來說的。
大部分fs函數(shù)會忽略回調(diào)參數(shù),如果忽略,將會用默認函數(shù)拋出異常。如果想得到原調(diào)用點的堆棧信息,需要設置環(huán)境變量NODE_DEBUG:
$ cat script.js
function bad() {
require('fs').readFile('/');
}
bad();
$ env NODE_DEBUG=fs node script.js
fs.js:66
throw err;
^
Error: EISDIR, read
at rethrow (fs.js:61:21)
at maybeCallback (fs.js:79:42)
at Object.fs.readFile (fs.js:153:18)
at bad (/path/to/script.js:2:17)
at Object. (/path/to/script.js:5:1)
異步函數(shù)rename(2)。回調(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。
同步函數(shù)rename(2)。 返回undefined。
異步函數(shù)ftruncate(2)。 回調(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。
同步函數(shù)ftruncate(2)。 返回undefined。
異步函數(shù)truncate(2)。 回調(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。 文件描述符也可以作為第一個參數(shù),如果這種情況,調(diào)用fs.ftruncate() 。
同步函數(shù)truncate(2)。 返回undefined。
異步函數(shù)chown(2)?;卣{(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。
同步函數(shù)chown(2)。返回undefined。
異步函數(shù)fchown(2)?;卣{(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。
同步函數(shù) fchown(2)。返回undefined。
異步函數(shù)lchown(2)?;卣{(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。
同步函數(shù)lchown(2)。返回undefined。
異步函數(shù)chmod(2)?;卣{(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。
同步函數(shù)chmod(2)。返回 undefined。
異步函數(shù)fchmod(2)。回調(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。
同步函數(shù)fchmod(2)。返回undefined。
異步函數(shù) lchmod(2)。回調(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。
僅在Mac OS X可用。
同步函數(shù)lchmod(2)。返回undefined。
異步函數(shù)stat(2)。回調(diào)函數(shù)有兩個參數(shù):(err, stats) ,其中stats是一個fs.Stats對象。 詳情請參考fs.Stats。
異步函數(shù)lstat(2)。回調(diào)函數(shù)有兩個參數(shù):(err, stats) ,其中stats是一個fs.Stats對象。lstat()與stat()基本相同,區(qū)別在于,如果path是鏈接,讀取的是鏈接本身,而不是它所鏈接到的文件。
異步函數(shù)fstat(2)?;卣{(diào)函數(shù)有兩個參數(shù): (err, stats),其中stats是一個fs.Stats對象。
同步函數(shù)stat(2)。返回fs.Stats實例。
同步函數(shù)lstat(2)。返回fs.Stats實例。
同步函數(shù)fstat(2)。返回fs.Stats實例。
異步函數(shù)link(2)?;卣{(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。
同步函數(shù)link(2)。返回undefined。
異步函數(shù)symlink(2)?;卣{(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常。
type可能是'dir','file', 或'junction' (默認'file') ,僅在Windows(不考慮其他系統(tǒng))有效。注意, Windows junction要求目的地址需要絕對的。當使用'junction'的時候,destination參數(shù)將會自動轉(zhuǎn)換為絕對路徑。
同步函數(shù)symlink(2)。 返回undefined。
異步函數(shù)readlink(2)。回調(diào)函數(shù)有2個參數(shù)(err, linkString).
同步函數(shù)readlink(2)。返回符號鏈接的字符串值。
異步函數(shù)realpath(2)?;卣{(diào)函數(shù)有2個參數(shù)(err,resolvedPath)??梢允褂?code>process.cwd來解決相對路徑問題。
例如:
var cache = {'/etc':'/private/etc'};
fs.realpath('/etc/passwd', cache, function (err, resolvedPath) {
if (err) throw err;
console.log(resolvedPath);
});同步函數(shù)realpath(2)。返回解析出的路徑。
異步函數(shù)unlink(2)?;卣{(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常.
同步函數(shù)unlink(2)。返回undefined。
異步函數(shù)rmdir(2)?;卣{(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常.
同步函數(shù)rmdir(2)。返回undefined。
異步函數(shù)mkdir(2)?;卣{(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常. mode默認為0777.
同步函數(shù)mkdir(2)。返回undefined。
異步函數(shù)readdir(3)。讀取文件夾的內(nèi)容。回調(diào)有2個參數(shù) (err, files)files是文件夾里除了名字為'.'和'..'之外的所有文件名。
同步函數(shù)readdir(3)。返回除了文件名為'.'和'..'之外的所有文件.
異步函數(shù)close(2)。回調(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常.
同步函數(shù)close(2)。返回 undefined。
異步函數(shù)file open. 參見open(2)。flags是:
'r'- 以只讀模式打開;如果文件不存在,拋出異常。
'r+'-以讀寫模式打開;如果文件不存在,拋出異常。
'rs'- 同步的,以只讀模式打開;指令繞過操作系統(tǒng)直接使用本地文件系統(tǒng)緩存。這個功能主要用來打開NFS掛載的文件,因為它能讓你跳過可能過時的本地緩存。如果對I/O性能很在乎,就不要使用這個標志位。
這里不是調(diào)用fs.open()變成同步阻塞請求,如果你想要這樣,可以調(diào)用fs.openSync()。
'rs+'- 同步模式下以讀寫方式打開文件。注意事項參見'rs'.
'w'- 以只寫模式打開。文件會被創(chuàng)建 (如果文件不存在) 或者覆蓋 (如果存在)。
'wx'- 和'w'類似,如果文件存儲操作失敗
'w+'- 以可讀寫方式打開。文件會被創(chuàng)建 (如果文件不存在) 或者覆蓋 (如果存在)
'wx+'- 和'w+'類似,如果文件存儲操作失敗。
'a'- 以附加的形式打開。如果文件不存在則創(chuàng)建一個。
'ax'- 和'a'類似,如果文件存儲操作失敗。
'a+'- 以只讀和附加的形式打開文件.若文件不存在,則會建立該文件
'ax+'- 和'a+'類似,如果文件存儲操作失敗.如果文件存在,參數(shù)mode設置文件模式 (permission和sticky bits)。 默認是0666,可讀寫。
回調(diào)有2個參數(shù)(err, fd).
排除標記'x'(對應open(2)的O_EXCL標記) 保證path是新創(chuàng)建的。在POSIX系統(tǒng)里,即使文件不存在,也會被認定為文件存在。排除標記不能確定在網(wǎng)絡文件系統(tǒng)中是否有效。
Linux系統(tǒng)里,無法對以追加模式打開的文件進行指定位置寫。系統(tǒng)核心忽略了位置參數(shù),每次把數(shù)據(jù)寫到文件的最后。
fs.open()的同步版本. 返回整數(shù)形式的文件描述符。.
改變指定路徑文件的時間戳。
fs.utimes()的同步版本。返回undefined。
改變傳入的文件描述符指向文件的時間戳。
fs.futimes()的同步版本。返回undefined。
異步函數(shù)fsync(2)?;卣{(diào)函數(shù)只有一個參數(shù):可能出現(xiàn)的異常.
同步fsync(2)。返回undefined。
將buffer寫到fd指定的文件里。
參數(shù)offset和length確定寫哪個部分的緩存。
參數(shù)position是要寫入的文件位置。如果typeof position !== 'number',將會在當前位置寫入。參見pwrite(2)。
回調(diào)函數(shù)有三個參數(shù)(err, written, buffer),written指定buffer的多少字節(jié)用來寫。
注意,如果fs.write 的回調(diào)還沒執(zhí)行,就多次調(diào)用fs.write,這樣很不安全。因此,推薦使用fs.createWriteStream 。
Linux系統(tǒng)里,無法對以追加模式打開的文件進行指定位置寫。系統(tǒng)核心忽略了位置參數(shù),每次把數(shù)據(jù)寫到文件的最后。
將buffer寫到fd指定的文件里。如果data不是buffer,那么它就會被強制轉(zhuǎn)換為字符串。
參數(shù)position是要寫入的文件位置。如果typeof position !== 'number',將會在當前位置寫入。參見pwrite(2)。
參數(shù)encoding :字符串的編碼方式.
回調(diào)函數(shù)有三個參數(shù)(err, written, buffer),written指定buffer的多少字節(jié)用來寫。注意寫入的字節(jié)(bytes)和字符(string characters)不同。參見Buffer.byteLength。
和寫入buffer不同,必須寫入整個字符串,不能截取字符串。這是因為返回的字節(jié)的位移跟字符串的位移是不一樣的。
注意,如果fs.write的回調(diào)還沒執(zhí)行,就多次調(diào)用fs.write,這樣很不安全。因此,推薦使用fs.createWriteStream
Linux系統(tǒng)里,無法對以追加模式打開的文件進行指定位置寫。系統(tǒng)核心忽略了位置參數(shù),每次把數(shù)據(jù)寫到文件的最后。
fs.write()的同步版本. 返回要寫的bytes數(shù).
讀取fd指定文件的數(shù)據(jù)。
buffer是緩沖區(qū),數(shù)據(jù)將會寫入到這里.
offset寫入的偏移量
length需要讀的文件長度
position讀取的文件起始位置,如果position是null, 將會從當前位置讀。
回調(diào)函數(shù)有3個參數(shù),(err, bytesRead, buffer).
fs.read的同步版本。返回bytesRead的數(shù)量.
filename {String}options {Object}
encoding {String | Null} 默認 = nullflag {String} 默認 = 'r'callback {Function}異步讀取整個文件的內(nèi)容。例如:
fs.readFile('/etc/passwd', function (err, data) {
if (err) throw err;
console.log(data);
});回調(diào)函數(shù)有2個參數(shù)(err, data),參數(shù)data是文件的內(nèi)容。如果沒有指定參數(shù)encoding,返回原生buffer
fs.readFile的同步版本. 返回整個文件的內(nèi)容.
如果沒有指定參數(shù)encoding,返回buffer。
filename {String}data {String | Buffer}options {Object}
encoding {String | Null} 默認 = 'utf8'mode {Number} 默認 = 438 (aka 0666 in Octal)flag {String} 默認 = 'w'callback {Function}異步寫文件,如果文件已經(jīng)存在則替換。data可以是緩存或者字符串。
如果參數(shù)data是buffer,會忽略參數(shù)encoding。默認值是'utf8'。
列如:
fs.writeFile('message.txt', 'Hello Node', function (err) {
if (err) throw err;
console.log('It\'s saved!');
});fs.writeFile的同步版本。返回undefined。
filename {String}data {String | Buffer}options {Object}
encoding {String | Null} 默認 = 'utf8'mode {Number} 默認 = 438 (aka 0666 in Octal)flag {String} 默認 = 'a'callback {Function}異步的給文件添加數(shù)據(jù),如果文件不存在,就創(chuàng)建一個。data可以是緩存或者字符串。
例如:
fs.appendFile('message.txt', 'data to append', function (err) {
if (err) throw err;
console.log('The "data to append" was appended to file!');
});fs.appendFile的同步版本。返回undefined。
穩(wěn)定性: 2 - 不穩(wěn)定。 盡可能的用 fs.watch 來替換。監(jiān)視filename文件的變化。每當文件被訪問的時候都會調(diào)用listener。
第二個參數(shù)可選。如果有,它必須包含兩個boolean參數(shù)(persistent和interval)的對象。persistent指定文件被監(jiān)視時進程是否繼續(xù)運行。interval指定了查詢文件的間隔,以毫秒為單位。缺省值為{ persistent: true, interval: 5007 }。
listener有兩個參數(shù),第一個為文件現(xiàn)在的狀態(tài),第二個為文件的前一個狀態(tài):
fs.watchFile('message.text', function (curr, prev) {
console.log('the current mtime is: ' + curr.mtime);
console.log('the previous mtime was: ' + prev.mtime);
});listener中的文件狀態(tài)對象類型為fs.Stat。
如果想修改文件時被通知,而不是訪問的時候就通知,可以比較curr.mtime和prev.mtime。
穩(wěn)定性: 2 - 不穩(wěn)定. 盡可能的用 fs.watch 來替換。停止監(jiān)視filename文件的變化。如果指定了listener,那只會移除這個listener。否則,移除所有的listener,并會停止監(jiān)視filename。
調(diào)用fs.unwatchFile()停止監(jiān)視一個沒被監(jiān)視的文件,不會觸發(fā)錯誤,而會發(fā)生一個no-op。
穩(wěn)定性: 2 - 不穩(wěn)定.觀察filename指定的文件或文件夾的改變。返回對象是 fs.FSWatcher。
第二個參數(shù)可選。如果有,它必須是包含兩個boolean參數(shù)(persistent和recursive)的對象。persistent指定文件被監(jiān)視時進程是否繼續(xù)運行。 recursive表明是監(jiān)視所有的子文件夾還是當前文件夾,這個參數(shù)只有監(jiān)視對象是文件夾時才有效,而且僅在支持的系統(tǒng)里有效(參見下面注意事項)。
默認值{ persistent: true, recursive: false }.
回調(diào)函數(shù)有2個參數(shù)(event, filename)。event是rename或change。filename是觸發(fā)事件的文件名。
fs.watchAPI 不是100%的跨平臺兼容,可能在某些情況下不可用。
recursive參數(shù)僅在OS X上可用。僅FSEvents支持這個類型文件的監(jiān)視,所以未來也不太可能有新的平臺加入。
這些特性依賴于底層系統(tǒng)提供文件系統(tǒng)變動的通知。
inotify.kqueue.kqueue,文件夾使用FSEvents.event ports.ReadDirectoryChangesW.如果底層系統(tǒng)函數(shù)不可用,那么fs.watch就無法工作。例如,監(jiān)視網(wǎng)絡文件系統(tǒng)(NFS、 SMB等)經(jīng)常不能用。你仍然可以用fs.watchFile查詢,但是會比較慢,且不可靠。
回調(diào)函數(shù)中提供文件名參數(shù),不是每個平臺都能用(Linux和Windows就不行)。即使在可用的平臺,也不能保證都能提供。所以不要假設回調(diào)函數(shù)中filename參數(shù)有效,要在代碼里添加一些為空的邏輯判斷。
fs.watch('somedir', function (event, filename) {
console.log('event is: ' + event);
if (filename) {
console.log('filename provided: ' + filename);
} else {
console.log('filename not provided');
}
});判斷文件是否存在,回調(diào)函數(shù)參數(shù)是bool值。例如:
fs.exists('/etc/passwd', function (exists) {
util.debug(exists ? "it's there" : "no passwd!");
});fs.exists()是老版本的函數(shù),因此在代碼里不要用。
另外,打開文件前判斷是否存在有漏洞,在fs.exists()和fs.open()調(diào)用中間,另外一個進程有可能已經(jīng)移除了文件。最好用fs.open()來打開文件,根據(jù)回調(diào)函數(shù)來判斷是否有錯誤。
fs.exists()未來會被移除。
fs.exists()的同步版本. 如果文件存在返回true, 否則返回false。
fs.existsSync()未來會被移除。
測試由參數(shù)path指向的文件的用戶權(quán)限??蛇x參數(shù)mode為整數(shù),它表示需要檢查的權(quán)限。下面列出了所有值。mode可以是單個值,或者可以通過或運算,掩碼運算實現(xiàn)多個權(quán)限檢查。
fs.F_OK- 文件是對于進程可見,可以用來檢查文件是否存在。參數(shù)mode的默認值。 fs.R_OK- 文件對于進程是否可讀。fs.W_OK- 文件對于進程是否可寫。fs.X_OK- 文件對于進程是否可執(zhí)行。(Windows系統(tǒng)不可用,執(zhí)行效果等同fs.F_OK) 第三個參數(shù)是回調(diào)函數(shù)。如果檢查失敗,回調(diào)函數(shù)的參數(shù)就是響應的錯誤。下面的例子檢查文件/etc/passwd是否能被當前的進程讀寫。
fs.access('/etc/passwd', fs.R_OK | fs.W_OK, function(err) {
util.debug(err ? 'no access!' : 'can read/write');
});fs.access的同步版本. 如果發(fā)生錯誤拋出異常,否則不做任何事情。
fs.stat(), fs.lstat()和fs.fstat()以及同步版本的返回對象。
stats.isFile()stats.isDirectory()stats.isBlockDevice()stats.isCharacterDevice()stats.isSymbolicLink() (only valid with fs.lstat())stats.isFIFO()stats.isSocket()對普通文件使用util.inspect(stats),返回的字符串和下面類似:
{ dev: 2114,
ino: 48064969,
mode: 33188,
nlink: 1,
uid: 85,
gid: 100,
rdev: 0,
size: 527,
blksize: 4096,
blocks: 8,
atime: Mon, 10 Oct 2011 23:24:11 GMT,
mtime: Mon, 10 Oct 2011 23:24:11 GMT,
ctime: Mon, 10 Oct 2011 23:24:11 GMT,
birthtime: Mon, 10 Oct 2011 23:24:11 GMT }atime, mtime, birthtime, 和ctime都是Date的實例,需要使用合適的方法來比較這些值。通常使用getTime()來獲取時間戳(毫秒,從 1 January 1970 00:00:00 UTC開始算),這個整數(shù)基本能滿足任何比較條件。也有一些其他方法來顯示額外信息。更多參見MDN JavaScript Reference
狀態(tài)對象(stat object)有以下語義:
atime訪問時間 - 文件的最后訪問時間. mknod(2), utimes(2), 和 read(2)等系統(tǒng)調(diào)用可以改變.mtime修改時間 - 文件的最后修改時間. mknod(2), utimes(2), 和 write(2)等系統(tǒng)調(diào)用可以改變.ctime改變時間 - 文件狀態(tài)(inode)的最后修改時間. chmod(2), chown(2),link(2), mknod(2), rename(2), unlink(2), utimes(2), read(2), 和write(2)等系統(tǒng)調(diào)用可以改變.birthtime"Birth Time" - 文件創(chuàng)建時間,文件創(chuàng)建時生成。 在一些不提供文件birthtime的文件系統(tǒng)中, 這個字段會使用ctime或1970-01-01T00:00Z (ie, unix epoch timestamp 0)來填充。在Darwin和其他FreeBSD系統(tǒng)變體中,也將atime顯式地設置成比它現(xiàn)在的birthtime更早的一個時間值,這個過程使用了 utimes(2)系統(tǒng)調(diào)用。在Node v0.12版本之前,Windows系統(tǒng)里ctime有birthtime值. 注意在v.0.12版本中, ctime不再是"creation time", 而且在Unix系統(tǒng)中,他一直都不是。
返回可讀流對象 (見Readable Stream)。
options默認值如下:
{ flags: 'r',
encoding: null,
fd: null,
mode: 0666,
autoClose: true
}參數(shù)options提供start和end位置來讀取文件的特定范圍內(nèi)容,而不是整個文件。start和end都在文件范圍里,并從0開始,encoding是'utf8', 'ascii'或'base64'。
如果給了fd值,ReadStream將會忽略path參數(shù),而使用文件描述,這樣不會觸發(fā)任何open事件。
如果autoClose為false,即使發(fā)生錯誤文件也不會關(guān)閉,需要你來負責關(guān)閉,避免文件描述符泄露。如果autoClose是true(默認值),遇到error或end,文件描述符將會自動關(guān)閉。
例如,從100個字節(jié)的文件里,讀取最少10個字節(jié):
fs.createReadStream('sample.txt', {start: 90, end: 99});ReadStream是 Readable Stream。
fd{Integer} ReadStream 所使用的文件描述符。當創(chuàng)建文件的ReadStream時觸發(fā)。
返回一個新的寫對象 (參見 Writable Stream)。
options是一個對象,默認值:
{ flags: 'w',
encoding: null,
fd: null,
mode: 0666 }options也可以包含一個start選項,在指定文件中寫入數(shù)據(jù)開始位置。 修改而不替換文件需要flags的模式指定為r+而不是默值的w。
和之前的ReadStream類似,如果fd不為空,WriteStream將會忽略path參數(shù),轉(zhuǎn)而使用文件描述,這樣不會觸發(fā)任何open事件。
WriteStream是 Writable Stream。
fd{Integer} WriteStream所用的文件描述符打開WriteStream file時觸發(fā)。
目前寫入的字節(jié)數(shù),不含等待寫入的數(shù)據(jù)。
fs.watch()返回的對象就是這個類.
停止觀察fs.FSWatcher對象中的更改。
event{String} fs改變的類型filename{String} 改變的文件名 (if relevant/available)當監(jiān)聽的文件或文件夾改變的時候觸發(fā),參見fs.watch。
error{Error object}錯誤發(fā)生時觸發(fā)。
JavaScript 錯誤 - throw、try 和 catch

我們在微信上24小時期待你的聲音
解答本文疑問/技術(shù)咨詢/運營咨詢/技術(shù)建議/互聯(lián)網(wǎng)交流