How to set a timeout on a http.request() in Node? の解決方法【2025年最新版】

エラーの概要・症状
このエラーが発生する原因
解決方法1（最も効果的）
解決方法2（代替手段）
解決方法3（上級者向け）
エラーの予防方法
関連するエラーと対処法
まとめ

エラーの概要・症状

Node.jsを使用してHTTPリクエストを行う際に、リクエストがタイムアウトする問題に直面することがあります。このエラーは、特にネットワークの不安定さやサーバーの遅延によって引き起こされることが多く、ユーザーがリクエストを送信した後、応答が得られない状態が続くことを意味します。

例えば、リクエストを実行してから数秒が経過してもサーバーからの応答がない場合、プログラムは無限に待機することになります。これにより、アプリケーションがフリーズしたり、ユーザー体験が悪化したりする可能性があります。特に、APIを利用するアプリケーションでは、他の処理が完了するまで待たされることにより、全体のパフォーマンスが低下します。

このエラーが発生する原因

HTTPリクエストのタイムアウトが発生する原因は主に以下の通りです。

ネットワークの遅延: ネットワーク接続が不安定である場合、リクエストが送信されてから応答が返ってくるまでに時間がかかることがあります。
サーバーの負荷: リクエストを処理するサーバーが高負荷状態にある場合、応答が遅れることがあります。特に多数のリクエストが同時に送られる場合、サーバーが処理しきれずにタイムアウトが発生することがあります。
タイムアウト設定の欠如: Node.jsのHTTPリクエストにはデフォルトでタイムアウトが設定されていないため、プログラマが明示的にタイムアウトを設定しない限り、リクエストは無限に待機します。
不正なURL: 不正なURLや存在しないサーバーへのリクエストも、タイムアウトの原因となることがあります。送信先のサーバーが応答できない場合、リクエストはタイムアウトします。
クライアント側の設定ミス: HTTPリクエストの設定ミスもタイムアウトの一因です。リクエストオプションが不適切に設定されていると、期待する動作が得られません。

解決方法1（最も効果的）

Node.jsでHTTPリクエストのタイムアウトを設定する最も効果的な方法は、http.requestメソッドのオプションにtimeoutを指定することです。以下にその手順を示します。

手順1-1（具体的なステップ）

httpモジュールを読み込みます。
リクエストオプションを設定します。ここでtimeoutプロパティを指定します。
リクエストを作成し、コールバック関数を定義します。
timeoutイベントをリッスンし、タイムアウト時にリクエストを破棄します。

手順1-2（詳細な操作方法）

以下は具体的なコード例です。

const http = require('http');

const options = {
    hostname: 'example.com',
    port: 80,
    path: '/path',
    method: 'GET',
    timeout: 3000 // タイムアウトを3秒に設定
};

const req = http.request(options, (res) => {
    res.on('data', (d) => {
        process.stdout.write(d);
    });
});

req.on('timeout', () => {
    console.log('リクエストがタイムアウトしました。');
    req.destroy(); // リクエストを破棄
});

req.on('error', (err) => {
    console.error(err);
});

req.end();

このコードでは、optionsオブジェクトにtimeoutプロパティを追加し、3000ミリ秒（3秒）のタイムアウトを設定しています。リクエストがタイムアウトした場合、timeoutイベントが発生し、リクエストが破棄されます。

手順1-3（注意点とトラブルシューティング）

タイムアウトを設定することで、リクエストが無限に待機することを防ぎますが、タイムアウトが短すぎると正常なリクエストも破棄されてしまう可能性があります。適切な時間を設定することが重要です。
timeoutイベントは、リクエストが送信されてから受信するまでの時間を計測します。これを考慮して、適切なタイムアウト値を設定してください。

解決方法2（代替手段）

上記の方法が効果がない場合、別の方法として、socketイベントを使用してタイムアウトを設定することもできます。この方法は、ソケットのタイムアウトを明示的に設定するものです。

以下にその手順を示します。

const http = require('http');

const options = {
    hostname: 'example.com',
    port: 80,
    path: '/path',
    method: 'GET'
};

const req = http.request(options, (res) => {
    res.on('data', (d) => {
        process.stdout.write(d);
    });
});

req.on('socket', (socket) => {
    socket.setTimeout(3000); // ソケットのタイムアウトを3秒に設定
    socket.on('timeout', () => {
        console.log('ソケットがタイムアウトしました。');
        req.abort(); // リクエストを中止
    });
});

req.on('error', (err) => {
    console.error(err);
});

req.end();

この方法では、ソケットが割り当てられた後にタイムアウトを設定しています。

解決方法3（上級者向け）

上級者向けの方法として、request.setTimeoutメソッドを使用することもできます。このメソッドは、リクエストオブジェクトに直接タイムアウトを設定する簡単な方法です。

const http = require('http');

const req = http.request('http://example.com', (res) => {
    res.on('data', (chunk) => {
        console.log(chunk);
    });
});

req.setTimeout(3000, () => {
    console.log('リクエストがタイムアウトしました。');
    req.abort();
});

req.on('error', (err) => {
    console.error(err);
});

req.end();

この方法では、setTimeoutメソッドを使用してタイムアウトを簡潔に設定できます。タイムアウトが発生した場合、指定したコールバック関数が実行されます。

エラーの予防方法

HTTPリクエストのタイムアウトを予防するためには、以下の対策を講じることが重要です。

適切なタイムアウト設定: 各アプリケーションに応じて、適切なタイムアウト値を設定することが重要です。一般的には、ネットワーク環境やサーバーの応答時間に基づいて調整します。
定期的なメンテナンス: 使用するAPIやサーバーのパフォーマンスを定期的にチェックし、必要に応じて改善を行います。
エラーハンドリングの実装: タイムアウトやエラーが発生した場合の処理を適切に実装することで、アプリケーションの堅牢性を高めます。

まとめ

HTTPリクエストのタイムアウトを設定することは、Node.jsアプリケーションのパフォーマンスを向上させ、ユーザー体験を向上させるために非常に重要です。適切なタイムアウト値を設定し、エラーハンドリングを実装することで、アプリケーションの信頼性を高めることができます。次のステップとして、実際のアプリケーションにこれらの方法を適用し、タイムアウトに関する問題を未然に防ぎましょう。

How to set a timeout on a http.request() in Node? の解決方法【2…