This repository was archived by the owner on Aug 24, 2022. It is now read-only.
Repository navigation
This repository was archived by the owner on Aug 24, 2022. It is now read-only.
API 文档 - url 模块 #56
Description
API 文档 - url 模块
JavaScript 接口
_.url.parseQuery(query)
把 query string 解析为以对象的方式保存的名值对。
参数
query-- 字符串。需要解析的 query string。
返回值
对象。解析结果，以名值对的方式保存。
注意事项
- 传入不合法的参数，则一律返回空对象（
{}）。 - Query string 中的所有 key 都会被转换为小写。
- Query string 的格式为
foo=1&bar=2，不包含问号，多个连续的&字符会被视为一个。 - 解析结果中的值如果为
true、false、null、undefined或数字时，总是以字符串的方式保存，不会自动转换数据类型。 - 当 query string 中出现某个 key 但没有对应的值时（比如
foo&bar=2或foo=&bar=2中的foo），其值将解析为空字符串。
已知缺陷
- 重复出现的 key 将只解析最后一次出现的值，不会把所有值加入到一个数组中。
- 不处理复杂模式的 key，比如
foo[]或foo[bar]都不会被视为特殊含义，只会视为普通的 key。
示例
_.url.parseQuery('foo=1&bar=2') // => {foo: '1', bar: '2'}
_.url.parseQuery('foo=&bar=2') // => {foo: '', bar: '2'}
_.url.parseQuery('foo&bar=2') // => {foo: '', bar: '2'}
_.url.parseQuery('') // => {}_.url.getParam(key)
获取当前页面的某个 URL 参数的值。（“URL 参数” 即为 query string 中的名值对。）
参数
key-- 字符串。需要获取的 URL 参数名，忽略大小写。
返回值
字符串或 undefined。对应 URL 参数的值。
注意事项
- Query string 的解析方式参见
_.url.parseQuery()方法。 - 当页面 URL 发生变化时（比如调用
history.pushState()等方法时），返回结果总是当前的。
示例
假设当前页面的 URL 为 http://domain.com/path/file?foo&bar=2，此时：
_.url.parseQuery('foo') // => ''
_.url.parseQuery('bar') // => '2'
_.url.parseQuery('absentKey') // => undefined_.url.appendParam(url, param)
为给定的 URL 附加新的参数。
参数
url-- 字符串。待处理的 URL。param-- 对象。需要附加的 URL 参数（名值对）。
返回值
字符串。已附加 URL 参数的新的 URL。
示例
var url = 'http://domain.com/path/file'
url = _.url.appendParam(url, {foo: 'bar'}) // => 'http://domain.com/path/file?foo=bar'
url = _.url.appendParam(url, {test: 1}) // => 'http://domain.com/path/file?foo=bar&test=1'_.url.parseUrl(url, [part])
解析 URL 的各个组成部分。URL 各个组成部分的名称及含义如下：
protocol-- 协议hostname-- 主机名port-- 端口号host-- 主机（含端口号）pathname-- 路径（含文件名）search-- query string 部分（含开头的?字符）hash-- hash 部分（含开头的#字符）
可以看出它们和 location 对象的各个 key 的含义相同。
参数
url-- 字符串。需要解析的 URL。若此 URL 不完整，则视为相对路径，以当前页面为基准进行解析。part-- 字符串。可选参数。需要解析 URL 中的特定部分，合法的取值参见上述 “URL 的各个组成部分” 的名称。
返回值
- 当未指定任何参数时：空对象（
{}）。 - 当未指定
part参数时：对象。整个 URL 的解析结果，URL 的各个组成部分以名值对的方式保存。 - 当指定
part参数时：字符串。URL 中的指定部分的值。如不存在某个部分，则值为空字符串。
注意事项
port的值并不会被转换为数字。
示例
var url = 'http://domain.com/foo/bar'
_.url.parseUrl(url) // => {
// protocol: 'http:',
// hostname: 'domain.com',
// port: '',
// host: 'domain.com',
// pathname: '/foo/bar',
// search: '',
// hash: '',
// }
_.url.parseUrl(url, 'pathname') // => '/foo/bar'
_.url.parseUrl(url, 'search') // => ''
Activity
cssmagic commentedon May 9, 2015
JavaScript 接口
_.url.composeUrl(parts)根据提供的 URL 各个要素，构造完整的 URL。URL 各个组成部分的名称及含义同
_.url.parseUrl()接口的描述。参数
parts-- 对象。URL 的各个要素的名值对。返回值
字符串。构造出的完整 URL。
当参数不合法时，返回空字符串。
注意事项
host时，将忽略hostname和port字段。pathname必须以/开头；不以/开头则会自动补上。search必须以?开头；不以?开头则会自动补上。hash必须以#开头；不以#开头则会自动补上。host、hostname、pathname中的?和#字符会被编码；search中的#字符会被编码。port值在经过parseInt(port, 10)转换后必须为0或正整数；其它值均视为0。protocol-- 若省略则取当前页面的location.protocol。host-- 若省略则取hostname和port。port-- 若省略则取当前页面的location.port。hostname-- 若省略则取当前页面的location.hostname。pathname-- 若省略则取根目录（/）。search-- 若省略则不输出。hash-- 若省略则不输出。示例
_.url.removeHashFromUrl(url)把 URL 中的 hash 部分去除。
参数
url-- 字符串。待处理的 URL。返回值
字符串。若参数不合法则返回空字符串。
示例
_.url.getHashFromUrl(url)获取 URL 中的 hash 部分。获取结果包含开头的
#字符。若需要得到当前页面 URL 的 hash 部分，请直接使用
location.hash。参数
url-- 字符串。待处理的 URL，可以是完整的 URL，也可以是相对路径。返回值
字符串。若参数不合法则返回空字符串；若 URL 中不包含 hash 部分则返回空字符串。
示例
_.url.getHashFromLink(link)获取指定链接的
href属性值中的 hash 部分。获取结果包含开头的#字符。参数
link-- DOM 元素。待处理的链接元素（<a>或<link>）。返回值
字符串。若参数不合法则返回空字符串；若元素的
href属性值中不包含 hash 部分则返回空字符串。示例
别名
_.url.isHash_.str.isHash()的别名。_.url.stripHash_.str.stripHash()的别名。_.url.isFullUrl_.str.isFullUrl()的别名。_.url.isAbsolutePath_.str.isAbsolutePath()的别名。hax commentedon May 11, 2015
总体上最好需要 follow 某种惯用 API，以减少学习成本和方便记忆。
可以考虑 whatwg URL spec（ https://url.spec.whatwg.org/#api ） 或 nodejs 的 API（ https://iojs.org/api/url.html ）
hax commentedon May 11, 2015
_.url.isInFrame 在 url 下似乎有点诡异。
cssmagic commentedon May 11, 2015
😄 是的，略诡异。好几年前不严谨的 API 组织方式一直残留下来。不过暂时也想不出放进哪个模块（命名空间）更适合。改成
_.env.isInFrame是不是更好？不过单独为它建个模块又觉得略蛋疼。另外还想把这种预定义的变量（属性）改成方法：
.isInFrame()。cssmagic commentedon Jun 24, 2015
决定暂时删掉
_.url.isInFrame这个 API。Remove `_.url.isInFrame` API. See CMUI#56.