body-parser Middleware

Node.js Körper parsen Middleware.

Analysieren Sie eingehende Request-Körper in einer Middleware vor Ihrem Handler, verfügbar unter der req.body Eigenschaft.

Note As req.body’s shape is based on user-controlled input, all properties and values in this object are untrusted and should be validated before trusting. Zum Beispiel req.body.foo.toString() kann auf mehreren Wegen fehlschlagen, zum Beispiel könnte die foo Eigenschaft nicht vorhanden sein oder kein String sein, und toString sind möglicherweise keine Funktion und stattdessen eine Zeichenkette oder andere Benutzereingabe.

Erfahren Sie mehr über die Anatomie einer HTTP-Transaktion in Node.js.

Dies behandelt nicht mehrteilige Körper, aufgrund ihrer komplexen und typischerweise großen Natur. Für mehrteilige Einrichtungen können Sie sich für folgende Module interessieren:

Dieses Modul bietet folgende Parser:

JSON Körper Parser
Rohkörper-Parser
Text Körper Parser
URL-kodierter Form-Body Parser

All parsers support automatic inflation of gzip, br (brotli), deflate and zstd encodings. zstd is available in Node.js ^22.15.0 and >=23.8.0.

Andere Körper-Parser, die Sie interessieren können:

body
co-body

Installation

npm install body-parser

Note

body-parser does not include its own TypeScript type definitions. If you use TypeScript, also install the community-maintained types from DefinitelyTyped as a development dependency:

npm install --save-dev @types/body-parser

API

// Import all parsers
const bodyParser = require('body-parser');

// Or import individual parsers directly
const json = require('body-parser/json');
const urlencoded = require('body-parser/urlencoded');
const raw = require('body-parser/raw');
const text = require('body-parser/text');

Das Objekt bodyParser legt verschiedene Fabriken auf, um Middleware zu erstellen. Alle Middlewares werden die Eigenschaft req.body mit dem analysierten Körper füllen, wenn der Content-Type Request Header mit der Option type übereinstimmt.

Note As of v2, req.body is left undefined when no body is parsed (for example when the request has neither Content-Length nor Transfer-Encoding, or when Content-Type does not match). In v1, req.body was always initialized to {}. Code that assumes req.body is always an object should use optional chaining (for example req.body?.username) or set a default.

Die verschiedenen Fehler, die von diesem Modul zurückgegeben werden, werden im Fehlerabschnitt beschrieben.

bodyParser.json([options])

Gibt Middleware zurück, die nur json analysiert und nur Anfragen ansieht, bei denen der Content-Type Header mit der type Option übereinstimmt. This parser accepts any Unicode encoding of the body.

Ein neues body Objekt mit den geparsten Daten wird auf dem request Objekt nach der Middleware (d.h. req.body) gefüllt.

Optionen

The json function takes an optional options object that may contain any of the following keys:

defaultCharset

Geben Sie den Standardzeichensatz für den json-Inhalt an, wenn der Zeichensatz nicht im Content-Type-Header der Anfrage angegeben ist. Standard ist utf-8.

inflate

Wenn auf true gesetzt, dann werden die entschärften (komprimierten) Körper aufgeblasen; wenn false wird, werden die entschärften Körper abgelehnt. Standard ist true.

limit

Steuert die maximale Größe des Request-Bodys. Wenn dies eine Zahl ist, gibt der Wert die Anzahl der Bytes an; wenn es sich um einen String handelt, wird der Wert an die bytes Bibliothek zum Parsen übergeben. Standard ist '100kb'.

Es wird empfohlen, nicht ein sehr hohes Limit zu konfigurieren und den Standardwert wann immer möglich zu verwenden. Das Erlauben größerer Payloads erhöht die Speicherauslastung aufgrund der Ressourcen, die für die Dekodierung und Transformation benötigt werden, und es kann auch zu längeren Reaktionszeiten führen, wenn mehr Daten verarbeitet werden. Mit „sehr hoch“ meinen wir Werte über dem Standardwert, zum Beispiel mit einer Nutzlast von 5 MB oder mehr können bereits damit begonnen werden, diese Risiken einzuführen. Bei den Standardlimits treten diese Probleme nicht auf.

reviver

Die Option reviver wird als zweites Argument direkt an JSON.parse übergeben. You can find more information on this argument in the MDN documentation about JSON.parse.

strict

When set to true, it will only accept arrays and objects; when false, it will accept anything JSON.parse accepts. Standard ist true.

type

Die Option type wird verwendet, um festzustellen, welcher Medientyp die Middleware parst. Diese Option kann ein String, ein Array von Strings oder eine Funktion sein. Wenn nicht Funktion, Die Option type wird direkt an die type-is übergeben und kann ein Name der Erweiterung sein (wie json), ein Mime-Typ (wie application/json) oder ein Mime-Typ mit einem Platzhalter (wie */* oder */json). Wenn eine Funktion aufgerufen wird, wird die Option type als fn(req) aufgerufen und die Anfrage wird geparst, wenn sie einen wahrhaften Wert zurückgibt. Standard ist application/json.

verify

Die verify Option, falls vorhanden, wird als verify(req, res, buf, encoding) aufgerufen, wobei buf ein Buffer des Roh-Request-Body ist und encoding die Kodierung der Anfrage. Das Parsen kann durch Werfen eines Fehlers abgebrochen werden.

bodyParser.raw([options])

Gibt Middleware zurück, die alle Körper als Buffer parst und nur Anfragen ansieht, wo der Content-Type Header mit der type Option übereinstimmt.

Ein neues body Objekt mit den geparsten Daten wird auf dem request Objekt nach der Middleware (d.h. req.body) gefüllt. Dies wird ein Buffer Objekt des Körpers sein.

Optionen

The raw function takes an optional options object that may contain any of the following keys:

inflate

Wenn auf true gesetzt, dann werden die entschärften (komprimierten) Körper aufgeblasen; wenn false wird, werden die entschärften Körper abgelehnt. Standard ist true.

limit

Es wird empfohlen, nicht ein sehr hohes Limit zu konfigurieren und den Standardwert wann immer möglich zu verwenden. Das Erlauben größerer Payloads erhöht die Speicherauslastung aufgrund der Ressourcen, die für die Dekodierung und Transformation benötigt werden, und es kann auch zu längeren Reaktionszeiten führen, wenn mehr Daten verarbeitet werden. Mit „sehr hoch“ meinen wir Werte über dem Standardwert, zum Beispiel mit einer Nutzlast von 5 MB oder mehr können bereits damit begonnen werden, diese Risiken einzuführen. Bei den Standardlimits treten diese Probleme nicht auf.

type

Die Option type wird verwendet, um festzustellen, welcher Medientyp die Middleware parst. Diese Option kann ein String, ein Array von Strings oder eine Funktion sein. Wenn nicht eine Funktion, type Option wird direkt an die type-is Bibliothek übergeben und diese kann ein Name der Erweiterung sein (wie bin), ein Mime-Typ (wie application/octet-stream) oder ein Mime-Typ mit einem Platzhalter (wie */* oder application/*). If a function, the type option is called as fn(req) and the request is parsed if it returns a truthy value. Standardmäßig application/octet-stream.

verify

bodyParser.text([options])

Gibt Middleware zurück, die alle Körper als String parst und nur Anfragen ansieht, in denen der Content-Type Header mit der type Option übereinstimmt.

A new body string containing the parsed data is populated on the request object after the middleware (i.e. req.body). This will be a string of the body.

Optionen

The text function takes an optional options object that may contain any of the following keys:

defaultCharset

Specify the default character set for the text content if the charset is not specified in the Content-Type header of the request. Standard ist utf-8.

inflate

Wenn auf true gesetzt, dann werden die entschärften (komprimierten) Körper aufgeblasen; wenn false wird, werden die entschärften Körper abgelehnt. Standard ist true.

limit

Es wird empfohlen, nicht ein sehr hohes Limit zu konfigurieren und den Standardwert wann immer möglich zu verwenden. Das Erlauben größerer Payloads erhöht die Speicherauslastung aufgrund der Ressourcen, die für die Dekodierung und Transformation benötigt werden, und es kann auch zu längeren Reaktionszeiten führen, wenn mehr Daten verarbeitet werden. Mit „sehr hoch“ meinen wir Werte über dem Standardwert, zum Beispiel mit einer Nutzlast von 5 MB oder mehr können bereits damit begonnen werden, diese Risiken einzuführen. Bei den Standardlimits treten diese Probleme nicht auf.

type

Die Option type wird verwendet, um festzustellen, welcher Medientyp die Middleware parst. Diese Option kann ein String, ein Array von Strings oder eine Funktion sein. If not a function, type option is passed directly to the type-is library and this can be an extension name (like txt), a mime type (like text/plain), or a mime type with a wildcard (like */* or text/*). If a function, the type option is called as fn(req) and the request is parsed if it returns a truthy value. Defaults to text/plain.

verify

bodyParser.urlencoded([options])

Returns middleware that only parses urlencoded bodies and only looks at requests where the Content-Type header matches the type option. This parser accepts only UTF-8 and ISO-8859-1 encodings of the body.

Ein neues body Objekt mit den geparsten Daten wird auf dem request Objekt nach der Middleware (d.h. req.body) gefüllt. This object will contain key-value pairs, where the value can be a string or array (when extended is false), or any type (when extended is true).

Optionen

The urlencoded function takes an optional options object that may contain any of the following keys:

extended

The “extended” syntax allows for rich objects and arrays to be encoded into the URL-encoded format, allowing for a JSON-like experience with URL-encoded. For more information, please see the qs library.

Defaults to false.

inflate

Wenn auf true gesetzt, dann werden die entschärften (komprimierten) Körper aufgeblasen; wenn false wird, werden die entschärften Körper abgelehnt. Standard ist true.

limit

Es wird empfohlen, nicht ein sehr hohes Limit zu konfigurieren und den Standardwert wann immer möglich zu verwenden. Das Erlauben größerer Payloads erhöht die Speicherauslastung aufgrund der Ressourcen, die für die Dekodierung und Transformation benötigt werden, und es kann auch zu längeren Reaktionszeiten führen, wenn mehr Daten verarbeitet werden. Mit „sehr hoch“ meinen wir Werte über dem Standardwert, zum Beispiel mit einer Nutzlast von 5 MB oder mehr können bereits damit begonnen werden, diese Risiken einzuführen. Bei den Standardlimits treten diese Probleme nicht auf.

parameterLimit

The parameterLimit option controls the maximum number of parameters that are allowed in the URL-encoded data. If a request contains more parameters than this value, a 413 will be returned to the client. Defaults to 1000.

type

Die Option type wird verwendet, um festzustellen, welcher Medientyp die Middleware parst. Diese Option kann ein String, ein Array von Strings oder eine Funktion sein. If not a function, type option is passed directly to the type-is library and this can be an extension name (like urlencoded), a mime type (like application/x-www-form-urlencoded), or a mime type with a wildcard (like */x-www-form-urlencoded). If a function, the type option is called as fn(req) and the request is parsed if it returns a truthy value. Defaults to application/x-www-form-urlencoded.

verify

defaultCharset

The default charset to parse as, if not specified in content-type. Must be either utf-8 or iso-8859-1. Standard ist utf-8.

charsetSentinel

Whether to let the value of the utf8 parameter take precedence as the charset selector. It requires the form to contain a parameter named utf8 with a value of ✓. Defaults to false.

interpretNumericEntities

Whether to decode numeric entities such as ☺ when parsing an iso-8859-1 form. Defaults to false.

depth

The depth option is used to configure the maximum depth of the qs library when extended is true. This allows you to limit the amount of keys that are parsed and can be useful to prevent certain types of abuse. Defaults to 32. It is recommended to keep this value as low as possible.

Errors

The middlewares provided by this module create errors using the http-errors module. The errors will typically have a status/statusCode property that contains the suggested HTTP response code, an expose property to determine if the message property should be displayed to the client, a type property to determine the type of error without matching against the message, and a body property containing the read body, if available.

The following are the common errors created, though any error can come through for various reasons.

content encoding unsupported

This error will occur when the request had a Content-Encoding header that contained an encoding but the “inflation” option was set to false. Die Eigenschaft status ist auf 415 gesetzt, die Eigenschaft type ist auf 'encoding.unsupported' und die Eigenschaft charset wird auf die nicht unterstützte Kodierung gesetzt.

entity parse failed

This error will occur when the request contained an entity that could not be parsed by the middleware. Die Eigenschaft status ist auf 400 gesetzt, die Eigenschaft type ist auf 'entity.parse.failed' und die Eigenschaft body ist auf gesetzt, der Entitätswert der fehlgeschlagen ist.

entity verify failed

This error will occur when the request contained an entity that could not be verified by the defined verify option. Die Eigenschaft status ist auf 403 gesetzt, die Eigenschaft type ist auf 'entity.verify.failed' und die Eigenschaft body wird auf den Entitätswert gesetzt, der bei der Überprüfung fehlgeschlagen ist.

request aborted

This error will occur when the request is aborted by the client before reading the body has finished. Die Eigenschaft received wird auf die Anzahl der empfangenen Bytes gesetzt, bevor die Anfrage abgebrochen wurde und die Eigenschaft expected ist auf die Anzahl der erwarteten Bytes gesetzt. Die Eigenschaft status wurde auf 400 gesetzt und type auf 'request.aborted' gesetzt.

request entity too large

This error will occur when the request body’s size is larger than the “limit” option. The limit property will be set to the byte limit and the length property will be set to the request body’s length. Die Eigenschaft status ist auf 413 gesetzt und die Eigenschaft type auf 'entity.too.large' gesetzt.

request size did not match content length

This error will occur when the request’s length did not match the length from the Content-Length header. This typically occurs when the request is malformed, typically when the Content-Length header was calculated based on characters instead of bytes. Die Eigenschaft status ist auf 400 gesetzt und die Eigenschaft type ist auf 'request.size.invalid' gesetzt.

stream encoding should not be set

This error will occur when something called the req.setEncoding method prior to this middleware. This module operates directly on bytes only and you cannot call req.setEncoding when using this module. Die Eigenschaft status ist auf 500 gesetzt und die Eigenschaft type ist auf 'stream.encoding.set' gesetzt.

stream is not readable

This error will occur when the request is no longer readable when this middleware attempts to read it. This typically means something other than a middleware from this module read the request body already and the middleware was also configured to read the same request. Die Eigenschaft status ist auf 500 gesetzt und die Eigenschaft type ist auf 'stream.not.readable' gesetzt.

too many parameters

This error will occur when the content of the request exceeds the configured parameterLimit for the urlencoded parser. Die Eigenschaft status ist auf 413 gesetzt und die Eigenschaft type ist auf 'parameters.too.many' gesetzt.

unsupported charset “BOGUS”

This error will occur when the request had a charset parameter in the Content-Type header, but the iconv-lite module does not support it OR the parser does not support it. The charset is contained in the message as well as in the charset property. Die Eigenschaft status ist auf 415 gesetzt, die Eigenschaft type ist auf 'charset.unsupported' und die Eigenschaft charset wird auf den Zeichensatz gesetzt, der nicht unterstützt wird.

unsupported content encoding “bogus”

This error will occur when the request had a Content-Encoding header that contained an unsupported encoding. The encoding is contained in the message as well as in the encoding property. Die Eigenschaft status ist auf 415 gesetzt, die Eigenschaft type ist auf 'encoding.unsupported' gesetzt und die Eigenschaft encoding wird auf die nicht unterstützte Kodierung gesetzt.

The input exceeded the depth

This error occurs when using bodyParser.urlencoded with the extended property set to true and the input exceeds the configured depth option. The status property is set to 400. It is recommended to review the depth option and evaluate if it requires a higher value. With the default depth of 32, an input with 33 or more levels of nesting gets this error.

Beispiele

Express/Connect top-level generic

This example demonstrates adding a generic JSON and URL-encoded parser as a top-level middleware, which will parse the bodies of all incoming requests. This is the simplest setup.

const express = require('express');
const bodyParser = require('body-parser');

const app = express();

// parse application/x-www-form-urlencoded
app.use(bodyParser.urlencoded());

// parse application/json
app.use(bodyParser.json());

app.use(function (req, res) {
  res.setHeader('Content-Type', 'text/plain');
  res.write('you posted:\n');
  res.end(String(JSON.stringify(req.body, null, 2)));
});

Express route-specific

This example demonstrates adding body parsers specifically to the routes that need them. In general, this is the most recommended way to use body-parser with Express.

const express = require('express');
const bodyParser = require('body-parser');

const app = express();

// create application/json parser
const jsonParser = bodyParser.json();

// create application/x-www-form-urlencoded parser
const urlencodedParser = bodyParser.urlencoded();

// POST /login gets urlencoded bodies
app.post('/login', urlencodedParser, function (req, res) {
  if (!req.body || !req.body.username) res.sendStatus(400);
  res.send('welcome, ' + req.body.username);
});

// POST /api/users gets JSON bodies
app.post('/api/users', jsonParser, function (req, res) {
  if (!req.body) res.sendStatus(400);
  // create user in req.body
});

Change accepted type for parsers

All the parsers accept a type option which allows you to change the Content-Type that the middleware will parse.

const express = require('express');
const bodyParser = require('body-parser');

const app = express();

// parse various different custom JSON types as JSON
app.use(bodyParser.json({ type: 'application/*+json' }));

// parse some custom thing into a Buffer
app.use(bodyParser.raw({ type: 'application/vnd.custom-type' }));

// parse an HTML body into a string
app.use(bodyParser.text({ type: 'text/html' }));

Lizenz

MIT