
HarmonyOS API:@ohos.url (URL字符串解析)
版本:v3.1 Beta
@ohos.url (URL字符串解析)
更新时间: 2023-02-17 09:19
说明
本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
导入模块
URLParams9+
constructor9+
constructor(init?: string[][] | Record<string, string> | string | URLSearchParams)
URLParams的构造函数。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
init | string[][] | Record<string, string> | string | URLSearchParams | 否 | 入参对象。 - string[][]:字符串二维数组 - Record<string, string>:对象列表 - string:字符串 - URLSearchParams:对象 |
示例:
append9+
append(name: string, value: string): void
将新的键值对插入到查询字符串。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 需要插入搜索参数的键名。 |
value | string | 是 | 需要插入搜索参数的值。 |
示例:
delete9+
delete(name: string): void
删除指定名称的键值对。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 需要删除的键值名称。 |
示例:
getAll9+
getAll(name: string): string[]
获取指定名称的所有键对应值的集合。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 指定的键值名称。 |
返回值:
类型 | 说明 |
string[] | 返回指定名称的所有键对应值的集合。 |
示例:
entries9+
entries(): IterableIterator<[string, string]>
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
IterableIterator<[string, string]> | 返回一个ES6的迭代器。 |
示例:
forEach9+
forEach(callbackFn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void
通过回调函数来遍历URLSearchParams实例对象上的键值对。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
callbackFn | function | 是 | 回调函数。 |
thisArg | Object | 否 | callbackFn被调用时用作this值 |
表1 callbackFn的参数说明
参数名 | 类型 | 必填 | 说明 |
value | string | 是 | 当前遍历到的键值。 |
key | string | 是 | 当前遍历到的键名。 |
searchParams | Object | 是 | 当前调用forEach方法的实例对象。 |
示例:
get9+
get(name: string): string | null
获取指定名称对应的第一个值。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 指定键值对的名称。 |
返回值:
类型 | 说明 |
string | 返回第一个值。 |
null | 如果没找到,返回 null。 |
示例:
has9+
has(name: string): boolean
判断一个指定的键名对应的值是否存在。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 要查找的参数的键名。 |
返回值:
类型 | 说明 |
boolean | 是否存在相对应的key值,存在返回true,否则返回false。 |
示例:
set9+
set(name: string, value: string): void
将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对,请将第一个键值对的值设置为value并删除所有其他值。如果不是,则将键值对附加到查询字符串。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 将要设置的参数的键值名。 |
value | string | 是 | 所要设置的参数值。 |
示例:
sort9+
sort(): void
对包含在此对象中的所有键值对进行排序,并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 (即,将保留具有相等键的键值对之间的相对顺序)。
系统能力: SystemCapability.Utils.Lang
示例:
keys9+
keys(): IterableIterator<string>
返回一个所有键值对的name的ES6迭代器。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
IterableIterator<string> | 返回一个所有键值对的name的ES6迭代器。 |
示例:
values9+
values(): IterableIterator<string>
返回一个所有键值对的value的ES6迭代器。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
IterableIterator<string> | 返回一个所有键值对的value的ES6迭代器。 |
示例:
[Symbol.iterator]9+
[Symbol.iterator](): IterableIterator<[string, string]>
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
IterableIterator<[string, string]> | 返回一个ES6的迭代器。 |
示例:
tostring9+
toString(): string
返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
string | 返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。 |
示例:
URL
属性
系统能力: SystemCapability.Utils.Lang
名称 | 类型 | 可读 | 可写 | 说明 |
hash | string | 是 | 是 | 获取和设置URL的片段部分。 |
host | string | 是 | 是 | 获取和设置URL的主机部分。 |
hostname | string | 是 | 是 | 获取和设置URL的主机名部分,不带端口。 |
href | string | 是 | 是 | 获取和设置序列化的URL。 |
origin | string | 是 | 否 | 获取URL源的只读序列化。 |
password | string | 是 | 是 | 获取和设置URL的密码部分。 |
pathname | string | 是 | 是 | 获取和设置URL的路径部分。 |
port | string | 是 | 是 | 获取和设置URL的端口部分。 |
protocol | string | 是 | 是 | 获取和设置URL的协议部分。 |
search | string | 是 | 是 | 获取和设置URL的序列化查询部分。 |
searchParams | URLSearchParams | 是 | 否 | 获取URLSearchParams表示URL查询参数的对象。 |
username | string | 是 | 是 | 获取和设置URL的用户名部分。 |
constructor(deprecated)
说明
从API version 7开始支持,从API version 9开始废弃,建议使用parseURL9+替代。
constructor(url: string, base?: string | URL)
URL的构造函数。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
url | string | 是 | 入参对象。 |
base | string | URL | 否 | 入参字符串或者对象。 - string:字符串 - URL:字符串或对象 |
示例:
constructor9+
constructor()
URL的无参构造函数。parseURL调用后返回一个URL对象,不单独使用。
系统能力: SystemCapability.Utils.Lang
parseURL9+
static parseURL(url : string, base?: string | URL): URL
URL静态成员函数。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
url | string | 是 | 入参对象。 |
base | string | URL | 否 | 入参字符串或者对象。 - string:字符串 - URL:字符串或对象 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
10200002 | Invalid url string. |
示例:
tostring
toString(): string
将解析过后的URL转化为字符串。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
string | 用于返回网址的字符串序列化。 |
示例:
toJSON
toJSON(): string
将解析过后的URL转化为JSON字符串。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
string | 用于返回网址的字符串序列化。 |
示例:
URLSearchParams(deprecated)
constructor(deprecated)
constructor(init?: string[][] | Record<string, string> | string | URLSearchParams)
URLSearchParams的构造函数。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.constructor9+替代。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
init | string[][] | Record<string, string> | string | URLSearchParams | 否 | 入参对象。 - string[][]:字符串二维数组 - Record<string, string>:对象列表 - string:字符串 - URLSearchParams:对象 |
示例:
append(deprecated)
append(name: string, value: string): void
将新的键值对插入到查询字符串。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.append9+替代。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 需要插入搜索参数的键名。 |
value | string | 是 | 需要插入搜索参数的值。 |
示例:
delete(deprecated)
delete(name: string): void
删除指定名称的键值对。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.delete9+替代。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 需要删除的键值名称。 |
示例:
getAll(deprecated)
getAll(name: string): string[]
获取指定名称的所有键值对。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.getAll9+替代。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 指定的键值名称。 |
返回值:
类型 | 说明 |
string[] | 返回指定名称的所有键值对。 |
示例:
entries(deprecated)
entries(): IterableIterator<[string, string]>
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.entries9+替代。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
IterableIterator<[string, string]> | 返回一个ES6的迭代器。 |
示例:
forEach(deprecated)
forEach(callbackFn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void
通过回调函数来遍历URLSearchParams实例对象上的键值对。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.forEach9+替代。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
callbackFn | function | 是 | 回调函数。 |
thisArg | Object | 否 | callbackFn被调用时用作this值 |
表1 callbackFn的参数说明
参数名 | 类型 | 必填 | 说明 |
value | string | 是 | 当前遍历到的键值。 |
key | string | 是 | 当前遍历到的键名。 |
searchParams | Object | 是 | 当前调用forEach方法的实例对象。 |
示例:
get(deprecated)
get(name: string): string | null
获取指定名称对应的第一个值。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.get9+替代。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 指定键值对的名称。 |
返回值:
类型 | 说明 |
string | 返回第一个值。 |
null | 如果没找到,返回 null。 |
示例:
has(deprecated)
has(name: string): boolean
判断一个指定的键名对应的值是否存在。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.has9+替代。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 要查找的参数的键名。 |
返回值:
类型 | 说明 |
boolean | 是否存在相对应的key值,存在返回true,否则返回false。 |
示例:
set(deprecated)
set(name: string, value: string): void
将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对,请将第一个键值对的值设置为value并删除所有其他值。如果不是,则将键值对附加到查询字符串。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.set9+替代。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
name | string | 是 | 将要设置的参数的键值名。 |
value | string | 是 | 所要设置的参数值。 |
示例:
sort(deprecated)
sort(): void
对包含在此对象中的所有键值对进行排序,并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 (即,将保留具有相等键的键值对之间的相对顺序)。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.sort9+替代。
系统能力: SystemCapability.Utils.Lang
示例:
keys(deprecated)
keys(): IterableIterator<string>
返回一个所有键值对的name的ES6迭代器。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.keys9+替代。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
IterableIterator<string> | 返回一个所有键值对的name的ES6迭代器。 |
示例:
values(deprecated)
values(): IterableIterator<string>
返回一个所有键值对的value的ES6迭代器。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.values9+替代。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
IterableIterator<string> | 返回一个所有键值对的value的ES6迭代器。 |
示例:
[Symbol.iterator](deprecated)
[Symbol.iterator](): IterableIterator<[string, string]>
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.[Symbol.iterator]9+替代。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
IterableIterator<[string, string]> | 返回一个ES6的迭代器。 |
示例:
tostring(deprecated)
toString(): string
返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。
说明
从API version 7开始支持,从API version 9开始废弃,建议使用URLParams.tostring9+替代。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
string | 返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。 |
示例:
