URL字符串解析

說明： 本模塊首批接口從API version 7開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。 開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導入模塊

import Url from '@ohos.url'

URLSearchParams

constructor

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

URLSearchParams的構造函數。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var objectParams = new Url.URLSearchParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]);
var objectParams1 = new Url.URLSearchParams({"fod" : 1 , "bard" : 2});
var objectParams2 = new Url.URLSearchParams('?fod=1&bard=2');
var urlObject = new Url.URL('https://developer.mozilla.org/?fod=1&bard=2');
var params = new Url.URLSearchParams(urlObject.search);

append

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

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

系統能力： SystemCapability.Utils.Lang

參數：

示例：

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

delete(name: string): void

刪除指定名稱的鍵值對。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

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

getAll(name: string): string[]

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

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

示例：

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); // Add a second value for the fod parameter.
console.log(params.getAll('fod')) // Output ["1","3"].

entries

entries(): IterableIterator<[string, string]>

返回一個ES6的迭代器，迭代器的每一項都是一個 JavaScript Array。Array的第一項是name，Array的第二項是value。

系統能力： SystemCapability.Utils.Lang

返回值：

示例：

var 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

forEach(callbackfn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void

通過回調函數來遍歷URLSearchParams實例對象上的鍵值對。

系統能力： SystemCapability.Utils.Lang

參數：

表1 callbackfn的參數說明

示例：

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

get(name: string): string | null

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

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

示例：

var paramsOject = new Url.URLSearchParams(document.location.search.substring(1)); 
var name = paramsOject.get("name"); // is the string "Jonathan" 
var age = parseInt(paramsOject.get("age"), 10); // is the number 18
var address = paramsOject.get("address"); // null

has

has(name: string): boolean

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

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

示例：

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

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

將與name關聯的URLSearchParams對象中的值設置為value。如果存在名稱為name的鍵值對，請將第一個鍵值對的值設置為value并刪除所有其他值。如果不是，則將鍵值對附加到查詢字符串。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

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

sort(): void

對包含在此對象中的所有鍵值對進行排序，并返回undefined。排序順序是根據鍵的Unicode代碼點。該方法使用穩定的排序算法 （即，將保留具有相等鍵的鍵值對之間的相對順序）。

系統能力： SystemCapability.Utils.Lang

示例：

var 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

keys(): IterableIterator

返回一個所有鍵值對的name的ES6迭代器。

系統能力： SystemCapability.Utils.Lang

返回值：

示例：

var 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

values(): IterableIterator

返回一個所有鍵值對的value的ES6迭代器。

系統能力： SystemCapability.Utils.Lang

返回值：

示例：

var 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。

系統能力： SystemCapability.Utils.Lang

返回值：

示例：

const paramsObject = new Url.URLSearchParams('fod=bay&edg=bap');
for (const [name, value] of paramsObject) { 
    console.log(name, value); 
}

tostring

toString(): string

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

系統能力： SystemCapability.Utils.Lang

返回值：

示例：

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

屬性

系統能力： 以下各項對應的系統能力均為SystemCapability.Utils.Lang

constructor

constructor(url: string, base?: string | URL)

URL的構造函數。

系統能力： SystemCapability.Utils.Lang

參數：

示例：

var mm = 'http://username:password@host:8080';
var a = new Url.URL("/", mm); // Output 'http://username:password@host:8080/';
var b = new Url.URL(mm); // Output 'http://username:password@host:8080/';
new Url.URL('path/path1', b); // Output 'http://username:password@host:8080/path/path1';
var c = new Url.URL('/path/path1', b);  // Output 'http://username:password@host:8080/path/path1'; 
new Url.URL('/path/path1', c); // Output 'http://username:password@host:8080/path/path1';
new Url.URL('/path/path1', a); // Output 'http://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('http://www.shanxi.com', ); // Output http://www.shanxi.com/
new Url.URL('http://www.shanxi.com', b); // Output http://www.shanxi.com/

tostring

toString(): string

將解析過后的URL轉化為字符串。

系統能力： SystemCapability.Utils.Lang

返回值：

示例：

const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da');
url.toString()

toJSON

toJSON(): string

將解析過后的URL轉化為JSON字符串。

系統能力： SystemCapability.Utils.Lang

返回值：

示例：

const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da');

審核編輯 黃宇