詳解nodejs 文本操作模塊-fs模塊（二）

更新時(shí)間：2016年12月22日 14:05:23 作者：zyl_lyr1019

這篇文章主要介紹了詳解nodejs 文本操作模塊-fs模塊（二）,主要包括文件的讀寫操作，有興趣的可以了解一下。

前一篇學(xué)習(xí)了文件的打開和關(guān)閉，文件操作總不能只包含打開和關(guān)閉吧，這里就開始文件的讀寫操作。

fs模塊方法

1:read和readSync方法

該方法，是從文件的指定位置處讀取文件，一直讀取到文件底部，然后江都區(qū)到的內(nèi)容輸出到一個(gè)緩存區(qū)，使用方法如下：

fs.read(fd,buffer,offset,length,position,callback);

在read方法中，支持6個(gè)參數(shù)：

fd參數(shù)，是文件描述符，是open方法的回調(diào)函數(shù)中獲取到的，是一個(gè)數(shù)字。
buffer，是一個(gè)buffer對(duì)象，用于指定將文件數(shù)據(jù)讀取到那個(gè)緩存區(qū)，如果不定義，則會(huì)生成一個(gè)新的緩存區(qū)，進(jìn)行存放新讀取到的數(shù)據(jù)。
offset，是一個(gè)整數(shù)值，用于指定向緩存區(qū)中寫入數(shù)據(jù)時(shí)的開始位置，以字節(jié)為單位。其實(shí)也就是，讀入到緩存中的數(shù)據(jù)，從buffer對(duì)象的第幾個(gè)元素開始寫入。
length，是一個(gè)整數(shù)值，表示讀入的數(shù)據(jù)，多少數(shù)據(jù)寫入到buffer對(duì)象中去，要保證不能超出buffer的容納范圍，否則會(huì)拋出一個(gè)范圍異常。
position，是一個(gè)整數(shù)值，表示，從文件中的哪個(gè)位置，開始讀取數(shù)據(jù)，如果設(shè)置為非0的整數(shù)，則從該整數(shù)所示的位置，讀取長(zhǎng)度為length的數(shù)據(jù)到buffer對(duì)象中。
callback，回調(diào)函數(shù)，當(dāng)讀取文件成功之后，把執(zhí)行該函數(shù)，該回調(diào)函數(shù)支持三個(gè)參數(shù)：

function (err,bytesRead,buffer){ 
 //err為讀取文件操作失敗時(shí)，觸發(fā)的錯(cuò)誤對(duì)象 
 //bytesRead為讀取到的字節(jié)數(shù)，如果文件的比較大，則該值就是length的值， 
 //如果文件的大小比length小，則該值為實(shí)際中讀取到的字節(jié)數(shù)。 
 //buffer為讀取到的內(nèi)容，保存到了該緩存區(qū)，如果在使用read時(shí)， 
 //傳入了buffer對(duì)象，則此處的buffer就是傳入的buffer對(duì)象。 
 //如果在read時(shí)沒有傳入buffer，則此處的buffer為新創(chuàng)建的buffer對(duì)象 
}

上面把參數(shù)的含義以及回調(diào)函數(shù)的定義，都說明了一下，這里就看一個(gè)示例吧：

var fs = require("fs"); 
 
fs.open("fs.txt","r",function(err,fd){ 
 //讀取fs.text，文件的內(nèi)容為“123456789”，長(zhǎng)度為9 
 var buffer = new Buffer([0,0,0,0,0,0,0,0,0,0]); 
 //創(chuàng)建一個(gè)長(zhǎng)度為10，初始值為0的buffer對(duì)象。 
 //數(shù)據(jù)比較少，就直接寫了，否則還是使用fill方法吧。 
 console.log(buffer); 
 //<Buffer 00 00 00 00 00 00 00 00 00 00> 
 //初始時(shí)的buffer對(duì)象 
  
 fs.read(fd,buffer,4,6,4,function(err,bytesRead,buffer1){ 
  //讀取到的數(shù)據(jù)，從buffer對(duì)象的第5個(gè)元素開始保存，保存6個(gè)字節(jié)的元素 
  //讀取文件，是從文件的第5個(gè)字節(jié)開始，因?yàn)槲募袃?nèi)容長(zhǎng)度為9， 
  //那么，讀取到的內(nèi)容就是56789，所以buffer的最后一位仍然為初始值。 
  //由于想要讀取的字節(jié)長(zhǎng)度為6，但是文件內(nèi)容過短，只讀取了5個(gè)字節(jié)的有效數(shù)據(jù) 
  //就到了文件的結(jié)尾了，所以，bytesRead的值不是6，而是5。 
  //而buffer對(duì)象，為被寫入新數(shù)據(jù)之后的對(duì)象。 
  console.log(bytesRead); //5 
    console.log(buffer1);  
  //<Buffer 00 00 00 00 35 36 37 38 39 00> 
    console.log(buffer); 
  //<Buffer 00 00 00 00 35 36 37 38 39 00> 
  //它們倆是完全相同的。其實(shí)質(zhì)是，它們倆占據(jù)的內(nèi)存也是相同的， 
  //它們就是同一個(gè)緩存區(qū)。 
 }); 
});

一般情況下，異步調(diào)用時(shí)，回調(diào)函數(shù)中，只有兩個(gè)參數(shù)存在，第一個(gè)參數(shù)為err對(duì)象，第二個(gè)參數(shù)為操作之后的數(shù)據(jù)，可是，這里有三個(gè)數(shù)據(jù)，那么在同步時(shí)，什么才是返回值呢？

所以，要做如下的測(cè)試：

var fs = require("fs"); 
 
fs.open("fs.txt","r",function(err,fd){ 
 //讀取fs.text，文件的內(nèi)容為“123456789”，長(zhǎng)度為9 
 var buffer = new Buffer([0,0,0,0,0,0,0,0,0,0]); 
  
 var bytesRead = fs.readSync(fd,buffer,4,6,4); 
 console.log(bytesRead); 
});

返回的是bytesRead的值，并沒有返回buffer對(duì)象，可以想象，因?yàn)閎uffer對(duì)象是原本傳入的buffer對(duì)象，依然可以通過傳入的buffer對(duì)象，直接訪問到重寫數(shù)據(jù)之后的buffer對(duì)象。

但是，有個(gè)問題就來了，如果沒有傳入buffer對(duì)象呢？這又要如何呢？這個(gè)問題暫且別過，因?yàn)檫@個(gè)問題，并沒有在一些API文檔中說明，在書中也沒有看到這個(gè)用法，但是接下來，我們?nèi)シ治鲆幌略创a，就能發(fā)現(xiàn)，除了上述的兩種常用的方法之外，還有其他的使用方式。

OK，先看下read方法的源碼：

fs.read = function(fd, buffer, offset, length, position, callback) { 
 if (!util.isBuffer(buffer)) { 
 //如果傳入的第二個(gè)參數(shù)不是一個(gè)buffer對(duì)象，則做一些自適應(yīng)的處理 
 // legacy string interface (fd, length, position, encoding, callback) 
 var cb = arguments[4], 
  encoding = arguments[3]; 
 //本來read方法是有6個(gè)參數(shù)的，當(dāng)buffer沒有傳入的時(shí)候， 
 //則相應(yīng)的offset也變得沒有意義，所以變?yōu)榱?個(gè)參數(shù)。 
 //而這個(gè)時(shí)候，參數(shù)的形式就變成了前面英文部分的樣子。5個(gè)參數(shù)，加入了encoding參數(shù)。 
  
 assertEncoding(encoding); 
 //判斷傳入的encoding是否是當(dāng)前支持的編碼方式 
 //如果不是，則拋出異常 
 
 position = arguments[2]; 
 length = arguments[1]; 
 buffer = new Buffer(length); 
 offset = 0; 
 //設(shè)置對(duì)應(yīng)的值，新建buffer對(duì)象 
 
 //把callback做一個(gè)代理，根據(jù)傳入的編碼方式，把結(jié)果按照指定的編碼，傳入回調(diào)函數(shù) 
 callback = function(err, bytesRead) { 
  if (!cb) return; 
  //如果回調(diào)函數(shù)不存在，則直接退出 
  
  var str = (bytesRead > 0) ? buffer.toString(encoding, 0, bytesRead) : ''; 
 
  //注意，當(dāng)讀取文件成功后，執(zhí)行了wrapper的回調(diào)，從wrapper中， 
  //執(zhí)行到該callback回調(diào)時(shí)，并沒有傳入buffer對(duì)象， 
  //并且，調(diào)用read中的回調(diào)的三個(gè)參數(shù)是:err,str(按照指定編碼之后的字符串)， 
  //bytesRead(讀取字節(jié)數(shù))，并沒有buffer對(duì)象傳入 
  (cb)(err, str, bytesRead); 
 }; 
 } 
 
 function wrapper(err, bytesRead) { 
 // Retain a reference to buffer so that it can't be GC'ed too soon. 
 // 由這里可以看出，在C++讀取文件時(shí)，回調(diào)函數(shù)只有兩個(gè)值 
 //err對(duì)象和真實(shí)讀取的字節(jié)數(shù)，至于buffer對(duì)象，則是nodejs代理之后 
 //給添加上的 
 callback && callback(err, bytesRead || 0, buffer); 
 } 
 
 //創(chuàng)建一個(gè)實(shí)例，定義oncomplete屬性 
 //該實(shí)例，按照猜測(cè)，應(yīng)該是分段讀取文件的一個(gè)對(duì)象 
 //當(dāng)讀取文件完成之后，會(huì)執(zhí)行oncomplete方法 
 var req = new FSReqWrap(); 
 req.oncomplete = wrapper; 
 
 //調(diào)用C++的接口，開始讀取文件 
 binding.read(fd, buffer, offset, length, position, req); 
};

看了上面的源碼分析，那么也就發(fā)現(xiàn)了另外一種使用read的方法了，即，不輸入buffer和offset，添加encoding的5個(gè)參數(shù)的使用，舉一個(gè)最簡(jiǎn)單的實(shí)例吧。

var fs = require("fs"); 
 
fs.open("fs.txt","r",function(err,fd){ 
 //讀取fs.text，文件的內(nèi)容為“123456789”，長(zhǎng)度為9 
 var buf1 = new Buffer([0,0,0,0,0,0,0,0,0,0]); 
  
 fs.read(fd,6,4,null,function(err,str,bytesRead){ 
  console.log(err); 
  //null 
  console.log("str="+str); 
  //str=56789 
  console.log("bytesRead="+bytesRead); 
  //bytesRead=5 
 }); 
  
});

注意，當(dāng)不傳入buffer對(duì)象時(shí)，回調(diào)函數(shù)中的三個(gè)參數(shù)也相應(yīng)的有了變化，詳情請(qǐng)看前面的實(shí)例代碼中，回調(diào)函數(shù)的參數(shù)以及源碼中的注釋。

繼續(xù)看下readSync的源碼，在本文的前面，也給出了一個(gè)readSync的示例，當(dāng)傳入buffer對(duì)象時(shí)，返回值是讀取到真是字節(jié)數(shù)，那么，既然read方法可以省略buffer對(duì)象，改為返回讀取到的字符串，那么readSync方法呢？這個(gè)就讓我們看下源碼中，是如何處理這些數(shù)據(jù)的。

fs.readSync = function(fd, buffer, offset, length, position) { 
 var legacy = false; 
 if (!util.isBuffer(buffer)) { 
 // legacy string interface (fd, length, position, encoding, callback) 
 //該部分的處理，和read方法內(nèi)部，完全相同，不再注釋。 
 //唯一區(qū)別，legacy標(biāo)識(shí)符，標(biāo)志是否傳入了buffer，為false時(shí)，表示傳入了 
 legacy = true; 
 var encoding = arguments[3]; 
 
 assertEncoding(encoding); 
 
 position = arguments[2]; 
 length = arguments[1]; 
 buffer = new Buffer(length); 
 
 offset = 0; 
 } 
 
 //C++的read方法，如果傳入了第六個(gè)參數(shù)，則屬于讀取成功之后，執(zhí)行的回調(diào)相關(guān)的對(duì)象 
 //如果不傳入，則返回值為讀取到的真是字節(jié)數(shù)，該數(shù)小于等于length 
 var r = binding.read(fd, buffer, offset, length, position); 
 if (!legacy) { 
 //如果，傳入了buffer對(duì)象，則直接返回讀取到的真是字節(jié)數(shù) 
 return r; 
 } 
 
 var str = (r > 0) ? buffer.toString(encoding, 0, r) : ''; 
 //如果沒有傳入buffer對(duì)象，那么返回一個(gè)數(shù)組，該數(shù)組包含兩個(gè)元素， 
 //字符串和讀取到的字節(jié)數(shù) 
 return [str, r]; 
};

那么接下來看下，如果不傳入buffer對(duì)象時(shí)的一個(gè)示例吧：

var fs = require("fs"); 
 
fs.open("fs.txt","r",function(err,fd){ 
 //讀取fs.text，文件的內(nèi)容為“123456789”，長(zhǎng)度為9 
 var buf1 = new Buffer([0,0,0,0,0,0,0,0,0,0]); 
  
 var arr = fs.readSync(fd,6,4,null); 
 console.log(arr); 
 //["56789",5] 
});

OK，到這里，關(guān)于read和readSync方法的使用及一些原理性東西，也基本說完了。

2：write和writeSync方法

有讀取的方法，那么就必然有寫入的方法了，要么flag=w不就無用了么。并且看到了前面的關(guān)于read的一些使用，那么接下來，對(duì)于write的使用，看起來就變得更加的簡(jiǎn)單了，現(xiàn)在直接看下示例：

var fs = require("fs"); 
 
fs.open("fs.txt","a+",function(err,fd){ 
 //讀取fs.text，文件的內(nèi)容為“123456789”，長(zhǎng)度為9 
 var buf1 = new Buffer("我喜愛Nodejs"); 
 console.log(buf1); 
 //顯示buf1的buffer數(shù)據(jù) 
 //計(jì)算buf1的長(zhǎng)度，把該數(shù)據(jù)全部寫入到fs.txt文件中 
 fs.write(fd,buf1,0,buf1.length,0,function(err,len,buf){ 
  console.log("len="+len); 
  //寫入的長(zhǎng)度 
   
  //寫入的buf，其實(shí)和buf1完全相等 
  console.log(buf); 
  fs.read(fd,len,9,"utf8",function(err,str,len2){ 
   console.log("len2="+len2); 
   //讀取從9開始的數(shù)據(jù) 
   console.log("str="+str); 
   //讀取相應(yīng)得到的字符串 
   //我喜愛Nodejs 
  }); 
 }); 
});

從上面這個(gè)示例可以看出，write方法和read方法，使用基本是完全一樣的，只是一個(gè)是在讀取文件一個(gè)是在寫入文件，前提也是需要你在open打開文件時(shí)，使用的flag打開文件方式，要支持讀寫才行。

既然，write和read是相同的使用方法，那么也可以不定義buffer的直接寫入數(shù)據(jù)，所以，可以繼續(xù)看下面的這個(gè)示例：

var fs = require("fs"); 
 
fs.open("fs.txt","a+",function(err,fd){ 
 //讀取fs.text，文件的內(nèi)容為“123456789”，長(zhǎng)度為9 
  
 //復(fù)雜的寫法，和簡(jiǎn)單的寫法，就看個(gè)人喜好了，0代表的是字符串的開始位置 
 //fs.write(fd,"我喜愛Nodejs",0,"utf8",function(err,len,str) 
 fs.write(fd,"我喜愛Nodejs",function(err,len,str){ 
  console.log("len="+len); //len=15 
  //寫入的長(zhǎng)度 
   
  //當(dāng)直接寫入字符串時(shí)，返回的也不再是buffer對(duì)象，而是字符串 
  console.log("str="+str); //我喜愛Nodejs 
  fs.read(fd,len,9,"utf8",function(err,str,len2){ 
   console.log("len2="+len2); //len2=15 
   //讀取從9開始的數(shù)據(jù) 
   console.log("str="+str); 
   //讀取相應(yīng)得到的字符串 
   //我喜愛Nodejs 
  }); 
 }); 
});

這里就不再分析源碼了，基本上write的源碼和read的源碼處理方式類似，只是在最后調(diào)用C++接口不同而已，所以這里也就不再占用空間了。有興趣的可以直接去nodejs的github源碼中，查看：fs.js。

關(guān)于writeSync的用法，用法和write是相同的，只是不需要回調(diào)函數(shù)，并且也不需要返回寫入的數(shù)據(jù)，所以，和readSync的區(qū)別，也就是，readSync在不傳入buffer時(shí)，會(huì)返回一個(gè)長(zhǎng)度為2的數(shù)組，而writeSync不受buffer對(duì)象的影響，只要寫入成功，就會(huì)返回寫入的真實(shí)字節(jié)數(shù)。
不加示例，不加源碼分析，請(qǐng)參考上面的read方法，readSync方法和write方法，也可以參考nodejs的API文檔：Nodejs的API中文版。

總結(jié)

本篇的read和write是文檔操作的基礎(chǔ)，是屬于最基本的操作，也是最重要的操作，本篇也是屬于fs模塊中的基本使用方法，對(duì)于以后學(xué)習(xí)其他方法，以及更好的了解fs模塊有重要的作用，好好學(xué)習(xí)，天天向上。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: