js-apis-url.md 25.1 KB
Newer Older
1
# @ohos.url (URL字符串解析)
Z
zengyawen 已提交
2

3 4
> **说明:**
>
Z
zengyawen 已提交
5
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
6

Z
zengyawen 已提交
7
## 导入模块
Z
zengyawen 已提交
8 9 10 11

```
import Url from '@ohos.url' 
```
12
## URLParams<sup>9+</sup>
Z
zengyawen 已提交
13

Z
zengyawen 已提交
14

15
### constructor<sup>9+</sup>
Z
zengyawen 已提交
16

17
constructor(init?: string[][] | Record&lt;string, string&gt; | string | URLSearchParams)
18 19 20 21 22 23 24 25 26

URLParams的构造函数。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
27
| init | string[][] \| Record&lt;string, string&gt; \| string \| URLSearchParams | 否 | 入参对象。<br/>- string[][]:字符串二维数组<br/>- Record&lt;string, string&gt;:对象列表<br/>- string:字符串<br/>- URLSearchParams:对象 |
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142

**示例:**

```js
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 = new Url.URL('https://developer.mozilla.org/?fod=1&bard=2');
let params = new Url.URLParams(urlObject.search);
```


### append<sup>9+</sup>

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

将新的键值对插入到查询字符串。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 需要插入搜索参数的键名。 |
| value | string | 是 | 需要插入搜索参数的值。 |

**示例:**

```js
let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new Url.URLParams(urlObject.search.slice(1));
paramsObject.append('fod', '3');
```


### delete<sup>9+</sup>

delete(name: string): void

删除指定名称的键值对。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 需要删除的键值名称。 |

**示例:**

```js
let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsobject = new Url.URLParams(urlObject.search.slice(1));
paramsobject.delete('fod');
```


### getAll<sup>9+</sup>

getAll(name: string): string[]

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

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

**返回值:**

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

**示例:**

```js
let urlObject = new Url.URL('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"].
```


### entries<sup>9+</sup>

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

返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。

**系统能力:** SystemCapability.Utils.Lang

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| IterableIterator&lt;[string, string]&gt; | 返回一个ES6的迭代器。 |

**示例:**

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


### forEach<sup>9+</sup>

143
forEach(callbackFn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void
144 145 146 147 148 149 150 151 152

通过回调函数来遍历URLSearchParams实例对象上的键值对。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
153 154
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackFn被调用时用作this值 |
155

156
**表1** callbackFn的参数说明
157 158 159 160 161 162 163 164 165 166 167

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | string | 是 | 当前遍历到的键值。 |
| key | string | 是 | 当前遍历到的键名。 |
| searchParams | Object | 是 | 当前调用forEach方法的实例对象。 |

**示例:**

```js
const myURLObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); 
小马奔腾 已提交
168
myURLObject.searchParams.forEach((value, name, searchParams) => {  
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
    console.log(name, value, myURLObject.searchParams === searchParams);
});
```


### get<sup>9+</sup>

get(name: string): string | null

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

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

**返回值:**

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

**示例:**

```js
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
```


### has<sup>9+</sup>

has(name: string): boolean

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

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

**返回值:**

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

**示例:**

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


### set<sup>9+</sup>

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

将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对,请将第一个键值对的值设置为value并删除所有其他值。如果不是,则将键值对附加到查询字符串。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

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

**示例:**

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


### sort<sup>9+</sup>

sort(): void

对包含在此对象中的所有键值对进行排序,并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 (即,将保留具有相等键的键值对之间的相对顺序)。

**系统能力:** SystemCapability.Utils.Lang

**示例:**

```js
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
```


### keys<sup>9+</sup>

keys(): IterableIterator&lt;string&gt;

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

**系统能力:** SystemCapability.Utils.Lang

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| IterableIterator&lt;string&gt; | 返回一个所有键值对的name的ES6迭代器。 |

**示例:**

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


### values<sup>9+</sup>

values(): IterableIterator&lt;string&gt;

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

**系统能力:** SystemCapability.Utils.Lang

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| IterableIterator&lt;string&gt; | 返回一个所有键值对的value的ES6迭代器。 |

**示例:**

```js
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]<sup>9+</sup>

[Symbol.iterator]\(): IterableIterator&lt;[string, string]&gt;

返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。

**系统能力:** SystemCapability.Utils.Lang

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| IterableIterator&lt;[string, string]&gt; | 返回一个ES6的迭代器。 |

**示例:**

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


### tostring<sup>9+</sup>

toString(): string

返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。

**系统能力:** SystemCapability.Utils.Lang

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| string | 返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。 |

**示例:**

```js
let url = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let params = new Url.URLParams(url.search.slice(1)); 
params.append('fod', '3');
console.log(params.toString());
```

## URLSearchParams<sup>(deprecated)</sup>

### constructor<sup>(deprecated)</sup>

373 374 375
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>](#constructor9+)替代。
Z
zengyawen 已提交
376

Z
zengyawen 已提交
377
constructor(init?: string[][] | Record&lt;string, string&gt; | string | URLSearchParams)
Z
zengyawen 已提交
378 379 380

URLSearchParams的构造函数。

Z
zengyawen 已提交
381 382
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
383 384 385 386
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
387
| init | string[][] \| Record&lt;string, string&gt; \| string \| URLSearchParams | 否 | 入参对象。<br/>- string[][]:字符串二维数组<br/>- Record&lt;string, string&gt;:对象列表<br/>- string:字符串<br/>- URLSearchParams:对象 |
Z
zengyawen 已提交
388

Z
zengyawen 已提交
389 390
**示例:**

391
```js
392 393 394 395 396
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);
Z
zengyawen 已提交
397
```
Z
zengyawen 已提交
398

399
### append<sup>(deprecated)</sup>
Z
zengyawen 已提交
400

401 402 403
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.append<sup>9+</sup>](#append9)替代。
Z
zengyawen 已提交
404 405

append(name: string, value: string): void
Z
zengyawen 已提交
406 407 408

将新的键值对插入到查询字符串。

Z
zengyawen 已提交
409 410
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
411 412 413 414 415 416
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 需要插入搜索参数的键名。 |
| value | string | 是 | 需要插入搜索参数的值。 |
Z
zengyawen 已提交
417

Z
zengyawen 已提交
418 419
**示例:**

420
```js
421 422
let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1));
S
shikai-123 已提交
423
paramsObject.append('fod', '3');
Z
zengyawen 已提交
424
```
Z
zengyawen 已提交
425

426
### delete<sup>(deprecated)</sup>
Z
zengyawen 已提交
427

428 429 430
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.delete<sup>9+</sup>](#delete9)替代。
Z
zengyawen 已提交
431 432

delete(name: string): void
Z
zengyawen 已提交
433 434 435

删除指定名称的键值对。

Z
zengyawen 已提交
436 437
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
438 439 440 441 442
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 需要删除的键值名称。 |
Z
zengyawen 已提交
443

Z
zengyawen 已提交
444 445
**示例:**

446
```js
447 448
let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsobject = new Url.URLSearchParams(urlObject.search.slice(1));
449
paramsobject.delete('fod');
Z
zengyawen 已提交
450
```
Z
zengyawen 已提交
451

452
### getAll<sup>(deprecated)</sup>
Z
zengyawen 已提交
453

454 455 456
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.getAll<sup>9+</sup>](#getall9)替代。
Z
zengyawen 已提交
457 458

getAll(name: string): string[]
Z
zengyawen 已提交
459 460 461

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

Z
zengyawen 已提交
462 463
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
464 465 466 467 468 469 470 471 472 473 474
**参数:**

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| string[] | 返回指定名称的所有键值对。 |
Z
zengyawen 已提交
475

Z
zengyawen 已提交
476
**示例:**
Z
zengyawen 已提交
477

478
```js
S
shikai-123 已提交
479 480 481 482
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"].
Z
zengyawen 已提交
483
```
Z
zengyawen 已提交
484

485
### entries<sup>(deprecated)</sup>
Z
zengyawen 已提交
486

487 488 489
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.entries<sup>9+</sup>](#entries9)替代。
Z
zengyawen 已提交
490

X
xdmal 已提交
491
entries(): IterableIterator<[string, string]>
Z
zengyawen 已提交
492 493

返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。
Z
zengyawen 已提交
494

Z
zengyawen 已提交
495 496
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
497 498 499 500
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
501
| IterableIterator&lt;[string, string]&gt; | 返回一个ES6的迭代器。 |
Z
zengyawen 已提交
502 503

**示例:**
Z
zengyawen 已提交
504

505
```js
506
let searchParamsObject = new Url.URLSearchParams("keyName1=valueName1&keyName2=valueName2"); 
Z
zengyawen 已提交
507 508 509 510
for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pairs
    console.log(pair[0]+ ', '+ pair[1]);
}
```
Z
zengyawen 已提交
511 512


513
### forEach<sup>(deprecated)</sup>
514 515 516
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.forEach<sup>9+</sup>](#foreach9)替代。
Z
zengyawen 已提交
517

518
forEach(callbackFn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void
Z
zengyawen 已提交
519 520 521

通过回调函数来遍历URLSearchParams实例对象上的键值对。

Z
zengyawen 已提交
522 523
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
524 525 526 527
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
528 529
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackFn被调用时用作this值 |
Z
zengyawen 已提交
530

531
**表1** callbackFn的参数说明
Z
zengyawen 已提交
532 533 534 535 536 537 538 539 540

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | string | 是 | 当前遍历到的键值。 |
| key | string | 是 | 当前遍历到的键名。 |
| searchParams | Object | 是 | 当前调用forEach方法的实例对象。 |

**示例:**

541
```js
542
const myURLObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2'); 
Z
zengyawen 已提交
543 544 545 546
myURLObject.searchParams.forEach((value, name, searchParams) => {  
    console.log(name, value, myURLObject.searchParams === searchParams);
});
```
Z
zengyawen 已提交
547 548


549
### get<sup>(deprecated)</sup>
550 551 552
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.get<sup>9+</sup>](#get9)替代。
Z
zengyawen 已提交
553 554

get(name: string): string | null
Z
zengyawen 已提交
555 556 557

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

Z
zengyawen 已提交
558 559
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
560 561 562 563 564
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 指定键值对的名称。 |
Z
zengyawen 已提交
565

Z
zengyawen 已提交
566
**返回值:**
Z
zengyawen 已提交
567

Z
zengyawen 已提交
568 569 570
| 类型 | 说明 |
| -------- | -------- |
| string | 返回第一个值。 |
571
| null | 如果没找到,返回 null。 |
Z
zengyawen 已提交
572 573 574

**示例:**

575
```js
Z
zengyawen 已提交
576 577 578
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
Z
zengyawen 已提交
579
```
Z
zengyawen 已提交
580 581


582
### has<sup>(deprecated)</sup>
583 584 585
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.has<sup>9+</sup>](#has9)替代。
Z
zengyawen 已提交
586 587

has(name: string): boolean
Z
zengyawen 已提交
588 589

判断一个指定的键名对应的值是否存在。
Z
zengyawen 已提交
590

Z
zengyawen 已提交
591 592
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
593 594 595 596 597 598 599
**参数:**

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

**返回值:**
Z
zengyawen 已提交
600

Z
zengyawen 已提交
601 602 603 604 605 606
| 类型 | 说明 |
| -------- | -------- |
| boolean | 是否存在相对应的key值,存在返回true,否则返回false。 |

**示例:**

607
```js
608 609
let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1)); 
Z
zengyawen 已提交
610 611
paramsObject.has('bard') === true;
```
Z
zengyawen 已提交
612 613


614
### set<sup>(deprecated)</sup>
615 616 617
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.set<sup>9+</sup>](#set9)替代。
Z
zengyawen 已提交
618 619

set(name: string, value: string): void
Z
zengyawen 已提交
620 621 622

将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对,请将第一个键值对的值设置为value并删除所有其他值。如果不是,则将键值对附加到查询字符串。

Z
zengyawen 已提交
623 624
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
625
**参数:**
Z
zengyawen 已提交
626

Z
zengyawen 已提交
627 628 629 630 631 632 633
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 将要设置的参数的键值名。 |
| value | string | 是 | 所要设置的参数值。 |

**示例:**

634
```js
635 636
let urlObject = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let paramsObject = new Url.URLSearchParams(urlObject.search.slice(1));
S
shikai-123 已提交
637
paramsObject.set('baz', '3'); // Add a third parameter.
Z
zengyawen 已提交
638
```
Z
zengyawen 已提交
639 640


641
### sort<sup>(deprecated)</sup>
642 643 644
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.sort<sup>9+</sup>](#sort9)替代。
Z
zengyawen 已提交
645

Z
zengyawen 已提交
646
sort(): void
Z
zengyawen 已提交
647

Z
zengyawen 已提交
648
对包含在此对象中的所有键值对进行排序,并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 (即,将保留具有相等键的键值对之间的相对顺序)。
Z
zengyawen 已提交
649

Z
zengyawen 已提交
650 651
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
652
**示例:**
Z
zengyawen 已提交
653

654
```js
655
let searchParamsObject = new Url.URLSearchParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object
Z
zengyawen 已提交
656 657 658
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
```
Z
zengyawen 已提交
659 660


661
### keys<sup>(deprecated)</sup>
662 663 664
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.keys<sup>9+</sup>](#keys9)替代。
Z
zengyawen 已提交
665

Z
zengyawen 已提交
666
keys(): IterableIterator&lt;string&gt;
Z
zengyawen 已提交
667

Z
zengyawen 已提交
668
返回一个所有键值对的name的ES6迭代器。
Z
zengyawen 已提交
669

Z
zengyawen 已提交
670 671
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
672
**返回值:**
Z
zengyawen 已提交
673

Z
zengyawen 已提交
674 675 676
| 类型 | 说明 |
| -------- | -------- |
| IterableIterator&lt;string&gt; | 返回一个所有键值对的name的ES6迭代器。 |
Z
zengyawen 已提交
677

Z
zengyawen 已提交
678
**示例:**
Z
zengyawen 已提交
679

680
```js
681
let searchParamsObject = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
Z
zengyawen 已提交
682 683 684 685
for (var key of searchParamsObject .keys()) { // Output key-value pairs
    console.log(key);
}
```
Z
zengyawen 已提交
686 687


688
### values<sup>(deprecated)</sup>
689 690 691
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[URLParams<sup>9+</sup>.values<sup>9+</sup>](#values9)替代。
Z
zengyawen 已提交
692

Z
zengyawen 已提交
693 694 695 696
values(): IterableIterator&lt;string&gt;

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

Z
zengyawen 已提交
697 698
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
699
**返回值:**
Z
zengyawen 已提交
700

Z
zengyawen 已提交
701 702 703 704 705 706
| 类型 | 说明 |
| -------- | -------- |
| IterableIterator&lt;string&gt; | 返回一个所有键值对的value的ES6迭代器。 |

**示例:**

707
```js
708 709
let searchParams = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing
for (var value of searchParams.values()) {
Z
zengyawen 已提交
710 711 712
    console.log(value);
}
```
Z
zengyawen 已提交
713 714


715
### [Symbol.iterator]<sup>(deprecated)</sup>
G
ge-yafang 已提交
716

717 718
> **说明:**
>
G
ge-yafang 已提交
719
> 从API version 7开始支持,从API version 9开始废弃,建议使用[[Symbol.iterator]<sup>9+</sup>](#symboliterator9)替代。
Z
zengyawen 已提交
720

Z
zengyawen 已提交
721
[Symbol.iterator]\(): IterableIterator&lt;[string, string]&gt;
Z
zengyawen 已提交
722 723 724

返回一个ES6的迭代器,迭代器的每一项都是一个 JavaScript Array。Array的第一项是name,Array的第二项是value。

Z
zengyawen 已提交
725 726
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
727
**返回值:**
Z
zengyawen 已提交
728

Z
zengyawen 已提交
729 730
| 类型 | 说明 |
| -------- | -------- |
731
| IterableIterator&lt;[string, string]&gt; | 返回一个ES6的迭代器。 |
Z
zengyawen 已提交
732

Z
zengyawen 已提交
733
**示例:**
Z
zengyawen 已提交
734

735
```js
736
const paramsObject = new Url.URLSearchParams('fod=bay&edg=bap');
737
for (const [name, value] of paramsObject) {
Z
zengyawen 已提交
738 739 740
    console.log(name, value); 
} 
```
Z
zengyawen 已提交
741

742
### tostring<sup>(deprecated)</sup>
743 744
> **说明:**
>
G
ge-yafang 已提交
745
> 从API version 7开始支持,从API version 9开始废弃,建议使用[tostring<sup>9+</sup>](#tostring9)替代。
Z
zengyawen 已提交
746

Z
zengyawen 已提交
747
toString(): string
Z
zengyawen 已提交
748 749 750

返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。

Z
zengyawen 已提交
751 752
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
753
**返回值:**
Z
zengyawen 已提交
754

Z
zengyawen 已提交
755 756 757
| 类型 | 说明 |
| -------- | -------- |
| string | 返回序列化为字符串的搜索参数,必要时对字符进行百分比编码。 |
Z
zengyawen 已提交
758

Z
zengyawen 已提交
759
**示例:**
Z
zengyawen 已提交
760

761
```js
762 763
let url = new Url.URL('https://developer.exampleUrl/?fod=1&bard=2');
let params = new Url.URLSearchParams(url.search.slice(1)); 
S
shikai-123 已提交
764
params.append('fod', '3');
Z
zengyawen 已提交
765 766
console.log(params.toString());
```
Z
zengyawen 已提交
767 768 769 770 771

## URL

### 属性

Z
zengyawen 已提交
772 773
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Utils.Lang

774
| 名称 | 类型 | 可读 | 可写 | 说明 |
Z
zengyawen 已提交
775 776 777 778 779 780 781 782 783 784 785
| -------- | -------- | -------- | -------- | -------- |
| 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的序列化查询部分。 |
786
| searchParams | URLSearchParams | 是 | 否 | 获取URLSearchParams表示URL查询参数的对象。 |
787
| URLParams | URLParams | 是 | 否 | 获取URLParams表示URL查询参数的对象。 |
Z
zengyawen 已提交
788 789
| username | string | 是 | 是 | 获取和设置URL的用户名部分。 |

790
### constructor<sup>(deprecated)</sup>
Z
zengyawen 已提交
791

792 793
> **说明:**
>
794
> 从API version 7开始支持,从API version 9开始废弃,建议使用[parseURL<sup>9+</sup>](#parseurl9)替代。
Z
zengyawen 已提交
795

796
constructor(url: string, base?: string | URL)
Z
zengyawen 已提交
797

Z
zengyawen 已提交
798 799
URL的构造函数。

Z
zengyawen 已提交
800 801
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
802
**参数:**
Z
zengyawen 已提交
803

Z
zengyawen 已提交
804 805 806
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| url | string | 是 | 入参对象。 |
807
| base | string \| URL | 否 | 入参字符串或者对象。<br/>- string:字符串<br/>- URL:字符串或对象 |
Z
zengyawen 已提交
808

Z
zengyawen 已提交
809
**示例:**
Z
zengyawen 已提交
810

811
```js
Z
zengyawen 已提交
812 813 814 815 816 817 818
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';
819 820 821
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
822 823
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/
Z
zengyawen 已提交
824
```
Z
zengyawen 已提交
825

826 827
### parseURL<sup>9+</sup>

828
static parseURL(url : string, base?: string | URL): URL
829 830 831 832 833 834 835 836 837

URL静态成员函数。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
838 839
| url | string | 是 | 入参对象。 |
| base | string \| URL | 否 | 入参字符串或者对象。<br/>- string:字符串<br/>- URL:字符串或对象 |
840 841 842 843

**示例:**

```js
Z
zengyawen 已提交
844 845
let mm = 'https://username:password@host:8080';
Url.URL.parseURL(mm); // Output 'https://username:password@host:8080/';
846
```
Z
zengyawen 已提交
847

Z
zengyawen 已提交
848
### tostring
Z
zengyawen 已提交
849

Z
zengyawen 已提交
850
toString(): string
Z
zengyawen 已提交
851

Z
zengyawen 已提交
852
将解析过后的URL转化为字符串。
Z
zengyawen 已提交
853

Z
zengyawen 已提交
854 855
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
856
**返回值:**
Z
zengyawen 已提交
857

Z
zengyawen 已提交
858 859 860
| 类型 | 说明 |
| -------- | -------- |
| string | 用于返回网址的字符串序列化。 |
Z
zengyawen 已提交
861

Z
zengyawen 已提交
862
**示例:**
Z
zengyawen 已提交
863

864
```js
Z
zengyawen 已提交
865
const url = new Url.URL('https://username:password@host:8080/directory/file?query=pppppp#qwer=da');
866
url.toString();
Z
zengyawen 已提交
867
```
Z
zengyawen 已提交
868 869


Z
zengyawen 已提交
870
### toJSON
Z
zengyawen 已提交
871

Z
zengyawen 已提交
872 873 874
toJSON(): string

将解析过后的URL转化为JSON字符串。
Z
zengyawen 已提交
875

Z
zengyawen 已提交
876 877
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
878
**返回值:**
Z
zengyawen 已提交
879

Z
zengyawen 已提交
880 881 882
| 类型 | 说明 |
| -------- | -------- |
| string | 用于返回网址的字符串序列化。 |
Z
zengyawen 已提交
883

Z
zengyawen 已提交
884
**示例:**
885
```js
Z
zengyawen 已提交
886
const url = new Url.URL('https://username:password@host:8080/directory/file?query=pppppp#qwer=da');
887
url.toJSON();
Z
zengyawen 已提交
888
```
889
<!--no_check-->