【Node.js24.x】Object::ClientRequest()メソッドの使い方

ClientRequestメソッドは、Node.jsのアプリケーションがHTTPまたはHTTPSプロトコルを用いて、外部のWebサーバーなどのリソースへネットワークリクエストを送信する処理を実行するメソッドです。

このメソッドは、送信するリクエストの準備から、ヘッダー情報の追加、リクエストボディデータの書き込み、そしてサーバーからの応答を受け取るまでの一連のHTTP通信プロセスを制御する役割を担います。システムエンジニアの観点では、例えばWeb APIを利用して外部サービスと連携したり、ファイルをアップロードしたりする際に、この機能が利用されます。

ClientRequestメソッドは通常、http.request()やhttps.request()といった高レベルな関数を通じて利用され、その結果として返されるオブジェクトを通じて、送信するデータの形式やリクエストの動作を詳細にカスタマイズすることが可能です。具体的には、write()メソッドでリクエストボディの一部を送信し、end()メソッドでリクエストの送信を完了させたり、サーバーからの応答を非同期に処理するためのイベントリスナーを設定したりすることができます。このように、ClientRequestメソッドは、Node.jsで堅牢なネットワーククライアントアプリケーションを構築する上で不可欠な機能を提供しています。

Copy
1const http = require('node:http');
2
3const postData = JSON.stringify({
4  'message': 'Hello Node.js ClientRequest'
5});
6
7const options = {
8  hostname: 'example.com',
9  port: 80,
10  path: '/submit',
11  method: 'POST',
12  headers: {
13    'Content-Type': 'application/json',
14    'Content-Length': Buffer.byteLength(postData)
15  }
16};
17
18const clientRequestInstance = http.request(options, (res) => {
19  res.on('data', (chunk) => {});
20  res.on('end', () => {});
21});
22
23clientRequestInstance.on('error', (error) => {});
24
25clientRequestInstance.write(postData);
26clientRequestInstance.end();

input, options, cb

• input: any: リクエストで送信するデータ
• options: object: リクエストの設定
• cb: function: レスポンス受信時に実行されるコールバック関数

ClientRequest

ClientRequestクラスのコンストラクタです。HTTPクライアントリクエストを生成し、そのリクエストオブジェクト自身を返します。