JS URL()和URLSearchParams() API接口详细介绍

这篇文章发布于 2019年08月26日,星期一,00:13,归类于 JS API。 阅读 6898 次, 今日 4 次 18 条评论

 

网络 URL 占位图

一、先快速了解这两个API干嘛用的

以前我们要对地址栏中的URL地址进行分析处理,需要自己进行字符串分析,例如:

https://www.zhangxinxu.com/wordpress/?s=url

我们想要知道s参数后面的值是什么,往往需要进行字符切割匹配,要么正则匹配。

实际上,现在,浏览器已经有了内置的API接口可以对URL进行处理,这个API就是URLSearchParams()以及URL()

例如获取s的查询参数值,可以直接下面这样:

new URL('https://www.zhangxinxu.com/wordpress/?s=url').searchParams.get('s');

或者:

new URLSearchParams('?s=url').get('s');

二、先来了解下URLSearchParams()语法

语法

// URL查询字符串
var myUrlSearchParams = new URLSearchParams(strSearchParams);
// 查询字符序列
var myUrlSearchParams = new URLSearchParams(arrSearchSequence);
// 查询键值对象
var myUrlSearchParams = new URLSearchParams(objSearchKeyValue);

参数

strSearchParams
URL查询字符串。使用示意:
var params1 = new URLSearchParams('?s=url');
或者对当前地址栏地址的查询字符串进行实例化:
var params2 = new URLSearchParams(location.search);
arrSearchSequence
数组形式的查询字符序列。例如:
var params3 = new URLSearchParams([['s', 'url'], ['someId', 1]]);
objSearchKeyValue
键值对形式的查询对象。例如:
var params4 = new URLSearchParams({"s": "url", "someId": 2})

三、URLSearchParams实例方法们

上面执行new URLSearchParams()的返回值myUrlSearchParams就是一个URLSearchParams实例。

这个URLSearchParams实例包含众多方法,具体如下:

URLSearchParams.append(name, key)
添加新的键值对作为查询参数。例如:

var params = new URLSearchParams('?s=url');   // 也可以没有问号直接's=url'
params.append('from', 'zxx');
// 此时的查询字符串是:'s=url&from=zxx'

append查询字符串运行结果

URLSearchParams.delete(name)
删除已存在的查询参数。例如:

var params = new URLSearchParams('?s=url');
params.delete('s');
// 此时的查询字符串是:''

删除查询

URLSearchParams.entries()
返回查询参数们的迭代器对象,我们可以迭代该迭代器对象获得所有的键值对。例如使用for..of

var searchParams = new URLSearchParams("s=url&from=zxx");
// 显示所有的键值对
for (var pair of searchParams.entries()) {
   console.log(pair[0]+ ', '+ pair[1]); 
}

控制台输入结果示意:
遍历结果示意

URLSearchParams.forEach(callback)
此方法可以遍历查询对象。

其中callback是遍历方法,支持两个参数,分别是每个键值对的值和键。示意:

var searchParams = new URLSearchParams("s=url&from=zxx");
// 输出值和键的内容
searchParams.forEach(function(value, key) {
  console.log(value, key);
});

查询语句输出值

URLSearchParams.get(name)
返回指定关键字对象的值。例如:

var params = new URLSearchParams('s=url&from=zxx');
params.get('s');
// 返回值是:'url'

get参数使用示意

如果没有对应的值,则返回null

URLSearchParams.getAll(name)
以数组形式返回所有当前查询关键字对应的值,例如:

var params = new URLSearchParams('s=url&s=urlsearchparams&from=zxx');
params.getAll('s');
// 返回值是:['url', 'urlsearchparams']

getAll返回数组示意

URLSearchParams.has(name)
返回布尔值,true或者false,是否包含某个查询关键字。

var params = new URLSearchParams('?s=url');
params.has('s') == true;    // true

是否有查询关键字s

URLSearchParams.keys()
返回一个迭代器对象,允许迭代该对象中所有的关键字。使用示意:

var searchParams = new URLSearchParams("s=url&from=zxx");
// 显示所有的键
for (var key of searchParams.keys()) {
   console.log(key); 
}

迭代查询关键字们

URLSearchParams.values()
返回一个迭代器对象,允许迭代该对象中所有的关键字值。使用示意:

var searchParams = new URLSearchParams("s=url&from=zxx");
// 显示所有的值
for (var value of searchParams.values()) {
   console.log(value); 
}

值迭代器匹配

URLSearchParams.set(name, value)
有则替换,无则加冕。例如:

var params = new URLSearchParams('s=url&s=urlsearchparams&from=zxx');
params.set('s', 'css世界');
params.getAll('s');    // 返回值是:['css世界']

替换所有的s

可以看到会替换之前所有的's'查询参数值。下面这个例子展示“无则加冕”:

var params = new URLSearchParams('s=url'); 
params.set('from', 'zxx');
params.toString();    // 结果是:'s=url&from=zxx'

set方法添加效果示意
也就是原本没有对应参数的时候会添加这个参数。

URLSearchParams.sort()
方法将此对象中包含的所有键/值对就地排序,并返回undefined。排序顺序根据键的Unicode码位。该方法使用一种稳定的排序算法(即保留具有相同键的键/值对之间的相对顺序)。例如:

var searchParams = new URLSearchParams('c=4&a=2&b=3&a=1'); 
// 键值对排序
searchParams.sort();
// 显示排序后的查询字符串
console.log(searchParams.toString());    // 结果是:a=2&a=1&b=3&c=4

键值对排序结果示意

URLSearchParams.toString()
把URLSearchParams对象转换成查询字符串。这个代码示意上面多次出现,这里不重复展示。

URLSearchParams()兼容性

Edge17+支持。

URLSearchParams兼容性截图

四、再来了解下URL()语法

URL接口用于解析、构造、规范化和编码URL。其构造的实例支持若干属性和方法,可以用来读写URL相关的属性值。我们甚至可以把文件内容作为URL的一部分进行呈现。

在使用URL()之前,建议先做个浏览器支持与否的判断,例如:

if (window.URL) {
    // ...
}

另外,URL接口支持在web workers中使用。

语法

var myUrl = new URL(url, [base])

参数

url
相对地址或者绝对地址。如果是相对地址,需要设置base参数,如果是绝对地址,则会忽略base设置。我们也可以使用URL对象作为url参数。此时作用的值是URL对象中的href属性值。
base
如果URL地址是相对地址,则需要这个参数,作用是作为相对计算的基础地址。我们也可以使用URL对象作为base参数,此时作用的值是URL对象中的href属性值。如果不设置该参数,则会按照空字符串''进行处理。

如果参数值无法组合成完整URL地址,则会报TypeError错误。

测试与用法示意

基本使用示意:

var base = 'https://www.zhangxinxu.com';
// 结果是:https://www.zhangxinxu.com/study
console.log(new URL('study', base).href);
// 结果是:https://www.zhangxinxu.com/study
console.log(new URL('/study', base).href);

可以直接使用URL对象作为参数:

var base = 'https://www.zhangxinxu.com';
var urlFromBase = new URL('study', base);
// 结果是:https://www.zhangxinxu.com/study
console.log(new URL(urlFromBase).href);
// 结果是:https://www.zhangxinxu.com/wordpress
console.log(new URL('wordpress', urlFromBase).href);

使用URL对象作为参数示意

下面是带有较深层级base地址和不同相对地址形式的测试:

var base = 'https://www.zhangxinxu.com/study/a/b/c';
// 结果是:https://www.zhangxinxu.com/study/a/b/sp/icon
console.log(new URL('sp/icon', base).href);
// 结果是:https://www.zhangxinxu.com/study/a/b/sp/icon
// 上下结果对比表明./和裸露相对地址没有区别
console.log(new URL('./sp/icon', base).href);
// 结果是:https://www.zhangxinxu.com/study/a/sp/icon
// 向上一层URL层级深度
console.log(new URL('../sp/icon', base).href);
// 结果是:https://www.zhangxinxu.com/study/a/b/sp/icon
// 层级按照斜杠来算的
console.log(new URL('../sp/icon', base + '/').href);
// 结果是:https://www.zhangxinxu.com/sp/icon
// 斜杠开头表示跟地址开始匹配
console.log(new URL('/sp/icon', base).href);

眼见为实,下面的是控制台输出结果:

控制台输出的层级测试结果

下面是不同域名之间的测试:

var base = 'https://www.zhangxinxu.com';
// 结果是:http://image.zhangxinxu.com和https://image.zhangxinxu.com
// 没有协议的url认为是相对地址,协议取自base地址
console.log(new URL('//image.zhangxinxu.com', 'http://www.zhangxinxu.com').href);
console.log(new URL('//image.zhangxinxu.com', 'https://www.zhangxinxu.com').href);
// 结果是:https://image.zhangxinxu.com
// 这里url是完整的绝对地址,因此,忽略后面的base参数
console.log(new URL('https://image.zhangxinxu.com', base).href);

这是运行后的结果:

运行后的测试结果

下面是出错的测试:

// 没有绝对地址,会报错
console.log(new URL('').href);
console.log(new URL('//image.zhangxinxu.com').href);

报错截图

五、URL实例对象的属性和方法

new URL()返回值就是一个实例对象,包括下面这些属性和方法。

属性

已知有URL地址如下:

var url = new URL('https://www.zhangxinxu.com:80/wordpress/?s=url#comments');
var ftp = new URL('ftp://username:password@192.168.1.1/path/file');
hash
URL地址中的锚链值,包含字符串'#',例如这里url.hash的返回值是'#comments'
host
URL地址中host主机地址,包括协议端口号,这里url.host的返回值是'www.zhangxinxu.com:80'
hostname
URL地址中主机名称,不包括端口号,这里url.hostname的返回值是'www.zhangxinxu.com'
href
完成的URL地址。
origin [只读]
返回URL地址的来源,会包含URL协议,域名和端口。这里url.origin的返回值是'https://www.zhangxinxu.com:80'
password
返回URL地址域名前的密码。ftp协议中比较常见。这里ftp.password的返回值是'password'
username
返回URL地址域名前的用户名。ftp协议中比较常见。这里ftp.username的返回值是'username'
pathname
返回URL中的目录+文件名。例如这里ftp.pathname的返回值是'/path/file'
port
返回URL地址中的端口号。例如这里url.port的返回值是'80'ftp.port的返回值是''
protocol
返回URL地址的协议,包括后面的冒号':'。例如这里url.protocol的返回值是'https:'ftp.protocol的返回值是'ftp:'
search
返回URL地址的查询字符串,如果有参数,则返回值以问号'?'开头。例如这里url.search的返回值是'?s=url'
searchParams
返回一个URLSearchParams对象,可以调用URLSearchParams对象各种方法,对查询字符串进行非常方便的处理。例如我们想要知道查询关键字s对应的值,可以:

url.searchParams.get('s');

方法

toString()
返回的完整的URL地址,你可以理解为URL.href的另外一种形式,不过这个只能输出,不能修改值。
toJSON()
同样返回完整的URL地址,返回的字符串和href属性一样。

静态方法

URL.createObjectURL(object)
可以把File,Blob或者MediaSource对象变成一个一个唯一的blob URL。其中参数object可以是File,Blob或者MediaSource对象。
URL.revokeObjectURL(objectURL)
撤消之前使用URL.createObjectURL()创建的URL对象。其中参数objectURL表示之前使用URL.createObjectURL()创建的URL返回值。

静态方法实际使用案例一则
我们使用Ajax请求一个跨域图片避免canvas跨域生成问题的时候可以使用这两个静态方法:

var xhr = new XMLHttpRequest();
xhr.onload = function () {
    var url = URL.createObjectURL(this.response);
    var img = new Image();
    img.onload = function () {
        // 此时你就可以使用canvas对img为所欲为了
        // ... code ...
        // 图片用完后记得释放内存
        URL.revokeObjectURL(url);
    };
    img.src = url;
};
xhr.open('GET', url, true);
xhr.responseType = 'blob';
xhr.send();

兼容性

Edge 12+支持。

URL()兼容性截图

六、这两个JS API的polyfill

从兼容性表可以看出,URLSearchParams Edge 17才开始支持,而URL 从Edge 12才开始支持,似乎兼容性不佳,但是,这并不妨碍我们在实际项目中使用,为什么呢?因为有polyfill。

这里有一个一直支持到ES7最新规范的URL和URLSearchParams polyfill项目:https://github.com/lifaon74/url-polyfill

按照官方说法,兼容到IE 10+。

IE9究竟支不支持,还是仅仅是部分支持,我大致简单测试了一下,结论如下:

除了URL()几个静态方法以外的基本使用IE9都是支持的!

对于我来说,够用了够用了。

如果以后实际应用发现其他细节再更新。

七、结语

web这块,无论是CSS,HTML还是JS API都在不断进步,标准且跨平台,以前很多需要自定义的方法和特性,现在浏览器都已经原生支持,以前的那些语言框架价值越来越低。

是时候开始尝试拥抱原生,辛苦地学习与积累,简单且轻松的实现,面向产品,面向用户,立足未来,方能穿越长河。

那些咨询我前端问题的小伙伴,不用再问我任何关于Vue和React的问题了,我全部用都没用过,以后也不会用,不是我的方向,也不是未来的方向。

(本篇完)

分享到:
×


发表评论(目前18 条评论)

  1. saber酱说道:

    哇,正好我可以用得上。之前自己写了一个方法从 url 里查询字段,现在方便了。谢谢张老师。

  2. 传奇10号说道:

    跟着旭哥的步伐与时俱进。才是硬道理。学习了😊 。非常感谢分享

  3. 陈佳涛说道:

    原文这里有误:
    ——————————————————-
    下面是带有较深层级base地址和不同相对地址形式的测试:

    var base = ‘https://www.zhangxinxu.com/study/a/b/c’;
    // 结果是:https://www.zhangxinxu.com/study/a/sp/icon
    console.log(new URL(‘sp/icon’, base).href);
    ——————————————————
    这个base变量的值有误,应该是var base = ‘https://www.zhangxinxu.com/study/a/b’;

  4. 雄蚊子说道:

    那个 URL()介绍里面有笔误哦。注释写的结果和实际console.log出来的结果不同哦。

    • 张 鑫旭说道:

      请问具体是哪一个?

      • 陈佳涛说道:

        原文这里有误:
        ——————————————————-
        下面是带有较深层级base地址和不同相对地址形式的测试:

        var base = ‘https://www.zhangxinxu.com/study/a/b/c’;
        // 结果是:https://www.zhangxinxu.com/study/a/sp/icon
        console.log(new URL(‘sp/icon’, base).href);
        ——————————————————
        这个base变量的值有误,应该是var base = ‘https://www.zhangxinxu.com/study/a/b’;

  5. amour说道:

    有事没事来这里逛逛,收获不少

  6. 史蒂芬库里说道:

    已经习惯隔三差五 来逛逛,每次都有收获,不错

  7. XboxYan说道:

    见过好多没框架就干不了活的,写个活动页面都要搬上vue全家桶🙈

  8. 乐亦栗说道:

    张老师您好,我很好奇,能不能谈一谈为什么您认为「Vue和React不是未来的方向呢」?

  9. vanlau说道:

    最后一句总结真给力啊

  10. naux说道:

    polyfill 推荐使用corejs

  11. LeonZou说道:

    鑫老师,我一直不明白,为什么很多人都抵制原生,而拥抱想JQ之类的框架。难道是因为原生的兼容性还是不够吗?

    • 小乐数学zzllrr Mather说道:

      我想到的原因是,原生发展实在太慢了和太不健全了,有很大的历史局限性,而流行框架简化了原生的使用,当然应用者更多。但原生与框架都各有利弊,相辅相成,相互促进。没有必要抵制某一方,事实上,两者在发展过程中,都可能会面临一些缺少严格系统化的设计缺陷。

      原生规范设计的发展慢,一是商业利益掣肘导致,二是实用至上对基础理论关心少,缺少更严谨深入的数学设计理论导致,三是软硬件工程发展变化实在太快,实验性的标准难以快速推进。

      一般来讲,web语言规范,事实上都要等w3c中的浏览器及硬件大厂的代表,条件都谈妥了,才能开始标准化。当然为了保证充分的权威性、易推广性和降低应用者的学习门槛,原生语法和接口太多,反而是坏事。

    • xuerlengzi说道:

      因为学会框架可以直接上手干活,所以都不重视基础

    • 张鑫旭说道:

      工作用框架无可厚非,毕竟是做产品,需要更快有收益,但是学习可不能只盯着框架。