node中的url常用方法解析

weixin_33766168發表於2018-03-10

url字串是一個結構化的字串,由好幾個有意義部分組成。我們在工作中不可避免的會用到其中的某個部分,最原始的通過字串擷取和正則匹配的方法難免用起來會不太方便和美觀,所以在我們的nodejs中提供了一個處理和解析url的模組url,該模組提供了一些實用的函式使我們解析起來更加的方便快捷,那接下里我們來分析一下它提供的常用的函式的用法

url模組提供了兩套API來處理URLs:
一個是Node.js遺留的特有的API,

保留的原因:雖然Node.js遺留的特有的API並沒有被棄用,但是保留的目的是用於向後相容已有應用程式。因此新的應用程式請使用WHATWG API。

另一個則是通常使用在web瀏覽器中 實現了WHATWG URL Standard的API.該API是在node8.0.0中正式應用的

在瀏覽器中,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');
1、parse(urlStr,queryString,AnalysisHost)

Node.js遺留的特有的API
引數:

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'}.預設是false

作用:解析url,返回一個url屬性物件

例如:

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。

2、resolve(from, to)

引數:

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'
3、format(url,options)

引數:

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'
4、new URL(input[, base])

瀏覽器相容的 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/
5.URLSearchParams

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
6、domainToASCII(domain)

返回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'));
  // 輸出空字串
7. domainToUnicode(domain)

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

相關文章