目录

• querystring（查询字符串）
  • querystring.decode()
  • querystring.encode()
  • querystring.escape(str)
  • querystring.parse(str[, sep[, eq[, options]]])
  • querystring.stringify(obj[, sep[, eq[, options]]])
  • querystring.unescape(str)

querystring（查询字符串）#

源代码: lib/querystring.js

querystring 模块提供用于解析和格式化 URL 查询字符串的实用工具。 可以使用以下方式访问它：

const querystring = require('querystring');

querystring.decode()#

querystring.decode() 函数是 querystring.parse() 的别名。

querystring.encode()#

querystring.encode() 函数是 querystring.stringify() 的别名。

querystring.escape(str)#

• str <string>

querystring.escape() 方法以对 URL 查询字符串的特定要求进行了优化的方式对给定的 str 执行 URL 百分比编码。

querystring.escape() 方法由 querystring.stringify() 使用，通常不会被直接地使用。 它的导出主要是为了允许应用程序代码在需要时通过将 querystring.escape 赋值给替代函数来提供替换的百分比编码实现。

querystring.parse(str[, sep[, eq[, options]]])#

• str <string> 要解析的 URL 查询字符串。
• sep <string> 用于在查询字符串中分隔键值对的子字符串。默认值: '&'。
• eq <string> 用于在查询字符串中分隔键和值的子字符串。默认值: '='。
• options <Object>
  • decodeURIComponent <Function> 当解码查询字符串中的百分比编码字符时使用的函数。默认值: querystring.unescape()。
  • maxKeys <number> 指定要解析的键的最大数量。指定 0 可移除键的计数限制。默认值: 1000。

querystring.parse() 方法将 URL 查询字符串 str 解析为键值对的集合。

例如，查询字符串 'foo=bar&abc=xyz&abc=123' 会被解析为：

{
  foo: 'bar',
  abc: ['xyz', '123']
}

querystring.parse() 方法返回的对象不是原型地继承自 JavaScript 的 Object。 这意味着典型的 Object 方法如 obj.toString()、 obj.hasOwnProperty() 等都没有被定义并且不起作用。

默认情况下，会假定查询字符串中的百分比编码字符使用 UTF-8 编码。 如果使用其他的字符编码，则需要指定其他的 decodeURIComponent 选项：

// 假设 gbkDecodeURIComponent 函数已存在。

querystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,
                  { decodeURIComponent: gbkDecodeURIComponent });

querystring.stringify(obj[, sep[, eq[, options]]])#

• obj <Object> 要序列化为 URL 查询字符串的对象。
• sep <string> 用于在查询字符串中分隔键值对的子字符串。默认值: '&'。
• eq <string> 用于在查询字符串中分隔键和值的子字符串。默认值: '='。
• options
  • encodeURIComponent <Function> 当将查询字符串中不安全的 URL 字符转换为百分比编码时使用的函数。默认值: querystring.escape()。

querystring.stringify() 方法通过遍历对象的自身属性从给定的 obj 生成 URL 查询字符串。

它会序列化传入的 obj 中以下类型的值：<string> | <number> | <boolean> | <string[]> | <number[]> | <boolean[]>。 任何其他的输入值都将会被强制转换为空字符串。

querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' });
// 返回 'foo=bar&baz=qux&baz=quux&corge='

querystring.stringify({ foo: 'bar', baz: 'qux' }, ';', ':');
// 返回 'foo:bar;baz:qux'

默认情况下，查询字符串中需要进行百分比编码的字符将会被编码为 UTF-8。 如果需要其他的编码，则需要指定其他的 encodeURIComponent 选项：

// 假设 gbkEncodeURIComponent 函数已存在。

querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
                      { encodeURIComponent: gbkEncodeURIComponent });

querystring.unescape(str)#

• str <string>

querystring.unescape() 方法在给定的 str 上执行 URL 百分比编码字符的解码。

querystring.unescape() 方法由 querystring.parse() 使用，通常不会被直接地使用。 它的导出主要是为了允许应用程序代码在需要时通过将 querystring.unescape 赋值给替代函数来提供替换的解码实现。

默认情况下， querystring.unescape() 方法将会尝试使用 JavaScript 内置的 decodeURIComponent() 方法进行解码。 如果失败，则将会使用更保险的不会因格式错误的 URL 而抛出异常的同类方法。