middleware parser corpo

Análise do Node.js corpo de middleware.

Analise os corpos recebidos em um middleware antes dos seus manipuladores, disponível sob a propriedade req.body.

Nota Como perguntar. a forma do ody é baseada na entrada controlada pelo usuário, todas as propriedades e valores neste objeto não são confiáveis e devem ser validados antes de confiabilidade. Por exemplo, req.body.foo. oString() pode falhar em múltiplas formas como, por exemplo, a propriedade foo pode não estar presente ou não ser uma string, e toString não podem ser uma função e, em vez disso, uma string ou outra entrada do usuário.

Aprenda sobre a anatomia de uma transação HTTP no Node.js.

Isso não lida com organismos multipartes, devido à sua natureza complexa e tipicamente grande. Para organismos de várias partes, você pode estar interessado nos seguintes módulos :

Este módulo fornece os seguintes analisadores:

Analisador JSON de corpo
Analisador de corpo primo
Text body parser
Analisador de forma codificado em URL

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.

Outros analisadores de corpo que você pode interessar:

body
co-body

Instalação

npm install body-parser

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');

O objeto bodyParser expõe várias fábricas para criar intermediários. Todos os middlewares irão preencher a propriedade req.body com o corpo analisado quando o cabeçalho de solicitação Content-Type corresponde à opção type.

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.

Os vários erros retornados por este módulo estão descritos na seção de erro.

bodyParser.json([options])

Retorna um middleware que só analisa json e só olha para solicitações onde o cabeçalho Content-Type corresponde à opção type. This parser accepts any Unicode encoding of the body.

Um novo objeto body contendo os dados analisados é preenchido no objeto request após o middleware (ou seja, req.body).

Opções

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

padrãoCharset

Especifique o conjunto de caracteres padrão para o conteúdo de json se o conjunto de caracteres não for especificado no cabeçalho Content-Type da solicitação. Padrão para ‘utf-8’.

inflar

Quando definido como true, os corpos (comprimidos) serão inflacionados; quando false, os corpos desbotados forem rejeitados. O padrão é ‘true’.

limite

Controla o tamanho máximo do corpo da requisição. Se este é um número, o valor especifica o número de bytes; se é uma string, o valor é passado para a biblioteca bytes para análise. O padrão para '100kb'.

É recomendado não configurar um limite muito alto e usar o valor padrão sempre que possível. Permitir que cargas maiores aumenta o uso de memória por causa dos recursos necessários para decodificação e transformações, e também pode levar a tempos de resposta mais longos à medida que mais dados são processados. Por “muito alto”, queremos dizer valores acima do padrão, por exemplo, pagamentos de 5 MB ou mais já podem começar a introduzir esses riscos. Com os limites padrão, estas questões não ocorrem.

reviver

A opção reviver é passada diretamente para JSON.parse como o segundo argumento . You can find more information on this argument in the MDN documentation about JSON.parse.

estrito

When set to true, it will only accept arrays and objects; when false, it will accept anything JSON.parse accepts. O padrão é ‘true’.

Tipo

The type option is used to determine what media type the middleware will parse. Esta opção pode ser uma string, um array de frases ou uma função. Se não é uma função , A opção type é passada diretamente para a biblioteca type-is e isto pode ser um nome de extensão (como json), um tipo de mime (como application/json), ou um tipo de mime com um caractere curinga (como */* ou */json). Se uma função, a opção type for chamada como fn(req) e a solicitação for analisada se ela retornar um valor real . O padrão é application/json.

verificar

A opção verificar, se fornecida, é chamada como verificar(req, res, buf, codificação), onde buf é um Buffer do corpo da solicitação bruta e encoding é a codificação da solicitação. A análise pode ser abortada lançando um erro.

bodyParser.raw([options])

Retorna um middleware que analisa todos os corpos como um Buffer e só olha para solicitações onde o cabeçalho Content-Type corresponde à opção type.

Um novo objeto body contendo os dados analisados é preenchido no objeto request após o middleware (ou seja, req.body). Este será um objeto Buffer do corpo.

Opções

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

inflar

Quando definido como true, os corpos (comprimidos) serão inflacionados; quando false, os corpos desbotados forem rejeitados. O padrão é ‘true’.

limite

É recomendado não configurar um limite muito alto e usar o valor padrão sempre que possível. Permitir que cargas maiores aumenta o uso de memória por causa dos recursos necessários para decodificação e transformações, e também pode levar a tempos de resposta mais longos à medida que mais dados são processados. Por “muito alto”, queremos dizer valores acima do padrão, por exemplo, pagamentos de 5 MB ou mais já podem começar a introduzir esses riscos. Com os limites padrão, estas questões não ocorrem.

Tipo

The type option is used to determine what media type the middleware will parse. Esta opção pode ser uma string, um array de frases ou uma função. Se não é uma função, A opção type é passada diretamente para a biblioteca type-is e este pode ser um nome de extensão (como bin), um tipo MIME (como application/octet-stream), ou um tipo MIME com um curinga (como */* ou application/*). Se uma função, a opção type for chamada como fn(req) e a solicitação for analisada se ela retornar um valor verdadeiro. O padrão é application/octet-stream.

verificar

bodyParser.text([options])

Retorna um middleware que analisa todos os corpos como uma seqüência de caracteres e só olha para solicitações onde o cabeçalho Content-Type corresponde à opção type.

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.

Opções

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

padrãoCharset

Specify the default character set for the text content if the charset is not specified in the Content-Type header of the request. Padrão para ‘utf-8’.

inflar

Quando definido como true, os corpos (comprimidos) serão inflacionados; quando false, os corpos desbotados forem rejeitados. O padrão é ‘true’.

limite

É recomendado não configurar um limite muito alto e usar o valor padrão sempre que possível. Permitir que cargas maiores aumenta o uso de memória por causa dos recursos necessários para decodificação e transformações, e também pode levar a tempos de resposta mais longos à medida que mais dados são processados. Por “muito alto”, queremos dizer valores acima do padrão, por exemplo, pagamentos de 5 MB ou mais já podem começar a introduzir esses riscos. Com os limites padrão, estas questões não ocorrem.

Tipo

The type option is used to determine what media type the middleware will parse. Esta opção pode ser uma string, um array de frases ou uma função. 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.

verificar

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.

Um novo objeto body contendo os dados analisados é preenchido no objeto request após o middleware (ou seja, req.body). 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).

Opções

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.

inflar

Quando definido como true, os corpos (comprimidos) serão inflacionados; quando false, os corpos desbotados forem rejeitados. O padrão é ‘true’.

limite

É recomendado não configurar um limite muito alto e usar o valor padrão sempre que possível. Permitir que cargas maiores aumenta o uso de memória por causa dos recursos necessários para decodificação e transformações, e também pode levar a tempos de resposta mais longos à medida que mais dados são processados. Por “muito alto”, queremos dizer valores acima do padrão, por exemplo, pagamentos de 5 MB ou mais já podem começar a introduzir esses riscos. Com os limites padrão, estas questões não ocorrem.

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.

Tipo

The type option is used to determine what media type the middleware will parse. Esta opção pode ser uma string, um array de frases ou uma função. 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.

verificar

padrãoCharset

The default charset to parse as, if not specified in content-type. Must be either utf-8 or iso-8859-1. Padrão para ‘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. The status property is set to 415, the type property is set to 'encoding.unsupported', and the charset property will be set to the encoding that is unsupported.

entity parse failed

This error will occur when the request contained an entity that could not be parsed by the middleware. The status property is set to 400, the type property is set to 'entity.parse.failed', and the body property is set to the entity value that failed parsing.

entity verify failed

This error will occur when the request contained an entity that could not be verified by the defined verify option. The status property is set to 403, the type property is set to 'entity.verify.failed', and the body property is set to the entity value that failed verification.

request aborted

This error will occur when the request is aborted by the client before reading the body has finished. The received property will be set to the number of bytes received before the request was aborted and the expected property is set to the number of expected bytes. The status property is set to 400 and type property is set to 'request.aborted'.

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. The status property is set to 413 and the type property is set to 'entity.too.large'.

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. The status property is set to 400 and the type property is set to 'request.size.invalid'.

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. The status property is set to 500 and the type property is set to 'stream.encoding.set'.

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. The status property is set to 500 and the type property is set to 'stream.not.readable'.

too many parameters

This error will occur when the content of the request exceeds the configured parameterLimit for the urlencoded parser. The status property is set to 413 and the type property is set to 'parameters.too.many'.

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. The status property is set to 415, the type property is set to 'charset.unsupported', and the charset property is set to the charset that is unsupported.

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. The status property is set to 415, the type property is set to 'encoding.unsupported', and the encoding property is set to the encoding that is unsupported.

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.

Exemplos

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' }));

Tipo:

MIT