Node.js チュートリアル
Node.jsを使い始める

備考

バージョン

Hello World HTTPサーバー

まず、ご使用のプラットフォーム用のNode.jsをインストールします。

この例では、 Hello, World!を送信するポート1337でリッスンするHTTPサーバーを作成しますHello, World!ブラウザに送信します。ポート1337を使用する代わりに、他のサービスで現在使用されていない任意のポート番号を使用できます。

httpモジュールはNode.js コアモジュール （Node.jsのソースに含まれ、追加のリソースのインストールを必要としないモジュール）です。 httpモジュールは、 http.createServer()メソッドを使用してHTTPサーバーを作成する機能を提供します。アプリケーションを作成するには、次のJavaScriptコードを含むファイルを作成します。

const http = require('http'); // Loads the http module

http.createServer((request, response) => {

    // 1. Tell the browser everything is OK (Status code 200), and the data is in plain text
    response.writeHead(200, {
        'Content-Type': 'text/plain'
    });

    // 2. Write the announced text to the body of the page
    response.write('Hello, World!\n');

    // 3. Tell the server that all of the response headers and body have been sent
    response.end();

}).listen(1337); // 4. Tells the server what port to be on

任意のファイル名でファイルを保存します。この場合、 hello.jsという名前を付けると、ファイルがあるディレクトリに移動して次のコマンドを実行することで、アプリケーションを実行できます。

node hello.js

作成されたサーバーは、ブラウザーでURL http：// localhost：1337またはhttp://127.0.0.1:1337でアクセスできます。

以下のスクリーンショットに示すように、上部に「Hello、World！」テキストが表示された簡単なWebページが表示されます。

編集可能なオンラインの例。

Hello Worldコマンドライン

Node.jsは、コマンドラインユーティリティの作成にも使用できます。以下の例は、コマンドラインから最初の引数を読み込み、Helloメッセージを出力します。

このコードをUnixシステムで実行するには：

1. 新しいファイルを作成し、以下のコードを貼り付けます。ファイル名は無関係です。
2. このファイルをchmod 700 FILE_NAME実行可能にする
3. アプリを./APP_NAME David実行する

Windowsでは、ステップ1を実行し、 node APP_NAME Davidそれを実行しnode APP_NAME David

#!/usr/bin/env node

'use strict';

/*
    The command line arguments are stored in the `process.argv` array, 
    which has the following structure:
    [0] The path of the executable that started the Node.js process
    [1] The path to this application
    [2-n] the command line arguments

    Example: [ '/bin/node', '/path/to/yourscript', 'arg1', 'arg2', ... ]
    src: https://nodejs.org/api/process.html#process_process_argv
 */

// Store the first argument as username.
var username = process.argv[2];

// Check if the username hasn't been provided.
if (!username) {

    // Extract the filename
    var appName = process.argv[1].split(require('path').sep).pop();

    //  Give the user an example on how to use the app.
    console.error('Missing argument! Example: %s YOUR_NAME', appName);

    // Exit the app (success: 0, error: 1). 
    // An error will stop the execution chain. For example:
    //   ./app.js && ls       -> won't execute ls
    //   ./app.js David && ls -> will execute ls
    process.exit(1);
}

// Print the message to the console.
console.log('Hello %s!', username);

Node.jsのインストールと実行

まず、開発用コンピュータにNode.jsをインストールします。

Windows： ダウンロードページに移動し、インストーラをダウンロード/実行します。

Mac： ダウンロードページに移動し、インストーラをダウンロード/実行します。または、 brew install nodeを使用してHomebrew経由でNodeをインストールすることもできbrew install node 。 HomebrewはMacintosh向けのコマンドラインパッケージマネージャであり、詳細はHomebrewのWebサイトを参照してください 。

Linux： コマンドラインのインストールページでディストリビューションの指示に従ってください 。

ノードプログラムの実行

Node.jsプログラムを実行するには、 node app.jsまたはnodejs app.js実行しnode app.js 。ここで、 app.jsは、ノードappのソースコードのファイル名です。実行するスクリプトを見つけるためにNodeに.js接尾辞を含める必要はありません。

あるいは、UNIXベースのオペレーティングシステムでは、ノードプログラムを端末スクリプトとして実行することができます。これを行うには、 #!/usr/bin/env nodeようなNodeインタプリタを指すシバンで始める必要があり#!/usr/bin/env node 。このファイルも実行可能ファイルとして設定する必要があります。これはchmodを使って行うことができます。スクリプトはコマンドラインから直接実行できるようになりました。

オンラインでアプリケーションを展開する

アプリケーションを（Node.js固有の）ホスト環境にデプロイすると、この環境では通常、サーバーを実行するために使用できるPORT環境変数が提供されます。 process.env.PORTポート番号を変更すると、アプリケーションにアクセスできます。

例えば、

http.createServer(function(request, response) {
   // your server code
}).listen(process.env.PORT);

また、デバッグ中にオフラインでアクセスしたい場合は、次のようにしてください：

http.createServer(function(request, response) {
  // your server code
}).listen(process.env.PORT || 3000);

ここで、 3000はオフラインポート番号です。

NodeJSアプリケーションのデバッグ

ノードインスペクタを使用することができます。 npm経由でインストールするには、次のコマンドを実行します。

npm install -g node-inspector

次に、あなたはアプリケーションをデバッグすることができます

node-debug app.js

Githubのリポジトリはhttps://github.com/node-inspector/node-inspectorにあります。

ネイティブにデバッグする

また、次のようにnode.jsをネイティブにデバッグすることもできます。

node debug your-script.js

デバッガを目的のコード行で正確にブレークするには、次のようにします。

debugger;

詳細はこちらをご覧ください 。

node.js 8では、次のコマンドを使用します。

node --inspect-brk your-script.js

次に、Google Chromeの最新バージョンでabout://inspect開き、Nodeスクリプトを選択してChromeのDevToolsのデバッグ環境を取得します。

エクスプローラー付きのHello World

次の例では、Expressを使用してポート3000でリッスンするHTTPサーバーを作成します。このサーバーは「Hello、World！」と応答します。 Expressは、HTTP APIを作成するのに便利な一般的なWebフレームワークです。

最初に、 myApp新しいフォルダを作成します。 myApp入り、次のコードを含む新しいJavaScriptファイルを作成します（たとえば、 hello.jsという名前を付けてhello.js ）。次に、コマンドラインからnpm install --save expressを使用してExpressモジュールをインストールします。 パッケージのインストール方法の詳細については、 このドキュメントを参照してください 。

// Import the top-level function of express
const express = require('express');

// Creates an Express application using the top-level function
const app = express();

// Define port number as 3000
const port = 3000;

// Routes HTTP GET requests to the specified path "/" with the specified callback function
app.get('/', function(request, response) {
  response.send('Hello, World!');
});

// Make the app listen on port 3000
app.listen(port, function() {
  console.log('Server listening on http://localhost:' + port);
});

コマンドラインから次のコマンドを実行します。

node hello.js

ブラウザを開き、 http://localhost:3000またはhttp://127.0.0.1:3000して、応答を確認します。

Expressフレームワークの詳細については、「 Web Apps with Express」セクションをチェックしてください

Hello World基本ルーティング

ノードを持つHTTPサーバーを作成する方法を理解したら、ユーザーがナビゲートしたパスに基づいて物事を「行う」方法を理解することが重要です。この現象を「ルーティング」といいます。

これの最も基本的な例はif (request.url === 'some/path/here')をチェックし、新しいファイルで応答する関数を呼び出すことです。

これの例はここで見ることができます：

const http = require('http');

function index (request, response) {
    response.writeHead(200);
    response.end('Hello, World!');
}

http.createServer(function (request, response) {
    
    if (request.url === '/') {
        return index(request, response);
    }

    response.writeHead(404);
    response.end(http.STATUS_CODES[404]);

}).listen(1337);

しかし、このような "ルート"を定義し続けると、大規模なコールバック関数が1つだけ発生することになります。そのような巨大な混乱を望んでいないので、これをクリーンアップできるかどうかを見てみましょう。

まず、すべてのルートをオブジェクトに保存しましょう：

var routes = {
    '/': function index (request, response) {
        response.writeHead(200);
        response.end('Hello, World!');
    },
    '/foo': function foo (request, response) {
        response.writeHead(200);
        response.end('You are now viewing "foo"');
    }
}

オブジェクトに2つのルートを格納したので、ここで主なコールバックでそれらをチェックできます：

http.createServer(function (request, response) {
    
    if (request.url in routes) {
        return routes[request.url](request, response);
    }

    response.writeHead(404);
    response.end(http.STATUS_CODES[404]);

}).listen(1337);

今すぐあなたのウェブサイトをナビゲートしようとするたびに、あなたのルートにそのパスの存在を確認し、それぞれの機能を呼び出します。ルートが見つからない場合、サーバーは404（Not Found）で応答します。

また、HTTP Server APIを使用したルーティングは非常に簡単です。

TLSソケット：サーバーとクライアント

これと通常のTCP接続との主な違いは、プライベートキーとオプションオブジェクトに設定する必要があるパブリック証明書だけです。

キーと証明書を作成する方法

このセキュリティプロセスの第一歩は、プライベートキーの作成です。そしてこの秘密鍵は何ですか？基本的には、情報の暗号化に使用されるランダムノイズのセットです。理論的には、1つの鍵を作成し、それを使って必要なものを暗号化することができます。しかし、特定のものに対して異なるキーを持つことがベストプラクティスです。誰かがあなたの秘密鍵を盗むと、それはあなたの家の鍵を盗むことに似ています。あなたが車、ガレージ、オフィスなどをロックするために同じキーを使用した場合を想像してください。

openssl genrsa -out private-key.pem 1024

秘密鍵を取得したら、証明書署名要求（CSR）を作成することができます。この要求は、秘密鍵が秘密の機関に署名されていることを要求しています。だからあなたの会社に関連する情報を入力する必要があります。この情報は署名当局に表示され、あなたの確認に使用されます。私たちの場合、あなたが入力したものは問題ではありません。次のステップでは、証明書に署名するつもりであるからです。

openssl req -new -key private-key.pem -out csr.pem

ペーパーワークを完成させたら、我々はクールな署名機関であるとふるまうべき時です。

openssl x509 -req -in csr.pem -signkey private-key.pem -out public-cert.pem

プライベートキーとパブリック証明書を取得したので、2つのNodeJSアプリ間の安全な接続を確立できます。そして、サンプルコードでわかるように、非常に単純なプロセスです。

重要！

私たちは公然の証明書を作成して以来、まったく正直なところ、証明書は無価値です。 NodeJSサーバーはデフォルトでこのような証明書を信頼しません。そのため、次のオプションrejectUnauthorized：falseを使用して証明書を実際に信頼するように伝える必要があります。 非常に重要 ：本番環境ではこの変数をtrueに設定しないでください。

TLSソケットサーバー

'use strict';

var tls = require('tls');
var fs = require('fs');

const PORT = 1337;
const HOST = '127.0.0.1'

var options = {
    key: fs.readFileSync('private-key.pem'),
    cert: fs.readFileSync('public-cert.pem')
};

var server = tls.createServer(options, function(socket) {

    // Send a friendly message
    socket.write("I am the server sending you a message.");

    // Print the data that we received
    socket.on('data', function(data) {

        console.log('Received: %s [it is %d bytes long]',
            data.toString().replace(/(\n)/gm,""),
            data.length);

    });

    // Let us know when the transmission is over
    socket.on('end', function() {

        console.log('EOT (End Of Transmission)');

    });

});

// Start listening on a specific port and address
server.listen(PORT, HOST, function() {

    console.log("I'm listening at %s, on port %s", HOST, PORT);

});

// When an error occurs, show it.
server.on('error', function(error) {

    console.error(error);

    // Close the connection after the error occurred.
    server.destroy();

});

TLSソケットクライアント

'use strict';

var tls = require('tls');
var fs = require('fs');

const PORT = 1337;
const HOST = '127.0.0.1'

// Pass the certs to the server and let it know to process even unauthorized certs.
var options = {
    key: fs.readFileSync('private-key.pem'),
    cert: fs.readFileSync('public-cert.pem'),
    rejectUnauthorized: false
};

var client = tls.connect(PORT, HOST, options, function() {

    // Check if the authorization worked
    if (client.authorized) {
        console.log("Connection authorized by a Certificate Authority.");
    } else {
        console.log("Connection not authorized: " + client.authorizationError)
    }

    // Send a friendly message
    client.write("I am the client sending you a message.");

});

client.on("data", function(data) {

    console.log('Received: %s [it is %d bytes long]',
        data.toString().replace(/(\n)/gm,""),
        data.length);

    // Close the connection after receiving the message
    client.end();

});

client.on('close', function() {

    console.log("Connection closed");

});

// When an error ocoures, show it.
client.on('error', function(error) {

    console.error(error);

    // Close the connection after the error occurred.
    client.destroy();

});

REPLのHello World

引数なしで呼び出されると、Node.jsは " ノードシェル "とも呼ばれるREPL（Read-Eval-Print-Loop）を開始します。

コマンドプロンプトでnode入力しnode 。

$ node
>

ノードのシェルプロンプトで>タイプの「Hello World！」

$ node
> "Hello World!"
'Hello World!'

コアモジュール

Node.jsはブラウザ外でJavascriptを実行できるJavascriptエンジン（GoogleのChrome用V8エンジン、C ++で書かれています）です。ノードの機能を拡張するために多数のライブラリが利用可能ですが、エンジンには基本機能を実装する一連のコアモジュールが付属しています。

現在、34個のコアモジュールがノードに含まれています：

[ 'assert',
  'buffer',
  'c/c++_addons',
  'child_process',
  'cluster',
  'console',
  'crypto',
  'deprecated_apis',
  'dns',
  'domain',
  'Events',
  'fs',
  'http',
  'https',
  'module',
  'net',
  'os',
  'path',
  'punycode',
  'querystring',
  'readline',
  'repl',
  'stream',
  'string_decoder',
  'timers',
  'tls_(ssl)',
  'tracing',
  'tty',
  'dgram',
  'url',
  'util',
  'v8',
  'vm',
  'zlib' ]

このリストは、Node documentation API https://nodejs.org/api/all.html（JSONファイル： https : //nodejs.org/api/all.json ）から入手しました。

すべてのコアモジュールを一目で見る

アサート

assertモジュールは不変をテストするために使用することができるアサーションテストの簡単なセットを提供します。

バッファ

ECMAScript 2015（ES6）にTypedArrayを導入する前は、JavaScript言語にはバイナリデータのストリームを読み込んだり操作したりする仕組みがありませんでした。 Bufferクラスは、Node.js APIの一部として導入され、TCPストリームやファイルシステム操作などのコンテキストでオクテットストリームとやり取りできるようにしました。

TypedArrayがES6で追加されたので、 Bufferクラスは、Node.jsのユースケースに合わせて最適化された方法でUin t8Array APIを実装します。

c / c ++ _ addons

Node.js Addonsは、CまたはC ++で書かれた動的にリンクされた共有オブジェクトで、 require()関数を使用してNode.jsにロードでき、通常のNode.jsモジュールと同じように使用できます。主に、Node.jsで実行されているJavaScriptとC / C ++ライブラリとの間のインタフェースを提供するために使用されます。

child_process

child_processモジュールは、popen（3）に類似しているが同一ではない方法で子プロセスを生成する機能を提供します。

クラスタ

Node.jsの単一のインスタンスは、単一のスレッドで実行されます。マルチコアシステムを利用するには、負荷を処理するNode.jsプロセスのクラスタを起動する必要があることがあります。クラスタモジュールを使用すると、すべてのサーバーポートを共有する子プロセスを簡単に作成できます。

コンソール

consoleモジュールは、ウェブブラウザによって提供されるJavaScriptコンソール機構と同様の単純なデバッグコンソールを提供する。

暗号

cryptoモジュールは、OpenSSLのハッシュ、HMAC、暗号、解読、署名、検証機能用のラッパーセットを含む暗号機能を提供します。

deprecated_apis

（a）APIの使用が危険であると考えられているか、（b）改良された代替APIが利用可能になっている、（c）将来のメジャーリリースでAPIへの変更の破棄が予想される場合、Node.jsはAPIを非難することがあります。

DNS

dnsモジュールには、2つの異なるカテゴリに属する​​関数が含まれています。

1. 基本的なオペレーティングシステム機能を使用して名前解決を実行する機能で、必ずしもネットワーク通信を実行する必要はありません。このカテゴリに含まれる関数は、 dns.lookup()です。
2. 実際のDNSサーバーに接続して名前解決を実行し、 常にネットワークを使用してDNSクエリを実行する関数。このカテゴリには、 dns.lookup() を除く dnsモジュール内のすべての関数が含まれます。

ドメイン

このモジュールは保留中です 。置換APIが完成すると、このモジュールは完全に廃止されます。ほとんどのエンドユーザーは、このモジュールを使用する必要はありません 。ドメインが提供する機能を絶対に必要とするユーザーは、当面はその機能に頼っているかもしれませんが、将来は別のソリューションに移行する必要があります。

イベント

Node.jsコアAPIの多くは、特定の種類のオブジェクト（「エミッタ」と呼ばれます）が定期的に名前付きイベントを生成し、Functionオブジェクト（「リスナー」）を呼び出すような慣用的な非同期イベント駆動アーキテクチャをベースに構築されています。

fs

ファイルI / Oは、標準のPOSIX関数に関する単純なラッパーによって提供されます。このモジュールを使用するには、 require('fs')ます。すべてのメソッドは、非同期形式と同期形式を持ちます。

http

Node.jsのHTTPインタフェースは、従来使用が困難であったプロトコルの多くの機能をサポートするように設計されています。特に、チャンクエンコードされた大規模なメッセージ。このインターフェースは、リクエストやレスポンス全体をバッファリングしないように注意しています。ユーザーはデータをストリーミングすることができます。

https

HTTPSは、TLS / SSL上のHTTPプロトコルです。 Node.jsでは、これは別のモジュールとして実装されています。

モジュール

Node.jsには単純なモジュールローディングシステムがあります。 Node.jsでは、ファイルとモジュールは1対1で対応しています（各ファイルは個別のモジュールとして扱われます）。

ネット

netモジュールは、非同期ネットワークラッパーを提供します。サーバーとクライアントの両方を作成するための関数（ストリームと呼ばれます）が含まれています。このモジュールにはrequire('net');を含めることができますrequire('net'); 。

OS

osモジュールは、多くのオペレーティングシステム関連のユーティリティメソッドを提供します。

パス

pathモジュールは、ファイルおよびディレクトリパスを操作するためのユーティリティを提供します。

punycode

Node.jsにバンドルされているpunycodeモジュールのバージョンは廃止予定です 。

クエリ文字列

querystringモジュールは、URLクエリ文字列の解析と書式設定のためのユーティリティを提供します。

読み込まれた行

readlineモジュールは、Readableストリーム（ process.stdinなど）から一度に1行ずつデータを読み込むためのインターフェイスを提供します。

repl

replモジュールは、スタンドアロン・プログラムとしても、他のアプリケーションでも使用可能なRead-Eval-Print-Loop（REPL）実装を提供します。

ストリーム

ストリームは、Node.jsのストリーミングデータを操作するための抽象的なインターフェイスです。 streamモジュールは、ストリームインターフェイスを実装するオブジェクトを簡単に構築できる基本APIを提供します。

Node.jsによって提供される多くのストリームオブジェクトがあります。例えば、HTTPサーバとprocess.stdoutへのリクエストは両方ともストリームインスタンスです。

string_decoder

string_decoderモジュールは、エンコードされたマルチバイトUTF-8およびUTF-16文字を保持する方法で、 BufferオブジェクトをストリングにデコードするためのAPIを提供します。

タイマー

timerモジュールは、ある将来の期間に呼び出されるスケジューリング関数用のグローバルAPIを公開します。タイマー関数はグローバルであるため、APIを使用するrequire('timers') timer require('timers')を呼び出すrequire('timers')はありません。

Node.js内のタイマー関数は、Webブラウザーで提供されるタイマーAPIと同様のAPIを実装しますが、Node.jsイベントループの周りに構築された別の内部実装を使用します 。

tls_（ssl）

tlsモジュールは、OpenSSLの上に構築されたTLS（Transport Layer Security）およびSSL（Secure Socket Layer）プロトコルの実装を提供します。

トレース

トレースイベントは、V8、ノードコア、およびユーザー空間コードによって生成されたトレース情報を集中管理するメカニズムを提供します。

Node.jsアプリケーションの起動時に--trace-events-enabledフラグを渡すと、トレースを有効にすることができます。

tty

ttyモジュールは提供tty.ReadStreamとtty.WriteStreamクラスを。ほとんどの場合、このモジュールを直接使用する必要はありません。

dgram

dgramモジュールは、UDPデータグラムソケットの実装を提供します。

URL

urlモジュールは、URL解決と解析のためのユーティリティを提供します。

ユーティリティ

utilモジュールは、主にNode.js自身の内部APIのニーズをサポートするように設計されています。しかし、ユーティリティの多くは、アプリケーション開発者やモジュール開発者にとっても有用です。

v8

v8モジュールは、Node.jsバイナリに組み込まれているV8のバージョンに特有のAPIを公開しています。

注 ：APIと実装はいつでも変更されることがあります。

VM

vmモジュールは、V8仮想マシンのコンテキスト内でコードをコンパイルおよび実行するためのAPIを提供します。 JavaScriptコードはすぐにコンパイルして実行することも、コンパイルして保存して後で実行することもできます。

注 ：vmモジュールはセキュリティ機構ではありません。 信頼できないコードの実行には使用しないでください 。

zlib

zlibモジュールは、GzipとDeflate / Inflateを使用して実装された圧縮機能を提供します。

基本的なHTTPS Webサーバーを起動して実行する方法

システムにnode.jsがインストールされたら、以下の手順に従って、HTTPとHTTPSの両方をサポートしている基本Webサーバーを稼働させることができます。

手順1：認証局を構築する

1. キーと証明書を保存するフォルダを作成します。

   mkdir conf

2. そのディレクトリに移動します：

   cd conf

3. このca.cnfファイルを取得して設定ショートカットとして使用する：

   wget https://raw.githubusercontent.com/anders94/https-authorized-clients/master/keys/ca.cnf

4. この構成を使用して新しい認証局を作成します。

   openssl req -new -x509 -days 9999 -config ca.cnf -keyout ca-key.pem -out ca-cert.pem

5. ca-key.pemとca-cert.pemに認証局があるので、サーバーの秘密鍵を生成しましょう：

   openssl genrsa -out key.pem 4096

6. このserver.cnfファイルを取得して設定ショートカットとして使用します。

   wget https://raw.githubusercontent.com/anders94/https-authorized-clients/master/keys/server.cnf

7. 次の設定を使用して証明書署名要求を生成します。

   openssl req -new -config server.cnf -key key.pem -out csr.pem

8. リクエストに署名してください：

   openssl x509 -req -extfile server.cnf -days 999 -passin "pass:password" -in csr.pem -CA ca-cert.pem -CAkey ca-key.pem -CAcreateserial -out cert.pem

手順2：証明書をルート証明書としてインストールする

1. 証明書をルート証明書のフォルダにコピーします。

   sudo cp ca-crt.pem /usr/local/share/ca-certificates/ca-crt.pem

2. CAストアを更新する：

   sudo update-ca-certificates

手順3：ノードサーバーの起動

まず、実際のサーバーコードを含むserver.jsファイルを作成します。

Node.jsのHTTPSサーバーの最小限の設定は、次のようになります。

var https = require('https');
var fs = require('fs');

var httpsOptions = {
    key: fs.readFileSync('path/to/server-key.pem'),
    cert: fs.readFileSync('path/to/server-crt.pem')
};

var app = function (req, res) {
  res.writeHead(200);
  res.end("hello world\n");
}

https.createServer(httpsOptions, app).listen(4433);

httpリクエストをサポートしたい場合は、この小さな変更を行う必要があります。

var http = require('http');
var https = require('https');
var fs = require('fs');

var httpsOptions = {
    key: fs.readFileSync('path/to/server-key.pem'),
    cert: fs.readFileSync('path/to/server-crt.pem')
};

var app = function (req, res) {
  res.writeHead(200);
  res.end("hello world\n");
}

http.createServer(app).listen(8888);
https.createServer(httpsOptions, app).listen(4433);

1. server.jsがあるディレクトリに移動します：

   cd /path/to

2. server.js実行しserver.js 。

   node server.js