url字符串是一个结构化的字符串,由好几个有意义部分组成。咱们在工做中不可避免的会用到其中的某个部分,最原始的经过字符串截取和正则匹配的方法不免用起来会不太方便和美观,因此在咱们的nodejs中提供了一个处理和解析url的模块url,该模块提供了一些实用的函数使咱们解析起来更加的方便快捷,那接下里咱们来分析一下它提供的经常使用的函数的用法node
url模块提供了两套API来处理URLs:
一个是Node.js遗留的特有的API,web
保留的缘由:虽然Node.js遗留的特有的API并无被弃用,可是保留的目的是用于向后兼容已有应用程序。所以新的应用程序请使用WHATWG API。算法
另外一个则是一般使用在web浏览器中 实现了WHATWG URL Standard的API.该API是在node8.0.0中正式应用的c#
在浏览器中,WHATWG URL在全局老是可用的,而在Node.js中,任何状况下打开 或使用一个连接都必须事先引用'url'模块:require('url').URL浏览器
const url = require('url');
let http = require('http'); let url = require('url'); console.log(url); // { Url: [Function: Url], // parse: [Function: urlParse], // resolve: [Function: urlResolve], // resolveObject: [Function: urlResolveObject], // format: [Function: urlFormat], // URL: [Function: URL], // URLSearchParams: [Function: URLSearchParams], // domainToASCII: [Function: domainToASCII], // domainToUnicode: [Function: domainToUnicode] }
let {parse, resolve, format, URL, URLSearchParams, domainToASCII, domainToUnicode} = require('url');
Node.js遗留的特有的API
参数:app
urlStr: 要解析的url地址
queryString: 解析出来的查询字符串仍是查询对象,true是对象 false是字符串,例如:http://foo/bar?a=123, true的话 query: {a: 123}, false的话 query: 'a=123' 默认是false
AnalysisHost: 是否要解析出来host (即将//以后至下一个/以前的字符串),例如://foo/bar 会被解析为{host: 'foo', pathname: '/bar},不然{pathname: '//foo/bar'}.默认是falsedom
做用:解析url,返回一个url属性对象函数
例如:ui
const myURLA = url.parse('https://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash', true); console.log(myURLA); // Url { // protocol: 'https:', // 协议 // slashes: true, // auth: 'user:pass', // 用户名密码 // host: 'sub.host.com:8080', // host主机名 // port: '8080', // 端口号 // hostname: 'sub.host.com', // 主机名不带端口号 // hash: '#hash', // 哈希值 // search: '?query=string',// 查询字符串 // query: 'query=string', // 请求参数 // pathname: '/p/a/t/h', // 路径名 // path: '/p/a/t/h?query=string', // 带查询的路径名 // href: 'https://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash' // 原字符串自己 }
错误:编码
若是urlStr不是字符串将会抛出TypeError。
const myurl = url.parse({a:123}); TypeError: Parameter "url" must be a string, not object
若是auth属性存在但没法编码则抛出URIError。
参数:
from: 解析时对应的基本的url
to:要解析的超连接url
做用:以一种 Web 浏览器解析超连接的方式把一个目标 URL 解析成相对于一个基础 URL。
例如:
const url = require('url'); url.resolve('/one/two/three', 'four'); // '/one/two/four' url.resolve('http://example.com/', '/one'); // 'http://example.com/one' url.resolve('http://example.com/one', '/two'); // 'http://example.com/two'
参数:
url: 一个WHATWG URL对象
options:
1. auth: 若是序列化的URL字符串应该包含用户名和密码为true,不然为false。默认为true。
2. fragment: 若是序列化的URL字符串应该包含分段为true,不然为false。默认为true。便是不是须要包含哈希值
3. search: 若是序列化的URL字符串应该包含搜索查询为true,不然为false。默认为true。
4. unicode: true 若是出如今URL字符串主机元素里的Unicode字符应该被直接编码而不是使用Punycode编码为true,默认为false。
返回一个WHATWG URL对象的可自定义序列化的URL字符串表达。
虽然URL对象的toString()方法和href属性均可以返回URL的序列化的字符串。然而,二者都不能够被自定义。而url.format(URL[, options])方法容许输出的基本自定义。
例如:
const { URL } = require('url'); const myURL = new URL('https://a:b@你好你好?abc#foo'); console.log(myURL.href); // 输出 https://a:b@xn--6qqa088eba/?abc#foo console.log(myURL.toString()); // 输出 https://a:b@xn--6qqa088eba/?abc#foo console.log(url.format(myURL, { fragment: false, unicode: true, auth: false })); // 输出 'https://你好你好/?abc'
浏览器兼容的 URL 类,根据 WHATWG URL 标准实现。
注意: 根据浏览器的约定,URL 对象的全部属性都是在类的原型上实现为getter和setter,而不是做为对象自己的数据属性。所以,与[遗留的urlObjects][]不一样,在 URL 对象的任何属性(例如 delete myURL.protocol,delete myURL.pathname等)上使用 delete 关键字没有任何效果,但仍返回 true。
参数:
input: 解析的输入url
base: 若是“input”是相对url,则为要解析的基本url
做用:经过将input解析到base上建立一个新的URL对象。若是base是一个字符串,则解析方法与new URL(base)相同。
例如:
const { URL } = require('url'); const myURL = new URL('/foo', 'https://example.org/'); // https://example.org/foo
若是input或base是无效URLs,将会抛出TypeError。请注意给定值将被强制转换为字符串。例如:
const { URL } = require('url'); const myURL = new URL({ toString: () => 'https://example.org/' }); // https://example.org/
存在于input主机名中的Unicode字符将被使用Punycode算法自动转换为ASCII。
const { URL } = require('url'); const myURL = new URL('https://你好你好'); // https://xn--6qqa088eba/
URLSearchParamsAPI接口提供对URLquery部分的读写权限。URLSearchParams类也可以与如下四个构造函数中的任意一个单独使用。
例如:
const { URL, URLSearchParams } = require('url'); const myURL = new URL('https://example.org/?abc=123'); console.log(myURL.searchParams.get('abc')); // 输出 123 myURL.searchParams.append('abc', 'xyz'); console.log(myURL.href); // 输出 https://example.org/?abc=123&abc=xyz myURL.searchParams.delete('abc'); myURL.searchParams.set('a', 'b'); console.log(myURL.href); // 输出 https://example.org/?a=b const newSearchParams = new URLSearchParams(myURL.searchParams); // 上面的代码等同于 // const newSearchParams = new URLSearchParams(myURL.search); newSearchParams.append('a', 'c'); console.log(myURL.href); // 输出 https://example.org/?a=b console.log(newSearchParams.toString()); // 输出 a=b&a=c // newSearchParams.toString() 被隐式调用 myURL.search = newSearchParams; console.log(myURL.href); // 输出 https://example.org/?a=b&a=c newSearchParams.delete('a'); console.log(myURL.href); // 输出 https://example.org/?a=b&a=c
返回Punycode ASCII序列化的domain. 若是domain是无效域名,将返回空字符串。
它执行的是url.domainToUnicode()的逆运算。
const url = require('url'); console.log(url.domainToASCII('español.com')); // 输出 xn--espaol-zwa.com console.log(url.domainToASCII('中文.com')); // 输出 xn--fiq228c.com console.log(url.domainToASCII('xn--iñvalid.com')); // 输出空字符串
返回Unicode序列化的domain. 若是domain是无效域名,将返回空字符串。
它执行的是url.domainToASCII()的逆运算。
const url = require('url'); console.log(url.domainToUnicode('xn--espaol-zwa.com')); // 输出 español.com console.log(url.domainToUnicode('xn--fiq228c.com')); // 输出 中文.com console.log(url.domainToUnicode('xn--iñvalid.com')); // 输出空字符串