cadena de consulta do módulo

O módulo querystring ofrece algunhas funcións prácticas para analizar e serializar os parámetros de consulta de URL. Usando o módulo de querystring, pode analizar facilmente os parámetros de consulta de URL en obxectos ou cadeas e tamén pode serializar obxectos en cadeas de parámetros de consulta de URL.

As seguintes son as querystringfuncións de uso habitual do módulo:

• querystring.parse(str[, sep[, eq[, options]]]): Analiza os parámetros de consulta de URL en obxectos
• querystring.stringify(obj[, sep[, eq[, options]]]): serializa o obxecto nunha cadea de parámetros de consulta de URL

Entre eles, stratópase a cadea de parámetros de consulta de URL que se vai analizar e objé o obxecto a serializar.

O seguinte exemplo mostra como usar querystringo módulo para analizar os parámetros de consulta dun URL en obxectos:

1
2
3
4
5
6
7
8
const querystring = require('querystring');

const url = 'https://www.example.com/path/to/page?foo=bar&baz=qux';

const search = new URL(url).search; // return '?foo=bar&baz=qux'
const query = querystring.parse(search.slice(1)); // parse query string

console.log(query); // output { foo: 'bar', baz: 'qux' }

O código anterior obtén primeiro un URL, despois extrae a parte do parámetro de consulta, usa querystring.parse()a función para analizalo nun obxecto e, finalmente, imprime o obxecto.

A continuación, un exemplo mostra como usar querystringo módulo para serializar un obxecto nunha cadea de parámetros de consulta de URL:

1
2
3
4
5
6
7
8
9
10
const querystring = require('querystring');

const obj = {
    foo: 'bar',
    baz: 'qux'
};

const query = querystring.stringify(obj);

console.log(query); // output "foo=bar&baz=qux"

No código anterior, primeiro defínese un obxecto, despois querystring.stringify()utilízase a función para serializalo nunha cadea de parámetros de consulta de URL e, finalmente, imprímese a cadea.

Pódese comprobar que o uso querystringdo módulo pode analizar e serializar facilmente os parámetros de consulta de URL, reducindo o engorroso procesamento das cadeas e mellorando a lexibilidade e mantebilidade do código.

función estática

escape

urlCodificación de seguranza da cadea parcial

1
static String querystring.escape(String str);

Parámetros de chamada:

• str: Cadena, para codificarurl

Resultados de devolución:

• String, devolve a cadea codificada

---

unescape

urlDecodificación segura de cadeas

1
static String querystring.unescape(String str);

Parámetros de chamada:

• str: Cadena, para decodificarurl

Resultados de devolución:

• String, devolve a cadea descodificada

---

parse

Analizar a cadea de consulta

1
2
3
4
static HttpCollection querystring.parse(String str,
    String sep = "&",
    String eq = "=",
    Object opt = {});

Parámetros de chamada:

• str: String, a cadea que se vai analizar
• sep: String, a cadea dividida utilizada durante a análise, o valor predeterminado é &
• eq: String, a cadea de asignación utilizada durante a análise, o valor predeterminado é =
• opt: Obxecto, parámetros de análise, aínda non compatible

Resultados de devolución:

• HttpCollection, devolve o obxecto descodificado

---

stringify

Serializar un obxecto nunha cadea de consulta

1
2
3
4
static String querystring.stringify(Object obj,
    String sep = "&",
    String eq = "=",
    Object opt = {});

Parámetros de chamada:

• obj: Obxecto, o obxecto a serializar
• sep: String, a cadea dividida utilizada durante a serialización, o valor predeterminado é &
• eq: String, a cadea de asignación utilizada durante a serialización, o valor predeterminado é =
• opt: Obxecto, parámetros de análise, aínda non compatible

Resultados de devolución:

• String, devolve a cadea serializada