【JS】URLSearchParams 对象（以对象的形式上传参数到url）

一、基本用法

此功能某些浏览器尚在开发中，兼容性可能不是很好。

• URLSearchParams() 构造器：创建并返回一个新的URLSearchParams 对象。 开头的’?’ 字符会被忽略。
• 语法：

// init: 参数可选，为一个 USVString
var URLSearchParams = new URLSearchParams(init);

• 示例：

// 传入一个字符串字面值
var searchParams = new URLSearchParams('https://example.com?foo=1&bar=2');
console.log(searchParams.toString());	// foo=1&bar=2
// 查找字符串
console.log(searchParams.has('foo'));	// true
// 获取字符串对应的数据
console.log(searchParams.get('foo'));	// 1
// 设置字符串
searchParams.set('ttl','3');	// 1
console.log(searchParams.toString());	// foo=1&bar=2&ttl=3


// 传入一个 sequence
var params3 = new URLSearchParams([["foo", 1],["bar", 2]]);
console.log(params3.toString());	// foo=1&bar=2

// 传入一个 record
var params4 = new URLSearchParams({"foo" : 1 , "bar" : 2});
console.log(params4.toString());	// foo=1&bar=2

url的打印结果：

二、实例方法

方法	描述
append()	插入一个指定的键/值对作为新的搜索参数。
delete()	从搜索参数列表里删除指定的搜索参数及其对应的值。
entries()	返回一个iterator可以遍历所有键/值对的对象。
get()	获取指定搜索参数的第一个值。
getAll()	获取指定搜索参数的所有值，返回是一个数组。
has()	返回 Boolean 判断是否存在此搜索参数。
keys()	返回iterator 此对象包含了键/值对的所有键名。
set()	设置一个搜索参数的新值，假如原来有多个值将删除其他所有的值。
sort()	按键名排序。
toString()	返回搜索参数组成的字符串，可直接使用在 URL 上。
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"

三、实践运用

• 函数封装：

export function toSearch(record: Record<string, string>) {
  return new URLSearchParams(record).toString();
}

• 使用

// Button 按钮是adtd里面的，这里只展示局部代码
<Button
  type="link"
  href={`#/project/flowpage?${toSearch({
    id: 666,
    name: "liu",
  })}`}
  target="_blank"
>
  点击按钮
</Button>

• 效果：

// 前面域名指向当前网页的域名，这里暂用...省略
...#/project/flowpage?id=666&name="liu"