QueryString参数处理小利器

2018-12-26 本文已影响0人饥人谷_流水

querystring（查询字符串）

querystring 模块用于解析与格式化 URL 的查询字符串。使用方法如下：

const querystring = require('querystring');

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

obj <Object> 要序列化成 URL 查询字符串的对象。
sep <string> 用于界定查询字符串中的键值对的子字符串。默认为 '&'。
eq <string> 用于界定查询字符串中的键与值的子字符串。默认为 '='。
options
- encodeURIComponent <Function> 把对象中的字符转换成查询字符串时使用的函数。默认为 querystring.escape()。

该方法通过遍历给定的 obj 对象的自身属性，生成 URL 查询字符串。

例子：

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

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

str <string> 要解析的 URL 查询字符串。
sep <string> 用于界定查询字符串中的键值对的子字符串。默认为 '&'。
eq <string> 用于界定查询字符串中的键与值的子字符串。默认为 '='。
options <Object>
- decodeURIComponent <Function> 解码查询字符串的字符时使用的函数。默认为 querystring.unescape()。
- maxKeys <number> 指定要解析的键的最大数量。指定为 0 则不限制。默认为 1000。

该方法会把一个 URL 查询字符串 str 解析成一个键值对的集合。

例子，查询字符串 'foo=bar&abc=xyz&abc=123' 被解析成：

querystring.parse('foo=bar&abc=xyz&abc=123')
输出
{
  foo: 'bar',
  abc: ['xyz', '123']
}

但是当字符串中的界定字符串的子字符串不是默认的‘=’和‘&’
时必须传递相对应的参数

querystring.parse('foo:bar,abc:xyz,abc:123',',',':')
输出
{
  foo: 'bar',
  abc: ['xyz', '123']
}

3. querystring.escape(str)

str <string>

对给定的 str 进行 URL 编码(转义)。

querystring.escape('<改革春风吹满地>')
输出
%3C%E6%94%B9%E9%9D%A9%E6%98%A5%E9%A3%8E%E5%90%B9%E6%BB%A1%E5%9C%B0%3E

该方法是提供给 querystring.stringify() 使用的，通常不直接使用。它之所以对外开放，是为了在需要时可以通过给 querystring.escape 赋值一个函数来重写编码的实现。

该方法返回的对象不继承自 JavaScript 的 Object 类。这意味着 Object 类的方法如 obj.toString()、obj.hasOwnProperty() 等没有被定义且无法使用。

默认情况下，查询字符串中的字符会被视为使用 UTF-8 编码。如果使用的是其他字符编码，则需要指定 decodeURIComponent 选项，例如：

// 假设存在 gbkDecodeURIComponent 函数。
querystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,
                  { decodeURIComponent: gbkDecodeURIComponent });

4. querystring.unescape(str)

str <string>

对给定的 str 进行解码。（反转义）

querystring.escape('<中国人民真争气>')
输出
%3C%E4%B8%AD%E5%9B%BD%E4%BA%BA%E6%B0%91%E7%9C%9F%E4%BA%89%E6%B0%94%3E

该方法是提供给 querystring.parse() 使用的，通常不直接使用。它之所以对外开放，是为了在需要时可以通过给 querystring.unescape 赋值一个函数来重写解码的实现。

默认使用 JavaScript 内置的 decodeURIComponent() 方法来解码。