1# URL字符串解析 2 3>  **说明：** 4> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 5 6 7## 导入模块 8 9``` 10import Url from '@ohos.url' 11``` 12 13## URLSearchParams 14 15 16### constructor 17 18constructor(init?: string[][] | Record<string, string> | string | URLSearchParams) 19 20URLSearchParams的构造函数。 21 22**系统能力：** SystemCapability.Utils.Lang 23 24**参数：** 25 26| 参数名 | 类型 | 必填 | 说明 | 27| -------- | -------- | -------- | -------- | 28| init | string[][] \| Record<string, string> \| string \| URLSearchParams | 否 | 入参对象。<br/>- string[][]：字符串二维数组<br/>- Record<string, string>：对象列表<br/>- string：字符串<br/>- URLSearchParams：对象 | 29 30**示例：** 31 32```js 33let objectParams = new Url.URLSearchParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]); 34let objectParams1 = new Url.URLSearchParams({"fod" : '1' , "bard" : '2'}); 35let objectParams2 = new Url.URLSearchParams('?fod=1&bard=2'); 36let urlObject = new Url.URL('https://developer.mozilla.org/?fod=1&bard=2'); 37let params = new Url.URLSearchParams(urlObject.search); 38``` 39 40 41### append 42 43append(name: string, value: string): void 44 45将新的键值对插入到查询字符串。 46 47**系统能力：** SystemCapability.Utils.Lang 48 49**参数：** 50 51| 参数名 | 类型 | 必填 | 说明 | 52| -------- | -------- | -------- | -------- | 53| name | string | 是 | 需要插入搜索参数的键名。 | 54| value | string | 是 | 需要插入搜索参数的值。 | 55 56**示例：** 57 58```js 59let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); 60let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1)); 61paramsObject.append('fod', '3'); 62``` 63 64 65### delete 66 67delete(name: string): void 68 69删除指定名称的键值对。 70 71**系统能力：** SystemCapability.Utils.Lang 72 73**参数：** 74 75| 参数名 | 类型 | 必填 | 说明 | 76| -------- | -------- | -------- | -------- | 77| name | string | 是 | 需要删除的键值名称。 | 78 79**示例：** 80 81```js 82let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); 83let paramsobject = new Url.URLSearchParams(urlObject.search.slice(1)); 84paramsobject.delete('fod'); 85``` 86 87 88### getAll 89 90getAll(name: string): string[] 91 92获取指定名称的所有键值对。 93 94**系统能力：** SystemCapability.Utils.Lang 95 96**参数：** 97 98| 参数名 | 类型 | 必填 | 说明 | 99| -------- | -------- | -------- | -------- | 100| name | string | 是 | 指定的键值名称。 | 101 102**返回值：** 103 104| 类型 | 说明 | 105| -------- | -------- | 106| string[] | 返回指定名称的所有键值对。 | 107 108**示例：** 109 110```js 111let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); 112let params = new Url.URLSearchParams(urlObject.search.slice(1)); 113params.append('fod', '3'); // Add a second value for the fod parameter. 114console.log(params.getAll('fod').toString()) // Output ["1","3"]. 115``` 116 117 118### entries 119 120entries(): IterableIterator<[string, string]> 121 122返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。 123 124**系统能力：** SystemCapability.Utils.Lang 125 126**返回值：** 127 128| 类型 | 说明 | 129| -------- | -------- | 130| IterableIterator<[string, string]> | 返回一个ES6的迭代器。 | 131 132**示例：** 133 134```js 135let searchParamsObject = new Url.URLSearchParams("keyName1=valueName1&keyName2=valueName2"); 136for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pairs 137 console.log(pair[0]+ ', '+ pair[1]); 138} 139``` 140 141 142### forEach 143 144forEach(callbackfn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void 145 146通过回调函数来遍历URLSearchParams实例对象上的键值对。 147 148**系统能力：** SystemCapability.Utils.Lang 149 150**参数：** 151 152| 参数名 | 类型 | 必填 | 说明 | 153| -------- | -------- | -------- | -------- | 154| callbackfn | function | 是 | 回调函数。 | 155| thisArg | Object | 否 | callbackfn被调用时用作this值 | 156 157**表1** callbackfn的参数说明 158 159| 参数名 | 类型 | 必填 | 说明 | 160| -------- | -------- | -------- | -------- | 161| value | string | 是 | 当前遍历到的键值。 | 162| key | string | 是 | 当前遍历到的键名。 | 163| searchParams | Object | 是 | 当前调用forEach方法的实例对象。 | 164 165**示例：** 166 167```js 168const myURLObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); 169myURLObject.searchParams.forEach((value, name, searchParams) => { 170 console.log(name, value, myURLObject.searchParams === searchParams); 171}); 172``` 173 174 175### get 176 177get(name: string): string | null 178 179获取指定名称对应的第一个值。 180 181**系统能力：** SystemCapability.Utils.Lang 182 183**参数：** 184 185| 参数名 | 类型 | 必填 | 说明 | 186| -------- | -------- | -------- | -------- | 187| name | string | 是 | 指定键值对的名称。 | 188 189**返回值：** 190 191| 类型 | 说明 | 192| -------- | -------- | 193| string | 返回第一个值。 | 194| null | 如果没找到，返回 null。 | 195 196**示例：** 197 198```js 199let paramsObject = new Url.URLSearchParams('name=Jonathan&age=18'); 200let name = paramsObject.get("name"); // is the string "Jonathan" 201let age = parseInt(paramsObject.get("age"), 10); // is the number 18 202``` 203 204 205### has 206 207has(name: string): boolean 208 209判断一个指定的键名对应的值是否存在。 210 211**系统能力：** SystemCapability.Utils.Lang 212 213**参数：** 214 215| 参数名 | 类型 | 必填 | 说明 | 216| -------- | -------- | -------- | -------- | 217| name | string | 是 | 要查找的参数的键名。 | 218 219**返回值：** 220 221| 类型 | 说明 | 222| -------- | -------- | 223| boolean | 是否存在相对应的key值，存在返回true，否则返回false。 | 224 225**示例：** 226 227```js 228let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); 229let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1)); 230paramsObject.has('bard') === true; 231``` 232 233 234### set 235 236set(name: string, value: string): void 237 238将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对，请将第一个键值对的值设置为value并删除所有其他值。如果不是，则将键值对附加到查询字符串。 239 240**系统能力：** SystemCapability.Utils.Lang 241 242**参数：** 243 244| 参数名 | 类型 | 必填 | 说明 | 245| -------- | -------- | -------- | -------- | 246| name | string | 是 | 将要设置的参数的键值名。 | 247| value | string | 是 | 所要设置的参数值。 | 248 249**示例：** 250 251```js 252let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); 253let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1)); 254paramsObject.set('baz', '3'); // Add a third parameter. 255``` 256 257 258### sort 259 260sort(): void 261 262对包含在此对象中的所有键值对进行排序，并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 （即，将保留具有相等键的键值对之间的相对顺序）。 263 264**系统能力：** SystemCapability.Utils.Lang 265 266**示例：** 267 268```js 269let searchParamsObject = new Url.URLSearchParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object 270searchParamsObject.sort(); // Sort the key/value pairs 271console.log(searchParamsObject.toString()); // Display the sorted query string // Output a=9&b=2&c=3&d=4 272``` 273 274 275### keys 276 277keys(): IterableIterator<string> 278 279返回一个所有键值对的name的ES6迭代器。 280 281**系统能力：** SystemCapability.Utils.Lang 282 283**返回值：** 284 285| 类型 | 说明 | 286| -------- | -------- | 287| IterableIterator<string> | 返回一个所有键值对的name的ES6迭代器。 | 288 289**示例：** 290 291```js 292let searchParamsObject = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing 293for (var key of searchParamsObject .keys()) { // Output key-value pairs 294 console.log(key); 295} 296``` 297 298 299### values 300 301values(): IterableIterator<string> 302 303返回一个所有键值对的value的ES6迭代器。 304 305**系统能力：** SystemCapability.Utils.Lang 306 307**返回值：** 308 309| 类型 | 说明 | 310| -------- | -------- | 311| IterableIterator<string> | 返回一个所有键值对的value的ES6迭代器。 | 312 313**示例：** 314 315```js 316let searchParams = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing 317for (var value of searchParams.values()) { 318 console.log(value); 319} 320``` 321 322 323### [Symbol.iterator] 324 325[Symbol.iterator]\(): IterableIterator<[string, string]> 326 327返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。 328 329**系统能力：** SystemCapability.Utils.Lang 330 331**返回值：** 332 333| 类型 | 说明 | 334| -------- | -------- | 335| IterableIterator<[string, string]> | 返回一个ES6的迭代器。 | 336 337**示例：** 338 339```js 340const paramsObject = new Url.URLSearchParams('fod=bay&edg=bap'); 341for (const [name, value] of paramsObject) { 342 console.log(name, value); 343} 344``` 345 346 347### tostring 348 349toString(): string 350 351返回序列化为字符串的搜索参数，必要时对字符进行百分比编码。 352 353**系统能力：** SystemCapability.Utils.Lang 354 355**返回值：** 356 357| 类型 | 说明 | 358| -------- | -------- | 359| string | 返回序列化为字符串的搜索参数，必要时对字符进行百分比编码。 | 360 361**示例：** 362 363```js 364let url = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); 365let params = new Url.URLSearchParams(url.search.slice(1)); 366params.append('fod', '3'); 367console.log(params.toString()); 368``` 369 370 371## URL 372 373### 属性 374 375**系统能力：** 以下各项对应的系统能力均为SystemCapability.Utils.Lang 376 377| 名称 | 参数类型 | 可读 | 可写 | 说明 | 378| -------- | -------- | -------- | -------- | -------- | 379| hash | string | 是 | 是 | 获取和设置URL的片段部分。 | 380| host | string | 是 | 是 | 获取和设置URL的主机部分。 | 381| hostname | string | 是 | 是 | 获取和设置URL的主机名部分，不带端口。 | 382| href | string | 是 | 是 | 获取和设置序列化的URL。 | 383| origin | string | 是 | 否 | 获取URL源的只读序列化。 | 384| password | string | 是 | 是 | 获取和设置URL的密码部分。 | 385| pathname | string | 是 | 是 | 获取和设置URL的路径部分。 | 386| port | string | 是 | 是 | 获取和设置URL的端口部分。 | 387| protocol | string | 是 | 是 | 获取和设置URL的协议部分。 | 388| search | string | 是 | 是 | 获取和设置URL的序列化查询部分。 | 389| searchParams | URLsearchParams | 是 | 否 | 获取URLSearchParams表示URL查询参数的对象。 | 390| username | string | 是 | 是 | 获取和设置URL的用户名部分。 | 391 392 393### constructor 394 395constructor(url: string, base?: string | URL) 396 397URL的构造函数。 398 399**系统能力：** SystemCapability.Utils.Lang 400 401**参数：** 402 403| 参数名 | 类型 | 必填 | 说明 | 404| -------- | -------- | -------- | -------- | 405| url | string | 是 | 入参对象。 | 406| base | string \| URL | 否 | 入参字符串或者对象。<br/>- string：字符串<br/>- URL：字符串或对象 | 407 408**示例：** 409 410```js 411let mm = 'http://username:password@host:8080'; 412let a = new Url.URL("/", mm); // Output 'http://username:password@host:8080/'; 413let b = new Url.URL(mm); // Output 'http://username:password@host:8080/'; 414new Url.URL('path/path1', b); // Output 'http://username:password@host:8080/path/path1'; 415let c = new Url.URL('/path/path1', b); // Output 'http://username:password@host:8080/path/path1'; 416new Url.URL('/path/path1', c); // Output 'http://username:password@host:8080/path/path1'; 417new Url.URL('/path/path1', a); // Output 'http://username:password@host:8080/path/path1'; 418new Url.URL('/path/path1', "https://www.exampleUrl/fr-FR/toto"); // Output https://www.exampleUrl/path/path1 419new Url.URL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL 420new Url.URL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL 421new Url.URL('http://www.shanxi.com', ); // Output http://www.shanxi.com/ 422new Url.URL('http://www.shanxi.com', b); // Output http://www.shanxi.com/ 423``` 424 425 426### tostring 427 428toString(): string 429 430将解析过后的URL转化为字符串。 431 432**系统能力：** SystemCapability.Utils.Lang 433 434**返回值：** 435 436| 类型 | 说明 | 437| -------- | -------- | 438| string | 用于返回网址的字符串序列化。 | 439 440**示例：** 441 442```js 443const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da'); 444url.toString(); 445``` 446 447 448### toJSON 449 450toJSON(): string 451 452将解析过后的URL转化为JSON字符串。 453 454**系统能力：** SystemCapability.Utils.Lang 455 456**返回值：** 457 458| 类型 | 说明 | 459| -------- | -------- | 460| string | 用于返回网址的字符串序列化。 | 461 462**示例：** 463```js 464const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da'); 465url.toJSON(); 466``` 467
