Express.jsのreqとresパラメータ：理解を深めるための詳細解説とサンプルコード

2024-04-28

Express 関数における「res」と「req」パラメータとは？

Express.js でルートやミドルウェアを定義する際によく用いられる関数には、req と res という 2 つのパラメータが渡されます。これらのパラメータは、リクエストとレスポンスに関する情報をそれぞれ提供し、Web アプリケーションを開発する上で重要な役割を果たします。

req (Request) オブジェクト

クライアントから送信された HTTP リクエストに関する情報を保持します。
具体的な情報としては、以下が挙げられます。
- HTTP メソッド (GET、POST、PUT など)
- リクエストヘッダー
- URL パラメータ
- クエリ文字列
- リクエストボディ (JSON やフォームデータなど)

例：

app.get('/', function(req, res) {
  console.log(req.method); // GET
  console.log(req.headers['content-type']); // application/json
  console.log(req.params.id); // 123 (URL パラメータ `/users/:id` の場合)
  console.log(req.query.name); // 山田太郎 (クエリ文字列 `?name=山田太郎`)
  console.log(req.body); // { name: '山田太郎', age: 30 } (JSON 形式のボディ)
});

res (Response) オブジェクト

クライアントに送信する HTTP レスポンスを生成するために使用されます。
具体的な機能としては、以下が挙げられます。
- ステータスコードの設定 (200 OK、404 Not Found など)
- レスポンスヘッダーの設定
- レスポンスボディの設定 (HTML、JSON、テキストなど)

app.get('/', function(req, res) {
  const user = { name: '山田太郎', age: 30 };
  res.status(200).json(user); // ステータスコード 200 OK で JSON 形式のデータを返す
});

req オブジェクトは、リクエストに関する情報を提供し、クライアントからの要求を理解するのに役立ちます。
res オブジェクトは、レスポンスを生成し、クライアントに適切な情報を返すのに役立ちます。

これらのパラメータを理解することで、Express.js を用いた Web アプリケーション開発において、より柔軟かつ効率的なコーディングが可能になります。

補足:

上記はあくまでも基本的な説明であり、req と res オブジェクトにはさらに多くの機能が含まれています。

サンプルコード：ユーザー登録とログイン機能

このサンプルコードでは、Express.js と MongoDB を利用して、ユーザー登録とログイン機能を備えたシンプルな Web アプリケーションを作成します。

必要なもの

Node.js
Express.js
MongoDB

手順

プロジェクトを初期化します。

npm init -y
npm install express mongodb

データベース接続とスキーマ定義を行います。

const express = require('express');
const mongoose = require('mongoose');

// データベース接続
mongoose.connect('mongodb://localhost:27017/userdb', { useNewUrlParser: true, useUnifiedTopology: true });

// ユーザー スキーマ
const userSchema = new mongoose.Schema({
  name: String,
  email: String,
  password: String
});

// ユーザーモデル
const User = mongoose.model('User', userSchema);

ユーザー登録処理を定義します。

app.post('/register', async (req, res) => {
  const { name, email, password } = req.body;

  try {
    const user = new User({ name, email, password });
    await user.save();
    res.status(201).json({ message: 'ユーザー登録が完了しました。' });
  } catch (error) {
    res.status(500).json({ message: error.message });
  }
});

ログイン処理を定義します。

app.post('/login', async (req, res) => {
  const { email, password } = req.body;

  try {
    const user = await User.findOne({ email });
    if (!user) {
      return res.status(404).json({ message: 'ユーザーが見つかりません。' });
    }

    const isMatch = await user.comparePassword(password);
    if (!isMatch) {
      return res.status(401).json({ message: 'パスワードが間違っています。' });
    }

    // ログイン成功処理 (セッション作成など)
    res.status(200).json({ message: 'ログインしました。' });
  } catch (error) {
    res.status(500).json({ message: error.message });
  }
});

ルーティングを設定します。

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.use('/api/users', require('./routes/user'));

起動します。

node index.js

このコードはあくまで一例であり、より高度な機能を実装するには、認証ミドルウェアやセッション管理などの仕組みを追加する必要があります。

補足

このサンプルコードでは、セキュリティ対策が十分に考慮されていません。本番環境で利用する場合は、適切な対策を講じてください。
エラー処理やバリデーションなどは省略されています。実用的には、より詳細な処理を実装する必要があります。

Express.js で req と res パラメータを使用する以外にも、リクエストとレスポンスを処理する方法がいくつかあります。それぞれのアプローチには長所と短所があり、状況に応じて使い分けることが重要です。

Koa.js:

Express.js に代わる軽量な Web フレームワークです。
ジェネレータを使用し、非同期処理をより流暢に扱えます。
コンテキストオブジェクト (ctx) を介してリクエストとレスポンスにアクセスできます。
ctx.req と ctx.res プロパティを使用して、リクエストとレスポンス情報にアクセスできます。

const Koa = require('koa');
const app = new Koa();

app.use(async (ctx) => {
  // リクエスト処理
  ctx.body = 'Hello World!';
});

app.listen(3000);

Nest.js:

TypeScript に基づいた、モジュラーでオブジェクト指向の Node.js フレームワークです。
コントローラーとプロバイダを使用して、アプリケーションロジックを構造化します。
コントローラーメソッド内で、@Inject デコレータを使用して Request と Response オブジェクトを注入できます。

import { Controller, Get } from '@nestjs/common';
import { Request, Response } from 'express';

@Controller('api/users')
export class UserController {
  constructor() {}

  @Get()
  async findAll(req: Request, res: Response) {
    // ユーザー一覧を取得
    const users = await this.userService.findAll();
    res.json(users);
  }
}

Fastify:

高速で軽量な Node.js Web フレームワークです。
関数ベースのルーティングを採用しており、コードがより簡潔になります。
fastify.request と fastify.reply オブジェクトを使用して、リクエストとレスポンスにアクセスできます。

const fastify = require('fastify');

const app = fastify();

app.get('/', async (req, reply) => {
  reply.send('Hello World!');
});

app.listen(3000);

RESTful API を構築するための Node.js フレームワークです。
リソース、ルート、メソッドを定義することで、API を設計します。

const restify = require('restify');

const server = restify.createServer();

server.get('/', (req, res, next) => {
  res.send(200, 'Hello World!');
  next();
});

server.listen(3000);

それぞれの利点と欠点

フレームワーク	利点	欠点
Express.js	最も人気があり、豊富なリソースとコミュニティがある	複雑で冗長なコードになりがち
Koa.js	軽量で高速、非同期処理に適している	Express.js ほど成熟していない
Nest.js	モジュラーで構造化しやすい、TypeScript に最適	習得コストがやや高い
Fastify	高速で簡潔、関数ベースのルーティング	コミュニティが小さい
Restify	RESTful API に特化している	Express.js ほど汎用性がない