Node.js URL 模块概述
稳定性: 3 - 稳定
Node.js的URL模块提供了用于分析和解析URL的实用程序。可以调用require('url')
来访问它:
const url = require('url');
解析URL对象有以下内容,依赖于他们是否在URL字符串里存在。任何不在URL字符串里的部分,都不会出现在解析对象里。例子如下:
'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'
-
href
:准备解析的完整的URL,包含协议和主机(小写)。例子:
'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'
-
protocol
: 请求协议,小写。例子:
'http:'
-
slashes
: 协议要求的斜杠(冒号后)例子:true或false
-
host
: 完整的URL小写主机部分,包含端口信息。例子:
'host.com:8080'
-
auth
: url中的验证信息。例子:
'user:pass'
-
hostname
: 域名中的小写主机名例子:
'host.com'
-
port
: 主机的端口号例子:
'8080'
-
pathname
: URL中的路径部分,在主机名后,查询字符前,包含第一个斜杠。例子:
'/p/a/t/h'
-
search
: URL中得查询字符串,包含开头的问号例子:
'?query=string'
-
path
:pathname
和search
连在一起例子:
'/p/a/t/h?query=string'
-
query
: 查询字符串中得参数部分,或者使用querystring.parse()解析后返回的对象。例子:
'query=string'
或者{'query':'string'}
-
hash
: URL的“#”后面部分(包括 # 符号)例子:
'#hash'
URL模块提供了以下方法:
url.parse(urlStr[, parseQueryString][, slashesDenoteHost])
输入URL字符串,返回一个对象。
第二个参数为true
时,使用querystring
来解析查询字符串。如果为true
,query
属性将会一直赋值为对象,并且search
属性将会一直是字符串(可能为空)。默认为false
。
第三个参数为true
,把//foo/bar
当做{ host: 'foo', pathname: '/bar' }
,而不是{ pathname: '//foo/bar' }
。默认为false
。
url.format(urlObj)
输入一个解析过的URL对象,返回格式化过的字符串。
格式化的工作流程:
href
会被忽略protocol
无论是否有末尾的 : (冒号),会同样的处理http
,https
,ftp
,gopher
,file
协议会被添加后缀://
mailto
,xmpp
,aim
,sftp
,foo
等协议添加后缀:
slashes
如果协议需要://
,设置为true。- 仅需对之前列出的没有斜杠的协议,比如议
mongodb://localhost:8000/
- 仅需对之前列出的没有斜杠的协议,比如议
auth
如果出现将会使用.hostname
仅在缺少host
时使用port
仅在缺少host
时使用host
用来替换hostname
和port
pathname
无论结尾是否有“/”将会同样处理search
将会替 query属性- 无论前面是否有“/”将会同样处理
query
(对象;参见querystring
) 如果没有search,将会使用hash
无论前面是否有#,都会同样处理
url.resolve(from, to)
给一个基础URL,href 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'