nodejs学习 -- url模块

[mt51]

url 模块

url模块用来处于URL的解析和处理，使用方式如下：

const url = require('url')

URL 字符串是具有结构的字符串，包含多个意义不同的组成部分。 URL 字符串可以被解析为一个 URL 对象，其属性对应于字符串的各组成部分。

url模块提供了两套API来处理URL字符串，一套是nodejs特有的API，一套是实现了WHATWG URL Standard的API。

下图中，网址 'http://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash' 上方是由遗留的url.parse()返回的对象的属性。网址下方的则是WHATWG URL对象的属性。

WHATWG URL的origin属性包括protocol和host，但不包含username、password。

┌─────────────────────────────────────────────────────────────────────────────────────────────┐
│                                            href                                             │
├──────────┬──┬─────────────────────┬─────────────────────┬───────────────────────────┬───────┤
│ protocol │  │        auth         │        host         │           path            │ hash  │
│          │  │                     ├──────────────┬──────┼──────────┬────────────────┤       │
│          │  │                     │   hostname   │ port │ pathname │     search     │       │
│          │  │                     │              │      │          ├─┬──────────────┤       │
│          │  │                     │              │      │          │ │    query     │       │
"  https:   //    user   :   pass   @ sub.host.com : 8080   /p/a/t/h  ?  query=string   #hash "
│          │  │          │          │   hostname   │ port │          │                │       │
│          │  │          │          ├──────────────┴──────┤          │                │       │
│ protocol │  │ username │ password │        host         │          │                │       │
├──────────┴──┼──────────┴──────────┼─────────────────────┤          │                │       │
│   origin    │                     │       origin        │ pathname │     search     │ hash  │
├─────────────┴─────────────────────┴─────────────────────┴──────────┴────────────────┴───────┤
│                                            href                                             │
└─────────────────────────────────────────────────────────────────────────────────────────────┘

使用nodejs提供的API解析一个URL字符串

const url = require('url')
const myurl = url.parse('http://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash')

使用WHATWG API解析一个URL字符串：

const { URL } = require('url')
const myurl = new URL('http://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash')

URL 类

URL类实例化返回一个URL对象，URL 对象的所有属性都是在类的原型上实现为getter和setter。

new URL(input[,base])

• input：要解析的url字符串
• base：如果input是相对URL，则base为要解析的基本URL。

当input使用相对URL时不提供base会抛出invalid URL异常。

URLSearchParams 类

new URLSearchParams([url])

• url <string> | <object> | ：实例化一个URLSearchParams对象

const { URLSearchParams } = require('url')
const search = new URLSearchParams('query=string#hash')

urlSearchParams.append(name, value)

在查询字符串中加入一个键值对

urlSearchParams.delete(name)

删除所有键名为name的键值对

urlSearchParams.get(name)

返回键是name的第一个键值对的值。如果没有对应的键值对则返回null

urlSearchParams.getAll(name)

返回所有键是name的键值对的值

urlSearchParams.has(name)

判读是否存在键是name的键值对。

urlSearchParams.set(name, value)

将URLSearchParams对象中与name相对应的值设置为value。如果已经存在键为name的键值对，将第一对的值设为value并且删除其他对。如果不存在，则将此键值对附加在查询字符串后。

urlSearchParams.sort()

按现有名称就地排列所有的名称-值对

urlSearchParams.toString()

返回序列化后的字符串

url.format(URL[,options])

格式化一个URL对象或者是字符串，如果传入的是字符串会调用url.parse()转换成URL对象。

url.parse(urlString[,parseQueryString[,slasherDenoteHost]])

url.parse() 方法会解析一个 URL 字符串并返回一个 URL 对象

url.resolve(from, to)

• from 解析时相对的基本 URL。
• to 要解析的超链接 URL。

url.resolve() 方法会以一种 Web 浏览器解析超链接的方式把一个目标 URL 解析成相对于一个基础 URL。

const { URLSearchParams } = require('url')
const search = new URLSearchParams()

search.append('a', 'a')  // {a => a}
search.append('b', 'b')  // {a => a, b => b}
search.append('c', 'c')  // {a => a, b => b, c => c}

search.has('a')  // true
search.has('d')  // false

search.delete('c')  // {a => a, b => b}

search.append('a', 'a1')
search.getAll('a')  //  ['a', 'a1']

search.set('a', 'a2') //  {a => a2, b => b}

参考

nodejs 中文文档