node中的url模块

URL

URL是因特网资源的标准化名称,URI是通用的资源标识符,URL是URI的子集,URL分三部分组成,比如我们访问一个网站

https://www.jianshu.com/writer#/notebooks/32702255/notes/38896642/preview
第一部分 (http)是URL的方案(scheme),方案可以告诉web客户端怎样访问资源,在这里说明URL使用的是HTTP协议。
第二部分(www.jianshu.com)表示的是服务器的位置。
第三部分(writer#/notebooks/32702255/notes/38896642/preview)是资源路径,路径说明是请求的服务器上那个本地的资源。URL语法URL提供了一种定位因特网上任意资源的手段,但这些资源是可以通过各种不同的方案(比如HTTP、FTP、SMTP)来访问,因此URL语法会随着方案的不同而不同。
://:@:/:?#
scheme: 方案是如何访问指定资源的主要标识符,他会告诉负责解析URL应用程序应该使用什么协议。
host: 主机组件标识了因特网上能够访问资源的宿主机器,可以有主机名或者是IP地址来表示。
port: 端口标识了服务器正在监听的网络端口。默认端口号是80。
path: URL的路径组件说明了资源位于服务器的什么地方。
params: URL中通过协议参数来访问资源,比名值对列表,分号分割来进行访问。query: 字符串是通过提问问题或进行查询来缩小请求资源类的范围。
frag: 为了引用部分资源或资源的一个片段,比如URL指定HTML文档中一个图片或一个小节。HTTP通常只处理整个对象,而不是对象的片段,客户端不能将片段传送给服务器。浏览器从服务器获取整个资源之后,会根据片段来显示你感兴趣的片段部分。

node中的url模块

URL模块用于解析和处理URL的字符串,提供了如下三个方法:

  1. parse
  2. resolve
  3. format
使用方法如下:
const url = require('url');

1、parse(urlStr,queryString,AnalysisHost) (将url字符串地址转为一个对象。)

参数:

urlStr: 要解析的url地址;(默认false)

queryString: 解析出来的查询字符串还是查询对象,true是对象 false是字符串,例如:

url.parse('http://foo/bar?a=123', true)
输出
query: {a: 123},


url.parse('http://foo/bar?a=123', false)
输出
query: 'a=123' 默认是false;

AnalysisHost: 是否要解析出来host (即将//之后至下一个/之前的字符串)(默认是false)
(当我们不知道传输来的url的协议,我们仍想解析地址。我们可以这样用url.parse('//user:[email protected]:8080/p/a/t/h?query=string#hash'))
例如:

url.parse('//foo/bar ',ture,ture)
会被解析为
{host: 'foo', pathname: '/bar},

url.parse('//foo/bar ',ture,false)
会被解析为
{pathname: '//foo/bar'}.默认是false;

parse()作用:解析url,返回一个url属性对象
例如:

const myURLA =url.parse('https://user:[email protected]:8080/p/a/t/h?query=string#hash', true);
console.log(myURLA);

输出

Url {
      protocol: 'https:', // 协议
      slashes: true,(协议的“:”号后是否有“/”)(slashes意思是斜杠)
      auth: 'user:pass', // 用户名,密码
      host: 'sub.host.com:8080', // host主机名
      port: '8080', // 端口号
      hostname: 'sub.host.com', // 主机名不带端口号
      hash: '#hash', // 哈希值 (URL属性中在井号“#”后面的分段)
      search: '?query=string',// 查询字符串 (URL属性中跟在问号后面的部分包括?号)
      query: 'query=string', // 请求参数
      pathname: '/p/a/t/h', // 路径名
      path: '/p/a/t/h?query=string', // 带查询的路径名
      href: 'https://user:[email protected]: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)(用于拼接URL, 它根据相对URL拼接成新的URL;)

作用:以一种 Web 浏览器解析超链接的方式把一个目标 URL 解析成相对于一个基础 URL。

参数:

from: 解析时对应的基本的url
to:要解析的超链接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 url.format(URL[, options])

  • URL 一个WHATWG URL对象

  • options

    • auth 如果序列化的URL字符串应该包含用户名和密码为true,否则为false。默认为true
    • fragment 如果序列化的URL字符串应该包含分段为true,否则为false。默认为true
    • search 如果序列化的URL字符串应该包含搜索查询为true,否则为false。默认为true
    • 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'
    
    eg:
    const myURL1 = url.format({
        protocol: 'https:',
        slashes: true,
        auth: 'user:pass',
        host: 'sub.host.com:8080',
        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:[email protected]:8080/p/a/t/h?query=string#hash' }
      )
      console.log(myURL1)
    

    输出:

    https://user:[email protected]:8080/p/a/t/h?query=string#hash
    

    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/
    

    你可能感兴趣的:(node中的url模块)