OpenHarmony语言基础类库【@ohos.url (URL字符串解析)】

说明：

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

复制代码

import Url from '@ohos.url'

URLParams9+

URLParams接口定义了一些处理URL查询字符串的实用方法。

constructor9+

constructor(init?: string[][] | Record<string, string> | string | URLParams)

URLParams的构造函数。

系统能力： SystemCapability.Utils.Lang

参数：

| 参数名 | 类型 HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿 | 必填 | 说明 |
|------|-----------------------------------------------|--------------------------|--------|-----------|---|--------------------------------------------------------------------------------------------------------|
| init | string[][] | Record<string, string> | string | URLParams | 否 | 入参对象。 - string[][]：字符串二维数组 - Record<string, string>：对象列表 - string：字符串 - URLParams：对象 - 默认值：null。 |

鸿蒙开发指导文档：gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md点击或者复制转到。

示例：

复制代码

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);

append9+

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');

delete9+

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');

getAll9+

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"].

entries9+

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]);
}

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方法的实例对象。

示例：

复制代码

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);
});

get9+

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

has9+

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');

set9+

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.

sort9+

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

keys9+

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);
}

values9+

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]9+

获取指定名称的所有键值对。

说明：

从API version 7开始支持，从API version 9开始废弃，建议使用URLParams.getAll9+替代。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
name	string	是	指定的键值名称。

返回值：

类型	说明
string[]	返回指定名称的所有键值对。

示例：

复制代码

let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let params = new Url.URLSearchParams(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(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的迭代器。

示例：

复制代码

let searchParamsObject = new Url.URLSearchParams("keyName1=valueName1&keyName2=valueName2"); 
for (var pair of searchParamsObject.entries()) { // Show keyName/valueName pairs
    console.log(pair[0]+ ', '+ pair[1]);
}

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方法的实例对象。

示例：

复制代码

const myURLObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); 
myURLObject.searchParams.forEach((value, name, searchParams) => {  
    console.log(name, value, myURLObject.searchParams === searchParams);
});

get(deprecated)

get(name: string): string | null

获取指定名称对应的第一个值。

说明：

从API version 7开始支持，从API version 9开始废弃，建议使用URLParams.get9+替代。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
name	string	是	指定键值对的名称。

返回值：

类型	说明
string	返回第一个值。
null	如果没找到，返回 null。

示例：

复制代码

let paramsObject = new Url.URLSearchParams('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(deprecated)

has(name: string): boolean

判断一个指定的键名对应的值是否存在。

说明：

从API version 7开始支持，从API version 9开始废弃，建议使用URLParams.has9+替代。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
name	string	是	要查找的参数的键名。

返回值：

类型	说明
boolean	是否存在相对应的key值，存在返回true，否则返回false。

示例：

复制代码

let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1)); 
paramsObject.has('bard') === true;

set(deprecated)

set(name: string, value: string): void

说明：

从API version 7开始支持，从API version 9开始废弃，建议使用URLParams.set9+替代。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
name	string	是	将要设置的参数的键值名。
value	string	是	所要设置的参数值。

示例：

复制代码

let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1));
paramsObject.set('baz', '3'); // Add a third parameter.

sort(deprecated)

sort(): void

说明：

从API version 7开始支持，从API version 9开始废弃，建议使用URLParams.sort9+替代。

系统能力： SystemCapability.Utils.Lang

示例：

复制代码

let searchParamsObject = new Url.URLSearchParams("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(deprecated)

keys(): IterableIterator<string>

返回一个所有键值对的name的ES6迭代器。

说明：

从API version 7开始支持，从API version 9开始废弃，建议使用URLParams.keys9+替代。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
IterableIterator<string>	返回一个所有键值对的name的ES6迭代器。

示例：

复制代码

let searchParamsObject = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
for (var key of searchParamsObject .keys()) { // Output key-value pairs
    console.log(key);
}

values(deprecated)

values(): IterableIterator<string>

返回一个所有键值对的value的ES6迭代器。

说明：

从API version 7开始支持，从API version 9开始废弃，建议使用URLParams.values9+替代。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
IterableIterator<string>	返回一个所有键值对的value的ES6迭代器。

示例：

复制代码

let searchParams = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
for (var value of searchParams.values()) {
    console.log(value);
}

Symbol.iterator

Symbol.iterator\](): IterableIterator\<\[string, string\]\> 返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。 > **说明：** > > 从API version 7开始支持，从API version 9开始废弃，建议使用\[URLParams.\[Symbol.iterator\]9+\]([README.md · 李时珍的皮/Harmony OS - Gitee.com](https://gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md "README.md · 李时珍的皮/Harmony OS - Gitee.com"))替代。 **系统能力：** SystemCapability.Utils.Lang **返回值：** | 类型 | 说明 | |----------------------------------------|--------------| | IterableIterator\<\[string, string\]\> | 返回一个ES6的迭代器。 | **示例：** const paramsObject = new Url.URLSearchParams('fod=bay&edg=bap'); for (const [name, value] of paramsObject) { console.log(name, value); } #### tostring(deprecated) toString(): string 返回序列化为字符串的搜索参数，必要时对字符进行百分比编码。 > **说明：** > > 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams.tostring9+](https://gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md "URLParams.tostring9+")替代。 **系统能力：** SystemCapability.Utils.Lang **返回值：** `HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿` | 类型 | 说明 | |--------|-------------------------------| | string | 返回序列化为字符串的搜索参数，必要时对字符进行百分比编码。 | **示例：** let url = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); let params = new Url.URLSearchParams(url.search.slice(1)); params.append('fod', '3'); console.log(params.toString()); ## 鸿蒙Next核心技术分享 ### 1、鸿蒙基础知识←[《鸿蒙NEXT星河版开发学习文档》](https://docs.qq.com/doc/DUlNzQU5CV1JmUGlG "《鸿蒙NEXT星河版开发学习文档》") ![](https://file.jishuzhan.net/article/1784464320818581505/1d2aa7ea03466c25d35f29cb9c0d7b08.webp) ### 2、鸿蒙ArkUI←[《鸿蒙NEXT星河版开发学习文档》](https://docs.qq.com/doc/DUlNzQU5CV1JmUGlG "《鸿蒙NEXT星河版开发学习文档》") ### ![](https://file.jishuzhan.net/article/1784464320818581505/c2d3841c09109a882bd488536d020838.webp) ### 3、鸿蒙进阶技术←[《鸿蒙NEXT星河版开发学习文档》](https://docs.qq.com/doc/DUlNzQU5CV1JmUGlG "《鸿蒙NEXT星河版开发学习文档》") ### ![](https://file.jishuzhan.net/article/1784464320818581505/5966f527623bf208b2a6020d1ea58ea2.webp) ### 4、鸿蒙就业高级技能←[《鸿蒙NEXT星河版开发学习文档》](https://docs.qq.com/doc/DUlNzQU5CV1JmUGlG "《鸿蒙NEXT星河版开发学习文档》") ![](https://file.jishuzhan.net/article/1784464320818581505/bac18a163bccd726e496e333f4e93583.webp) ### 5、鸿蒙多媒体技术←[《鸿蒙NEXT星河版开发学习文档》](https://docs.qq.com/doc/DUlNzQU5CV1JmUGlG "《鸿蒙NEXT星河版开发学习文档》") ![](https://file.jishuzhan.net/article/1784464320818581505/16e5ec25bf5c306b062cdc2eb3a20a73.webp) ### 6、鸿蒙南向驱动开发←[《鸿蒙NEXT星河版开发学习文档》](https://docs.qq.com/doc/DUlNzQU5CV1JmUGlG "《鸿蒙NEXT星河版开发学习文档》") ![](https://file.jishuzhan.net/article/1784464320818581505/47bbbd9d10860d321d66009dc2a58508.webp) ### 7、鸿蒙南向内核设备开发←[《鸿蒙NEXT星河版开发学习文档》](https://docs.qq.com/doc/DUlNzQU5CV1JmUGlG "《鸿蒙NEXT星河版开发学习文档》") ![](https://file.jishuzhan.net/article/1784464320818581505/e05fd06ec46f202f4602b8e87e9af129.webp) ### 8、鸿蒙系统裁剪与移植←[《鸿蒙NEXT星河版开发学习文档》](https://docs.qq.com/doc/DUlNzQU5CV1JmUGlG "《鸿蒙NEXT星河版开发学习文档》") ![](https://file.jishuzhan.net/article/1784464320818581505/5b0ea7565a22af4cce9107610df9d2f0.webp)