欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

利用Node.js编写跨平台的spawn语句详解

程序员文章站 2022-10-20 08:57:32
前言 node.js 是跨平台的,也就是说它能运行在 windows、osx 和 linux 平台上。很多 node.js 开发者都是在 osx 上做开发的,然后再将代码...

前言

node.js 是跨平台的,也就是说它能运行在 windows、osx 和 linux 平台上。很多 node.js 开发者都是在 osx 上做开发的,然后再将代码部署到 linux 服务器上。由于 osx 和 linux 都是基于 unix 的,因此两者共性很多。windows 也是 node.js 官方支持的平台,只要你通过正确的方式写代码,就能在各个平台上毫无压力的跑起来。

node.js 的子进程 (child_process) 模块下有一 spawn 函数,可以用于调用系统上的命令,如在 linux, macos 等系统上,我们可以执行

const spawn = require('child_process').spawn;

spawn('npm', {
 stdio: 'inherit'
});

来调用 npm 命令。

然而,同样的语句在 windows 上执行则会报错。

error: spawn npm enoent
 at exports._errnoexception (util.js:855:11)
 at process.childprocess._handle.onexit (internal/child_process.js:178:32)
 at onerrornt (internal/child_process.js:344:16)
 at nexttickcallbackwith2args (node.js:455:9)
 at process._tickcallback (node.js:369:17)
 at function.module.runmain (module.js:432:11)
 at startup (node.js:141:18)
 at node.js:980:3

因为在 windows 上,当我们执行 npm 时,我们实际执行的是 npm.cmd 批处理,而在 windows 上, .cmd,  .bat 批处理是无法脱离 cmd.exe 这一解释器而单独运行的。

因此,我们需要显式地调用 cmd

spawn('cmd', ['/c', 'npm'], {
 stdio: 'inherit'
});

或者使用在调用 spawn 函数时,设置 shell 选项为 true 以隐式地调用 cmd (该选项自 node.js v6 版本)

spawn('npm', {
 stdio: 'inherit',
 shell: true
});

另外,虽然在 linux, macos 等系统上不需要设置 shell 选项,命令也能够正常执行;设置 shell true 也不会妨碍命令的执行,只是会额外的产生一个本不必要的 shell 进程,影响性能。

因此,如果想要编写跨平台的 spawn 命令,而又不想增加额外的开销的话,可以这样写

const process = require('process');
const { spawn } = require('child_process');

spawn('npm', {
 stdio: 'inherit',
 // 仅在当前运行环境为 windows 时,才使用 shell
 shell: process.platform === 'win32'
});

第三方模块 cross-spawn

关于 spawn 函数的跨平台写法,除了自己编写代码的时候做处理,也有第三方模块封装好了相关细节,如 。

使用该模块,可以在调用 spawn 函数时,自动根据当前的运行平台,来决定是否生成一个 shell 来执行所给的命令。

而且,还能够

  • 支持低于 v6 的 node.js 版本 (使用 shell 选项需要至少 node.js v6);
  • 跨平台地支持 shebang
  • 对命令和参数中的字符进行转义更为方便。

安装

npm install cross-spawn

用法

const spawn = require('cross-spawn');

spawn('npm', {
 stdio: 'inherit'
});

参考文档

在 windows 上衍生 .bat 和 .cmd 文件

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流。