querystring模块
以下内容来自Node.js中文网。
querystring 模块提供用于解析和格式化 URL 查询字符串的实用工具。 它可以使用以下方式访问:
const querystring = require('querystring');
querystring.escape(str)
- str
querystring.escape()
方法可以对 URL 查询字符串的特定要求进行了优化的方式对给定的 str
执行 URL 百分比编码。
querystring.escape()
方法由 querystring.stringify()
使用,通常不会直接使用。 它的导出主要是为了允许应用程序代码在必要时通过将 querystring.escape
指定给替代函数来提供替换的百分比编码实现。
querystring.parse(str[, sep[, eq[, options]]])
str
要解析的 URL 查询字符串。 sep
用于在查询字符串中分隔键值对的子字符串。默认值: '&'
。eq
用于在查询字符串中分隔键和值的子字符串。默认值: '='
。-
options
-
decodeURIComponent
解码查询字符串中的百分比编码字符时使用的函数。默认值: querystring.unescape()
。 -
maxKeys
指定要解析的键的最大数量。指定 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
sep
用于在查询字符串中分隔键值对的子字符串。默认值: '&'
。eq
用于在查询字符串中分隔键和值的子字符串。默认值: '='
。-
options
-
encodeURIComponent
在查询字符串中将 URL 不安全字符转换为百分比编码时使用的函数。默认值: querystring.escape()
。
-
querystring.stringify()
方法通过迭代对象的自身属性从给定的 obj
生成 URL 查询字符串。
它序列化了传入 obj
中的以下类型的值:
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
querystring.unescape()
方法在给定的str
上执行 URL 百分比编码字符的解码。
querystring.unescape()
方法由 querystring.parse()
使用,通常不会直接使用它。 它的导出主要是为了允许应用程序代码在必要时通过将 querystring.unescape
分配给替代函数来提供替换的解码实现。
默认情况下, querystring.unescape()
方法将尝试使用 JavaScript 内置的 decodeURIComponent()
方法进行解码。 如果失败,将使用更安全的不会丢失格式错误的 URL 的等价方法。