qs.stringify()、qs.parse()的使用

一、qs是什么？

qs是一个npm仓库所管理的包,可通过npm install qs命令进行安装
安装axios后自带qs可直接使用

import qs from "qs";

二、基本用法

2.1. qs.stringify()

将对象序列化成URL的形式，以&进行拼接

const obj = {
  method: "query_sql_dataset_data",
  projectId: "85",
  appToken: "7d22e38e-5717-11e7-907b-a6006ad3dba0",
};

console.log(qs.stringify(obj));

//打印出来的结果是：
method=query_sql_dataset_data&projectId=85&appToken=7d22e38e-5717-11e7-907b-a6006ad3dba0

2.2. qs.parse()

将URL解析成对象的形式

import qs from "qs";
let url =
  "method=query_sql_dataset_data&projectId=85&appToken=7d22e38e-5717-11e7-907b-a6006ad3dba0";
console.log(qs.parse(url));
//打印出来的结果是：
{
  method: "query_sql_dataset_data",
  projectId: "85",
  appToken: "7d22e38e-5717-11e7-907b-a6006ad3dba0",
};

三、指定数组编码格式

当对象的属性值为数组时，如：{ a: ['b', 'c', 'd'] }，序列化结果如下：

• 默认情况下

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

一般后端不需要这样的结构，而是这样的

'a=b&a=c&a=d'

3.1. 如何设置编码格式

• indices设置为false(常用)

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

• arrayFormat 选项进行格式化输出

// indices（默认）
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重写axios的paramsSerializer方法

config.paramsSerializer方法是axios用于序列化get请求的params参数对象，默认是indices序列化，如qs.stringify({ a: ['b', 'c', 'd'] });，序列化结果为 'a[0]=b&a[1]=c'，但是后端一般需要这样的格式'a=b&a=c&a=d'，所以我们要对paramsSerializer方法重写

// HTTPrequest拦截
axios.interceptors.request.use(
  (config) => {
    if (config.method === "get" && config.params) {
      // 重写axios默认的paramsSerializer方法
      config.paramsSerializer = function (params) {
        return qs.stringify(params, { arrayFormat: "repeat" });
      };
    }

    return config;
  },
  (error) => {
    return Promise.reject(error);
  }
);