node.js - "/usr/bin/env node"在 Node 文件的开头到底做了什么？

Question

我见过这条线 #!/usr/bin/env node在 nodejs 中一些示例的开头我用谷歌搜索没有找到任何可以回答该行原因的主题。

单词的性质使搜索变得不那么容易。

我读过一些 javascript和 nodejs最近的书，我不记得在其中任何一本中看到过。

如果你想要一个例子，你可以看到 RabbitMQ官方tutorial ，他们几乎在所有示例中都有它，这是其中之一:

#!/usr/bin/env node

var amqp = require('amqplib/callback_api');

amqp.connect('amqp://localhost', function(err, conn) {
  conn.createChannel(function(err, ch) {
    var ex = 'logs';
    var msg = process.argv.slice(2).join(' ') || 'Hello World!';

    ch.assertExchange(ex, 'fanout', {durable: false});
    ch.publish(ex, '', new Buffer(msg));
    console.log(" [x] Sent %s", msg);
  });

  setTimeout(function() { conn.close(); process.exit(0) }, 500);
});

有人能解释一下这行是什么意思吗？

如果我放置或删除此行，有什么区别？在什么情况下我需要它？

Answer 1

#!/usr/bin/env node是 shebang line 的实例 : 上可执行纯文本文件中的第一行类 Unix 平台 它告诉系统通过魔术#! 后面的命令行将该文件传递给哪个解释器来执行。前缀(称为shebang)。

注: Windows 不支持shebang行 ，所以它们在那里被有效地忽略了；在 Windows 上，它只是一个给定文件的文件扩展名，它决定了哪个可执行文件将解释它。 但是，您在 npm 的上下文中仍然需要它们。 .[1]

以下， shebang线的一般讨论仅限于类 Unix 平台:

在下面的讨论中，我将假设包含由 Node.js 执行的源代码的文件被简单地命名为 file .

您需要这条线 ，如果您想直接调用 Node.js 源文件，作为其本身的可执行文件 - 这假设该文件已使用诸如 chmod +x ./file 之类的命令标记为可执行文件。 ，然后允许您使用例如 ./file 调用文件，或者，如果它位于 $PATH 中列出的目录之一中变量，简单地为 file .

具体来说，您需要一个 shebang 行来创建基于 Node.js 源文件的 CLI 作为 npm 包的一部分，CLI 由 npm 安装。基于 "bin" key in a package's package.json file 的值;另见this answer了解如何与全局安装的软件包配合使用。脚注 [1] 显示了如何在 Windows 上进行处理。

您不需要 此行通过 node 显式调用文件解释器，例如，node ./file

可选背景信息 :
#!/usr/bin/env <executableName>是一种可移植地指定解释器的方法:简而言之，它说:执行 <executableName>无论您(首先)在 $PATH 中列出的目录中的何处找到它变量(并将其隐式传递到手头文件的路径)。

这说明了这样一个事实，即给定的解释器可能安装在跨平台的不同位置， node 绝对是这种情况。 ，Node.js 二进制文件。

相比之下， env的位置实用程序本身可以依赖于跨平台位于同一位置，即 /usr/bin/env - 并在shebang行中指定可执行文件的完整路径。

请注意 POSIX 实用程序 env在这里被重新用于按文件名定位并在 $PATH 中执行可执行文件. env的真正目的是管理命令的环境 - 见 env 's POSIX spec和 Keith Thompson's helpful answer .

还值得注意的是，Node.js 正在对 shebang 行进行语法异常(exception)处理，因为它们不是有效的 JavaScript 代码( # 在 JavaScript 中不是注释字符，与 POSIX 类 shell 和其他解释器不同)。

[1] 为了跨平台一致性， npm创建包装器 *.cmd Windows 上的文件(批处理文件)安装包的 package.json 中指定的可执行文件时文件(通过 "bin" 属性)。本质上，这些包装批处理文件模仿 Unix shebang 功能:它们 使用 shebang 行中指定的可执行文件显式调用目标文件 - 因此， 您的脚本必须包含一个 shebang 行，即使您只打算在 Windows 上运行它们 - 见 this answer我的详细信息。
自 *.cmd可以在没有 .cmd 的情况下调用文件扩展，这带来了无缝的跨平台体验:在 Windows 和 Unix 上，您可以有效地调用 npm -通过其原始的、无扩展名的名称安装了 CLI。