Node.js文件操作詳解
Node有一組數(shù)據(jù)流API，可以像處理網(wǎng)絡流那樣處理文件，用起來很方便，但是它只允許順序處理文件，不能隨機讀寫文件。因此，需要使用一些更底層的文件系統(tǒng)操作。
本章覆蓋了文件處理的基礎知識，包括如何打開文件，讀取文件某一部分，寫數(shù)據(jù)，以及關閉文件。
Node的很多文件API幾乎是UNIX（POSIX）中對應文件API 的翻版，比如使用文件描述符的方式，就像UNIX里一樣，文件描述符在Node里也是一個整型數(shù)字，代表一個實體在進程文件描述符表里的索引。
有3個特殊的文件描述符——1，2和3。他們分別代表標準輸入，標準輸出和標準錯誤文件描述符。標準輸入，顧名思義，是個只讀流，進程用它來從控制臺或者進程通道讀取數(shù)據(jù)。標準輸出和標準錯誤是僅用來輸出數(shù)據(jù)的文件描述符，他們經(jīng)常被用來向控制臺，其它進程或文件輸出數(shù)據(jù)。標準錯誤負責錯誤信息輸出，而標準輸出負責普通的進程輸出。
一旦進程啟動完畢，就能使用這幾個文件描述符了，它們其實并不存在對應的物理文件。你不能讀寫某個隨機位置的數(shù)據(jù)，（譯者注：原文是You can write to and read from specific positions within the file.根據(jù)上下文，作者可能少寫了個“not”），只能像操作網(wǎng)絡數(shù)據(jù)流那樣順序的讀取和輸出，已寫入的數(shù)據(jù)就不能再修改了。
普通文件不受這種限制，比如Node里，你即可以創(chuàng)建只能向尾部追加數(shù)據(jù)的文件，還可以創(chuàng)建讀寫隨機位置的文件。
幾乎所有跟文件相關的操作都會涉及到處理文件路徑，本章先會將介紹這些工具函數(shù)，然后再深入講解文件讀寫和數(shù)據(jù)操作
處理文件路徑
文件路徑分為相對路徑和絕對路徑兩種，用它們來表示具體的文件。你可以合并文件路徑，可以提取文件名信息，甚至可以檢測文件是否存在。
Node里，可以用字符串來操處理文件路徑，但是那樣會使問題變復雜，比如你要連接路徑的不同部分，有些部分以 “/”結(jié)尾有些卻沒有，而且路徑分割符在不同操作系統(tǒng)里也可能會不一樣，所以，當你連接它們時，代碼就會非常羅嗦和麻煩。
幸運的是，Node有個叫path的模塊，可以幫你標準化，連接，解析路徑，從絕對路徑轉(zhuǎn)換到相對路徑，從路徑中提取各部分信息，檢測文件是否存在?？偟膩碚f，path模塊其實只是些字符串處理，而且也不會到文件系統(tǒng)去做驗證（path.exists函數(shù)例外）。
路徑的標準化
在存儲或使用路徑之前將它們標準化通常是個好主意。比如，由用戶輸入或者配置文件獲得的文件路徑，或者由兩個或多個路徑連接起來的路徑，一般都應該被標準化?？梢杂胮ath模塊的normalize函數(shù)來標準化一個路徑，而且它還能處理“..”，“.”“//”。比如：
var path = require('path');
path.normalize('/foo/bar//baz/asdf/quux/..');
// => '/foo/bar/baz/asdf'
連接路徑
使用path.join()函數(shù)，可以連接任意多個路徑字符串，只用把所有路徑字符串依次傳遞給join()函數(shù)就可以：
var path = require('path');
path.join('/foo', 'bar', 'baz/asdf', 'quux', '..');
// => '/foo/bar/baz/asdf'
如你所見，path.join()內(nèi)部會自動將路徑標準化。
解析路徑
用path.resolve()可以把多個路徑解析為一個絕對路徑。它的功能就像對這些路徑挨個不斷進行“cd”操作，和cd命令的參數(shù)不同，這些路徑可以是文件，并且它們不必真實存在——path.resolve()方法不會去訪問底層文件系統(tǒng)來確定路徑是否存在，它只是一些字符串操作。
比如：
var path = require('path');
path.resolve('/foo/bar', './baz');
// => /foo/bar/baz
path.resolve('/foo/bar', '/tmp/file/');
// => /tmp/file
如果解析結(jié)果不是絕對路徑，path.resolve()會把當前工作目錄作為路徑附加到解析結(jié)果前面，比如：
path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif');
// 如果當前工作目錄是/home/myself/node, 將返回
// => /home/myself/node/wwwroot/static_files/gif/image.gif'
計算兩個絕對路徑的相對路徑
path.relative()可以告訴你如果從一個絕對地址跳轉(zhuǎn)到另外一個絕對地址，比如：
var path = require('path');
path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb');
// => ../../impl/bbb
從路徑提取數(shù)據(jù)
以路徑“/foo/bar/myfile.txt”為例，如果你想獲取父目錄（/foo/bar）的所有內(nèi)容，或者讀取同級目錄的其它文件，為此，你必須用path.dirname(filePath)獲得文件路徑的目錄部分，比如：
var path = require('path');
path.dirname('/foo/bar/baz/asdf/quux.txt');
// => /foo/bar/baz/asdf
或者，你想從文件路徑里得到文件名，也就是文件路徑的最后那一部分，可以使用path.basename函數(shù)：
var path = require('path');
path.basename('/foo/bar/baz/asdf/quux.html')
// => quux.html
文件路徑里可能還包含文件擴展名，通常是文件名中最后一個“.”字符之后的那部分字符串。
path.basename還可以接受一個擴展名字符串作為第二個參數(shù)，這樣返回的文件名就會自動去掉擴展名，僅僅返回文件的名稱部分：
var path = require('path');
path.basename('/foo/bar/baz/asdf/quux.html', '.html');
// => quux
要想這么做你首先還得知道文件的擴展名，可以用path.extname()來獲取擴展名：
var path = require('path');
path.extname('/a/b/index.html');
// => '.html'
path.extname('/a/b.c/index');
// => ''
path.extname('/a/b.c/.');
// => ''
path.extname('/a/b.c/d.');
// => '.'
檢查路徑是否存在
目前為止，前面涉及到的路徑處理操作都跟底層文件系統(tǒng)無關，只是一些字符串操作。然而，有些時候你需要判斷一個文件路徑是否存在，比如，你有時候需要判斷文件或目錄是否存在，如果不存在的話才創(chuàng)建它，可以用path.exsits()：
var path = require('path');
path.exists('/etc/passwd', function(exists) {
console.log('exists:', exists);
// => true
});
path.exists('/does_not_exist', function(exists) {
console.log('exists:', exists);
// => false
});
注意：從Node0.8版本開始，exists從path模塊移到了fs模塊，變成了fs.exists，除了命名空間不同，其它都沒變：
var fs = require('fs');
fs.exists('/does_not_exist', function(exists) {
console.log('exists:', exists);
// => false
});
path.exists()是個I/O操作，因為它是異步的，因此需要一個回調(diào)函數(shù)，當I/O操作返回后調(diào)用這個回調(diào)函數(shù)，并把結(jié)果傳遞給它。你還可以使用它的同步版本path.existsSync()，功能完全一樣，只是它不會調(diào)用回調(diào)函數(shù)，而是直接返回結(jié)果：
var path = require('path');
path.existsSync('/etc/passwd');
// => true
fs模塊介紹
fs模塊包含所有文件查詢和處理的相關函數(shù)，用這些函數(shù)，可以查詢文件信息，讀寫和關閉文件。這樣導入fs模塊：
var fs = require(‘fs')
查詢文件信息
有時你可能需要知道文件的大小，創(chuàng)建日期或者權(quán)限等文件信息，可以使用fs.stath函數(shù)來查詢文件或目錄的元信息：
var fs = require('fs');
fs.stat('/etc/passwd', function(err, stats) {
if (err) { throw err;}
console.log(stats);
});
這塊代碼片斷會有類似下面的輸出
{ dev: 234881026,
ino: 95028917,
mode: 33188,
nlink: 1,
uid: 0,
gid: 0,
rdev: 0,
size: 5086,
blksize: 4096,
blocks: 0,
atime: Fri, 18 Nov 2011 22:44:47 GMT,
mtime: Thu, 08 Sep 2011 23:50:04 GMT,
ctime: Thu, 08 Sep 2011 23:50:04 GMT }
1.fs.stat()調(diào)用會將一個stats類的實例作為參數(shù)傳遞給它的回調(diào)函數(shù)，可以像下面這樣使用stats實例：
2.stats.isFile() —— 如果是個標準文件，而不是目錄，socket，符號鏈接或者設備，則返回true，否則false
3.stats.isDiretory() —— 如果是目錄則返回tue，否則false
4.stats.isBlockDevice() —— 如果是塊設備則返回true，在大多數(shù)UNIX系統(tǒng)中塊設備通常都在/dev目錄下
5.stats.isChracterDevice() —— 如果是字符設備返回true
6.stats.isSymbolickLink() —— 如果是文件鏈接返回true
7.stats.isFifo() —— 如果是個FIFO(UNIX命名管道的一個特殊類型)返回true
8.stats.isSocket() —— 如果是個UNIX socket（TODO：googe it）
打開文件
在讀取或處理文件之前，必須先使用fs.open函數(shù)打開文件，然后你提供的回調(diào)函數(shù)會被調(diào)用，并得到這個文件的描述符，稍后你可以用這個文件描述符來讀寫這個已經(jīng)打開的文件：
var fs = require('fs');
fs.open('/path/to/file', 'r', function(err, fd) {
// got fd file descriptor
});
fs.open的第一個參數(shù)是文件路徑，第二個參數(shù)是一些用來指示以什么模式打開文件的標記，這些標記可以是r，r+，w，w+，a或者a+。下面是這些標記的說明（來自UNIX文檔的fopen頁）
1.r —— 以只讀方式打開文件，數(shù)據(jù)流的初始位置在文件開始
2.r+ —— 以可讀寫方式打開文件，數(shù)據(jù)流的初始位置在文件開始
3.w ——如果文件存在，則將文件長度清0，即該文件內(nèi)容會丟失。如果不存在，則嘗試創(chuàng)建它。數(shù)據(jù)流的初始位置在文件開始
4.w+ —— 以可讀寫方式打開文件，如果文件不存在，則嘗試創(chuàng)建它，如果文件存在，則將文件長度清0，即該文件內(nèi)容會丟失。數(shù)據(jù)流的初始位置在文件開始
5.a —— 以只寫方式打開文件，如果文件不存在，則嘗試創(chuàng)建它，數(shù)據(jù)流的初始位置在文件末尾，隨后的每次寫操作都會將數(shù)據(jù)追加到文件后面。
6.a+ ——以可讀寫方式打開文件，如果文件不存在，則嘗試創(chuàng)建它，數(shù)據(jù)流的初始位置在文件末尾，隨后的每次寫操作都會將數(shù)據(jù)追加到文件后面。
讀文件
一旦打開了文件，就可以開始讀取文件內(nèi)容，但是在開始之前，你得先創(chuàng)建一個緩沖區(qū)（buffer）來放置這些數(shù)據(jù)。這個緩沖區(qū)對象將會以參數(shù)形式傳遞給fs.read函數(shù)，并被fs.read填充上數(shù)據(jù)。
var fs = require('fs');
fs.open('./my_file.txt', 'r', function opened(err, fd) {
if (err) { throw err }
var readBuffer = new Buffer(1024),
bufferOffset = 0,
bufferLength = readBuffer.length,
filePosition = 100;
fs.read(fd,
readBuffer,
bufferOffset,
bufferLength,
filePosition,
function read(err, readBytes) {
if (err) { throw err; }
console.log('just read ' + readBytes + ' bytes');
if (readBytes > 0) {
console.log(readBuffer.slice(0, readBytes));
}
});
});
上面代碼嘗試打開一個文件，當成功打開后(調(diào)用opened函數(shù))，開始請求從文件流第100個字節(jié)開始讀取隨后1024個字節(jié)的數(shù)據(jù)（第11行）。
fs.read()的最后一個參數(shù)是個回調(diào)函數(shù)（第16行），當下面三種情況發(fā)生時，它會被調(diào)用：
1.有錯誤發(fā)生
2.成功讀取了數(shù)據(jù)
3.沒有數(shù)據(jù)可讀
如果有錯誤發(fā)生，第一個參數(shù)（err）會為回調(diào)函數(shù)提供一個包含錯誤信息的對象，否則這個參數(shù)為null。如果成功讀取了數(shù)據(jù)，第二個參數(shù)（readBytes）會指明被讀到緩沖區(qū)里數(shù)據(jù)的大小，如果值是0，則表示到達了文件末尾。
注意：一旦把緩沖區(qū)對象傳遞給fs.open()，緩沖對象的控制權(quán)就轉(zhuǎn)移給給了read命令，只有當回調(diào)函數(shù)被調(diào)用，緩沖區(qū)對象的控制權(quán)才會回到你手里。因此在這之前，不要讀寫或者讓其它函數(shù)調(diào)用使用這個緩沖區(qū)對象；否則，你可能會讀到不完整的數(shù)據(jù)，更糟的情況是，你可能會并發(fā)地往這個緩沖區(qū)對象里寫數(shù)據(jù)。
寫文件
通過傳遞給fs.write()傳遞一個包含數(shù)據(jù)的緩沖對象，來往一個已打開的文件里寫數(shù)據(jù)：
var fs = require('fs');
fs.open('./my_file.txt', 'a', function opened(err, fd) {
if (err) { throw err; }
var writeBuffer = new Buffer('writing this string'),
bufferPosition = 0,
bufferLength = writeBuffer.length, filePosition = null;
fs.write( fd,
writeBuffer,
bufferPosition,
bufferLength,
filePosition,
function wrote(err, written) {
if (err) { throw err; }
console.log('wrote ' + written + ' bytes');
});
});
這個例子里，第2（譯者注：原文為3）行代碼嘗試用追加模式（a）打開一個文件，然后第7行代碼（譯者注：原文為9）向文件寫入數(shù)據(jù)。緩沖區(qū)對象需要附帶幾個信息一起做為參數(shù)：
1.緩沖區(qū)的數(shù)據(jù)
2.待寫數(shù)據(jù)從緩沖區(qū)的什么位置開始
3.待寫數(shù)據(jù)的長度
4.數(shù)據(jù)寫到文件的哪個位置
5.當操作結(jié)束后被調(diào)用的回調(diào)函數(shù)wrote
這個例子里，filePostion參數(shù)為null，也就是說write函數(shù)將會把數(shù)據(jù)寫到文件指針當前所在的位置，因為是以追加模式打開的文件，因此文件指針在文件末尾。
跟read操作一樣，千萬不要在fs.write執(zhí)行過程中使用哪個傳入的緩沖區(qū)對象，一旦fs.write開始執(zhí)行它就獲得了那個緩沖區(qū)對象的控制權(quán)。你只能等到回調(diào)函數(shù)被調(diào)用后才能再重新使用它。
關閉文件
你可能注意到了，到目前為止，本章的所有例子都沒有關閉文件的代碼。因為它們只是些僅使用一次而且又小又簡單的例子，當Node進程結(jié)束時，操作系統(tǒng)會確保關閉所有文件。
但是，在實際的應用程序中，一旦打開一個文件你要確保最終關閉它。要做到這一點，你需要追蹤所有那些已打開的文件描述符，然后在不再使用它們的時候調(diào)用fs.close(fd[,callback])來最終關閉它們。如果你不仔細的話，很容易就會遺漏某個文件描述符。下面的例子提供了一個叫openAndWriteToSystemLog的函數(shù)，展示了如何小心的關閉文件：
var fs = require('fs');
function openAndWriteToSystemLog(writeBuffer, callback){
fs.open('./my_file', 'a', function opened(err, fd) {
if (err) { return callback(err); }
function notifyError(err) {
fs.close(fd, function() {
callback(err);
});
}
var bufferOffset = 0,
bufferLength = writeBuffer.length,
filePosition = null;
fs.write( fd, writeBuffer, bufferOffset, bufferLength, filePosition,
function wrote(err, written) {
if (err) { return notifyError(err); }
fs.close(fd, function() {
callback(err);
});
}
);
});
}
openAndWriteToSystemLog(
new Buffer('writing this string'),
function done(err) {
if (err) {
console.log("error while opening and writing:", err.message);
return;
}
console.log('All done with no errors');
}
);
在這兒，提供了一個叫openAndWriteToSystemLog的函數(shù)，它接受一個包含待寫數(shù)據(jù)的緩沖區(qū)對象，以及一個操作完成或者出錯后被調(diào)用的回調(diào)函數(shù)，如果有錯誤發(fā)生，回調(diào)函數(shù)的第一個參數(shù)會包含這個錯誤對象。
注意那個內(nèi)部函數(shù)notifyError，它會關閉文件，并報告發(fā)生的錯誤。
注意：到此為止，你知道了如何使用底層的原子操作來打開，讀，寫和關閉文件。然而，Node還有一組更高級的構(gòu)造函數(shù)，允許你用更簡單的方式來處理文件。
比如，你想用一種安全的方式，讓兩個或者多個write操作并發(fā)的往一個文件里追加數(shù)據(jù)，這時你可以使用WriteStream。
還有，如果你想讀取一個文件的某個區(qū)域，可以考慮使用ReadStream。這兩種用例會在第九章“數(shù)據(jù)的讀，寫流”里介紹。
小結(jié)
當你使用文件時，多數(shù)情況下都需要處理和提取文件路徑信息，通過使用path模塊你可以連接路徑，標準化路徑，計算路徑的差別，以及將相對路徑轉(zhuǎn)化成絕對路徑。你可以提取指定文件路徑的擴展名，文件名，目錄等路徑組件。
Node在fs模塊里提供了一套底層API來訪問文件系統(tǒng)，底層API使用文件描述符來操作文件。你可以用fs.open打開文件，用fs.write寫文件，用fs.read讀文件，并用fs.close關閉文件。
當有錯誤發(fā)生時，你應該總是使用正確的錯誤處理邏輯來關閉文件——以確保在調(diào)用返回前關閉那些已打開的文件描述符。
相關文章
Node中的util.promisify()方法的基本使用和實現(xiàn)
眾所周知，在JS中實現(xiàn)異步編程主要是通過以下幾種方案，回調(diào)函數(shù)，觀察者模式，Generator，Promise，async / await ，今天就和大家一起聊一下在node中的一個util.promisify()這個API的基本使用和基本實現(xiàn)2023-07-07
node.js中實現(xiàn)token的生成與驗證的操作方法
Token是一種用于在客戶端和服務器之間安全傳輸信息的加密字符串,常用于身份驗證、授權(quán)、狀態(tài)管理和安全性,在Node.js中,常用jsonwebtoken庫生成和驗證Token,本文介紹node.js中實現(xiàn)token的生成與驗證的操作方法,感興趣的朋友一起看看吧2025-01-01
Node做中轉(zhuǎn)服務器轉(zhuǎn)發(fā)接口
這篇文章主要介紹了Node做中轉(zhuǎn)服務器轉(zhuǎn)發(fā)接口的相關資料,需要的朋友可以參考下2017-10-10
這篇文章主要介紹了淺析node.js的模塊加載機制，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-05-05
TJ自我介紹： TJ Holowaychuk ，程序員兼藝術(shù)家，Koa、Co、Express、jade、mocha、node-canvas、commander.js等知名開源項目的創(chuàng)建和貢獻者。2014-07-07
本篇文章主要介紹了NodeJS實現(xiàn)圖片上傳代碼(Express) ，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-06-06
這篇文章主要為大家詳細介紹了Node.js系列之連接DB的方法，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-08-08
sync是一個流程控制工具包，提供了直接而強大的異步功能?；贘avaScript為Node.js設計，同時也可以直接在瀏覽器中使用。下面這篇文章主要介紹了node.js之異步控制工具async的相關資料，需要的朋友可以參考下。2017-02-02
使用pify實現(xiàn)Node.js回調(diào)函數(shù)的Promise化
使用pify庫,你可以非常便利地將任何遵循Node.js回調(diào)風格的函數(shù)轉(zhuǎn)換為返回Promise對象的函數(shù),從而使得你的異步代碼更加清晰和易于維護,本文通過豐富的代碼示例引導你如何有效地利用pify,需要的朋友可以參考下2024-06-06
這篇文章主要給大家介紹了關于利用Node.js檢測端口是否被占用的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧。2017-12-12