QueryString参数处理小利器

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 查询字符串。

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

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']
}

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

eg

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

3. querystring.escape(str)

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

eg

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 进行解码。(反转义)

eg

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() 方法来解码。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容