说明:
本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
import Url from '@ohos.url'
constructor(init?: string[][] | Record<string, string> | string | URLParams)
URLParams的构造函数。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
init | string[][] | Record<string, string> | string | URLParams | 否 | 入参对象。 - string[][]:字符串二维数组 - Record<string, string>:对象列表 - string:字符串 - URLParams:对象 - 默认值:null。 |
示例:
let objectParams = new Url.URLParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]);
let objectParams1 = new Url.URLParams({"fod" : '1' , "bard" : '2'});
let objectParams2 = new Url.URLParams('?fod=1&bard=2');
let urlObject = Url.URL.parseURL('https://developer.mozilla.org/?fod=1&bard=2');
let params = new Url.URLParams(urlObject.search);
append(name: string, value: string): void
将新的键值对插入到查询字符串。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 需要插入搜索参数的键名。 |
value | string | 是 | 需要插入搜索参数的值。 |
示例:
let urlObject = Url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new Url.URLParams(urlObject.search.slice(1));
paramsObject.append('fod', '3');
delete(name: string): void
删除指定名称的键值对。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 需要删除的键值名称。 |
示例:
let urlObject = Url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new Url.URLParams(urlObject.search.slice(1));
paramsObject.delete('fod');
getAll(name: string): string[]
获取指定名称的所有键对应值的集合。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 指定的键值名称。 |
返回值:
类型 | 说明 |
---|---|
string[] | 返回指定名称的所有键对应值的集合。 |
示例:
let urlObject = Url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let params = new Url.URLParams(urlObject.search.slice(1));
params.append('fod', '3'); // Add a second value for the fod parameter.
console.log(params.getAll('fod').toString()) // Output ["1","3"].
entries(): IterableIterator<[string, string]>
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
IterableIterator<[string, string]> | 返回一个ES6的迭代器。 |
示例:
let searchParamsObject = new Url.URLParams("keyName1=valueName1&keyName2=valueName2");
for (var pair of searchParamsObject.entries()) { // Show keyName/valueName pairs
console.log(pair[0]+ ', '+ pair[1]);
}
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方法的实例对象。 |
示例:
const myURLObject = Url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
myURLObject.params.forEach((value, name, searchParams) => {
console.log(name, value, myURLObject.params === searchParams);
});
get(name: string): string | null
获取指定名称对应的第一个值。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 指定键值对的名称。 |
返回值:
类型 | 说明 |
---|---|
string | 返回第一个值。 |
null | 如果没找到,返回 null。 |
示例:
let paramsObject = new Url.URLParams('name=Jonathan&age=18');
let name = paramsObject.get("name"); // is the string "Jonathan"
let age = parseInt(paramsObject.get("age"), 10); // is the number 18
has(name: string): boolean
判断一个指定的键名对应的值是否存在。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 要查找的参数的键名。 |
返回值:
类型 | 说明 |
---|---|
boolean | 是否存在相对应的key值,存在返回true,否则返回false。 |
示例:
let urlObject = Url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new Url.URLParams(urlObject.search.slice(1));
let result = paramsObject.has('bard');
set(name: string, value: string): void
将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对,请将第一个键值对的值设置为value并删除所有其他值。如果不是,则将键值对附加到查询字符串。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 将要设置的参数的键值名。 |
value | string | 是 | 所要设置的参数值。 |
示例:
let urlObject = Url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new Url.URLParams(urlObject.search.slice(1));
paramsObject.set('baz', '3'); // Add a third parameter.
sort(): void
对包含在此对象中的所有键值对进行排序,并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 (即,将保留具有相等键的键值对之间的相对顺序)。
系统能力: SystemCapability.Utils.Lang
示例:
let searchParamsObject = new Url.URLParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object
searchParamsObject.sort(); // Sort the key/value pairs
console.log(searchParamsObject.toString()); // Display the sorted query string // Output a=9&b=2&c=3&d=4
keys(): IterableIterator<string>
返回一个所有键值对的name的ES6迭代器。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
IterableIterator<string> | 返回一个所有键值对的name的ES6迭代器。 |
示例:
let searchParamsObject = new Url.URLParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
for (var key of searchParamsObject .keys()) { // Output key-value pairs
console.log(key);
}
values(): IterableIterator<string>
返回一个所有键值对的value的ES6迭代器。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
IterableIterator<string> | 返回一个所有键值对的value的ES6迭代器。 |
示例:
let searchParams = new Url.URLParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
for (var value of searchParams.values()) {
console.log(value);
}
[Symbol.iterator](): IterableIterator<[string, string]>
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
IterableIterator<[string, string]> | 返回一个ES6的迭代器。 |
示例:
const paramsObject = new Url.URLParams('fod=bay&edg=bap');
for (const [name, value] of paramsObject[Symbol.iterator]()) {
console.log(name, value);
}
toString(): string
返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
string | 返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。 |
示例:
let url = Url.URL.parseURL('https://developer.exampleUrl/?fod=1&bard=2');
let params = new Url.URLParams(url.search.slice(1));
params.append('fod', '3');
console.log(params.toString());
系统能力: 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的序列化查询部分。 |
params9+ | URLParams | 是 | 否 | 获取URLParams表示URL查询参数的对象。 |
username | string | 是 | 是 | 获取和设置URL的用户名部分。 |
constructor()
URL的无参构造函数。parseURL调用后返回一个URL对象,不单独使用。
系统能力: SystemCapability.Utils.Lang
static parseURL(url : string, base?: string | URL): URL
URL静态成员函数。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 是 | 入参对象。 |
base | string | URL | 否 | 入参字符串或者对象。 - string:字符串 - URL:字符串或对象 - 默认值是空字符串或空对象。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200002 | Invalid url string. |
示例:
let mm = 'https://username:password@host:8080';
let url = Url.URL.parseURL(mm);
let result = url.toString(); // Output 'https://username:password@host:8080/'
toString(): string
将解析过后的URL转化为字符串。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
string | 用于返回网址的字符串序列化。 |
示例:
const url = Url.URL.parseURL('https://username:password@host:8080/directory/file?query=pppppp#qwer=da');
let result = url.toString();
toJSON(): string
将解析过后的URL转化为JSON字符串。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
string | 用于返回网址的字符串序列化。 |
示例:
const url = Url.URL.parseURL('https://username:password@host:8080/directory/file?query=pppppp#qwer=da');
let result = url.toJSON();
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。