一些小眾卻有用的 Node.js 包
yargs
yargs 是一個(gè)用來處理命令行參數(shù)的包，可以幫你處理自行設(shè)置的命令行標(biāo)志和輸入的任何類型的數(shù)據(jù)，其中包括布爾值、浮點(diǎn)數(shù)和字符串等。這個(gè)包非常簡(jiǎn)單明了，不需要在項(xiàng)目中編寫大量的樣板代碼。
yargs 能夠幫你處理 “用法幫助” 輸出，可以輕松地告訴用戶在使用你程序時(shí)需要輸入哪些選項(xiàng)，包括哪些是必選的。
- var argv = require('yargs')
- .usage('Usage: $0 -x [num] -y [num]')
- .demand(['x','y'])
- .argv;
- console.log('Pow(x, y):', Math.pow(argv.x, argv.y));
把上面的代碼保存為 index.js，然后在命令行中執(zhí)行 node index.js -x 3，會(huì)看到如下消息：
- Usage: index.js -x [num] -y [num]
- Options:
- -x [required]
- -y [required]
- Missing required argument: y
yargs 能夠提示我們命令行中到底缺少什么參數(shù)，而我們只需要簡(jiǎn)單的調(diào)用 .usage()和 .demand() 方法就行了。
toobusy
這是一個(gè)非常實(shí)用的包。它輪詢 Node 事件循環(huán)并跟蹤完成請(qǐng)求所需的時(shí)間，如果發(fā)現(xiàn)延遲時(shí)間太長(zhǎng)，則 toobusy 會(huì)通知你，然后你就可以將 HTTP 503 "Service Unavailable" 狀態(tài)碼返回給客戶端。
這種處理是很重要的，因?yàn)榉?wù)器越忙，請(qǐng)求所等待的時(shí)間也就越長(zhǎng)。這很快就成為一個(gè)很復(fù)雜的問題，隨著時(shí)間的流逝會(huì)越來越嚴(yán)重。如果你聽之任之的話，那么服務(wù)將會(huì)崩潰。如果我們能及時(shí)的停止一些請(qǐng)求的處理，并返回 HTTP 503，這樣的話至少還能處理一些請(qǐng)求。
可以輕松的用 npm 命令安裝 toobusy：
- npm install toobusy
然后把它和類似 Express 的東西集成在一起：
- var toobusy = require('toobusy'),
- express = require('express');
- var app = express();
- // 如果服務(wù)器壓力過大將會(huì)阻止請(qǐng)求
- app.use(function(req, res, next) {
- if (toobusy()) {
- res.send(503, "Too many users!");
- } else {
- next();
- }
- });
- var server = app.listen(3000);
- process.on('SIGINT', function() {
- server.close();
- toobusy.shutdown(); // 正常退出
- process.exit();
- });
不需要寫多少代碼，也不用太多的配置就能繼承到我們自己的項(xiàng)目中。
chalk
在命令行上很難開發(fā)出一個(gè)好用的用戶界面，因?yàn)橛糜诤陀脩艚换サ闹皇敲钚写翱?。那么你該如何去提示一些重要的信息?在輸出的文本中添加格式不失為一種好方法。Express 就是一個(gè)很典型的例子，從它的輸出中，你可以很輕松地快讀找到重要的信息。
以下是 chalk 支持的樣式列表：
修飾符bold
- underline
- dim
- reset
- hidden
- inverse
- italic (并非所有環(huán)境都支持)
- strikethrough (任何環(huán)境下都不支持)
顏色
- red
- black
- green
- white
- yellow
- blue (在 Windows 上會(huì)使用較亮的版本，因?yàn)槠胀ǖ乃{(lán)色很難辨認(rèn))
- cyan
- gray
- magenta
背景顏色
- bgBlue
- bgBlack
- bgRed
- bgGreen
- bgCyan
- bgYellow
- bgWhite
- bgMagenta
雖然官方只支持這些顏色，但是任何符合 xterm 標(biāo)準(zhǔn)的終端都可以使用完整的 8 位色代碼。
只需要將字符串傳給用于著色或格式化的函數(shù)就能輕松的格式化這些文本。如果你需要讓用戶注意到嚴(yán)重錯(cuò)誤提示，可以用下面的格式：
- var chalk = require('chalk');
- var str = chalk.red.bold('ERROR: ') + chalk.bold('Everything just blew up...');
- console.log(str);
node-inspector
好用的調(diào)試器很難找，尤其是那些帶有好用的 GUI 的調(diào)試器，node-inspector 為你提供了一個(gè)網(wǎng)頁(yè) GUI 來幫助調(diào)試代碼。它有標(biāo)準(zhǔn)調(diào)試器的所有功能，例如斷點(diǎn)、單步執(zhí)行、退出代碼以及變量檢查等，另外還有一些不太常用的功能，但是這些功能非常有用，例如 CPU 和堆分析、網(wǎng)絡(luò)客戶端請(qǐng)求檢查以及實(shí)時(shí)編輯運(yùn)行代碼的功能。
node-inspector
不過 node-inspector 只與 Chrome 和 Opera 兼容，因?yàn)樗褂昧薆link Developer Tools，并與Node兼容。
一直以來我非常依賴控制臺(tái)輸出進(jìn)行調(diào)試，這會(huì)花費(fèi)了大量的時(shí)間。使用 GUI 能夠大大的節(jié)省調(diào)試時(shí)間。
terminal-kit
如果你的 Node 程序需要在命令行下支持除簡(jiǎn)單的文本輸入輸出之外的其他操作，那么你應(yīng)該需要 terminal-kit。terminal-kit 簡(jiǎn)化了與用戶交互的許多東西，使你可以專注于在程序中開發(fā)重要的內(nèi)容。terminal-kit 的主要功能是：
- 文字樣式(很像 chalk)
- 編輯屏幕
- 進(jìn)度條
- 用戶輸入
有很多適合終端工具包的例子。例如，如果你需要從網(wǎng)上下載一些內(nèi)容，那么就需要向用戶顯示進(jìn)度條。下面的代碼用來顯示虛擬進(jìn)度條：
- var terminal = require( 'terminal-kit' ).terminal;
- var progressBar;
- var progress = 0;
- function updateProgress() {
- // 產(chǎn)生一個(gè)隨機(jī)的進(jìn)度值
- progress += Math.random() / 10;
- progressBar.update(progress);
- // 檢查是否完成
- if (progress >= 1) {
- setTimeout(function() {
- terminal('\n');
- process.exit();
- }, 250);
- }
- else {
- setTimeout(updateProgress, 100 + Math.random() * 500);
- }
- }
- progressBar = terminal.progressBar({
- width: 80,
- title: 'Downloading file:',
- eta: true,
- percent: true
- });
- updateProgress();
上面的代碼會(huì)產(chǎn)生下面這種效果：
terminal-kit進(jìn)度欄
validator
validator 可以幫你進(jìn)行一系列常見的字符串驗(yàn)證(例如：電子郵件地址、電話號(hào)碼、IP地址等)。每當(dāng)你從用戶那里獲得輸入時(shí)，這樣的軟件包都是必不可少的。用戶會(huì)犯錯(cuò)誤，并會(huì)在文本框中輸入一些非常奇怪的東西，所以需要一個(gè)驗(yàn)證輸入的包，避免數(shù)據(jù)損壞或服務(wù)器崩潰。
以下是一些常用的驗(yàn)證器：
- isEmail(str [, options])
- isIP(str [, version])
- isMobilePhone(str, locale)
- isURL(str [, options])
validator也提供檢測(cè)器，可以對(duì)輸入字符串進(jìn)行規(guī)范化、刪除或轉(zhuǎn)義。例如對(duì)用戶提交的內(nèi)容進(jìn)行清理，避免他們輸入惡意的 HTML 或 JavaScript 代碼。
下面是常用的檢測(cè)器：
- blacklist(input, chars)
- escape(input)
- normalizeEmail(email [, options])
- whitelist(input, chars)
normalizeEmail() 方法它能夠確保電子郵件地址都是小寫字母，甚至可以刪除需要忽略的字符。假設(shè)你有電子郵件 abc.def+ghi@163.com，normalizeEmail() 會(huì)將其標(biāo)準(zhǔn)化為 abcdefghi@163.com。
formidable
formidable 可以幫你處理文件上傳的每個(gè)步驟，包括 multi-part 解析器、把文件寫入磁盤以及錯(cuò)誤處理等。這是我最喜歡的一個(gè)包，如果你不想重新發(fā)明輪子可以試一試。
下面是一個(gè)在普通 HTTP 服務(wù)器上使用 formidable 的例子，代碼是從包本身中給出的示例修改而來的：
- var http = require('http');
- var util = require('util');
- var formidable = require('formidable');
- var path = require('path');
- var PORT = 8080;
- var root = path.join(__dirname, '../');
- exports.dir = {
- root : root,
- lib : root + '/lib',
- fixture : root + '/test/fixture',
- tmp : root + '/test/tmp',
- };
- var server = http.createServer(function(req, res) {
- if (req.url == '/') {
- res.writeHead(200, {'content-type': 'text/html'});
- res.end(
- '<form action="/post" method="post">' +
- '<input type="text" name="title"><br>' +
- '<input type="text" name="data[foo][]"><br>' +
- '<input type="submit" value="Submit">' +
- '</form>'
- );
- } else if (req.url == '/post') {
- var form = new formidable.IncomingForm(),
- fields = [];
- form
- .on('error', function(err) {
- res.writeHead(200, {'content-type': 'text/plain'});
- res.end('error:\n\n' + util.inspect(err));
- })
- .on('field', function(field, value) {
- console.log(field, value);
- fields.push([field, value]);
- })
- .on('end', function() {
- console.log('-> post done');
- res.writeHead(200, {'content-type': 'text/plain'});
- res.end('received fields:\n\n ' + util.inspect(fields));
- });
- form.parse(req);
- } else {
- res.writeHead(404, {'content-type': 'text/plain'});
- res.end('404');
- }
- });
- server.listen(PORT);
- console.log('listening on http://localhost:' + PORT + '/');
shelljs
shelljs是一個(gè)能夠讓你在任何系統(tǒng)上使用通用的Unix命令的包，不管是 Windows、Linux 還是 Mac。這樣你就不用再為項(xiàng)目分別編寫 bash 和批處理腳本。shelljs 提供了類似 Unix 的環(huán)境，如果你需要編寫腳本來運(yùn)行測(cè)試、提交代碼或在服務(wù)器上啟動(dòng)，則只需編寫一次即可。
可以用命令執(zhí)行類似操作：
- require('shelljs/global');
- ls('*.js').forEach(function(file) {
- sed('-i', 'BUILD_VERSION', 'v2.0.3', file);
- sed('-i', /.*REMOVE_THIS_LINE.*\n/, '', file);
- sed('-i', /.*REPLACE_THIS_LINE.*\n/, cat('macro.js'), file);
- });
執(zhí)行常見命令：
- require('shelljs/global');
- mkdir('-p', 'release/data');
- cp('-R', 'data/*', 'release/data');
檢查可用的二進(jìn)制文件：
- require('shelljs/global');
- if (!which('git')) {
- echo('This script requires git!');
- exit(1);
- }
甚至可以像在 bash 腳本中一樣運(yùn)行命令：
- if (exec('git commit -am "Release commit"').code !== 0) {
- echo('Error: Git commit failed!');
- exit(1);
- }
