Express.js req.body が undefined になる原因と解決策

2024-04-02

Express.js で req.body が undefined になる場合、いくつかの原因が考えられます。この問題は、リクエストボディの解析に問題がある場合、またはリクエストヘッダーに問題がある場合に発生します。

原因

body-parser ミドルウェアの欠如:

Express 4.16.0 以前のバージョンでは、body-parser ミドルウェアをインストールして使用しないと、リクエストボディを解析できません。

Content-Type ヘッダーの誤り:

リクエストヘッダーの Content-Type が application/json に設定されていない場合、Express はリクエストボディを JSON として解析できません。

リクエストサイズ制限:

Express はデフォルトでリクエストサイズを 100kb に制限しています。リクエストサイズがこの制限を超えると、req.body は undefined になります。

中間処理エラー:

リクエスト処理の途中でエラーが発生すると、req.body は undefined になる可能性があります。

解決策

npm install body-parser

リクエストヘッダーの Content-Type を application/json に設定します。

curl -H "Content-Type: application/json" \
  -X POST \
  -d '{ "name": "John Doe" }' \
  http://localhost:3000/

リクエストサイズ制限を変更するには、app.use() メソッドを使用して express.json() ミドルウェアを設定します。

app.use(express.json({ limit: '5mb' }));

中間処理エラーが発生していないことを確認します。エラーが発生している場合は、エラーメッセージを確認して原因を特定します。

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

// body-parser ミドルウェアのインストール
app.use(express.json());

// POST リクエストの処理
app.post('/', (req, res) => {
  // req.body からデータを取得
  const name = req.body.name;
  const email = req.body.email;

  // データを処理
  console.log(`Name: ${name}`);
  console.log(`Email: ${email}`);

  // レスポンスを返す
  res.send('OK');
});

app.listen(3000);

このコードを実行し、以下のリクエストを送信すると、

curl -H "Content-Type: application/json" \
  -X POST \
  -d '{ "name": "John Doe", "email": "[email protected]" }' \
  http://localhost:3000/

コンソールに以下の出力が出力されます。

Name: John Doe
Email: [email protected]

このコードは、req.body から JSON データを取得して処理する方法を示しています。

補足

上記のコードは基本的な例です。実際のアプリケーションでは、必要に応じてコードを修正する必要があります。
req.body からデータを取得する前に、データが存在することを確認する必要があります。
データを処理する前に、データの形式をチェックする必要があります。

Express.js で req.body を取得するその他の方法

express.json() ミドルウェアを使用する

Express 4.16.0 以降では、body-parser ミドルウェアは非推奨となりました。代わりに、express.json() ミドルウェアを使用できます。

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

// express.json() ミドルウェアを使用する
app.use(express.json());

// POST リクエストの処理
app.post('/', (req, res) => {
  // req.body からデータを取得
  const name = req.body.name;
  const email = req.body.email;

  // データを処理
  console.log(`Name: ${name}`);
  console.log(`Email: ${email}`);

  // レスポンスを返す
  res.send('OK');
});

app.listen(3000);

raw-body ミドルウェアを使用すると、リクエストボディを生のバッファとして取得できます。

const express = require('express');
const app = express();
const rawBody = require('raw-body');

// raw-body ミドルウェアを使用する
app.use(rawBody());

// POST リクエストの処理
app.post('/', (req, res) => {
  // req.body からデータを取得
  const body = req.body;

  // データを処理
  console.log(body);

  // レスポンスを返す
  res.send('OK');
});

app.listen(3000);

qs モジュールを使用すると、リクエストボディをクエリ文字列として解析できます。

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

// POST リクエストの処理
app.post('/', (req, res) => {
  // req.body からデータを取得
  const body = qs.parse(req.body);

  // データを処理
  console.log(body);

  // レスポンスを返す
  res.send('OK');
});

app.listen(3000);