querystring模块
querystring查询字符串
- querystring.escape(str)
- [querystring.parse(str[, sep, eq[, options]])
- [querystring.stringify(obj[, sep, eq[, options]])
- querystring.unescape(str)
querystring.escape(str)
该方法是提供给querystring.stringify()使用的,通常不直接使用,之所以对外开放,是为了在需要时可以通过querystring.escape赋值一个函数来重写编程的实现
querystring.parse(str[, sep[, eq[, options]]])
-
str
要解析的URL查询字符串 -
sep
用于界定查询字符串中的键值对的子字符串。默认为'&'
-
eq
用于界定查询字符串中的键与值的子字符串。默认为'='
。 -
options
-
decodeURIComponent
解码查询字符串的字符时使用的函数。默认为querystring.unescape()
-
maxKeys
指定要解析的键的最大数量。指定为0
则不限制。默认为1000
。
-
该方法会把一个url查询字符串str解析成一个键值对的集合
var foo=bar&abc=xyz&abc=123
querystring.parse(foo)
//输出结果
/*
{
foo: 'bar',
abc: ['xyz', '123']
}
*/
注意:
该方法返回的对象不继承自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
要序列化成 URL 查询字符串的对象 -
sep
用于界定查询字符串中的键值对的子字符串。默认为'&'
。 -
eq
用于界定查询字符串中的键与值的子字符串。默认为'='
。 -
options
-
encodeURIComponent
把对象中的字符转换成查询字符串时使用的函数。默认为querystring.escape()
。该方法通过遍历给定的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
对给定的str进行解码
该方法是提供给
querystring.parse()
使用的,通常不直接使用。 它之所以对外开放,是为了在需要时可以通过给querystring.unescape
赋值一个函数来重写解码的实现。默认使用 JavaScript 内置的
decodeURIComponent()
方法来解码。