プログラミング

Expressのレスポンスオブジェクト完全ガイド

最終更新： 14/03/2025
1 分の読み

ExpressフレームワークにおけるHTTPリクエストのレスポンスオブジェクト（res）の取り扱いについて、完全かつ包括的に解説します。ExpressはNode.jsの軽量なWebフレームワークであり、リクエストとレスポンスを効率的に処理するために多くの便利な機能を提供しています。ここでは、HTTPレスポンスの基本的な概念から、高度な利用法までを詳しく説明します。

1. resオブジェクトの基本

res（レスポンス）オブジェクトは、HTTPレスポンスのヘッダー、ボディ、ステータスコードなどをクライアントに返すために使用されます。リクエストに対するレスポンスを作成するために、Expressではresオブジェクトに多くのメソッドが用意されています。

関連記事

以下は、基本的な使い方の例です。

javascript
const express = require('express');
const app = express();

app.get('/', (req, res) => {
  res.send('こんにちは、Express!');
});

app.listen(3000, () => {
  console.log('サーバーがポート3000で起動しました');
});

このコードでは、GETリクエストがルートパス（/）に送られると、res.send()メソッドによって「こんにちは、Express!」というメッセージをレスポンスとしてクライアントに返します。

2. ステータスコードの設定

レスポンスには、クライアントにステータスコード（HTTPステータスコード）を返すことができます。これにより、リクエストの結果が成功したのか失敗したのかを示すことができます。

例えば、リソースが見つからない場合には、404ステータスコードを返すことができます。

javascript
app.get('/not-found', (req, res) => {
  res.status(404).send('ページが見つかりません');
});

ここでは、res.status()メソッドを使って、ステータスコード404（Not Found）を設定し、メッセージを返しています。

3. JSONレスポンスの送信

多くのWebアプリケーションやAPIでは、JSON形式でデータを返すことが一般的です。Expressでは、res.json()メソッドを使用して簡単にJSONレスポンスを送信できます。

javascript
app.get('/api/data', (req, res) => {
  const data = {
    name: '山田太郎',
    age: 30
  };
  res.json(data);
});

このコードでは、クライアントにJSON形式のデータを返しています。res.json()メソッドは、レスポンスヘッダーにContent-Type: application/jsonを自動的に設定します。

4. レスポンスヘッダーの設定

レスポンスヘッダーを設定するには、res.set()メソッドを使用します。これにより、レスポンスにカスタムヘッダーを追加することができます。

javascript
app.get('/set-header', (req, res) => {
  res.set('X-Custom-Header', 'ヘッダーの値');
  res.send('カスタムヘッダーを設定しました');
});

このコードでは、X-Custom-Headerというカスタムヘッダーをレスポンスに追加しています。

5. リダイレクト

特定のURLにリダイレクトする場合には、res.redirect()メソッドを使用します。これにより、クライアントは指定されたURLに自動的に転送されます。

javascript
app.get('/old-page', (req, res) => {
  res.redirect(301, '/new-page');
});

app.get('/new-page', (req, res) => {
  res.send('新しいページにリダイレクトされました');
});

ここでは、/old-pageにアクセスすると、/new-pageにリダイレクトされます。ステータスコード301は、永久的なリダイレクトを意味します。

6. クッキーの設定

Expressでは、res.cookie()メソッドを使ってクッキーを設定することができます。このメソッドは、クライアントのブラウザにクッキーを送信します。

javascript
app.get('/set-cookie', (req, res) => {
  res.cookie('username', 'taro');
  res.send('クッキーを設定しました');
});

このコードでは、usernameという名前のクッキーにtaroという値を設定しています。クッキーには、オプションで有効期限やセキュリティ設定を追加することもできます。

7. ファイルの送信

res.sendFile()メソッドを使用して、サーバー上のファイルをクライアントに送信することができます。例えば、画像やPDFなどを返す場合に便利です。

javascript
app.get('/image', (req, res) => {
  res.sendFile(__dirname + '/image.png');
});

ここでは、サーバー内のimage.pngというファイルをクライアントに送信しています。

8. レスポンスのバッファリング

大きなレスポンスを送信する場合、バッファリングが有効に働きます。res.write()を使うことで、少しずつデータを送信することができます。

javascript
app.get('/stream', (req, res) => {
  res.write('データの一部...');
  setTimeout(() => {
    res.write('追加データ...');
    res.end('終了');
  }, 1000);
});

このコードでは、最初にデータの一部を送信し、その後1秒後に追加データを送信しています。

9. エラーハンドリング

エラーハンドリングは、レスポンスを適切に処理するために重要です。next()を使用してエラーハンドラーに制御を渡し、エラーメッセージを返すことができます。

javascript
app.get('/error', (req, res, next) => {
  const err = new Error('エラーが発生しました');
  next(err);
});

app.use((err, req, res, next) => {
  res.status(500).send(err.message);
});

このコードでは、エラーが発生すると500ステータスコードとともにエラーメッセージがクライアントに送信されます。

10. 最後に

Expressのresオブジェクトは、HTTPレスポンスを構築するために不可欠なツールです。res.send(), res.json(), res.redirect(), res.cookie()など、さまざまなメソッドを駆使して、リクエストに対する適切なレスポンスを返すことができます。適切なステータスコード、ヘッダー、エラーハンドリングを駆使することで、より高品質なWebアプリケーションを作成できます。

Expressのresオブジェクトを理解し、うまく活用することで、効率的で強力なAPIやWebアプリケーションを開発することができます。

最終更新： 14/03/2025
1 分の読み
Back to top button