qs.js - 更好的處理url參數

第一次接觸 qs 這個庫，是在使用axios時，用於給post方法編碼，在使用過程當中，接觸到了一些不一樣的用法，寫在這裏分享一下。

qs.parse

qs.parse 方法能夠把一段格式化的字符串轉換爲對象格式，好比

let url = 'http://item.taobao.com/item.htm?a=1&b=2&c=&d=xxx&e';
let data = qs.parse(url.split('?')[1]);

// data的結果是
{
    a: 1, 
    b: 2, 
    c: '', 
    d: xxx, 
    e: ''
}

qs.stringify

基本用法

qs.stringify 則和 qs.parse 相反，是把一個參數對象格式化爲一個字符串。

let params = { c: 'b', a: 'd' };
qs.stringify(params)

// 結果是
'c=b&a=d'

排序

甚至能夠對格式化後的參數進行排序：

qs.stringify(params, (a,b) => a.localeCompare(b))

// 結果是
'a=b&c=d'

指定數組編碼格式

let params = [1, 2, 3];

// indices(默認)
qs.stringify({a: params}, {
    arrayFormat: 'indices'
})
// 結果是
'a[0]=1&a[1]=2&a[2]=3'

// brackets 
qs.stringify({a: params}, {
    arrayFormat: 'brackets'
})
// 結果是
'a[]=1&a[]=2&a[]=3'

// repeat
qs.stringify({a: params}, {
    arrayFormat: 'repeat'
})
// 結果是
'a=1&a=2&a=3'

處理json格式的參數

在默認狀況下，json格式的參數會用 [] 方式編碼，

let json = { a: { b: { c: 'd', e: 'f' } } };

qs.stringify(json);
//結果 'a[b][c]=d&a[b][e]=f'

可是某些服務端框架，並不能很好的處理這種格式，因此須要轉爲下面的格式

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