URLSearchParams：JavaScript中的URL查询参数处理工具

在过去，处理URL查询参数是一项相对繁琐的任务。开发人员需要手动解析URL，提取查询字符串部分，并对其进行分割和解码。这个过程涉及到很多繁琐的字符串操作和编码解码步骤，容易出错且代码冗长。为了简化这一过程，ECMAScript 2015（ES6）引入了URLSearchParams API。
URLSearchParams是一个强大而实用的工具，可以简化处理URL查询参数的过程。通过URLSearchParams，我们可以轻松地解析、访问、操作和生成URL查询参数，而无需手动进行繁琐的字符串操作和编码解码。它提供了一系列的方法和属性，使得处理URL参数变得更加简单和高效。

URLSearchParams的作用

URLSearchParams的主要作用是对URL中的查询参数进行解析、访问和操作。它提供了一系列的方法，可以方便地执行以下操作：

• 解析URL查询参数：URLSearchParams可以接收一个URL查询字符串作为输入，并将其解析为一个可操作的对象。它自动处理编码和解码，将查询参数解析为键值对的形式，方便后续的操作。
• 访问查询参数：通过URLSearchParams提供的方法，可以轻松地访问和获取URL中的查询参数。开发人员可以根据参数名称获取对应的值，或者获取所有参数的迭代器，实现灵活的参数访问。
• 添加和修改查询参数：URLSearchParams允许开发人员动态地添加、修改或删除URL中的查询参数。它提供了一组方法，如append()、set()和delete()，使得对查询参数的修改变得简单明了。
• 生成查询参数：URLSearchParams不仅可以解析查询参数，还可以将其转换回URL查询字符串的形式。它提供了toString()方法，可以将当前的查询参数对象序列化为标准的URL查询字符串，方便用于URL构建或发送请求等场景。

URLSearchParams的方法和属性

URLSearchParams提供了一系列方法和属性，用于解析、访问和操作URL中的查询参数。

get(name)

根据参数名称获取对应的值。

const params = new URLSearchParams('?name=John&age=30');
const name = params.get('name');
console.log(name); // 输出：John

getAll(name)

根据参数名称获取对应的值数组。

const params = new URLSearchParams('?name=John&age=30&name=Alice');
const names = params.getAll('name');
console.log(names); // 输出：['John', 'Alice']

has(name)

判断是否存在指定名称的参数。

const params = new URLSearchParams('?name=John&age=30');
console.log(params.has('name')); // 输出：true
console.log(params.has('gender')); // 输出：false

append(name, value)

向URL中添加新的参数。

const params = new URLSearchParams('?name=John');
params.append('age', '30');
console.log(params.toString()); // 输出：'name=John&age=30'

set(name, value)

设置指定参数的值，如果参数不存在则添加新参数。

const params = new URLSearchParams('?name=John');
params.set('name', 'Alice');
params.set('age', '30');
console.log(params.toString()); // 输出：'name=Alice&age=30'

delete(name)

删除指定名称的参数。

const params = new URLSearchParams('?name=John&age=30');
params.delete('age');
console.log(params.toString()); // 输出：'name=John'

keys()

返回一个迭代器，用于遍历所有参数的名称。

const params = new URLSearchParams('?name=John&age=30');
for (const key of params.keys()) {
  console.log(key); // 输出：'name', 'age'
}

values()

返回一个迭代器，用于遍历所有参数的值。

const params = new URLSearchParams('?name=John&age=30');
for (const value of params.values()) {
  console.log(value); // 输出：'John', '30'
}

entries()

返回一个迭代器，用于遍历所有参数的键值对。

const params = new URLSearchParams('?name=John&age=30');
for (const [key, value] of params.entries()) {
  console.log(`${key}: ${value}`); // 输出：'name: John', 'age: 30'
}

toString()

将URLSearchParams对象转换为字符串表示形式。

const params = new URLSearchParams('?name=John&age=30');
const paramString = params.toString();
console.log(paramString); // 输出：'name=John&age=30'

使用示例

获取和解析URL参数

在Web开发中，经常需要获取URL中的参数值进行后续处理。

假设当前URL为：http://test.com/?name=John&age=25&gender=male。

// 创建URLSearchParams对象
const params = new URLSearchParams(window.location.search);

// 获取参数值
const name = params.get('name'); // "John"
const age = params.get('age'); // "25"
const gender = params.get('gender'); // "male"

// 输出参数值
console.log(`Name: ${name}`);
console.log(`Age: ${age}`);
console.log(`Gender: ${gender}`);

在上述示例中，通过window.location.search获取当前URL的查询参数部分，并使用URLSearchParams对象解析该参数。通过调用get()方法，可以根据参数名获取对应的值。

构建和更新URL参数

URLSearchParams提供了方便的方法来构建和更新URL参数。

// 创建URLSearchParams对象
const params = new URLSearchParams();

// 设置参数
params.set('name', 'John');
params.set('age', '25');

// 追加参数
params.append('gender', 'male');
params.append('hobby', 'reading');

// 获取参数字符串
const queryString = params.toString(); // "name=John&age=25&gender=male&hobby=reading"

// 构建URL
const url = `http://test.com/?${queryString}`;

在上述示例中，我们首先创建了一个空的URLSearchParams对象。然后，使用set()方法设置参数的键值对，使用append()方法追加参数。最后，通过toString()方法获取参数的字符串表示。我们可以将这个参数字符串与基本的URL拼接起来，从而构建出包含参数的完整URL。这种方式可以用于生成带有特定参数的URL，方便在页面之间进行导航和数据传递。

URL有#

链接：http://192.168.32.135:9020/#/authentication/Login?toekn=ceshi。

通过 window.location.search 获取到的参数为空""。因为hash会将url中第一个#后的内容都作为hash内容，所以search为空。

可通过window.location.hash.split("?")[1]获取。

// 接收参数 hash 模式
let queryString = window.location.hash.split('?')[1]; // 获取问号后面的查询字符串
let params = new URLSearchParams(queryString); // 转换为 URLSearchParams 对象
params.get('token'); // 'ceshi'

注意事项

在使用URLSearchParams时，有几个注意事项需要我们注意：

• 浏览器兼容性：URLSearchParams是一个相对较新的Web API，在旧版本的浏览器中可能不被支持。在使用URLSearchParams之前，要确保目标浏览器的兼容性。如果需要在旧版浏览器中使用，可以考虑使用替代方案。
• URL参数格式：URLSearchParams期望的URL参数格式是key=value，多个参数之间使用&分隔。在使用URLSearchParams之前，要确保URL参数的格式是正确的，否则可能导致解析错误或获取参数值失败。
• 参数值编码：URLSearchParams会自动对参数值进行编码，以确保URL的正确性和安全性。但在某些情况下，如果参数值已经被编码，使用URLSearchParams可能会导致重复编码或编码错误的问题。在这种情况下，我们可以手动对参数值进行编码或解码，以避免问题的发生。