nodejs中fs模塊三種讀寫文件方法的使用區(qū)別

更新時間：2024年10月19日 14:23:19 作者：隔壁老陳先生

Node.js的fs模塊有多種文件操作API,readFile、read、createReadStream讀取文件,writeFile、write、createWriteStream寫入文件,readFile和writeFile將文件寫入緩存區(qū),適合小文件操作,read和write分步驟讀寫,適合大文件,createReadStream和createWriteStream通過流處理文件

nodejs中所有與文件相關的操作都在fs模塊中，而讀寫操作又是我們會經(jīng)常用到的操作，nodejs的fs模塊針對讀操作為我們提供了readFile，read, createReadStream三個方法，針對寫操作為我們提供了writeFile，write， createWriteStream三個方法，下面分析一下它們的區(qū)別：

readFile和writeFile

readFile方法是將要讀取的文件內(nèi)容完整讀入緩存區(qū)，再從該緩存區(qū)中讀取文件內(nèi)容，具體操作如下：

fs.readFile('./test.txt', 'utf8', function(err, data){
    console.log(data);  
});
// 同步方法為：
var data = fs.readFileSync('./test.txt', 'utf8');
console.log(data);

同步方法和異步方法的區(qū)別是：在使用同步方法執(zhí)行的操作結(jié)束之前，不能執(zhí)行后續(xù)代碼的執(zhí)行；而異步方法將操作結(jié)果作為回調(diào)函數(shù)的參數(shù)進行返回，方法調(diào)用之后，就可以立即執(zhí)行后續(xù)的代碼，讀取完畢后會調(diào)用對應的回調(diào)函數(shù)。

writeFile方法是將要寫入的文件內(nèi)容完整的讀入緩存區(qū)，然后一次性的將緩存區(qū)中的內(nèi)容寫入都文件中，其同步和異步具體操作如下：

//異步方法
fs.writeFile('./message.txt', '這是第一行',function(err){
    if(err) console.log('寫文件操作失敗');
    else console.log('寫文件操作成功');
});

//同步方法
fs.writeFileSync('./message.txt','這是第一行');

以上的讀寫操作，Node.js將文件內(nèi)容視為一個整體，為其分配緩存區(qū)并且一次性將文件內(nèi)容讀取到緩存區(qū)中，在Sync方法期間，Node.js將不能執(zhí)行任何其他處理。所以當讀寫大文件的時候，有可能造成緩存區(qū)“爆倉”。

read和write

fs.read(fd, buffer, offset, length, position, callback) 知道就行也不用

fd - 通過 fs.open() 方法返回的文件描述符。
buffer - 數(shù)據(jù)寫入的緩沖區(qū)。
offset - 緩沖區(qū)寫入的寫入偏移量。
length - 要從文件中讀取的字節(jié)數(shù)。
position - 文件讀取的起始位置，如果 position 的值為 null，則會從當前文件指針的位置讀取。
callback - 回調(diào)函數(shù)，有三個參數(shù)err, bytesRead, buffer，err 為錯誤信息， bytesRead 表示讀取的字節(jié)數(shù)，buffer 為緩沖區(qū)對象。

read或readSync方法讀取文件內(nèi)容是不斷地將文件中的一小塊內(nèi)容讀入緩存區(qū)，最后從該緩存區(qū)中讀取文件內(nèi)容，具體操作如下

var fs = require('fs');
fs.open('./message.txt','r',function(err,fd){
    var buf = new Buffer(225);
    //讀取fd文件內(nèi)容到buf緩存區(qū)
    fs.read(fd,buf,0,9,3,function(err,bytesRead,buffer){
        console.log(buf.slice(0,bytesRead).toString());
    }); 
    var buff = new Buffer(225);
    //位置設置為null會默認從文件當前位置讀取
    fs.read(fd,buff,0,3,null,function(err,bytesRead,buffer){
        console.log(buff.slice(0,bytesRead).toString());
    });

    var buffer = new Buffer(225);
    //同步方法讀取文件
    var bytesRead = fs.readFileSync(fd,buffer,0,9,3);
    console.log(bytesRead);
    console.log(buffer.slice(0,bytesRead).toString());
});

write或writeSync方法寫入內(nèi)容時，node.js執(zhí)行以下過程：1將需要寫入的數(shù)據(jù)寫入到一個內(nèi)存緩存區(qū)；2待緩存區(qū)寫滿后再將緩存區(qū)中的內(nèi)容寫入到文件中；3重復執(zhí)行步驟1和步驟2，知道數(shù)據(jù)全部寫入文件為止。具體操作如下：

var fs = require('fs');
var buf = new Buffer('我喜愛編程');
fs.open('./mess.txt','w',function(err,fd){
    fs.write(fd,buf,3,9,0,function(err,written,buffer){
        fs.write(fd,buf,12,3,null,function(err,written,buffer){
            if(err) console.log('寫文件操作失敗');
            console.log('寫文件操作成功');
        });
    });
    //同步寫入
    fs.writeSync(fd,buf,3,9,0);
});

以上讀寫操作，node.js會將文件分成一塊一塊逐步操作，在讀寫文件過程中允許執(zhí)行其他操作。

但有的時候我們并不關心整個文件的內(nèi)容，而只關注從文件中讀取到的某些數(shù)據(jù)，以及讀取到數(shù)據(jù)時需要執(zhí)行的處理，這時我們可以使用文件流來處理。

createReadStream和createWriteStream

createReadStream方法創(chuàng)建一個將文件內(nèi)容讀取為流數(shù)據(jù)的ReadStream對象，方法如下所示：

var fs = require('fs');
var readStream = fs.createReadStream('./message.txt',{start:3,end:12});
readStream.on('open',function(fd){
    console.log('開始讀取文件');
});
readStream.on('data',function(data){
    console.log('讀取到數(shù)據(jù)：');
    console.log(data);
});
readStream.on('end',function(){
    console.log('文件已全部讀取完畢');
});
readStream.on('close',function(){
    console.log('文件被關閉');
});
readStream.on('error',function(err){
    console.log('讀取文件失敗');
});

createWriteStream方法創(chuàng)建一個將流數(shù)據(jù)寫入文件中的WriteStream對象，方法如下所示：

var fs = require('fs');
var file = fs.createReadStream('./message.txt');
var out = fs.createWriteStream('./anotherMessage.txt');
file.on('data',function(data){
    out.write(data);
});
out.on('open',function(fd){
    console.log('需要被寫入的文件已打開');
});
file.on('end',function(){
    //將操作系統(tǒng)緩存區(qū)中的數(shù)據(jù)全部寫入文件
    out.end('再見',function(){
        console.log('文件全部寫入完畢');
        console.log('共寫入'+out.bytesWritten+'數(shù)據(jù)');
    });
});

以上方法可以對讀寫文件的過程中進行監(jiān)聽，并定義相關的方法pause和resume暫?；蚧謴臀募淖x取操作，可以監(jiān)聽寫入時緩存區(qū)數(shù)據(jù)是否已滿或者是否已全部輸出，如下所示：

//監(jiān)聽writeStream對象的drain事件
var fs = require('fs');
var out = fs.createWriteStream('./test1.txt');
for(var i=0;i<10000;i++){
    //返回true或false true代表緩存區(qū)已滿
    var flag = out.write(i.toString());
    console.log(flag);
}
out.on('drain',function(){
    console.log('操作系統(tǒng)緩存區(qū)中的數(shù)據(jù)已全部輸出');
    var out = fs.createWriteStream('./test2.txt');
    for(var i=0;i<10;i++){
        var flag = out.write(i.toString());
        console.log(flag);
    }
    out.on('drain',function(){
        console.log('操作系統(tǒng)緩存區(qū)中的數(shù)據(jù)已全部輸出');
    });
});

readFile和createReadStream

Node.js提供了兩種讀取和執(zhí)行文件的方式，分別是使用readFile和createReadStream。readFile()是一個完全緩沖的進程，只有當完整的文件被推入緩沖區(qū)并被讀取時才返回響應。這是一個內(nèi)存密集型過程，在大文件的情況下，處理速度可能非常慢。而createReadStream是部分緩沖的，它將整個過程視為一個事件系列。整個文件被分成塊，然后被處理并作為響應一一發(fā)回。完成后，它們最終會從緩沖區(qū)中刪除。與readFile不同，createReadStream對于大文件的處理非常有效。