你不知道的Web Api —— URLSearchParams

What is it

官方解释： URLSearchParams 接口定义了一些实用的方法来处理 URL 的查询字符串。

怎么用？

一、获取浏览器地址栏参数

原来我们需要自己封装方法来获取，例如：

function getUrlParams() {
  let url = location.search; //获取url中"?"符后的字串
  let urlParams = {};
  if (url.indexOf("?") != -1) {
    let str = url.substr(1);
    strs = str.split("&");
    for (let i = 0; i < strs.length; i++) {
      urlParams[strs[i].split("=")[0]] = (strs[i].split("=")[1]);
    }
  }
  return urlParams ;
}

有了URLSearchParams就不需要了，简简单单：

let params = new URLSearchParams(location.search) // 自动解析成key:value格式对象
params.get(key)

二、处理axios参数

当我们用axios来进行数据请求时，总会遇到数据格式不一致的问题：

axios({
    method: 'post',
    url: '/test',
    data: {
        name: 'guaige',
        like: 'ao li gei'
    }
})

看着和ajax调用差不多，但数据格式是有很大的差别的：

区别原因：axios post方法默认使用application/json格式编码数据，那么解决方案就有两种，一是后台改变接收参数的方法，另一种则是将axios post方法的编码格式修改为application/x-www-form-urlencoded + transformRequest转换成formData的格式。

有了URLSearchParams就不需要这么繁琐了：

//直接转换成formData的格式
let params = new URLSearchParams();
params.append('name', 'guaige');
params.append('like', 'ao li gei');

axios({
    method: 'post',
    url: '/test',
    data: params
})

常用方法

1. URLSearchParams.append()
   插入一个指定的键/值对作为新的搜索参数。
2. URLSearchParams.delete()
   从搜索参数列表里删除指定的搜索参数及其对应的值。
3. URLSearchParams.entries()
   返回一个iterator可以遍历所有键/值对的对象。
4. URLSearchParams.get()
   获取指定搜索参数的第一个值。
5. URLSearchParams.getAll()
   获取指定搜索参数的所有值，返回是一个数组。
6. URLSearchParams.has()
   返回 Boolean 判断是否存在此搜索参数。
7. URLSearchParams.keys()
   返回iterator 此对象包含了键/值对的所有键名。
8. URLSearchParams.set()
   设置一个搜索参数的新值，假如原来有多个值将删除其他所有的值。
9. URLSearchParams.sort()
   按键名排序。
10. URLSearchParams.toString()
    返回搜索参数组成的字符串，可直接使用在URL上。
11. URLSearchParams.values()
    返回iterator 此对象包含了键/值对的所有值。

// 示例一
var paramsString = "q=URLUtils.searchParams&topic=api"
var searchParams = new URLSearchParams(paramsString);

for (let p of searchParams) {
 console.log(p);
}

searchParams.has("topic") === true; // true
searchParams.get("topic") === "api"; // true
searchParams.getAll("topic"); // ["api"]
searchParams.get("foo") === null; // true
searchParams.append("topic", "webdev");
searchParams.toString(); // "q=URLUtils.searchParams&topic=api&topic=webdev"
searchParams.set("topic", "More webdev");
searchParams.toString(); // "q=URLUtils.searchParams&topic=More+webdev"
searchParams.delete("topic");
searchParams.toString(); // "q=URLUtils.searchParams"


// 示例二
var paramsString1 = "http://example.com/search?query=%40";
var searchParams1 = new URLSearchParams(paramsString1);

searchParams1.has("query"); // false
searchParams1.has("http://example.com/search?query"); // true

searchParams1.get("query"); // null
searchParams1.get("http://example.com/search?query"); // "@" (equivalent to decodeURIComponent('%40'))

var paramsString2 = "?query=value";
var searchParams2 = new URLSearchParams(paramsString2);
searchParams2.has("query"); // true

var url = new URL("http://example.com/search?query=%40");
var searchParams3 = new URLSearchParams(url.search);
searchParams3.has("query") // true