Node.js 命令行程序開發教程

一種編程語言是否易用，很大程度上，取決於開發命令行程序的能力。

Node.js 作為目前最熱門的開發工具之一，怎樣使用它開發命令行程序，是 Web 開發者應該掌握的技能。

最近，Npm的網志有一組系列文章，我覺得寫得非常好。下面就是我在它的基礎上擴展的教程，應該是目前最好的解決方案了。

一、可執行腳本

我們從最簡單的講起。

首先，使用 JavaScript 語言，寫一個可執行腳本 hello 。

1. #!/usr/bin/env node
2. console.log('hello world');

然後，修改 hello 的權限。

1. $ chmod 755 hello

現在，hello 就可以執行了。

1. $ ./hello
2. hello world

如果想把 hello 前面的路徑去除，可以將 hello 的路徑加入環境變量 PATH。但是，另一種更好的做法，是在當前目錄下新建 package.json ，寫入下面的內容。

1. {
2. "name":"hello",
3. "bin":{
4. "hello":"hello"
5. }
6. }

然後執行 npm link 命令。

1. $ npm link

現在再執行 hello ，就不用輸入路徑了。

1. $ hello
2. hello world

二、命令行參數的原始寫法

命令行參數可以用系統變量 process.argv 獲取。

1. #!/usr/bin/env node
2. console.log('hello ', process.argv[2]);

執行時，直接在腳本文件後面，加上參數即可。

1. $ ./hello tom
2. hello tom

三、新建進程

腳本可以通過 child_process 模塊新建子進程，從而執行 Unix 系統命令。

1. #!/usr/bin/env node
2. var name = process.argv[2];
3. varexec=require('child_process').exec;
4. var child =exec('echo hello '+ name,function(err, stdout, stderr){
5. if(err)throw err;
6. console.log(stdout);
7. });

用法如下。

1. $ ./hello tom
2. hello tom

四、shelljs 模塊

shelljs 模塊重新包裝了 child_process，調用系統命令更加方便。它需要安裝後使用。

1. npm install --save shelljs

然後，改寫腳本。

1. #!/usr/bin/env node
2. var name = process.argv[2];
3. var shell =require("shelljs");
4. shell.exec("echo hello "+ name);

上面代碼是 shelljs 的本地模式，即通過 exec 方法執行 shell 命令。此外還有全局模式，允許直接在腳本中寫 shell 命令。

1. require('shelljs/global');
2. if(!which('git')){
3. echo('Sorry, this script requires git');
4. exit(1);
5. }
6. mkdir('-p','out/Release');
7. cp('-R','stuff/*','out/Release');
8. cd('lib');
9. ls('*.js').forEach(function(file){
10. sed('-i','BUILD_VERSION','v0.1.2', file);
11. sed('-i',/.*REMOVE_THIS_LINE.*\n/,'', file);
12. sed('-i',/.*REPLACE_LINE_WITH_MACRO.*\n/, cat('macro.js'), file);
13. });
14. cd('..');
15. if(exec('git commit -am "Auto-commit"').code !==0){
16. echo('Error: Git commit failed');
17. exit(1);
18. }

五、yargs 模塊

shelljs 只解決了如何調用 shell 命令，而 yargs 模塊能夠解決如何處理命令行參數。它也需要安裝。

1. $ npm install --save yargs

yargs 模塊提供 argv 對象，用來讀取命令行參數。請看改寫後的 hello 。

1. #!/usr/bin/env node
2. var argv =require('yargs').argv;
3. console.log('hello ', argv.name);

使用時，下面兩種用法都可以。

1. $ hello --name=tom
2. hello tom
3. $ hello --name tom
4. hello tom

如果將 argv.name 改成 argv.n，就可以使用一個字母的短參數形式了。

1. $ hello -n tom
2. hello tom

可以使用 alias 方法，指定 name 是 n 的別名。

1. #!/usr/bin/env node
2. var argv =require('yargs')
3. .alias('n','name')
4. .argv;
5. console.log('hello ', argv.n);

這樣一來，短參數和長參數就都可以使用了。

1. $ hello -n tom
2. hello tom
3. $ hello --name tom
4. hello tom

argv 對象有一個下劃線（_）屬性，可以獲取非連詞線開頭的參數。

1. #!/usr/bin/env node
2. var argv =require('yargs').argv;
3. console.log('hello ', argv.n);
4. console.log(argv._);

用法如下。

1. $ hello A -n tom B C
2. hello tom
3. ['A','B','C']

六、命令行參數的配置

yargs 模塊還提供3個方法，用來配置命令行參數。

• demand：是否必選
• default：默認值
• describe：提示

1. #!/usr/bin/env node
2. var argv =require('yargs')
3. .demand(['n'])
4. .default({n:'tom'})
5. .describe({n:'your name'})
6. .argv;
7. console.log('hello ', argv.n);

上面代碼指定 n 參數不可省略，默認值為 tom，並給出一行提示。

options 方法允許將所有這些配置寫進一個對象。

1. #!/usr/bin/env node
2. var argv =require('yargs')
3. .option('n',{
4. alias:'name',
5. demand:true,
6. default:'tom',
7. describe:'your name',
8. type:'string'
9. })
10. .argv;
11. console.log('hello ', argv.n);

有時，某些參數不需要值，只起到一個開關作用，這時可以用 boolean 方法指定這些參數返回布爾值。

1. #!/usr/bin/env node
2. var argv =require('yargs')
3. .boolean(['n'])
4. .argv;
5. console.log('hello ', argv.n);

上面代碼中，參數 n 總是返回一個布爾值，用法如下。

1. $ hello
2. hello false
3. $ hello -n
4. hello true
5. $ hello -n tom
6. hello true

boolean 方法也可以作為屬性，寫入 option 對象。

1. #!/usr/bin/env node
2. var argv =require('yargs')
3. .option('n',{
4. boolean:true
5. })
6. .argv;
7. console.log('hello ', argv.n);

七、幫助信息

yargs 模塊提供以下方法，生成幫助信息。

• usage：用法格式
• example：提供例子
• help：顯示幫助信息
• epilog：出現在幫助信息的結尾

1. #!/usr/bin/env node
2. var argv =require('yargs')
3. .option('f',{
4. alias:'name',
5. demand:true,
6. default:'tom',
7. describe:'your name',
8. type:'string'
9. })
10. .usage('Usage: hello [options]')
11. .example('hello -n tom','say hello to Tom')
12. .help('h')
13. .alias('h','help')
14. .epilog('copyright 2015')
15. .argv;
16. console.log('hello ', argv.n);

執行結果如下。

1. $ hello -h
2. Usage: hello [options]
3. Options:
4. -f,--name your name [string][required][default:"tom"]
5. -h,--help Show help [boolean]
6. Examples:
7. hello -n tom say hello to Tom
8. copyright 2015

八、子命令

yargs 模塊還允許通過 command 方法，設置 Git 風格的子命令。

1. #!/usr/bin/env node
2. var argv =require('yargs')
3. .command("morning","good morning",function(yargs){
4. console.log("Good Morning");
5. })
6. .command("evening","good evening",function(yargs){
7. console.log("Good Evening");
8. })
9. .argv;
10. console.log('hello ', argv.n);

用法如下。

1. $ hello morning -n tom
2. GoodMorning
3. hello tom

可以將這個功能與 shellojs 模塊結合起來。

1. #!/usr/bin/env node
2. require('shelljs/global');
3. var argv =require('yargs')
4. .command("morning","good morning",function(yargs){
5. echo("Good Morning");
6. })
7. .command("evening","good evening",function(yargs){
8. echo("Good Evening");
9. })
10. .argv;
11. console.log('hello ', argv.n);

每個子命令往往有自己的參數，這時就需要在回調函數中單獨指定。回調函數中，要先用 reset 方法重置 yargs 對象。

1. #!/usr/bin/env node
2. require('shelljs/global');
3. var argv =require('yargs')
4. .command("morning","good morning",function(yargs){
5. echo("Good Morning");
6. var argv = yargs.reset()
7. .option("m",{
8. alias:"message",
9. description:"provide any sentence"
10. })
11. .help("h")
12. .alias("h","help")
13. .argv;
14. echo(argv.m);
15. })
16. .argv;

用法如下。

1. $ hello morning -m "Are you hungry?"
2. GoodMorning
3. Are you hungry?

九、其他事項

（1）返回值

根據 Unix 傳統，程序執行成功返回 0，否則返回 1 。

1. if(err){
2. process.exit(1);
3. }else{
4. process.exit(0);
5. }

（2）重定向

Unix 允許程序之間使用管道重定向數據。

1. $ ps aux | grep 'node'

腳本可以通過監聽標准輸入的data 事件，獲取重定向的數據。

1. process.stdin.resume();
2. process.stdin.setEncoding('utf8');
3. process.stdin.on('data',function(data){
4. process.stdout.write(data);
5. });

下面是用法：

1. $ echo 'foo'|./hello
2. hello foo

（3）系統信號

操作系統可以向執行中的進程發送信號，process 對象能夠監聽信號事件。

1. process.on('SIGINT',function(){
2. console.log('Got a SIGINT');
3. process.exit(0);
4. });

發送信號的方法如下。

1. $ kill -s SIGINT [process_id]

下面的內容你可能也喜歡：

如何在CentOS 7安裝Node.js http://www.linuxidc.com/Linux/2015-02/113554.htm

Ubuntu 14.04下搭建Node.js開發環境 http://www.linuxidc.com/Linux/2014-12/110983.htm

Ubunru 12.04 下Node.js開發環境的安裝配置 http://www.linuxidc.com/Linux/2014-05/101418.htm

Node.Js入門[PDF+相關代碼] http://www.linuxidc.com/Linux/2013-06/85462.htm

Node.js開發指南 高清PDF中文版 +源碼 http://www.linuxidc.com/Linux/2014-09/106494.htm

Node.js入門開發指南中文版 http://www.linuxidc.com/Linux/2012-11/73363.htm

Ubuntu 編譯安裝Node.js http://www.linuxidc.com/Linux/2013-10/91321.htm

Node.js 的詳細介紹：請點這裡
Node.js 的下載地址：請點這裡