OpenHarmony語言基礎類庫【@ohos.url (URL字符串解析)】

說明：

本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

import Url from '@ohos.url'

URLParams9+

URLParams接口定義了一些處理URL查詢字符串的實用方法。

constructor9+

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

URLParams的構(gòu)造函數(shù)。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

鴻蒙開發(fā)指導文檔：[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

將新的鍵值對插入到查詢字符串。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

示例：

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

刪除指定名稱的鍵值對。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

示例：

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[]

獲取指定名稱的所有鍵對應值的集合。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

示例：

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。

系統(tǒng)能力： 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

通過回調(diào)函數(shù)來遍歷URLSearchParams實例對象上的鍵值對。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

表1 callbackFn的參數(shù)說明

示例：

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

獲取指定名稱對應的第一個值。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

示例：

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

判斷一個指定的鍵名對應的值是否存在。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

示例：

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關聯(lián)的URLSearchParams對象中的值設置為value。如果存在名稱為name的鍵值對，請將第一個鍵值對的值設置為value并刪除所有其他值。如果不是，則將鍵值對附加到查詢字符串。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

示例：

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。排序順序是根據(jù)鍵的Unicode代碼點。該方法使用穩(wěn)定的排序算法 （即，將保留具有相等鍵的鍵值對之間的相對順序）。

系統(tǒng)能力： 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迭代器。

系統(tǒng)能力： 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迭代器。

系統(tǒng)能力： 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。

系統(tǒng)能力： 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

返回序列化為字符串的搜索參數(shù)，必要時對字符進行百分比編碼。

系統(tǒng)能力： 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

用于解析、構(gòu)造、規(guī)范、編碼對應的URL字符串。

屬性

系統(tǒng)能力： SystemCapability.Utils.Lang

示例：

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的構(gòu)造函數(shù)。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

示例：

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的無參構(gòu)造函數(shù)。parseURL調(diào)用后返回一個URL對象，不單獨使用。

系統(tǒng)能力： SystemCapability.Utils.Lang

parseURL9+

static parseURL(url: string, base?: string | URL): URL

URL靜態(tài)成員函數(shù)。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

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轉(zhuǎn)化為字符串。

系統(tǒng)能力： 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轉(zhuǎn)化為JSON字符串。

系統(tǒng)能力： 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的構(gòu)造函數(shù)。

說明：

從API version 7開始支持，從API version 9開始廢棄，建議使用[URLParams.constructor9+]替代。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

示例：

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+]替代。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

示例：

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+]替代。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

示例：

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+]替代。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

示例：

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+]替代。

系統(tǒng)能力： 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

通過回調(diào)函數(shù)來遍歷URLSearchParams實例對象上的鍵值對。

說明：

從API version 7開始支持，從API version 9開始廢棄，建議使用[URLParams.forEach9+]替代。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

表1 callbackFn的參數(shù)說明

示例：

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+]替代。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

示例：

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+]替代。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

示例：

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關聯(lián)的URLSearchParams對象中的值設置為value。如果存在名稱為name的鍵值對，請將第一個鍵值對的值設置為value并刪除所有其他值。如果不是，則將鍵值對附加到查詢字符串。

說明：

從API version 7開始支持，從API version 9開始廢棄，建議使用[URLParams.set9+]替代。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

示例：

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。排序順序是根據(jù)鍵的Unicode代碼點。該方法使用穩(wěn)定的排序算法 （即，將保留具有相等鍵的鍵值對之間的相對順序）。

說明：

從API version 7開始支持，從API version 9開始廢棄，建議使用[URLParams.sort9+]替代。

系統(tǒng)能力： 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+]替代。

系統(tǒng)能力： 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+]替代。

系統(tǒng)能力： 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+]替代。

系統(tǒng)能力： 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

返回序列化為字符串的搜索參數(shù)，必要時對字符進行百分比編碼。

說明：

從API version 7開始支持，從API version 9開始廢棄，建議使用[URLParams.tostring9+]替代。

系統(tǒng)能力： 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());

審核編輯 黃宇