URL 字符串与 URL 对象

URL 字符串是结构化的字符串，包含多个含义不同的组成部分。 解析字符串后返回的 URL 对象，每个属性对应字符串的各个组成部分。
url 模块提供了两套 API 来处理 URL：一个是旧版本遗留的 API，一个是实现了 WHATWG标准的新 API。
遗留的 API 还没有被废弃，保留是为了兼容已存在的应用程序。 新的应用程序应使用 WHATWG 的 API。
WHATWG 的 API 与遗留的 API 的区别如下。 在下图中，URL 'http://user:pass@sub.example.com:8080/p/a/t/h?query=string#hash' 上方的是遗留的 url.parse() 返回的对象的属性。 下方的则是 WHATWG 的 URL对象的属性。
WHATWG 的 origin 属性包括 protocol 和 host，但不包括 username 或 password。
image.png使用 WHATWG 的 API 解析 URL 字符串：

  1. const myURL =
  2.   new URL('https://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash');
  4.   URL {
  5.   href:
  6.    'https://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash',
  7.   origin: 'https://sub.host.com:8080',
  8.   protocol: 'https:',
  9.   username: 'user',
  10.   password: 'pass',
  11.   host: 'sub.host.com:8080',
  12.   hostname: 'sub.host.com',
  13.   port: '8080',
  14.   pathname: '/p/a/t/h',
  15.   search: '?query=string',
  16.   searchParams: URLSearchParams { 'query' => 'string' },
  17.   hash: '#hash' }

使用遗留的 API 解析 URL 字符串：

  1. const url = require('url');
  2. const myURL =
  3.   url.parse('https://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash');
  5.   Url {
  6.   protocol: 'https:',
  7.   // slashes 属性是一个 boolean，如果 protocol 中的冒号后面跟着两个,
  8.   // ASCII 斜杠字符（/），则值为 true。
  9.   slashes: true,
  10.   auth: 'user:pass',
  11.   host: 'sub.host.com:8080',
  12.   port: '8080',
  13.   hostname: 'sub.host.com',
  14.   hash: '#hash',
  15.   search: '?query=string',
  16.   query: 'query=string',
  17.   pathname: '/p/a/t/h',
  18.   path: '/p/a/t/h?query=string',
  19.   href:
  20.    'https://user:pass@sub.host.com:8080/p/a/t/h?query=string#hash' }

WHATWG

url.toJSON()

返回string
在URL对象上调用toString()方法将返回序列化的URL。返回值与url.href和url.toJSON()的相同。

url.toString()

在URL对象上调用toJSON()方法将返回序列化的URL。返回值与url.href和url.toString()的相同。

  1. const { URL } = require('url');
  2. const myURLs = [
  3.   new URL('https://www.example.com'),
  4.   new URL('https://test.example.org')
  5. ];
  6. console.log(JSON.stringify(myURLs));
  7.   // 输出 ["https://www.example.com/","https://test.example.org/"]

url.searchParams

返回一个

url.domainToASCII(domain:string) : string

返回Punycode ASCII序列化的domain. 如果domain是无效域名，将返回空字符串。
它执行的是url.domainToUnicode()的逆运算。

url.domainToUnicode(domain:string) : string

返回Unicode序列化的domain. 如果domain是无效域名，将返回空字符串。
它执行的是url.domainToASCII()的逆运算。

url.fileURLToPath(url: string|URL) : string

此方法保证百分号编码字符解码结果的正确性，同时也确保绝对路径字符串在不同平台下的有效性。

  1. new URL('file:///C:/path/').pathname;    // 错误: /C:/path/
  2. fileURLToPath('file:///C:/path/');       // 正确: C:\path\ (Windows)
  3. new URL('file://nas/foo.txt').pathname;  // 错误: /foo.txt
  4. fileURLToPath('file://nas/foo.txt');     // 正确: \\nas\foo.txt (Windows)
  5. new URL('file:///你好.txt').pathname;    // 错误: /%E4%BD%A0%E5%A5%BD.txt
  6. fileURLToPath('file:///你好.txt');       // 正确: /你好.txt (POSIX)
  7. new URL('file:///hello world').pathname; // 错误: /hello%20world
  8. fileURLToPath('file:///hello world');    // 正确: /hello world (POSIX)

url.format(URL[, options])