ExpressでGETパラメータを取得する方法

Node.jsのExpressフレームワークで、URLの「?」以降に続くGETパラメータを取得する方法について日本語で解説します。

req.queryオブジェクトを使用する

最も一般的な方法です。Expressは、リクエストオブジェクトのreq.queryプロパティにGETパラメータをオブジェクトとして格納します。

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

app.get('/users', (req, res) => {
  const name = req.query.name;
  const age = req.query.age;

  // GETパラメータを処理する
  console.log('Name:', name);
  console.log('Age:', age);

  res.send('Hello, ' + name + '! You are ' + age + ' years old.');
});

app.listen(3000, () => {
  console.log('Server listening on port 3000');
});

上記の例では、URLがhttp://localhost:3000/users?name=John&age=30の場合、req.queryオブジェクトは{ name: 'John', age: '30' }となります。

query-stringモジュールを使用する

より複雑なGETパラメータの処理が必要な場合は、query-stringモジュールを使用することもできます。

const express = require('express');
const queryString = require('query-string');
const app = express();

app.get('/search', (req, res) => {
  const queryParams = queryString.parse(req.url);
  const query = queryParams.query;
  const page = queryParams.page;

  // GETパラメータを処理する
  console.log('Query:', query);
  console.log('Page:', page);

  res.send('Search results for: ' + query);
});

app.listen(3000, () => {
  console.log('Server listening on port 3000');
});

この方法では、req.urlを解析してGETパラメータを取得します。

ミドルウェアを使用する

複数のルートでGETパラメータを処理する必要がある場合は、ミドルウェアを使用することもできます。

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

function parseQueryParams(req, res, next) {
  const queryParams = queryString.parse(req.url);
  req.query = queryParams;
  next();
}

app.use(parseQueryParams);

app.get('/users', (req, res) => {
  // GETパラメータを処理する
  console.log('Name:', req.query.name);
  console.log('Age:', req.query.age);

  res.send('Hello, ' + req.query.name + '! You are ' + req.query.age + ' years old.');
});

app.listen(3000, () => {
  console.log('Server listening on port 3000');
});

この方法では、ミドルウェアがリクエストを処理する前にGETパラメータを解析し、req.queryオブジェクトに格納します。

コードの全体像

上記のコードは、Node.jsのExpressフレームワークを使って、URLの「?」以降に付与されたGETパラメータを取得し、処理する方法を示しています。

• コードの解説
  
  • nameとageというパラメータをreq.queryから取得し、変数に代入しています。
  • 取得したパラメータを使って、シンプルなメッセージを生成し、クライアントに返しています。
• req.query：リクエストオブジェクトのreq.queryプロパティは、GETパラメータをキーと値のペアで格納したオブジェクトです。

• コードの解説
  
  • req.urlからquery-stringモジュールを使って、GETパラメータを解析し、queryParamsオブジェクトに格納しています。
  • queryParamsからqueryとpageというパラメータを取得し、処理しています。
• 例
  http://localhost:3000/search?query=nodejs&page=2というURLの場合、queryParamsは{ query: 'nodejs', page: '2' }となります。
• query-stringモジュール
  より柔軟なパラメータ処理のために、query-stringモジュールを使用します。

• コードの解説
  
  • parseQueryParamsというミドルウェア関数で、req.urlを解析し、req.queryに結果を格納しています。
  • このミドルウェアをapp.useで登録することで、全てのルートでreq.queryが利用可能になります。
• ミドルウェア
  複数のルートで共通してGETパラメータを処理したい場合に、ミドルウェアを使用します。

各コードのポイント

• ミドルウェアは、コードの重複を減らし、可読性を向上させることができます。
• query-stringモジュールは、より複雑なパラメータ処理が必要な場合に有効です。
• req.queryは、GETパラメータを簡単に取得できる便利なプロパティです。

• レスポンスオブジェクト
  サーバーからクライアントへ送り返すレスポンスに関する情報を格納したオブジェクトです。
• リクエストオブジェクト
  クライアントからサーバーに送られてきたリクエストに関する情報を格納したオブジェクトです。
• GETパラメータ
  URLの「?」以降に付与される、キーと値のペアで表されるデータです。

より詳しく知りたい場合

• query-stringモジュールのドキュメント
  query-stringモジュールの使い方について詳細な情報が記載されています。
• Expressの公式ドキュメント
  Expressの機能やAPIについて詳細な情報が記載されています。

• セキュリティ面では、GETパラメータに直接ユーザーが入力した値を使用する場合は、XSSなどの攻撃に注意する必要があります。
• GETパラメータの値は、文字列として取得されます。数値として扱いたい場合は、適切な型変換を行う必要があります。

ルーティングパラメータと組み合わせる

GETパラメータだけでなく、URLのパス部分に含まれるパラメータも同時に取得したい場合、ルーティングパラメータと組み合わせる方法が考えられます。

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

app.get('/users/:userId/profile', (req, res) => {
    const userId = req.params.userId;
    const name = req.query.name;
    // ...
});

この例では、userIdはルーティングパラメータ、nameはGETパラメータとして取得しています。

ミドルウェアでカスタム処理

より高度なパラメータ処理が必要な場合、独自のミドルウェアを作成してリクエストオブジェクトに任意の情報を追加できます。

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

function customQueryParams(req, res, next) {
    // カスタムなパラメータ処理
    req.customParams = {
        // ...
    };
    next();
}

app.use(customQueryParams);

app.get('/users', (req, res) => {
    const customParam = req.customParams.someValue;
    // ...
});

サードパーティライブラリを利用

express-validatorなどのバリデーションライブラリを利用すると、入力値の検証と同時にパラメータを取得することができます。

const express = require('express');
const { check, validationResult } = require('express-validator');
const app = express();

app.get('/users', [
    check('name').isLength({ min: 5 })
], (req, res) => {
    const errors = validationResult(req);
    if (!errors.isEmpty()) {
        return res.status(400).json({ errors: errors.array() });
    }

    const name =    req.body.name; // バリデーション後に取得
    // ...
});

URLエンコード/デコード

GETパラメータはURLエンコードされているため、特殊文字を含むパラメータを扱う場合は、decodeURIComponent()関数を使ってデコードする必要があります。

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

app.get('/search', (req, res) => {
    const searchQuery = decodeURIComponent(req.query.query);
    // ...
});

どの方法を選ぶべきか？

• URLエンコード/デコード
  特殊文字を含むパラメータを扱う場合に必要です。
• バリデーション
  入力値の検証が必要な場合に便利です。
• カスタム処理
  独自のロジックでパラメータを処理したい場合に有効です。
• ルーティングパラメータとの組み合わせ
  URLの構造とパラメータの組み合わせによって使い分けます。
• シンプルなケース
  req.queryオブジェクトで十分な場合が多いです。

ExpressでGETパラメータを取得する方法は、req.queryオブジェクトを使うのが一般的ですが、状況に応じて様々な方法が考えられます。これらの方法を組み合わせることで、より複雑なアプリケーションに対応することができます。

選択する際のポイント

• 可読性
  コードの可読性を高めるために、適切な方法を選択する
• セキュリティ
  ユーザーが入力した値を直接使用する場合は、XSSなどの攻撃に注意し、適切なサニタイズを行う
• 処理の複雑さ
  シンプルな処理であればreq.queryで十分、複雑な処理であればミドルウェアやサードパーティライブラリを検討

• POSTパラメータ
  POSTメソッドで送信されるパラメータは、req.bodyオブジェクトで取得します。