Node.js querystring

Query String

稳定性:2 - Stable

querystring模块是node.js解析和格式化URL查询字符串的工具。在node.js中,querystring代表查询字符串,说白了就是HTTP GET方法请求服务器的查询参数,如果你还是不清楚这个概念,看了下图就明白了:

黄色的框内就是查询字符串

为什么要用Query String工具

首先要了解URI为什么要编码,可以参考这篇文章URI编码
下文用百分号编码代表URI编码

  • 使用安全的字符表示不安全的字符,如中文,某些特殊的字符等。这样的话不管是浏览器环境,或者服务器环境,传输的数据都是安全的,可以正确地使用,不会出现数据的丢失或显示错误的情况
  • 消除一些有歧义的字符,举个例子,你想通过一个参数data传输'&a=1&b=1&c=1'这几个字符,如果这样写
data=&a=1&b=1&c=1 // 服务器解析的时候实际是四个参数:data,a,b,c

但如果通过querystring处理,它就是下面这种情况

data=%26a%3D1%26b%3D1%26c%3D1  // 安全传输data

所以在处理查询参数的时候使用querystring是很有必要的,使用之前首先要引用它:

const querystring = require("querystring"); 
import querystring from "querystring";    //es6 也可以这样写,这两种方式都可以

querystring.escape(str)

  • str <String>
    这个方法跟JavaScript原生的方法encodeURIComponent得到的结果是一样的,根据规则将不安全的字符转化为百分号编码。
// 两个结果是一样的
encodeURIComponent('&a=1&b=1&c=1')
// returns '%26a%3D1%26b%3D1%26c%3D1'
querystring.escape('&a=1&b=1&c=1')
// returns '%26a%3D1%26b%3D1%26c%3D1'

但请注意,这个方法是querystring.stringify所使用的,不要直接调用哦!!

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

  • obj <Object> 把该对象序列化成URL的查询字符串
  • sep <String> 划分obj每个键值对的符号,默认是'&'
  • eq <String> 连接obj键和值的符号,默认是'='
  • options <Object>
    encodeURIComponent <function> 这个函数将不安全的字符转化为百分号编码,默认是querystring.escape()

一些例子:

querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' })    
// corge的值替换成null,undefined,NaN结果是一样的
// returns 'foo=bar&baz=qux&baz=quux&corge='

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

querystring.stringify({ data: '&a=1&b=1&c=1'})
// returns 'data=%26a%3D1%26b%3D1%26c%3D1'

以上的字符编码默认是UTF-8,如果想用其他的编码方式,可以这样写

// 假设gbkEncodeURIComponent方法已经存在

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

querystring.unescape(str)

  • str <String>
    该方法是将百分号编码解码,与querystring.escape()的作用正好是相反的。它默认使用的是JavaScript内置的方法decodeURIComponent(),如果失败,将使用更安全的等价值(格式正确的URLs)。同样,该函数是被querystring.parse所使用的,不要直接调用哦

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

  • str <String> 需要解析的URL查询字符串
  • sep <String> 划分键值对的符号,默认是'&'
  • eq <String> 划分键和值的符号,默认是'='
  • options <Object>
    decodeURIComponent <Function> 将百分号编码解码, 默认是querystring.unescape()
    maxKeys <number> 设置最大解析键值对的个数,默认是1000,如果是0则没有限制
querystring.parse('data=%26a%3D1%26b%3D1%26c%3D1&foo=bar&abc=xyz&abc=123')
// returns { data: '&a=1&b=1&c=1', foo: 'bar', abc: [ 'xyz', '123' ] }

querystring.parse('data=%26a%3D1%26b%3D1%26c%3D1&foo=bar&abc=xyz&abc=123', null, null, {maxKeys:2})
// returns { data: '&a=1&b=1&c=1', foo: 'bar' }

通过querystring.parse()返回的对象,不是JavaScript原型Object的扩展,所以原型Object一些相关的方法无法使用,如obj.toString()obj.hasOwnProperty()

querystring.parse('foo=bar&abc=xyz').toString()    // 报错
{a: 1, b: 2}.toString()    // 不会报错

同样,这个方法的字符编码也是UTF-8,如果想用其他的编码方式,可以参照下面的代码:

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

本文档是根据nodeJS目前稳定版本的文档Node.js v6.10.0 Documentation进行总结的,如您在阅读的过程中发现问题,请联系作者,最后感谢您的支持!

简书作者 小菜荔枝 转载请联系作者获得授权

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容