Node.js 命令行程序开发教程

Posted Linux中国

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Node.js 命令行程序开发教程相关的知识，希望对你有一定的参考价值。

一种编程语言是否易用，很大程度上，取决于开发命令行程序的能力。

Node.js 作为目前最热门的开发工具之一，怎样使用它开发命令行程序，是 Web 开发者应该掌握的技能。

最近，Npm的网志有一组，我觉得写得非常好。下面就是我在它的基础上扩展的教程，应该是目前最好的解决方案了。

一、可执行脚本

我们从最简单的讲起。

首先，使用 javascript 语言，写一个可执行脚本 hello 。

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

然后，修改 hello 的权限。

 
   
   
 
    
  
    
    
  
  1. $ chmod 755 hello
    2.

现在，hello 就可以执行了。

 
   
   
 
    
  
    
    
  
  1. $ ./hello
    2. 
  
    
    
  
  2. hello world
    3.

如果想把 hello 前面的路径去除，可以将 hello 的路径加入环境变量 PATH。但是，另一种更好的做法，是在当前目录下新建 package.json ，写入下面的内容。

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

然后执行 npm link 命令。

 
   
   
 
    
  
    
    
  
  1. $ npm link
    2.

现在再执行 hello ，就不用输入路径了。

 
   
   
 
    
  
    
    
  
  1. $ hello
    2. 
  
    
    
  
  2. hello world
    3.

二、命令行参数的原始写法

命令行参数可以用系统变量 process.argv 获取。

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

执行时，直接在脚本文件后面，加上参数即可。

 
   
   
 
    
  
    
    
  
  1. $ ./hello tom
    2. 
  
    
    
  
  2. hello tom
    3.

三、新建进程

脚本可以通过 child_process 模块新建子进程，从而执行 Unix 系统命令。

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

用法如下。

 
   
   
 
    
  
    
    
  
  1. $ ./hello tom
    2. 
  
    
    
  
  2. hello tom
    3.

四、shelljs 模块

模块重新包装了 child_process，调用系统命令更加方便。它需要安装后使用。

 
   
   
 
    
  
    
    
  
  1. npm install --save shelljs
    2.

然后，改写脚本。

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

上面代码是 shelljs 的本地模式，即通过 exec 方法执行 shell 命令。此外还有全局模式，允许直接在脚本中写 shell 命令。

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

五、yargs 模块

shelljs 只解决了如何调用 shell 命令，而 yargs 模块能够解决如何处理命令行参数。它也需要安装。

 
   
   
 
    
  
    
    
  
  1. $ npm install --save yargs
    2.

yargs 模块提供 argv 对象，用来读取命令行参数。请看改写后的 hello 。

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

使用时，下面两种用法都可以。

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

如果将 argv.name 改成 argv.n，就可以使用一个字母的短参数形式了。

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

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

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

这样一来，短参数和长参数就都可以使用了。

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

argv 对象有一个下划线（_）属性，可以获取非连词线开头的参数。

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

用法如下。

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

六、命令行参数的配置

yargs 模块还提供3个方法，用来配置命令行参数。

  • demand：是否必选

  • default：默认值

  • describe：提示

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

上面代码指定 n 参数不可省略，默认值为 tom，并给出一行提示。

options 方法允许将所有这些配置写进一个对象。

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

有时，某些参数不需要值，只起到一个开关作用，这时可以用 boolean 方法指定这些参数返回布尔值。

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

上面代码中，参数 n 总是返回一个布尔值，用法如下。

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

boolean 方法也可以作为属性，写入 option 对象。

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

七、帮助信息

yargs 模块提供以下方法，生成帮助信息。

  • usage：用法格式

  • example：提供例子

  • help：显示帮助信息

  • epilog：出现在帮助信息的结尾

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

执行结果如下。

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

八、子命令

yargs 模块还允许通过 command 方法，设置 Git 风格的子命令。

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

用法如下。

 
   
   
 
    
  
    
    
  
  1. $ hello morning -n tom
    2. 
  
    
    
  
  2. Good Morning
    3. 
  
    
    
  
  3. hello tom
    4.

可以将这个功能与 shellojs 模块结合起来。

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

每个子命令往往有自己的参数，这时就需要在回调函数中单独指定。回调函数中，要先用 reset 方法重置 yargs 对象。

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

用法如下。

 
   
   
 
    
  
    
    
  
  1. $ hello morning -m "Are you hungry?"
    2. 
  
    
    
  
  2. Good Morning
    3. 
  
    
    
  
  3. Are you hungry?
    4.

九、其他事项

（1）返回值

根据 Unix 传统，程序执行成功返回 0，否则返回 1 。

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

（2）重定向

Unix 允许程序之间使用管道重定向数据。

 
   
   
 
    
  
    
    
  
  1. $ ps aux | grep 'node'
    2.

脚本可以通过监听标准输入的data 事件，获取重定向的数据。

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

下面是用法：

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

（3）系统信号

操作系统可以向执行中的进程发送信号，process 对象能够监听信号事件。

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

发送信号的方法如下。

 
   
   
 
    
  
    
    
  
  1. $ kill -s SIGINT [process_id]
    2.

以上是关于Node.js 命令行程序开发教程的主要内容，如果未能解决你的问题，请参考以下文章

Node.js 原生开发入门完全教程（上）

cobra 2022 简明教程 - 8 个知识点快速上手

Node交互式命令行工具开发——自动化文档工具

Node.js JavaScript 片段中的跳过代码

node.js教程基础：node.js命令行选项

安装使用Mongoose配合Node.js操作MongoDB的基础教程转载