Node.js 常用工具
util 是一個Node.js 核心模塊，提供常用函數(shù)的集合，用于彌補核心JavaScript 的功能 過于精簡的不足。
util.inherits
util.inherits(constructor, superConstructor)是一個實現(xiàn)對象間原型繼承 的函數(shù)。
JavaScript 的面向?qū)ο筇匦允腔谠偷模c常見的基于類的不同。JavaScript 沒有 提供對象繼承的語言級別特性，而是通過原型復(fù)制來實現(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);
我們定義了一個基礎(chǔ)對象Base 和一個繼承自Base 的Sub，Base 有三個在構(gòu)造函數(shù) 內(nèi)定義的屬性和一個原型中定義的函數(shù)，通過util.inherits 實現(xiàn)繼承。運行結(jié)果如下：
注意：Sub 僅僅繼承了Base 在原型中定義的函數(shù)，而構(gòu)造函數(shù)內(nèi)部創(chuàng)造的 base 屬 性和 sayHello 函數(shù)都沒有被 Sub 繼承。
同時，在原型中定義的屬性不會被console.log 作 為對象的屬性輸出。如果我們?nèi)サ?objSub.sayHello(); 這行的注釋，將會看到：
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])是一個將任意對象轉(zhuǎn)換 為字符串的方法，通常用于調(diào)試和錯誤輸出。它至少接受一個參數(shù) object，即要轉(zhuǎn)換的對象。
showHidden 是一個可選參數(shù)，如果值為 true，將會輸出更多隱藏信息。
depth 表示最大遞歸的層數(shù)，如果對象很復(fù)雜，你可以指定層數(shù)以控制輸出信息的多 少。如果不指定depth，默認(rèn)會遞歸2層，指定為 null 表示將不限遞歸層數(shù)完整遍歷對象。 如果color 值為 true，輸出格式將會以ANSI 顏色編碼，通常用于在終端顯示更漂亮 的效果。
特別要指出的是，util.inspect 并不會簡單地直接把對象轉(zhuǎn)換為字符串，即使該對 象定義了toString 方法也不會調(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));
運行結(jié)果是：
util.isArray(object)
如果給定的參數(shù) "object" 是一個數(shù)組返回true，否則返回false。
var util = require('util');
util.isArray([])
// true
util.isArray(new Array)
// true
util.isArray({})
// false
util.isRegExp(object)
如果給定的參數(shù) "object" 是一個正則表達(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" 是一個日期返回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" 是一個錯誤對象返回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)語法如下所示：
var fs = require("fs")
異步和同步
Node.js 文件系統(tǒng)（fs 模塊）模塊中的方法均有異步和同步版本，例如讀取文件內(nèi)容的函數(shù)有異步的 fs.readFile() 和同步的 fs.readFileSync()。
異步的方法函數(shù)最后一個參數(shù)為回調(diào)函數(shù)，回調(diào)函數(shù)的第一個參數(shù)包含了錯誤信息(error)。
建議大家是用異步方法，比起同步，異步方法性能更高，速度更快，而且沒有阻塞。
實例
創(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)的方法。
打開文件
語法
以下為在異步模式下打開文件的語法格式：
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ù)，帶有兩個參數(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+'， 但是如果文件路徑存在，則文件讀取追加失敗。
實例
接下來我們創(chuàng)建 file.js 文件，并打開 input.txt 文件進行讀寫，代碼如下所示：
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é)果如下：
獲取文件信息
語法
以下為通過異步模式獲取文件信息的語法格式：
fs.stat(path, callback)
參數(shù)
參數(shù)使用說明如下：
<li>path - 文件路徑。
<li>callback - 回調(diào)函數(shù)，帶有兩個參數(shù)如：(err, stats), stats 是 fs.Stats 對象。
fs.stat(path)執(zhí)行后，會將stats類的實例返回給其回調(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。
實例
接下來我們創(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("讀取文件信息成功！");
// 檢測文件類型
console.log("是否為文件(isFile) ? " + stats.isFile());
console.log("是否為目錄(isDirectory) ? " + stats.isDirectory());
});
以上代碼執(zhí)行結(jié)果如下：
寫入文件
語法
以下為異步模式下寫入文件的語法格式：
fs.writeFile(file, data[, options], callback)
如果文件存在，該方法寫入的內(nèi)容會覆蓋舊的文件內(nèi)容。
參數(shù)
參數(shù)使用說明如下：
<li>file - 文件名或文件描述符。
<li>data - 要寫入文件的數(shù)據(jù)，可以是 String(字符串) 或 Buffer(流) 對象。
<li>options - 該參數(shù)是一個對象，包含 {encoding, mode, flag}。默認(rèn)編碼為 utf8, 模式為 0666 ， flag 為 'w'
<li>callback - 回調(diào)函數(shù)，回調(diào)函數(shù)只包含錯誤信息參數(shù)(err)，在寫入失敗時返回。
實例
接下來我們創(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é)果如下：
讀取文件
語法
以下為異步模式下寫入文件的語法格式：
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，則會從當(dāng)前文件指針的位置讀取。
<li>callback - 回調(diào)函數(shù)，有三個參數(shù)err, bytesRead, buffer，err 為錯誤信息， bytesRead 表示讀取的字節(jié)數(shù)，buffer 為緩沖區(qū)對象。
實例
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)閉文件
語法
以下為異步模式下關(guān)閉文件的語法格式：
fs.close(fd, callback)
該方法使用了文件描述符來讀取文件。
參數(shù)
參數(shù)使用說明如下：
<li>fd - 通過 fs.open() 方法返回的文件描述符。
<li>callback - 回調(diào)函數(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é)果如下：
截取文件
語法
以下為異步模式下截取文件的語法格式：
fs.ftruncate(fd, len, callback)
該方法使用了文件描述符來讀取文件。
參數(shù)
參數(shù)使用說明如下：
<li>fd - 通過 fs.open() 方法返回的文件描述符。
<li>len - 文件內(nèi)容截取的長度。
<li>callback - 回調(diào)函數(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é)果如下：
刪除文件
語法
以下為刪除文件的語法格式：
fs.unlink(path, callback)
參數(shù)
參數(shù)使用說明如下：
<li>path - 文件路徑。
<li>callback - 回調(diào)函數(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)建目錄
語法
以下為創(chuàng)建目錄的語法格式：
fs.mkdir(path[, mode], callback)
參數(shù)
參數(shù)使用說明如下：
<li>path - 文件路徑。
<li>mode - 設(shè)置目錄權(quán)限，默認(rèn)為 0777。
<li>callback - 回調(diào)函數(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)建成功。
讀取目錄
語法
以下為讀取目錄的語法格式：
fs.readdir(path, callback)
參數(shù)
參數(shù)使用說明如下：
<li>path - 文件路徑。
<li>callback - 回調(diào)函數(shù)，回調(diào)函數(shù)帶有兩個參數(shù)err, files，err 為錯誤信息，files 為 目錄下的文件數(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é)果如下：
刪除目錄
語法
以下為刪除目錄的語法格式：
fs.rmdir(path, callback)
參數(shù)
參數(shù)使用說明如下：
<li>path - 文件路徑。
<li>callback - 回調(diào)函數(shù)，沒有參數(shù)。
實例
接下來我們創(chuàng)建 file.js 文件，代碼如下所示：
var fs = require("fs");
// 執(zhí)行前創(chuàng)建一個空的 /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 目錄
……
