OpenHarmony语言基础类库【@ohos.url (URL字符串解析)】
说明:
导入模块
import Url from '@ohos.url'
URLParams9+
URLParams接口定义了一些处理URL查询字符串的实用方法。
constructor9+
constructor(init?: string[][] | Record | string | URLParams)
URLParams的构造函数。
系统能力:SystemCapability.Utils.Lang
参数:
参数名 |
必填 |
说明 |
|
---|---|---|---|
init |
string[][] |
Record |
string |
鸿蒙开发指导文档:[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 |
是 |
指定的键值名称。 |
返回值:
示例:
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
返回值:
示例:
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值,默认值是本对象。 |
表1callbackFn的参数说明
参数名 |
类型 |
必填 |
说明 |
---|---|---|---|
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 |
是 |
指定键值对的名称。 |
返回值:
示例:
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 |
是 |
要查找的参数的键名。 |
返回值:
示例:
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
返回一个所有键值对的name的ES6迭代器。
系统能力:SystemCapability.Utils.Lang
返回值:
示例:
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
返回一个所有键值对的value的ES6迭代器。
系统能力:SystemCapability.Utils.Lang
返回值:
示例:
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+
Symbol.iterator: IterableIterator<[string, string]>
返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
系统能力:SystemCapability.Utils.Lang
返回值:
示例:
const paramsObject = new Url.URLParams('fod=bay&edg=bap');for (const [name, value] of paramsObject[Symbol.iterator]()) {
console.log(name, value);
}
tostring9+
toString(): string
返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。
系统能力:SystemCapability.Utils.Lang
返回值:
示例:
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());
URL
用于解析、构造、规范、编码对应的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(deprecated) |
[URLSearchParams] |
是 |
否 |
获取URLSearchParams表示URL查询参数的对象。 -**说明:**此属性从API version 7开始支持,从API version 9开始被废弃。建议使用params9+替代。 |
params9+ |
[URLParams] |
是 |
否 |
获取URLParams表示URL查询参数的对象。 |
username |
string |
是 |
是 |
获取和设置URL的用户名部分。 |
示例:
let that = url.URL.parseURL('http://username:password@host:8080/directory/file?foo=1&bar=2#fragment');
console.log("hash " + that.hash) // hash #fragment
console.log("host " + that.host) // host host:8080
console.log("hostname " + that.hostname) // hostname host
console.log("href " + that.href) // href http://username:password@host:8080/directory/file?foo=1&bar=2#fragment
console.log("origin " + that.origin) // origin http://host:8080
console.log("password " + that.password) // password password
console.log("pathname " + that.pathname) // pathname /directory/file
console.log("port " + that.port) // port 8080
console.log("protocol " + that.protocol) // protocol http:
console.log("search " + that.search) // search ?foo=1&bar=2
console.log("username " + that.username) // username username
// that.params 返回值为URLParams对象
console.log("params: foo " + that.params.get("foo")) // params: foo 1
constructor(deprecated)
说明:
从API version 7开始支持,从API version 9开始废弃,建议使用[parseURL9+]替代。
constructor(url: string, base?: string | URL)
URL的构造函数。
系统能力:SystemCapability.Utils.Lang
参数:
参数名 |
类型 |
必填 |
说明 |
---|---|---|---|
url |
string |
是 |
入参对象。 |
base |
string |
URL |
否 |
示例:
let mm = 'https://username:password@host:8080';let a = new Url.URL("/", mm); // Output 'https://username:password@host:8080/';
let b = new Url.URL(mm); // Output 'https://username:password@host:8080/';
new Url.URL('path/path1', b); // Output 'https://username:password@host:8080/path/path1';
let c = new Url.URL('/path/path1', b); // Output 'https://username:password@host:8080/path/path1';
new Url.URL('/path/path1', c); // Output 'https://username:password@host:8080/path/path1';
new Url.URL('/path/path1', a); // Output 'https://username:password@host:8080/path/path1';
new Url.URL('/path/path1', "https://www.exampleUrl/fr-FR/toto"); // Output https://www.exampleUrl/path/path1
new Url.URL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL
new Url.URL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL
new Url.URL('https://www.example.com', ); // Output https://www.example.com/
new Url.URL('https://www.example.com', b); // Output https://www.example.com/
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 |
否 |
错误码:
以下错误码的详细介绍请参见[语言基础类库错误码]。
示例:
let mm = 'https://username:password@host:8080';
let url = Url.URL.parseURL(mm); let result = url.toString(); // Output 'https://username:password@host:8080/'
tostring
toString(): string
将解析过后的URL转化为字符串。
系统能力:SystemCapability.Utils.Lang
返回值:
示例:
const url = Url.URL.parseURL('https://username:password@host:8080/directory/file?query=pppppp#qwer=da');
let result = url.toString();
toJSON
toJSON(): string
将解析过后的URL转化为JSON字符串。
系统能力:SystemCapability.Utils.Lang
返回值:
示例:
const url = Url.URL.parseURL('https://username:password@host:8080/directory/file?query=pppppp#qwer=da');
let result = url.toJSON();
URLSearchParams(deprecated)
URLSearchParams接口定义了一些处理URL查询字符串的实用方法,从API version 9开始废弃,建议使用[URLParams]。
constructor(deprecated)
constructor(init?: string[][] | Record | string | URLSearchParams)
URLSearchParams的构造函数。
说明:
从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams.constructor9+]替代。
系统能力:SystemCapability.Utils.Lang
参数:
参数名 |
类型 |
必填 |
说明 |
---|---|---|---|
init |
string[][] |
Record |
string |
示例:
let objectParams = new Url.URLSearchParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]);let objectParams1 = new Url.URLSearchParams({"fod" : '1' , "bard" : '2'});let objectParams2 = new Url.URLSearchParams('?fod=1&bard=2');let urlObject = new Url.URL('https://developer.mozilla.org/?fod=1&bard=2');let params = new Url.URLSearchParams(urlObject.search);
append(deprecated)
append(name: string, value: string): void
将新的键值对插入到查询字符串。
说明:
从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams.append9+]替代。
系统能力: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.append('fod', '3');
delete(deprecated)
delete(name: string): void
删除指定名称的键值对。
说明:
从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams.delete9+]替代。
系统能力:SystemCapability.Utils.Lang
参数:
参数名 |
类型 |
必填 |
说明 |
---|---|---|---|
name |
string |
是 |
需要删除的键值名称。 |
示例:
let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsobject = new Url.URLSearchParams(urlObject.search.slice(1));
paramsobject.delete('fod');
getAll(deprecated)
getAll(name: string): string[]
获取指定名称的所有键值对。
说明:
从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams.getAll9+]替代。
系统能力:SystemCapability.Utils.Lang
参数:
参数名 |
类型 |
必填 |
说明 |
---|---|---|---|
name |
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
返回值:
示例:
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值,默认值是本对象。 |
表1callbackFn的参数说明
参数名 |
类型 |
必填 |
说明 |
---|---|---|---|
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 |
是 |
指定键值对的名称。 |
返回值:
示例:
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 |
是 |
要查找的参数的键名。 |
返回值:
示例:
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
将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对,请将第一个键值对的值设置为value并删除所有其他值。如果不是,则将键值对附加到查询字符串。
说明:
从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
对包含在此对象中的所有键值对进行排序,并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 (即,将保留具有相等键的键值对之间的相对顺序)。
说明:
从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
返回一个所有键值对的name的ES6迭代器。
说明:
从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams.keys9+]替代。
系统能力:SystemCapability.Utils.Lang
返回值:
示例:
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
返回一个所有键值对的value的ES6迭代器。
说明:
从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams.values9+]替代。
系统能力:SystemCapability.Utils.Lang
返回值:
示例:
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+]替代。
系统能力:SystemCapability.Utils.Lang
返回值:
示例:
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+]替代。
系统能力:SystemCapability.Utils.Lang
返回值:HarmonyOS与OpenHarmony鸿蒙文档籽料:mau123789是v直接拿
示例:
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());
审核编辑 黄宇
- URL
- 字符串
- 鸿蒙
- HarmonyOS
- OpenHarmony
评论
发布评论请先 登录