如何向Node.js程序传递并接收命令行参数

技术背景

在Node.js开发中，经常需要从命令行传递参数给程序，以实现不同的功能。例如，根据不同的参数执行不同的操作，或者为程序提供配置信息等。了解如何传递和接收命令行参数是Node.js开发的基础技能之一。

实现步骤

标准方法（不使用库）

Node.js中，命令行参数存储在process.argv数组中。其中，第一个元素是node，第二个元素是JavaScript文件的名称，后续元素是额外的命令行参数。

示例代码：

// print process.argv
process.argv.forEach(function (val, index, array) {
  console.log(index + ': ' + val);
});

若运行命令node process-2.js one two=three four，输出如下：

0: node
1: /Users/mjr/work/node/process-2.js
2: one
3: two=three
4: four

若要像常规JavaScript函数一样处理参数，可以使用以下代码：

var args = process.argv.slice(2);

使用minimist库

minimist是一个轻量级的命令行参数解析库。

示例代码：

var argv = require('minimist')(process.argv.slice(2));
console.dir(argv);

运行命令node example/parse.js -a beep -b boop，输出如下：

{ _: [], a: 'beep', b: 'boop' }

原生方法

从Node.js 18.3.0和16.17.0版本开始，增加了util.parseArgs函数。

示例代码：

const {parseArgs} = require('node:util');

const args = process.argv;
const options = {
  foo: {
    type: 'boolean',
    short: 'f'
  },
  bar: {
    type: 'string'
  }
};
const {
  values,
  positionals
} = parseArgs({ args, options, allowPositionals: true });

console.log(values);
console.log(positionals);

核心代码

不使用库解析参数

// 简单解析参数为对象
const getArgs = () =>
  process.argv.reduce((args, arg) => {
    // 长参数
    if (arg.slice(0, 2) === "--") {
      const longArg = arg.split("=");
      const longArgFlag = longArg[0].slice(2);
      const longArgValue = longArg.length > 1 ? longArg[1] : true;
      args[longArgFlag] = longArgValue;
    } 
    // 短参数
    else if (arg[0] === "-") {
      const flags = arg.slice(1).split("");
      flags.forEach((flag) => {
        args[flag] = true;
      });
    }
    return args;
  }, {});

const args = getArgs();
console.log(args);

使用command-line-args库

const commandLineArgs = require('command-line-args')
const optionDefinitions = [
  { name: 'verbose', alias: 'v', type: Boolean },
  { name: 'src', type: String, multiple: true, defaultOption: true },
  { name: 'timeout', alias: 't', type: Number }
]
const options = commandLineArgs(optionDefinitions)
console.log(options);

最佳实践

• 选择合适的库：如果只是简单的参数解析，可以使用标准方法或轻量级库如minimist；如果需要更复杂的功能，如子命令、帮助信息生成等，可以使用Commander.js、Yargs等。
• 错误处理：在解析参数时，要考虑参数缺失、格式错误等情况，进行适当的错误处理。
• 文档说明：为程序提供清晰的使用说明，方便用户正确传递参数。

常见问题

• 参数格式问题：不同的库对参数格式有不同的要求，需要根据库的文档正确传递参数。
• 兼容性问题：某些库可能不支持旧版本的Node.js，使用时要注意版本兼容性。
• 参数冲突：当使用多个库或自定义解析逻辑时，可能会出现参数冲突的情况，需要仔细检查和调整。