npm qs模块使用详解


Posted in Javascript onFebruary 07, 2020

本文基本使用谷歌翻译加上自己的理解,权当加深记忆。

npm

简介

qs 是一个增加了一些安全性的查询字符串解析和序列化字符串的库。
主要维护者:Jordan Harband
最初创建者和维护者:TJ Holowaychuk

用法

var qs = require('qs');
var assert = require('assert');
 
var obj = qs.parse('a=c');
assert.deepEqual(obj, { a: 'c' });
 
var str = qs.stringify(obj);
assert.equal(str, 'a=c');

解析对象

qs.parse(string, [options]);

qs 允许在查询字符串中使用[]的方式创建嵌套的对象。例如,字符串'foo[bar]=baz'可以转换为:

assert.deepEqual(qs.parse('foo[bar]=baz'), {
    foo: {
      bar: 'baz'
    }
  });

When using the plainObjects option the parsed value is returned as a null object, created via Object.create(null) and as such you should be aware that prototype methods will not exist on it and a user may set those names to whatever value they like:

var nullObject = qs.parse('a[hasOwnProperty]=b', { plainObjects: true });
  assert.deepEqual(nullObject, { a: { hasOwnProperty: 'b' } });

By default parameters that would overwrite properties on the object prototype are ignored, if you wish to keep the data from those fields either use plainObjects as mentioned above, or set allowPrototypes to true which will allow user input to overwrite those properties. WARNING It is generally a bad idea to enable this option as it can cause problems when attempting to use the properties that have been overwritten. Always be careful with this option.

var protoObject = qs.parse('a[hasOwnProperty]=b', { allowPrototypes: true });
  assert.deepEqual(protoObject, { a: { hasOwnProperty: 'b' } });

也可以解析 URI 编码:

assert.deepEqual(qs.parse('a%5Bb%5D=c'), {
    a: { b: 'c' }
  });

还可以像这样嵌套对象:'foo[bar][baz]=foobarbaz':

assert.deepEqual(qs.parse('foo[bar][baz]=foobarbaz'), {
    foo: {
      bar: {
        baz: 'foobarbaz'
      }
    }
  });

当使用嵌套对象时,qs 在默认情况下最多解析到的深度是第五层(注:从第一个方括号到算起,到第五个方括号),例如尝试解析一个这样的字符串'a[b][c][d][e][f][g][h][i]=j'将会得到以下结果:

var expected = {
    a: {
      b: {
        c: {
          d: {
            e: {
              f: {
                '[g][h][i]': 'j'
              }
            }
          }
        }
      }
    }
  };
  var string = 'a[b][c][d][e][f][g][h][i]=j';
  assert.deepEqual(qs.parse(string), expected);

可以给 qs.parse 传递一个 depth 参数覆盖默认值:

var deep = qs.parse('a[b][c][d][e][f][g][h][i]=j', { depth: 1 });
assert.deepEqual(deep, { a: { b: { '[c][d][e][f][g][h][i]': 'j' } } });

当 qs 用于解析用户输入的时候,解析深度的限制有助于减轻用户的滥用行为。最好将 depth 设置为一个合理的尽量小的数字。

出于类似的原因,qs 在默认情况下最多解析 1000 个参数。通过传递 parameterLimit 参数可以修改默认值:

var limited = qs.parse('a=b&c=d', { parameterLimit: 1 });
  assert.deepEqual(limited, { a: 'b' });

忽略查询字符串开头的 ? 可以使用 ignoreQueryPrefix:

var prefixed = qs.parse('?a=b&c=d', { ignoreQueryPrefix: true });
  assert.deepEqual(prefixed, { a: 'b', c: 'd' });

还可以根据自定义的分隔符来解析 delimiter:

var delimited = qs.parse('a=b;c=d', { delimiter: ';' });
  assert.deepEqual(delimited, { a: 'b', c: 'd' });

分隔符可以是正则表达式:

var regexed = qs.parse('a=b;c=d,e=f', { delimiter: /[;,]/ });
  assert.deepEqual(regexed, { a: 'b', c: 'd', e: 'f' });

allowDots 选项可以启用点表示法:

var withDots = qs.parse('a.b=c', { allowDots: true });
  assert.deepEqual(withDots, { a: { b: 'c' } });

解析数组

qs 也可以用[]解析数组:

var withArray = qs.parse('a[]=b&a[]=c');
  assert.deepEqual(withArray, { a: ['b', 'c'] });

可以指定数组索引:

var withIndexes = qs.parse('a[1]=c&a[0]=b');
  assert.deepEqual(withIndexes, { a: ['b', 'c'] });

请注意,如果想要将字符串解析成数组而不是对象,那么[]之间的值必须是一个数字。 在创建具有特定索引的数组时,qs会将稀疏数组压缩为仅保留其顺序的现有值:

var noSparse = qs.parse('a[1]=b&a[15]=c');
  assert.deepEqual(noSparse, { a: ['b', 'c'] });

空字符串也是一个值,并将被保留:

var withEmptyString = qs.parse('a[]=&a[]=b');
  assert.deepEqual(withEmptyString, { a: ['', 'b'] });
  
  var withIndexedEmptyString = qs.parse('a[0]=b&a[1]=&a[2]=c');
  assert.deepEqual(withIndexedEmptyString, { a: ['b', '', 'c'] });

qs 还会限制数组最大索引为 20,任何索引大于20的数组成员都将被转换为以索引为键的对象:

var withMaxIndex = qs.parse('a[100]=b');
 assert.deepEqual(withMaxIndex, { a: { '100': 'b' } });

arrayLimit 选项可以修改默认限制:

var withArrayLimit = qs.parse('a[1]=b', { arrayLimit: 0 });
  assert.deepEqual(withArrayLimit, { a: { '1': 'b' } });

字符串不解析成数组,可以设置 parseArrays 为 false

var noParsingArrays = qs.parse('a[]=b', { parseArrays: false });
  assert.deepEqual(noParsingArrays, { a: { '0': 'b' } });

如果混合使用两种格式,qs 会将字符串解析为对象:

var mixedNotation = qs.parse('a[0]=b&a[b]=c');
  assert.deepEqual(mixedNotation, { a: { '0': 'b', b: 'c' } });

也可以创建元素为对象的数组:

var arraysOfObjects = qs.parse('a[][b]=c');
  assert.deepEqual(arraysOfObjects, { a: [{ b: 'c' }] });

序列化字符串

qs.stringify(object, [options]);

默认情况下,对象序列化后进行URI编码后输出:

assert.equal(qs.stringify({ a: 'b' }), 'a=b');
  assert.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');

通过设置 encode 为 false 禁止 URI 编码:

var unencoded = qs.stringify({ a: { b: 'c' } }, { encode: false });
  assert.equal(unencoded, 'a[b]=c');

通过设置 encodeValuesOnly 为 true,可以禁用对 key 进行URI 编码:

var encodedValues = qs.stringify(
    { a: 'b', c: ['d', 'e=f'], f: [['g'], ['h']] },
    { encodeValuesOnly: true }
  );
  assert.equal(encodedValues,'a=b&c[0]=d&c[1]=e%3Df&f[0][0]=g&f[1][0]=h');

可以通过设置encoder 选项自定义编码方式(注意:当 encode 被设置为 false 的时候,不适用):

var encoded = qs.stringify({ a: { b: 'c' } }, { encoder: function (str) {
   // Passed in values `a`, `b`, `c`
   return // Return encoded string
 }})

与encoder 类似 decoder 可以用来解码:

var decoded = qs.parse('x=z', { decoder: function (str) {
    // Passed in values `x`, `z`
    return // Return decoded string
  }})

Examples beyond this point will be shown as though the output is not URI encoded for clarity. Please note that the return values in these cases will be URI encoded during real usage.

当数组被序列化时,默认显示索引:

qs.stringify({ a: ['b', 'c', 'd'] });
  // 'a[0]=b&a[1]=c&a[2]=d'

 可以通过设置 indices 为 false 不显示索引:

qs.stringify({ a: ['b', 'c', 'd'] }, { indices: false });
  // 'a=b&a=c&a=d'

可以通过设置 arrayFormat 选项指定数组输出格式:

qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'indices' })
  // 'a[0]=b&a[1]=c'
  qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'brackets' })
  // 'a[]=b&a[]=c'
  qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'repeat' })
  // 'a=b&a=c'

对象序列化时,默认使用 [] 表示法:

qs.stringify({ a: { b: { c: 'd', e: 'f' } } });
  // 'a[b][c]=d&a[b][e]=f'

通过设置 allowDots 为 true修改为点表示法:

qs.stringify({ a: { b: { c: 'd', e: 'f' } } }, { allowDots: true });
  // 'a.b.c=d&a.b.e=f'

空字符串和null值将被省略,但是=会保留:

assert.equal(qs.stringify({ a: '' }), 'a=');

没有值的键将什么也不返回(例如空对象或数组):

assert.equal(qs.stringify({ a: [] }), '');
  assert.equal(qs.stringify({ a: {} }), '');
  assert.equal(qs.stringify({ a: [{}] }), '');
  assert.equal(qs.stringify({ a: { b: []} }), '');
  assert.equal(qs.stringify({ a: { b: {}} }), '');

值为 undefined 的属性将会被完全忽略:

assert.equal(qs.stringify({ a: null, b: undefined }), 'a=');

addQueryPrefix 设置为 true可以在查询字符串前面加 ?:

assert.equal(qs.stringify({ a: 'b', c: 'd' }, { addQueryPrefix: true }), '?a=b&c=d');

分隔符也可以设置:

assert.equal(qs.stringify({ a: 'b', c: 'd' }, { delimiter: ';' }), 'a=b;c=d');

如果只是序列化日期对象,可以使用 serializeDate 选项:

var date = new Date(7);
  assert.equal(qs.stringify({ a: date }), 'a=1970-01-01T00:00:00.007Z'.replace(/:/g, '%3A'));
  assert.equal(
    qs.stringify({ a: date }, { serializeDate: function (d) { return d.getTime(); } }),
    'a=7'
  );

可以使用 sort 选项来修改键的顺序:

function alphabeticalSort(a, b) {
    return a.localeCompare(b);
  }
  assert.equal(qs.stringify({ a: 'c', z: 'y', b : 'f' }, { sort: alphabeticalSort }), 'a=c&b=f&z=y');

最后,可以使用 filter 选项过滤序列化输出的键。如果给filter传递一个函数,每个键调用一次该函数并用返回的值替换原来值。如果给filter传递一个数组,它将用于选择对象的key和数组的索引:

function filterFunc(prefix, value) {
    if (prefix == 'b') {
      // Return an `undefined` value to omit a property.
      return;
    }
    if (prefix == 'e[f]') {
      return value.getTime();
    }
    if (prefix == 'e[g][0]') {
      return value * 2;
    }
    return value;
  }
  qs.stringify({ a: 'b', c: 'd', e: { f: new Date(123), g: [2] } }, { filter: filterFunc });
  // 'a=b&c=d&e[f]=123&e[g][0]=4'
  qs.stringify({ a: 'b', c: 'd', e: 'f' }, { filter: ['a', 'e'] });
  // 'a=b&e=f'
  qs.stringify({ a: ['b', 'c', 'd'], e: 'f' }, { filter: ['a', 0, 2] });
  // 'a[0]=b&a[2]=d'

处理 null 值

默认情况下,null 值被视为空对象:

var withNull = qs.stringify({ a: null, b: '' });
 assert.equal(withNull, 'a=&b=');

解析字符串的时候并不会区分参数有没有等号,没有值的话都会解析为空字符串:

var equalsInsensitive = qs.parse('a&b=');
  assert.deepEqual(equalsInsensitive, { a: '', b: '' });

要想区分空字符串和null值可以使用 strictNullHandling 选项,序列化后的 null 值没有=

var strictNull = qs.stringify({ a: null, b: '' }, { strictNullHandling: true });
  assert.equal(strictNull, 'a&b=');

要解析不带 = 的值返回 null可以使用 strictNullHandling 选项:

var parsedStrictNull = qs.parse('a&b=', { strictNullHandling: true });
  assert.deepEqual(parsedStrictNull, { a: null, b: '' });

想要完全跳过值为 null 的键不解析,可以使用 skipNulls 选项:

var nullsSkipped = qs.stringify({ a: 'b', c: null}, { skipNulls: true });
  assert.equal(nullsSkipped, 'a=b');

处理特殊字符集:

默认情况下,字符的编码和解码在utf-8中完成。 如果希望将查询字符串编码为不同的字符集(i.e.Shift JIS),您可以使用qs-iconv库:

var encoder = require('qs-iconv/encoder')('shift_jis');
  var shiftJISEncoded = qs.stringify({ a: 'こんにちは!' }, { encoder: encoder });
  assert.equal(shiftJISEncoded, 'a=%82%B1%82%F1%82%C9%82%BF%82%CD%81I');

这也适用于解码查询字符串:

var decoder = require('qs-iconv/decoder')('shift_jis');
  var obj = qs.parse('a=%82%B1%82%F1%82%C9%82%BF%82%CD%81I', { decoder: decoder });
  assert.deepEqual(obj, { a: 'こんにちは!' });

RFC 3986 and RFC 1738 space encoding

RFC3986 used as default option and encodes ' ' to %20 which is backward compatible. In the same time, output can be stringified as per RFC1738 with ' ' equal to ‘+'.

  

assert.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');
 assert.equal(qs.stringify({ a: 'b c' }, { format : 'RFC3986' }), 'a=b%20c');
 assert.equal(qs.stringify({ a: 'b c' }, { format : 'RFC1738' }), 'a=b+c');

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
一个封装js代码-----展开收起效果示例
Jul 03 Javascript
使用控制台破解百小度一个月只准改一次名字
Aug 13 Javascript
js实现完美兼容各大浏览器的人民币大小写相互转换
Oct 29 Javascript
prototype.js常用函数详解
Jun 18 Javascript
纯js和css完成贪吃蛇小游戏demo
Sep 01 Javascript
微信 java 实现js-sdk 图片上传下载完整流程
Oct 21 Javascript
JavaScript切换搜索引擎的导航网页搜索框实例代码
Jun 11 Javascript
Angular 4根据组件名称动态创建出组件的方法教程
Nov 01 Javascript
javascript、php关键字搜索函数的使用方法
May 29 Javascript
解决angularjs service中依赖注入$scope报错的问题
Oct 02 Javascript
vue实现的网易云音乐在线播放和下载功能案例
Feb 18 Javascript
javascript 数组(list)添加/删除的实现
Dec 17 Javascript
Js参数RSA加密传输之jsencrypt.js的使用
Feb 07 #Javascript
Vue使用JSEncrypt实现rsa加密及挂载方法
Feb 07 #Javascript
jQuery实现获取多选框的值示例
Feb 07 #jQuery
微信小程序canvas开发水果老虎机的思路详解
Feb 07 #Javascript
Node.js 在本地生成日志文件的方法
Feb 07 #Javascript
node.js 微信开发之定时获取access_token
Feb 07 #Javascript
jQuery操作选中select下拉框的值代码实例
Feb 07 #jQuery
You might like
php提示undefined index的几种解决方法
2012/05/21 PHP
深入解析PHP的引用计数机制
2013/06/14 PHP
CI框架Session.php源码分析
2014/11/03 PHP
thinkphp5+layui实现的分页样式示例
2019/10/08 PHP
javascript 写类方式之四
2009/07/05 Javascript
javascript 最常用的10个自定义函数[推荐]
2009/12/26 Javascript
JavaScript实现页面滚动图片加载(仿lazyload效果)
2011/07/22 Javascript
jQuery contains过滤器实现精确匹配使用方法
2013/04/12 Javascript
Extjs实现进度条的两种便捷方式
2013/09/26 Javascript
基于JS实现checkbox全选功能实例代码
2016/10/31 Javascript
js Canvas实现的日历时钟案例分享
2016/12/25 Javascript
Nodejs 复制文件/文件夹的方法
2017/08/24 NodeJs
原生js中ajax访问的实例详解
2017/09/19 Javascript
JavaScript判断输入是否为数字类型的方法总结
2017/09/28 Javascript
webpack下实现动态引入文件方法
2018/02/22 Javascript
vue单个组件实现无限层级多选菜单功能
2018/04/10 Javascript
LayUi中接口传数据成功,表格不显示数据的解决方法
2018/08/19 Javascript
vue router 跳转后回到顶部的实例
2018/08/31 Javascript
webpack4实现不同的导出类型
2019/04/09 Javascript
JS函数基本定义与用法示例
2020/01/15 Javascript
[48:20]OpTic vs Serenity 2018国际邀请赛小组赛BO2 第二场 8.18
2018/08/19 DOTA
Python的Django应用程序解决AJAX跨域访问问题的方法
2016/05/31 Python
python使用matplotlib库生成随机漫步图
2018/08/27 Python
用Django写天气预报查询网站
2018/10/21 Python
python 将列表中的字符串连接成一个长路径的方法
2018/10/23 Python
Django ManyToManyField 跨越中间表查询的方法
2018/12/18 Python
解决Django后台ManyToManyField显示成Object的问题
2019/08/09 Python
python基于socket实现的UDP及TCP通讯功能示例
2019/11/01 Python
Django与pyecharts结合的实例代码
2020/05/13 Python
Schecker荷兰:狗狗用品和配件
2019/06/06 全球购物
护士专业推荐信
2013/11/02 职场文书
教师自查自纠工作情况报告
2014/10/29 职场文书
2016年班主任新年寄语
2015/08/18 职场文书
终止合同协议书范本
2016/03/22 职场文书
2016年学生会感恩节活动总结
2016/04/01 职场文书
CSS 鼠标选中文字后改变背景色的实现代码
2023/05/21 HTML / CSS