Node.js 常用工具

util 是一個(gè)Node.js 核心模塊，提供常用函數(shù)的集合漱挎，用于彌補(bǔ)核心JavaScript 的功能 過于精簡(jiǎn)的不足只磷。

util.inherits

util.inherits(constructor, superConstructor)是一個(gè)實(shí)現(xiàn)對(duì)象間原型繼承 的函數(shù)弱匪。
JavaScript 的面向?qū)ο筇匦允腔谠偷年侵瑁c常見的基于類的不同。JavaScript 沒有 提供對(duì)象繼承的語(yǔ)言級(jí)別特性帝璧，而是通過原型復(fù)制來實(shí)現(xiàn)的滥壕。
在這里我們只介紹util.inherits 的用法，示例如下：

var util = require('util'); 
function Base() { 
    this.name = 'base'; 
    this.base = 1991; 
    this.sayHello = function() { 
    console.log('Hello ' + this.name); 
    }; 
} 
Base.prototype.showName = function() { 
    console.log(this.name);
}; 
function Sub() { 
    this.name = 'sub'; 
} 
util.inherits(Sub, Base); 
var objBase = new Base(); 
objBase.showName(); 
objBase.sayHello(); 
console.log(objBase); 
var objSub = new Sub(); 
objSub.showName(); 
//objSub.sayHello(); 
console.log(objSub); 

我們定義了一個(gè)基礎(chǔ)對(duì)象Base 和一個(gè)繼承自Base 的Sub朽们，Base 有三個(gè)在構(gòu)造函數(shù) 內(nèi)定義的屬性和一個(gè)原型中定義的函數(shù)怀读，通過util.inherits 實(shí)現(xiàn)繼承。運(yùn)行結(jié)果如下：

注意：Sub 僅僅繼承了Base 在原型中定義的函數(shù)骑脱，而構(gòu)造函數(shù)內(nèi)部創(chuàng)造的 base 屬 性和 sayHello 函數(shù)都沒有被 Sub 繼承菜枷。
同時(shí)，在原型中定義的屬性不會(huì)被console.log 作 為對(duì)象的屬性輸出叁丧。如果我們?nèi)サ?objSub.sayHello(); 這行的注釋啤誊，將會(huì)看到：

node.js:201 
throw e; // process.nextTick error, or 'error' event on first tick 
^ 
TypeError: Object #<Sub> has no method 'sayHello' 
at Object.<anonymous> (/home/byvoid/utilinherits.js:29:8) 
at Module._compile (module.js:441:26) 
at Object..js (module.js:459:10) 
at Module.load (module.js:348:31) 
at Function._load (module.js:308:12) 
at Array.0 (module.js:479:10) 
at EventEmitter._tickCallback (node.js:192:40) 

util.inspect

util.inspect(object,[showHidden],[depth],[colors])是一個(gè)將任意對(duì)象轉(zhuǎn)換 為字符串的方法，通常用于調(diào)試和錯(cuò)誤輸出拥娄。它至少接受一個(gè)參數(shù) object蚊锹，即要轉(zhuǎn)換的對(duì)象。
showHidden 是一個(gè)可選參數(shù)稚瘾，如果值為 true牡昆，將會(huì)輸出更多隱藏信息。
depth 表示最大遞歸的層數(shù)摊欠，如果對(duì)象很復(fù)雜丢烘，你可以指定層數(shù)以控制輸出信息的多 少柱宦。如果不指定depth，默認(rèn)會(huì)遞歸2層播瞳，指定為 null 表示將不限遞歸層數(shù)完整遍歷對(duì)象捷沸。 如果color 值為 true，輸出格式將會(huì)以ANSI 顏色編碼狐史，通常用于在終端顯示更漂亮 的效果痒给。
特別要指出的是，util.inspect 并不會(huì)簡(jiǎn)單地直接把對(duì)象轉(zhuǎn)換為字符串骏全，即使該對(duì) 象定義了toString 方法也不會(huì)調(diào)用苍柏。

var util = require('util'); 
function Person() { 
    this.name = 'byvoid'; 
    this.toString = function() { 
    return this.name; 
    }; 
} 
var obj = new Person(); 
console.log(util.inspect(obj)); 
console.log(util.inspect(obj, true)); 

運(yùn)行結(jié)果是：

util.isArray(object)

如果給定的參數(shù) "object" 是一個(gè)數(shù)組返回true，否則返回false姜贡。

var util = require('util');
util.isArray([])
  // true
util.isArray(new Array)
  // true
util.isArray({})
  // false

util.isRegExp(object)

如果給定的參數(shù) "object" 是一個(gè)正則表達(dá)式返回true试吁，否則返回false。

var util = require('util');
util.isRegExp(/some regexp/)
  // true
util.isRegExp(new RegExp('another regexp'))
  // true
util.isRegExp({})
  // false

util.isDate(object)

如果給定的參數(shù) "object" 是一個(gè)日期返回true楼咳，否則返回false熄捍。

var util = require('util');
util.isDate(new Date())
  // true
util.isDate(Date())
  // false (without 'new' returns a String)
util.isDate({})
  // false

util.isError(object)

如果給定的參數(shù) "object" 是一個(gè)錯(cuò)誤對(duì)象返回true，否則返回false母怜。

var util = require('util');
util.isError(new Error())
  // true
util.isError(new TypeError())
  // true
util.isError({ name: 'Error', message: 'an error occurred' })
  // false

Node.js 文件系統(tǒng)

Node.js 提供一組類似 UNIX（POSIX）標(biāo)準(zhǔn)的文件操作API余耽。 Node 導(dǎo)入文件系統(tǒng)模塊(fs)語(yǔ)法如下所示：

var fs = require("fs")

異步和同步

Node.js 文件系統(tǒng)（fs 模塊）模塊中的方法均有異步和同步版本，例如讀取文件內(nèi)容的函數(shù)有異步的 fs.readFile() 和同步的 fs.readFileSync()苹熏。
異步的方法函數(shù)最后一個(gè)參數(shù)為回調(diào)函數(shù)碟贾，回調(diào)函數(shù)的第一個(gè)參數(shù)包含了錯(cuò)誤信息(error)。
建議大家是用異步方法轨域，比起同步袱耽，異步方法性能更高，速度更快干发，而且沒有阻塞朱巨。

實(shí)例

創(chuàng)建 input.txt 文件，內(nèi)容如下：

hello world!

創(chuàng)建 file.js 文件, 代碼如下：

var fs = require("fs");
// 異步讀取
fs.readFile('input.txt', function (err, data) {
   if (err) {
       return console.error(err);
   }
   console.log("異步讀取: " + data.toString());
});
// 同步讀取
var data = fs.readFileSync('input.txt');
console.log("同步讀取: " + data.toString());
console.log("程序執(zhí)行完畢枉长。");

以上代碼執(zhí)行結(jié)果如下：

接下來冀续，讓我們來具體了解下 Node.js 文件系統(tǒng)的方法。

打開文件

語(yǔ)法

以下為在異步模式下打開文件的語(yǔ)法格式：

fs.open(path, flags[, mode], callback)

參數(shù)

參數(shù)使用說明如下：
<li>path - 文件的路徑搀暑。
<li>flags - 文件打開的行為沥阳。具體值詳見下文跨琳。
<li>mode - 設(shè)置文件模式(權(quán)限)自点，文件創(chuàng)建默認(rèn)權(quán)限為 0666(可讀，可寫)脉让。
<li>callback - 回調(diào)函數(shù)桂敛，帶有兩個(gè)參數(shù)如：callback(err, fd)功炮。
flags 參數(shù)可以是以下值：
<li>r 以讀取模式打開文件。如果文件不存在拋出異常术唬。
<li>r+ 以讀寫模式打開文件薪伏。如果文件不存在拋出異常。
<li>rs 以同步的方式讀取文件粗仓。
<li>rs+ 以同步的方式讀取和寫入文件嫁怀。
<li>w 以寫入模式打開文件，如果文件不存在則創(chuàng)建借浊。
<li>wx 類似 'w'塘淑，但是如果文件路徑存在，則文件寫入失敗蚂斤。
<li>w+ 以讀寫模式打開文件存捺，如果文件不存在則創(chuàng)建。
<li>wx+ 類似 'w+'曙蒸， 但是如果文件路徑存在捌治，則文件讀寫失敗。
<li>a 以追加模式打開文件纽窟，如果文件不存在則創(chuàng)建肖油。
<li>ax 類似 'a'， 但是如果文件路徑存在臂港，則文件追加失敗构韵。
<li>a+ 以讀取追加模式打開文件，如果文件不存在則創(chuàng)建趋艘。
<li>ax+ 類似 'a+'疲恢， 但是如果文件路徑存在，則文件讀取追加失敗瓷胧。

實(shí)例

接下來我們創(chuàng)建 file.js 文件显拳，并打開 input.txt 文件進(jìn)行讀寫，代碼如下所示：

var fs = require("fs");
// 異步打開文件
console.log("準(zhǔn)備打開文件搓萧！");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
  console.log("文件打開成功杂数！");     
});

以上代碼執(zhí)行結(jié)果如下：

獲取文件信息

語(yǔ)法

以下為通過異步模式獲取文件信息的語(yǔ)法格式：

fs.stat(path, callback)

參數(shù)

參數(shù)使用說明如下：
<li>path - 文件路徑。
<li>callback - 回調(diào)函數(shù)瘸洛，帶有兩個(gè)參數(shù)如：(err, stats), stats 是 fs.Stats 對(duì)象揍移。
fs.stat(path)執(zhí)行后，會(huì)將stats類的實(shí)例返回給其回調(diào)函數(shù)反肋∧欠ィ可以通過stats類中的提供方法判斷文件的相關(guān)屬性。例如判斷是否為文件：

var fs = require('fs');
fs.stat('/Users/download/demo/demo.js', function (err, stats) {
    console.log(stats.isFile());        //true
})

stats類中的方法有：
<li>stats.isFile() 如果是文件返回 true，否則返回 false罕邀。
<li>stats.isDirectory() 如果是目錄返回 true畅形，否則返回 false。
<li>stats.isBlockDevice() 如果是塊設(shè)備返回 true诉探，否則返回 false日熬。
<li>stats.isCharacterDevice() 如果是字符設(shè)備返回 true，否則返回 false肾胯。
<li>stats.isSymbolicLink() 如果是軟鏈接返回 true竖席，否則返回 false。
<li>stats.isFIFO() 如果是FIFO敬肚，返回true怕敬，否則返回 false。FIFO是UNIX中的一種特殊類型的命令管道帘皿。
<li>stats.isSocket() 如果是 Socket 返回 true东跪，否則返回 false。

實(shí)例

接下來我們創(chuàng)建 file.js 文件鹰溜，代碼如下所示：

var fs = require("fs");
console.log("準(zhǔn)備打開文件虽填！");
fs.stat('input.txt', function (err, stats) {
   if (err) {
       return console.error(err);
   }
   console.log(stats);
   console.log("讀取文件信息成功！");
   // 檢測(cè)文件類型
   console.log("是否為文件(isFile) ? " + stats.isFile());
   console.log("是否為目錄(isDirectory) ? " + stats.isDirectory());    
});

以上代碼執(zhí)行結(jié)果如下：

寫入文件

語(yǔ)法

以下為異步模式下寫入文件的語(yǔ)法格式：

fs.writeFile(file, data[, options], callback)

如果文件存在曹动，該方法寫入的內(nèi)容會(huì)覆蓋舊的文件內(nèi)容斋日。

參數(shù)

參數(shù)使用說明如下：
<li>file - 文件名或文件描述符。
<li>data - 要寫入文件的數(shù)據(jù)墓陈，可以是 String(字符串) 或 Buffer(流) 對(duì)象恶守。
<li>options - 該參數(shù)是一個(gè)對(duì)象，包含 {encoding, mode, flag}贡必。默認(rèn)編碼為 utf8, 模式為 0666 兔港， flag 為 'w'
<li>callback - 回調(diào)函數(shù)，回調(diào)函數(shù)只包含錯(cuò)誤信息參數(shù)(err)仔拟，在寫入失敗時(shí)返回衫樊。

實(shí)例

接下來我們創(chuàng)建 file.js 文件，代碼如下所示：

var fs = require("fs");
console.log("準(zhǔn)備寫入文件");
fs.writeFile('input.txt', '我是通過寫入的文件內(nèi)容利花！',  function(err) {
   if (err) {
       return console.error(err);
   }
   console.log("數(shù)據(jù)寫入成功科侈！");
   console.log("--------我是分割線-------------")
   console.log("讀取寫入的數(shù)據(jù)！");
   fs.readFile('input.txt', function (err, data) {
      if (err) {
         return console.error(err);
      }
      console.log("異步讀取文件數(shù)據(jù): " + data.toString());
   });
});

以上代碼執(zhí)行結(jié)果如下：

讀取文件

語(yǔ)法

以下為異步模式下寫入文件的語(yǔ)法格式：

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

該方法使用了文件描述符來讀取文件炒事。

參數(shù)

參數(shù)使用說明如下：
<li>fd - 通過 fs.open() 方法返回的文件描述符臀栈。
<li>buffer - 數(shù)據(jù)寫入的緩沖區(qū)。
<li>offset - 緩沖區(qū)寫入的寫入偏移量挠乳。
<li>length - 要從文件中讀取的字節(jié)數(shù)权薯。
<li>position - 文件讀取的起始位置姑躲，如果 position 的值為 null，則會(huì)從當(dāng)前文件指針的位置讀取崭闲。
<li>callback - 回調(diào)函數(shù)肋联，有三個(gè)參數(shù)err, bytesRead, buffer威蕉，err 為錯(cuò)誤信息刁俭， bytesRead 表示讀取的字節(jié)數(shù)，buffer 為緩沖區(qū)對(duì)象韧涨。

實(shí)例

input.txt 文件內(nèi)容為：

hello,world!

接下來我們創(chuàng)建 file.js 文件牍戚，代碼如下所示：

var fs = require("fs");
var buf = new Buffer(1024);
console.log("準(zhǔn)備打開已存在的文件！");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   console.log("文件打開成功虑粥！");
   console.log("準(zhǔn)備讀取文件：");
   fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
      if (err){
         console.log(err);
      }
      console.log(bytes + "  字節(jié)被讀取");
      // 僅輸出讀取的字節(jié)
      if(bytes > 0){
         console.log(buf.slice(0, bytes).toString());
      }
   });
});

以上代碼執(zhí)行結(jié)果如下：

關(guān)閉文件

語(yǔ)法

以下為異步模式下關(guān)閉文件的語(yǔ)法格式：

fs.close(fd, callback)

該方法使用了文件描述符來讀取文件如孝。

參數(shù)

參數(shù)使用說明如下：
<li>fd - 通過 fs.open() 方法返回的文件描述符。
<li>callback - 回調(diào)函數(shù)娩贷，沒有參數(shù)第晰。

實(shí)例

input.txt 文件內(nèi)容為：

hello,world!

接下來我們創(chuàng)建 file.js 文件，代碼如下所示：

var fs = require("fs");
var buf = new Buffer(1024);
console.log("準(zhǔn)備打開文件彬祖！");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   console.log("文件打開成功茁瘦！");
   console.log("準(zhǔn)備讀取文件！");
   fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
      if (err){
         console.log(err);
      }
      // 僅輸出讀取的字節(jié)
      if(bytes > 0){
         console.log(buf.slice(0, bytes).toString());
      }
      // 關(guān)閉文件
      fs.close(fd, function(err){
         if (err){
            console.log(err);
         } 
         console.log("文件關(guān)閉成功");
      });
   });
});

以上代碼執(zhí)行結(jié)果如下：

截取文件

語(yǔ)法

以下為異步模式下截取文件的語(yǔ)法格式：

fs.ftruncate(fd, len, callback)

該方法使用了文件描述符來讀取文件储笑。

參數(shù)

參數(shù)使用說明如下：
<li>fd - 通過 fs.open() 方法返回的文件描述符甜熔。
<li>len - 文件內(nèi)容截取的長(zhǎng)度。
<li>callback - 回調(diào)函數(shù)突倍，沒有參數(shù)腔稀。

實(shí)例

input.txt 文件內(nèi)容為：

hello,world!

接下來我們創(chuàng)建 file.js 文件，代碼如下所示：

var fs = require("fs");
var buf = new Buffer(1024);
console.log("準(zhǔn)備打開文件羽历！");
fs.open('input.txt', 'r+', function(err, fd) {
   if (err) {
       return console.error(err);
   }
   console.log("文件打開成功焊虏！");
   console.log("截取10字節(jié)后的文件內(nèi)容。");
      // 截取文件
   fs.ftruncate(fd, 10, function(err){
      if (err){
         console.log(err);
      } 
      console.log("文件截取成功秕磷。");
      console.log("讀取相同的文件"); 
      fs.read(fd, buf, 0, buf.length, 0, function(err, bytes){
         if (err){
            console.log(err);
         }
         // 僅輸出讀取的字節(jié)
         if(bytes > 0){
            console.log(buf.slice(0, bytes).toString());
         }
         // 關(guān)閉文件
         fs.close(fd, function(err){
            if (err){
               console.log(err);
            } 
            console.log("文件關(guān)閉成功炕淮！");
         });
      });
   });
});

以上代碼執(zhí)行結(jié)果如下：

刪除文件

語(yǔ)法

以下為刪除文件的語(yǔ)法格式：

fs.unlink(path, callback)

參數(shù)

參數(shù)使用說明如下：
<li>path - 文件路徑。
<li>callback - 回調(diào)函數(shù)跳夭，沒有參數(shù)涂圆。

實(shí)例

input.txt 文件內(nèi)容為：

hello,world!

接下來我們創(chuàng)建 file.js 文件，代碼如下所示：

var fs = require("fs");
console.log("準(zhǔn)備刪除文件币叹！");
fs.unlink('input.txt', function(err) {
   if (err) {
       return console.error(err);
   }
   console.log("文件刪除成功润歉！");
});

以上代碼執(zhí)行結(jié)果如下：

再去查看 input.txt 文件，發(fā)現(xiàn)已經(jīng)不存在了颈抚。

創(chuàng)建目錄

語(yǔ)法

以下為創(chuàng)建目錄的語(yǔ)法格式：

fs.mkdir(path[, mode], callback)

參數(shù)

參數(shù)使用說明如下：
<li>path - 文件路徑踩衩。
<li>mode - 設(shè)置目錄權(quán)限嚼鹉，默認(rèn)為 0777。
<li>callback - 回調(diào)函數(shù)驱富，沒有參數(shù)锚赤。

實(shí)例

接下來我們創(chuàng)建 file.js 文件，代碼如下所示：

var fs = require("fs");
console.log("創(chuàng)建目錄 /tmp/test/");
fs.mkdir("/tmp/test/",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("目錄創(chuàng)建成功褐鸥。");
});

以上代碼執(zhí)行結(jié)果如下：

$ node file.js 
創(chuàng)建目錄 /tmp/test/
目錄創(chuàng)建成功线脚。

讀取目錄

語(yǔ)法

以下為讀取目錄的語(yǔ)法格式：

fs.readdir(path, callback)

參數(shù)

參數(shù)使用說明如下：
<li>path - 文件路徑。
<li>callback - 回調(diào)函數(shù)叫榕，回調(diào)函數(shù)帶有兩個(gè)參數(shù)err, files浑侥，err 為錯(cuò)誤信息，files 為 目錄下的文件數(shù)組列表晰绎。

實(shí)例

接下來我們創(chuàng)建 file.js 文件寓落，代碼如下所示：

var fs = require("fs");
console.log("查看Desktop 目錄");
fs.readdir("Desktop",function(err, files){
   if (err) {
       return console.error(err);
   }
   files.forEach( function (file){
       console.log( file );
   });
});

以上代碼執(zhí)行結(jié)果如下：

刪除目錄

語(yǔ)法

以下為刪除目錄的語(yǔ)法格式：

fs.rmdir(path, callback)

參數(shù)

參數(shù)使用說明如下：
<li>path - 文件路徑。
<li>callback - 回調(diào)函數(shù)荞下，沒有參數(shù)伶选。

實(shí)例

接下來我們創(chuàng)建 file.js 文件，代碼如下所示：

var fs = require("fs");
// 執(zhí)行前創(chuàng)建一個(gè)空的 /tmp/test 目錄
console.log("準(zhǔn)備刪除目錄 /tmp/test");
fs.rmdir("/tmp/test",function(err){
   if (err) {
       return console.error(err);
   }
   console.log("讀取 /tmp 目錄");
   fs.readdir("/tmp/",function(err, files){
      if (err) {
          return console.error(err);
      }
      files.forEach( function (file){
          console.log( file );
      });
   });
});

以上代碼執(zhí)行結(jié)果如下：

$ node file.js 
準(zhǔn)備刪除目錄 /tmp/test
讀取 /tmp 目錄
……

其他文件模塊方法請(qǐng)自行查詢資料