ノードファイルの先頭で「/ usr / bin / env node」は正確に何をしますか？

#!/usr/bin/env nodeのいくつかの例の冒頭でこの行を見たnodejsことがありますが、その行の理由に答えられるトピックを見つけることなくググっていました。

単語の性質上、検索はそれほど簡単ではありません。

私は最近、いくつかの本を読んだことがjavascriptありnodejs、それらのいずれかでそれを目にしたことを覚えていません。

例が必要な場合は、RabbitMQ公式チュートリアルを見ることができます。彼らはほとんどすべての例にそれを持っています。ここにその1つを示します。

#!/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);
});

誰かがこの行の意味を教えてくれませんか？

この行を追加または削除した場合の違いは何ですか？どのような場合に必要ですか？

#!/usr/bin/env nodeあるのインスタンスシェバング行は：上の実行可能なプレーンテキストファイル内の最初の行Unixライクなプラットフォームの実行のためにそのファイルを渡すためにどのような通訳システムを告げる魔法次のコマンドラインを経由して、#!接頭辞（と呼ばれるシェバング） 。

注：Windowsはシバン線をサポートしていないため、実際には無視されます。Windowsでは、特定のファイルのファイル名拡張子のみが、どの実行可能ファイルがそれを解釈するかを決定します。ただし、のコンテキストではまだ必要ですnpm。^[1]

以下のシバン行の一般的な説明は、Unixのようなプラットフォームに限定されています。

^{次の説明では、Node.jsで実行するためのソースコードを含むファイルの名前を単にと仮定しますfile。}

• あなたは、この行が必要あなたはNode.jsのソースファイルを起動したい場合は、直接それ自体で実行可能ファイルとして、 -これは、ファイルは次のようなコマンドで実行可能としてマークされていることを前提としchmod +x ./file、その後、ファイルを起動することを可能にします、たとえば、、./fileまたは、$PATH変数にリストされているディレクトリのいずれかにある場合は、単にとしてfile。

  • 具体的には、npm パッケージの一部としてNode.jsソースファイルに基づいてCLIを作成し、パッケージのファイル内のキーの値に基づいてCLIをインストールするためのシバン行が必要です。グローバルにインストールされたパッケージでどのように機能するかについては、この回答も参照してください。脚注[1]は、これがWindowsでどのように処理されるかを示しています。npm"bin"package.json

• あなたは必要ありません経由で明示的にファイルを呼び出すために、この行をnode、例えば、インタプリタnode ./file

オプションの背景情報：

#!/usr/bin/env <executableName>インタプリタを移植可能に指定する方法です。一言で言えば、変数に<executableName>リストされているディレクトリの中から（最初に）見つけた場所で実行し$PATHます（そして、手元のファイルへのパスを暗黙的に渡します）。

これは、特定のインタープリターがプラットフォーム間でさまざまな場所にインストールされる可能性があるという事実を説明しています。これはnode、Node.jsバイナリの場合は間違いありません。

対照的に、の位置envユーティリティ自体はであることに依拠することができる同じつまり、プラットフォーム間での位置/usr/bin/env-及び指定完全実行可能ファイルへのパスがされ必要シェバングラインに。

POSIXユーティリティenvは、ファイル名で検索し、で実行可能ファイルを実行するために、ここで再利用されていることに注意してください$PATH。
の真の目的はenv、コマンドの環境を管理することですenv。POSIX仕様とキーストンプソンの役立つ回答を参照してください。

有効なJavaScriptコードではない（POSIXのようなシェルや他のインタープリターとは異なり、JavaScriptのコメント文字ではない）ことを考えると、Node.jsがシバン行の構文例外を作成していることにも注意してください#。

^{[1]クロスプラットフォームの一貫性のために、（プロパティを介して）パッケージのファイルで指定された実行可能ファイルをインストールするときに、Windowsにラッパーファイル（バッチファイル）をnpm作成します *.cmd。基本的に、これらのラッパーバッチファイルは Unixシバン機能を模倣しています。シバン行で指定された実行可能ファイルを使用してターゲットファイルを明示的に呼び出します。したがって、Windowsでのみ実行するつもりでも、スクリプトにシバン行を含める必要があります - この回答を参照してください詳細は私のもの。 以来ファイルがなしで起動することができますpackage.json"bin"
*.cmd.cmdこれにより、シームレスなクロスプラットフォームエクスペリエンスが実現します。WindowsとUnixの両方で、インストールnpmされているCLIを、元の拡張子のない名前で効果的に呼び出すことができます。}

インタープリターによって実行されるスクリプトは、通常、最上部にシバン行があり、OSに実行方法を指示します。

という名前のスクリプトがfooあり、その最初の行がである#!/bin/sh場合、システムはその最初の行を読み取り、に相当するものを実行し/bin/sh fooます。このため、ほとんどのインタープリターは、スクリプトファイルの名前をコマンドライン引数として受け入れるように設定されています。

に続くインタープリター名#!は絶対パスでなければなりません。OSはあなた$PATHを検索してインタープリターを見つけません。

で実行するスクリプトがある場合node、最初の行を書く明白な方法は次のとおりです。

#!/usr/bin/node

ただし、nodeコマンドがにインストールされていない場合は機能しません/usr/bin。

一般的な回避策は、env次のコマンドを使用することです（これは、この目的を意図したものではありません）。

#!/usr/bin/env node

スクリプトがと呼ばれるfoo場合、OSは同等のことを行います

/usr/bin/env node foo

envコマンドは、名前がそのコマンドに任意の次の引数を渡し、そのコマンドラインで指定された別のコマンドを実行します。ここで使用する理由は、コマンドenvを検索する$PATHためです。もしそうnodeでインストールされている/usr/local/bin/node、とあなたが持っている/usr/local/binあなたに$PATH、envコマンドが起動します/usr/local/bin/node foo。

envコマンドの主な目的は、変更された環境で別のコマンドを実行し、コマンドを実行する前に指定された環境変数を追加または削除することです。ただし、追加の引数を指定せずに、変更されていない環境でコマンドを実行するだけです。この場合は、これで十分です。

このアプローチにはいくつかの欠点があります。最新のUnixライクなシステムには/usr/bin/envがありますが、envコマンドが別のディレクトリにインストールされている古いシステムで作業しました。このメカニズムを使用して渡すことができる追加の引数には制限がある場合があります。ユーザーがにnodeコマンドを含むディレクトリを持たない場合$PATH、またはと呼ばれる別のコマンドを持っている場合node、間違ったコマンドを呼び出すか、まったく機能しない可能性があります。

その他のアプローチは次のとおりです。

• コマンド自体#!へのフルパスを指定する行を使用して、nodeさまざまなシステムで必要に応じてスクリプトを更新します。または
• nodeスクリプトを引数としてコマンドを呼び出します。

トリックの詳細については、この質問（および私の回答）も参照してください#!/usr/bin/env。

ちなみに、私のシステム（Linux Mint 17.2）では、としてインストールされてい/usr/bin/nodejsます。私のメモによると、それはUbuntu 12.04と12.10の間でに変更され/usr/bin/nodeました/usr/bin/nodejs。#!/usr/bin/envそれとトリックしませんヘルプ（あなたは、シンボリックリンクまたは類似のものを設定していない限り）。

更新：mtraceurによるコメントは（再フォーマット済み）と述べています。

nodejsとnodeの問題の回避策は、次の6行でファイルを開始することです。

#!/bin/sh -
':' /*-
test1=$(nodejs --version 2>&1) && exec nodejs "$0" "$@"
test2=$(node --version 2>&1) && exec node "$0" "$@"
exec printf '%s\n' "$test1" "$test2" 1>&2
*/

これは最初に試行nodejsしてから試行しnode、両方が見つからない場合にのみエラーメッセージを出力します。説明はこれらのコメントの範囲外です。この回答が問題を提起したので誰かが問題に対処するのに役立つ場合に備えて、ここではそのままにしておきます。

私は最近NodeJSを使用していません。私が最初にこの回答を投稿してから数年でnodejsvs.のnode問題が解決されたことを願っています。Ubuntu 18.04では、nodejsパッケージは/usr/bin/nodejsへのシンボリックリンクとしてインストールされ/usr/bin/nodeます。以前の一部のOS（UbuntuまたはLinux Mint、どちらかはわかりません）では、へのシンボリックリンクとしてnodejs-legacy提供さnodeれるパッケージがありましたnodejs。すべての詳細が正しいことを保証するものではありません。

短い答え：それは通訳への道です。

編集（長回答）：「ノード」の前にスラッシュがないのは、常に＃！/ bin /の信頼性を保証できないためです。「/ env」ビットは、変更された環境でスクリプトを実行することにより、プログラムをよりクロスプラットフォームにし、インタープリタープログラムをより確実に見つけることができるようにします。

必ずしも必要ではありませんが、移植性（および専門性）を確保するために使用することをお勧めします