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')); // 輸出空字符串