diff --git a/zh-cn/application-dev/arkts-utils/arkts-utils-overview.md b/zh-cn/application-dev/arkts-utils/arkts-utils-overview.md index 29c4d82fd6db46635cef7d807b1903e87bb2dc21..a225b6c093e0a51745a353910f5466e13ef3e7a5 100644 --- a/zh-cn/application-dev/arkts-utils/arkts-utils-overview.md +++ b/zh-cn/application-dev/arkts-utils/arkts-utils-overview.md @@ -1,5 +1,5 @@ # ArkTS基础类库概述 -ArkTS基础类库是一个功能齐全的API集合，精心设计了一系列关键且实用的功能模块。 +ArkTS基础类库是一个功能齐全的API集合，设计了一系列关键且实用的功能模块。 -ArkTS基础类库主要提供了[XML生成解析转换](xml-overview.md)、[二进制Buffer](buffer.md)、[多种容器类库](container-overview.md)、[URL字符串解析](../reference/apis-arkts/js-apis-url.md)和[高精度浮点计算](../reference/apis-arkts/js-apis-arkts-decimal.md)等能力，协助开发者简化开发工作，提升开发效率。 +ArkTS基础类库主要提供了[XML生成解析转换](xml-overview.md)、[二进制Buffer](buffer.md)、[多种容器类库](container-overview.md)、[URL字符串解析](../reference/apis-arkts/js-apis-url.md)和[高精度浮点计算](../reference/apis-arkts/js-apis-arkts-decimal.md)等能力，简化开发工作，提升开发效率。 \ No newline at end of file diff --git a/zh-cn/application-dev/arkts-utils/buffer.md b/zh-cn/application-dev/arkts-utils/buffer.md index 3ca5ff1af15f82273fa1504570f157be74c5f26f..b5e6a098360b85704b968f6d215cf68258fb342f 100644 --- a/zh-cn/application-dev/arkts-utils/buffer.md +++ b/zh-cn/application-dev/arkts-utils/buffer.md @@ -2,44 +2,44 @@ ## 场景介绍 -Buffer和FastBuffer模块基于内存管理机制，将内存区域抽象为可以读写、修改的逻辑对象，旨在提供二进制数据处理的高效接口。每个Buffer实例对象都是连续的字节序列，支持创建自定义大小的内存块，方便存储和操作各种不同类型序列化后的数据。 +Buffer和FastBuffer模块将内存区域抽象为可读写、修改的逻辑对象，提供高效的二进制数据处理接口。每个Buffer实例是连续的字节序列，支持创建自定义大小的内存块，用于存储和操作序列化后的数据。 Buffer和FastBuffer模块的主要应用场景包括： -1. **大数据传输**：当需要传输大量数据，如二进制文件、数据库记录或网络报文时，使用Buffer作为数据的存储和处理容器，可减少拷贝和内存消耗，提升传输效率。 +1. **大数据传输**：传输大量数据，如二进制文件、数据库记录或网络报文时，使用Buffer作为数据的存储和处理容器，可减少拷贝和内存消耗，提升效率。 -2. **图像和音频处理**：在图像编码、解码，音频数据流处理等方面，Buffer可帮助开发者方便地操作像素或采样数据，确保数据的完整性。 +2. **图像和音频处理**：在图像编码、解码和音频数据流处理中，Buffer帮助开发者操作像素或采样数据，确保数据的完整性。 -3. **二进制数据操作**：Buffer提供稳定的接口解析和操作二进制数据。 +3. **二进制数据操作**：Buffer提供接口解析和操作二进制数据。 ## Buffer Buffer模块的核心功能包括： -1. **创建和分配内存**：允许开发者指定大小初始化Buffer，创建后拥有固定的内存容量。 +1. **创建和分配内存**：允许指定大小初始化Buffer，创建后内存容量固定。 -2. **读写和复制数据**：通过索引访问Buffer内的字节，支持按字节块读取和写入，支持将Buffer的某部分复制到另一个Buffer或数组。 +2. **读写和复制数据**：支持按索引访问Buffer内的字节，按字节块读取和写入，复制Buffer的某部分到其他Buffer或数组。 -3. **转换操作**：提供了将Buffer与基本类型（如Uint8Array、string等）之间互相转换的方法，满足不同数据处理需求。 +3. **转换操作**：提供Buffer与基本类型（如Uint8Array、string）之间的转换方法，满足不同的数据处理需求。 -4. **内存操作**：能够截取部分Buffer、切片以及合并多个Buffer，便于数据流的处理和管理。 +4. **内存操作**：支持截取部分Buffer、切片和合并多个Buffer，便于数据流的处理和管理。 Buffer模块各接口使用详见：[@ohos.buffer](../reference/apis-arkts/js-apis-buffer.md)。 ## FastBuffer -FastBuffer是一种高性能二进制数据容器，专为固定长度字节序列的存储与处理设计。相比 Buffer，它在效率、读写速度上具有显著优势。 +FastBuffer是一种高性能二进制数据容器，专为固定长度字节序列的存储与处理设计，相比Buffer，它在效率和读写速度上具有显著优势。 -当构造FastBuffer的入参为number | FastBuffer | Uint8Array | ArrayBuffer | Array\ | string时，推荐使用FastBuffer，可以高效处理大量二进制数据，如图片处理和文件接收上传等。 +当构造FastBuffer的入参为number | FastBuffer | Uint8Array | ArrayBuffer | Array\ | string时，推荐使用FastBuffer处理大量二进制数据，如图片处理和文件接收上传等。 FastBuffer模块的核心功能包括： -1. **创建和分配内存**：允许开发者基于uint32限制的指定大小初始化Buffer，创建后拥有固定的内存容量。 +1. **创建和分配内存**：允许基于uint32指定大小初始化FastBuffer，创建后内存容量固定。 -2. **读写和复制数据**：通过索引访问Buffer内的字节，支持按字节块读取和写入，支持将FastBuffer的某部分复制到另一个FastBuffer或数组。 +2. **读写和复制数据**：支持按索引访问Buffer内的字节，按字节块读取和写入，复制FastBuffer的某部分到其他FastBuffer或数组。 -3. **转换操作**：提供了将FastBuffer与基本类型（如Uint8Array、string等）之间互相转换的方法，满足不同数据处理需求。 +3. **转换操作**：提供FastBuffer与基本类型（如Uint8Array、string）之间的转换方法，满足不同的数据处理需求。 -4. **内存操作**：能够截取部分FastBuffer、切片以及合并多个FastBuffer，便于数据流的处理和管理。 +4. **内存操作**：支持截取部分FastBuffer、切片和合并多个FastBuffer，便于数据流的处理和管理。 FastBuffer模块各接口使用详见：[@ohos.fastbuffer](../reference/apis-arkts/js-apis-fastbuffer.md)。 \ No newline at end of file diff --git a/zh-cn/application-dev/arkts-utils/container-overview.md b/zh-cn/application-dev/arkts-utils/container-overview.md index a1836b0cad1de1bba105ed26c526bb2e663ce97c..93e5e3465e7208c82d56b236245b4307dcf6d1bd 100644 --- a/zh-cn/application-dev/arkts-utils/container-overview.md +++ b/zh-cn/application-dev/arkts-utils/container-overview.md @@ -1,7 +1,7 @@ # 容器类库概述 -容器类库用于存储各种数据类型的元素，并提供一系列处理数据元素的方法，作为纯数据结构容器来使用具有一定的优势。 +容器类库用于存储各种数据类型的元素，提供一系列处理数据的方法，作为纯数据结构容器具有一定的优势。 -容器类采用类似静态语言的方式来实现，通过限制存储位置和属性，确保每种类型的数据都能在完成自身功能的同时去除冗余逻辑，从而实现高效的数据访问，提升应用性能。 +容器类采用静态语言方式实现，限制存储位置和属性，确保每种类型的数据都能在完成自身功能的同时去除冗余逻辑，从而实现高效的数据访问，提升应用性能。 -当前提供了线性和非线性两类容器。[线性容器](linear-container.md)和[非线性容器](nonlinear-container.md)都是非多线程安全的。 +当前提供了线性和非线性两类容器。[线性容器](linear-container.md)和[非线性容器](nonlinear-container.md)均非多线程安全的。 diff --git a/zh-cn/application-dev/arkts-utils/linear-container.md b/zh-cn/application-dev/arkts-utils/linear-container.md index e93c78a0ef7aa3cfa4f305b1c9c5da5dd4383c89..e1c3e0a9c202c495b5603f5de2a84c209f076d60 100644 --- a/zh-cn/application-dev/arkts-utils/linear-container.md +++ b/zh-cn/application-dev/arkts-utils/linear-container.md @@ -4,25 +4,25 @@ 线性容器实现能按顺序访问的数据结构，其底层主要通过数组实现，包括ArrayList、Vector、List、LinkedList、Deque、Queue和Stack。 -线性容器充分考虑了数据访问的速度，运行时（Runtime）通过一条字节码指令就可以完成增、删、改、查等操作。 +线性容器优化了数据访问速度，运行时（Runtime）通过一条字节码指令即可完成增、删、改、查等操作。 ## 各线性容器类型特征对比 | 类名 | 特征及建议使用场景 | | --------- | ------- | | ArrayList | 动态数组，占用一片连续的内存空间。需要频繁读取元素时推荐使用。 | -| List | 单向链表，占用的空间可以不连续。需要频繁的插入删除元素且需要使用单向链表时推荐使用。 | -| LinkedList | 双向链表，占用的空间可以不连续。需要频繁的插入删除元素且需要使用双向链表时推荐使用。 | -| Deque | 双端队列，可以从容器头尾进行进出元素操作，占用一片连续的内存空间。需要频繁访问、操作头尾元素时推荐使用。 | -| Queue | 队列，从容器尾部插入元素，从容器头部弹出元素，占用一片连续的内存空间。一般符合先进先出的场景可以使用。 | -| Stack | 栈，只能从容器的一端进行插入删除操作，占用一片连续的内存空间。一般符合先进后出的场景可以使用。 | -| Vector | 动态数组，占用一片连续的内存空间。该类型已不再维护，推荐使用ArrayList。 | +| List | 单向链表，占用的空间可以不连续。推荐在需要频繁插入和删除元素，且需要使用单向链表时使用。 | +| LinkedList | 双向链表，占用的空间可以不连续。推荐在需要频繁插入和删除元素，且需要使用双向链表时使用。 | +| Deque | 双端队列，支持从头尾两端进行元素的插入和删除操作，占用连续的内存空间。推荐在需要频繁访问和操作头尾元素时使用。 +| Queue | 队列，是一种从尾部插入元素、从头部移除元素的数据结构，占用连续的内存空间，适用于先进先出的场景。 +| Stack | 栈，只能从一端进行插入和删除操作，占用连续的内存空间。适用于先进后出的场景。 | +| Vector | 动态数组，占用连续的内存空间。已不再维护，推荐使用 ArrayList。 ## ArrayList -[ArrayList](../reference/apis-arkts/js-apis-arraylist.md)即动态数组，可用来构造全局的数组对象。 当需要频繁读取集合中的元素时，推荐使用ArrayList。 +[ArrayList](../reference/apis-arkts/js-apis-arraylist.md)即动态数组，可用来构造全局的数组对象。需要频繁读取集合元素时，推荐使用ArrayList。 -ArrayList依据泛型定义，要求存储位置为连续的内存空间，初始容量大小为10，支持动态扩容，每次扩容为原始容量的1.5倍。 +ArrayList依据泛型定义，存储位置为连续的内存空间，初始容量为10，支持动态扩容，每次扩容为原始容量的1.5倍。 ArrayList支持增、删、改、查操作，常用API如下： @@ -31,7 +31,7 @@ ArrayList支持增、删、改、查操作，常用API如下： | 增加元素 | add(element: T) | 在数组尾部增加一个元素。 | | 增加元素 | insert(element: T, index: number) | 在指定位置插入一个元素。 | | 访问元素 | arr[index: number] | 获取指定index对应的value值。 | -| 访问元素 | forEach(callbackFn: (value: T, index?: number, arrlist?: ArrayList<T>) => void, thisArg?: Object) | 访问整个ArrayList容器的元素，其中`callbackFn`是`forEach`方法中用于处理每个元素的回调函数，它接收当前元素、索引和原列表作为参数。。 | +| 访问元素 | forEach(callbackFn: (value: T, index?: number, arrlist?: ArrayList<T>) => void, thisArg?: Object) | 访问整个ArrayList容器的元素，其中`callbackFn`是`forEach`方法中用于处理每个元素的回调函数，它接收当前元素、索引和原列表作为参数。 | | 访问元素 | \[Symbol.iterator]():IterableIterator<T> | 创建迭代器以进行数据访问。 | | 修改元素 | arr[index] = xxx | 修改指定index位置对应的value值。 | | 删除元素 | remove(element: T) | 删除第一个匹配到的元素。 | @@ -41,18 +41,18 @@ ArrayList支持增、删、改、查操作，常用API如下： [List](../reference/apis-arkts/js-apis-list.md)可用来构造一个单向链表对象，若需要查找List中某一个元素，只能从头结点开始遍历。List依据泛型定义，存储的元素在内存中的存储位置可以不连续。 -List和[LinkedList](../reference/apis-arkts/js-apis-linkedlist.md)相比，LinkedList是双向链表，支持快速在头部和尾部进行增删操作，而List是单向链表，不支持双向操作。 +List和[LinkedList](../reference/apis-arkts/js-apis-linkedlist.md)相比，LinkedList是双向链表，支持在头部和尾部快速增删操作。List则是单向链表，不支持双向操作。 -当需要频繁的插入删除元素，并且需要使用单向链表时，推荐使用List高效操作。 +当需要频繁插入和删除元素，并且使用单向链表时，推荐使用List进行高效操作。 -可以通过get/set等接口修改存储的元素，List支持增、删、改、查操作，常用API如下：： +可以通过get/set等接口修改存储的元素，List支持增、删、改、查操作，常用API如下： | 操作 | 方法 | 描述 | | --------- | ------- | ------- | | 增加元素 | add(element: T) | 在数组尾部增加一个元素。 | | 增加元素 | insert(element: T, index: number) | 在指定位置增加一个元素。 | | 访问元素 | get(index: number) | 获取指定index位置对应的元素。 | -| 访问元素 | list[index: number] | 获取指定index位置对应的元素，但会导致未定义结果。 | +| 访问元素 | list[index: number] | 获取指定索引位置的元素，可能导致未定义结果。 | | 访问元素 | getFirst() | 获取第一个元素。 | | 访问元素 | getLast() | 获取最后一个元素。 | | 访问元素 | getIndexOf(element: T) | 获取第一个匹配指定元素的位置。 | @@ -60,37 +60,37 @@ List和[LinkedList](../reference/apis-arkts/js-apis-linkedlist.md)相比，Linke | 访问元素 | forEach(callbackfn: (value:T, index?: number, list?: List<T>)=> void,thisArg?: Object) | 遍历访问整个List容器中的每个元素，并执行指定的回调函数。 | | 访问元素 | \[Symbol.iterator]():IterableIterator<T> | 创建迭代器以进行数据访问。 | | 修改元素 | set(index:number, element: T) | 修改指定index位置的元素值为element。 | -| 修改元素 | list[index] = element | 修改指定index位置的元素值为element素时，不会对链表中的实际节点进行任何更改，仅会在对象上添加一个属性，这将导致程序状态与链表实际内容不一致，从而产生未定义行为。 | +| 修改元素 | list[index] = element | 修改指定index位置的元素值为element时，不会对链表中的实际节点进行任何更改，仅会在对象上添加一个属性，这将导致程序状态与链表实际内容不一致，从而产生未定义行为。 | | 修改元素 | replaceAllElements(callbackFn:(value: T,index?: number,list?: List<T>)=>T,thisArg?: Object) | 对List内元素进行逐个替换。 | | 删除元素 | remove(element: T) | 通过 === 运算符逐个比对链表中的元素，删除第一个匹配成功的节点。对于对象类型，只有当传入的对象与链表中某节点的引用完全一致时才会被删除。 | | 删除元素 | removeByIndex(index:number) | 删除index位置对应的元素，如果index超出范围，则会报out of range错误。 | ## LinkedList -[LinkedList](../reference/apis-arkts/js-apis-linkedlist.md)可用于构造双向链表对象，支持在任意节点向前或向后遍历List。LinkedList依据泛型定义，其元素在内存中的存储位置可以不连续。 +[LinkedList](../reference/apis-arkts/js-apis-linkedlist.md)可用于构造双向链表对象，支持在任意节点向前或向后遍历LinkedList。LinkedList依据泛型定义，其元素在内存中的存储位置可以不连续。 -LinkedList和[List](../reference/apis-arkts/js-apis-list.md)相比，LinkedList是双向链表，支持快速的头尾增删操作，而List是单向链表，不支持双向操作。 +LinkedList和[List](../reference/apis-arkts/js-apis-list.md)相比，LinkedList是双向链表，支持快速的头尾增删操作。List是单向链表，不支持双向操作。 -LinkedList和[ArrayList](../reference/apis-arkts/js-apis-arraylist.md)相比，LinkedList插入数据的效率高于ArrayList，而ArrayList的查询效率高于LinkedList。 +LinkedList和[ArrayList](../reference/apis-arkts/js-apis-arraylist.md)相比，LinkedList插入数据的效率高于ArrayList，ArrayList查询效率高于LinkedList。 -当需要频繁的插入删除元素，并且需要使用双向链表时，推荐使用LinkedList高效操作。 +需要频繁插入删除元素且使用双向链表时，推荐使用LinkedList。 -可以通过get/set等接口对存储的元素进行修改，LinkedList支持增、删、改、查操作，常用API如下： +可以通过get/set等接口修改存储的元素。LinkedList支持增、删、改、查操作，常用API如下： | 操作 | 方法 | 描述 | | --------- | ------- | ------- | | 增加元素 | add(element: T) | 在数组尾部增加一个元素。 | | 增加元素 | insert(element: T, index: number) | 在指定位置插入一个元素。 | | 访问元素 | get(index: number) | 获取指定index位置对应的元素。 | -| 访问元素 | list[index: number] | 获取指定index位置对应的元素，但会导致未定义结果。 | +| 访问元素 | list[index: number] | 获取指定index位置对应的元素，可能导致未定义行为。 | | 访问元素 | getFirst() | 获取第一个元素。 | | 访问元素 | getLast() | 获取最后一个元素。 | | 访问元素 | getIndexOf(element: T) | 获取第一个匹配指定元素的位置。 | | 访问元素 | getLastIndexOf(element: T) | 获取最后一个匹配指定元素的位置。 | -| 访问元素 | forEach(callbackFn: (value: T, index?: number, list?: LinkedList<T>) => void, thisArg?: Object) | 遍历访问整个LinkedList容器的的每个元素，并执行指定的回调函数。 | +| 访问元素 | forEach(callbackFn: (value: T, index?: number, list?: LinkedList<T>) => void, thisArg?: Object) | 遍历访问整个LinkedList容器的每个元素，并执行指定的回调函数。 | | 访问元素 | \[Symbol.iterator]():IterableIterator<T> | 创建迭代器以进行数据访问。 | | 修改元素 | set(index:number, element: T) | 修改指定index位置的元素值为element。 | -| 修改元素 | list[index] = element | 修改指定index位置的元素值为element，但会导致未定义结果。 | +| 修改元素 | list[index] = element | 修改指定index位置的元素值为element，可能导致未定义行为。 | | 删除元素 | remove(element: T) | 删除第一个匹配到的元素。 | | 删除元素 | removeByIndex(index:number) | 删除index位置对应的元素。 | @@ -98,15 +98,15 @@ LinkedList和[ArrayList](../reference/apis-arkts/js-apis-arraylist.md)相比，L [Deque](../reference/apis-arkts/js-apis-deque.md)可用来构造双端队列对象，存储元素遵循先进先出以及先进后出的规则，双端队列可以分别从队头或者队尾进行访问。 -Deque依据泛型定义，要求存储位置为连续的内存空间，其初始容量大小为8，并支持动态扩容，每次扩容为原始容量的2倍。Deque底层采用循环队列实现，入队及出队操作效率高。 +Deque依据泛型定义，要求存储位置为连续的内存空间，初始容量为8，支持动态扩容，每次扩容为原容量的2倍。Deque底层采用循环队列实现，入队和出队操作效率高。 Deque和[Queue](../reference/apis-arkts/js-apis-queue.md)相比，Deque支持在两端进行元素的增删操作，而Queue仅支持在头部删除元素，尾部增加元素。 -Deque和[Vector](../reference/apis-arkts/js-apis-vector.md)相比，它们都支持在两端增删元素，但Deque不支持中间插入的操作。Deque对头部元素的插入删除效率高于Vector，而Vector访问元素的效率高于Deque。 +Deque和[Vector](../reference/apis-arkts/js-apis-vector.md)相比，都支持在两端增删元素，但Deque不支持中间插入。Deque在头部插入和删除元素的效率高于Vector，而Vector访问元素的效率高于Deque。 -需要频繁在集合两端进行增删元素的操作时，推荐使用Deque。 +需要频繁在两端增删元素时，推荐使用Deque。 -Deque支持增、删、改、查操作，常用API如下： +Deque支持增、删、改、查操作。常用API如下： | 操作 | 方法 | 描述 | | --------- | ------- | ------- | @@ -114,7 +114,7 @@ Deque支持增、删、改、查操作，常用API如下： | 增加元素 | insertEnd(element: T) | 在尾部增加一个元素。 | | 访问元素 | getFirst() | 获取第一个元素，不进行出队操作。 | | 访问元素 | getLast() | 获取最后一个元素，不进行出队操作。 | -| 访问元素 | forEach(callbackFn:(value: T, index?: number, deque?: Deque<T>) => void, thisArg?: Object) | 遍历访问整个Deque容器的的每个元素，并执行指定的回调函数。 | +| 访问元素 | forEach(callbackFn:(value: T, index?: number, deque?: Deque<T>) => void, thisArg?: Object) | 遍历访问整个Deque容器的每个元素，并执行指定的回调函数。 | | 访问元素 | \[Symbol.iterator]():IterableIterator<T> | 创建迭代器以进行数据访问。 | | 删除元素 | popFirst() | 将队首元素作为返回值进行返回，并将其出队，如果队列为空，则返回undefined。 | | 删除元素 | popLast() | 将队尾元素作为返回值进行返回，并将其出队，如果队列为空，则返回undefined。 | @@ -123,13 +123,13 @@ Deque支持增、删、改、查操作，常用API如下： [Queue](../reference/apis-arkts/js-apis-queue.md)可用来构造队列对象，存储元素遵循先进先出的规则。 -Queue依据泛型定义，存储位置必须是连续的内存空间，初始容量大小为8，并支持动态扩容，每次扩容为原始容量的2倍。 +Queue基于泛型定义，存储位置为连续的内存空间，初始容量为8，支持动态扩容，每次扩容容量翻倍。 -Queue底层采用循环队列实现，因此入队及出队操作效率都很高。 +Queue底层采用循环队列实现，入队和出队操作效率高。 -Queue和[Deque](../reference/apis-arkts/js-apis-deque.md)相比，Queue只能在一端删除一端增加，而Deque支持两端增删。 +Queue和[Deque](../reference/apis-arkts/js-apis-deque.md)相比，Queue仅支持在头部删除元素，尾部增加元素，而Deque支持在两端进行元素的增删操作。 -一般符合先进先出的场景可以使用Queue。 +符合先进先出的场景可以使用Queue。 Queue支持增、删、改、查操作，常用API如下： @@ -139,17 +139,17 @@ Queue支持增、删、改、查操作，常用API如下： | 访问元素 | getFirst() | 获取队首元素，不进行出队操作。 | | 访问元素 | forEach(callbackFn: (value: T, index?: number, queue?: Queue<T>) => void,thisArg?: Object) | 遍历访问整个Queue容器的每个元素，并执行指定的回调函数。 | | 访问元素 | \[Symbol.iterator]():IterableIterator<T> | 创建迭代器以进行数据访问。 | -| 删除元素 | pop() | 将队首元素作为返回值进行返回，并将其出队。| +| 删除元素 | pop() | 将队首元素作为返回值进行返回，并将其移除。| ## Stack [Stack](../reference/apis-arkts/js-apis-stack.md)可用来构造栈对象，存储元素遵循先进后出的规则。 -Stack依据泛型定义，要求存储位置为连续的内存空间，初始容量大小为8，并支持动态扩容，每次扩容为原始容量的1.5倍。Stack底层基于数组实现，入栈和出栈操作均在数组的一端进行。 +Stack基于泛型定义，要求使用连续的内存空间存储元素，初始容量为8，并支持动态扩容，每次扩容为原容量的1.5倍。Stack底层使用数组实现，入栈和出栈操作均在数组的一端进行。 -Stack和[Queue](../reference/apis-arkts/js-apis-queue.md)相比，Queue基于循环队列实现，只能在头部删除元素，尾部增加元素，而Stack都在一端操作。 +Stack和[Queue](../reference/apis-arkts/js-apis-queue.md)相比，Queue基于循环队列实现，仅支持在头部删除元素，尾部增加元素，而Stack都在一端进行操作。 -一般符合先进后出的场景可以使用Stack。 +符合先进后出的场景可以使用Stack。 Stack支持增、删、改、查操作，常用API如下： @@ -160,7 +160,7 @@ Stack支持增、删、改、查操作，常用API如下： | 访问元素 | locate(element: T) | 获取元素对应的位置。 | | 访问元素 | forEach(callbackFn: (value: T, index?: number, stack?: Stack<T>) => void, thisArg?: Object) | 遍历访问整个Stack容器的每个元素，并执行指定的回调函数。 | | 访问元素 | \[Symbol.iterator]():IterableIterator<T> | 创建迭代器以进行数据访问。 | -| 删除元素 | pop() | 将栈顶元素作为返回值进行返回，并将其出队。| +| 删除元素 | pop() | 将栈顶元素作为返回值进行返回，并将其移除。| ## Vector @@ -168,9 +168,9 @@ Stack支持增、删、改、查操作，常用API如下： > > API version 9开始，该接口不再维护，推荐使用[ArrayList](../reference/apis-arkts/js-apis-arraylist.md)。 -[Vector](../reference/apis-arkts/js-apis-vector.md)是指连续存储结构，用来构造全局的数组对象。Vector依据泛型定义，要求存储位置是为连续的内存空间，初始容量大小为10，并支持动态扩容，每次扩容为原始容量的2倍。 +[Vector](../reference/apis-arkts/js-apis-vector.md)是一种连续存储结构，用于创建全局数组对象。它基于泛型定义，要求存储在连续的内存空间中。Vector的初始容量为10，支持动态扩容，每次扩容时容量增加为原来的两倍。 -Vector和[ArrayList](../reference/apis-arkts/js-apis-arraylist.md)相似，都是基于数组实现，但Vector提供了更多操作数组的接口。Vector支持操作符访问，并增加了get/set接口，提供更完善的校验及容错机制，满足用户不同场景的需求。 +Vector和[ArrayList](../reference/apis-arkts/js-apis-arraylist.md)相似，都基于数组实现，但Vector提供了更多操作数组的接口，支持操作符访问，增加get/set接口，提供更完善的校验和容错机制，满足不同的场景需求。 Vector支持增、删、改、查操作，常用API如下： @@ -196,7 +196,7 @@ Vector支持增、删、改、查操作，常用API如下： ## 线性容器的使用 -此处列举常用的线性容器ArrayList、Deque、Stack、List的使用示例，包括导入模块、增加元素、访问元素及修改等操作。示例代码如下所示： +此处列举常用的线性容器ArrayList、Deque、Stack、List的使用示例，包括导入模块、添加元素、访问元素及修改等操作。示例代码如下所示： ```ts diff --git a/zh-cn/application-dev/arkts-utils/nonlinear-container.md b/zh-cn/application-dev/arkts-utils/nonlinear-container.md index 037a052d6e705ccb519f9896ce0329bdb6455352..3d25fc0abd5f602a1affa882169e85166d25a5d3 100644 --- a/zh-cn/application-dev/arkts-utils/nonlinear-container.md +++ b/zh-cn/application-dev/arkts-utils/nonlinear-container.md @@ -7,21 +7,21 @@ | 类名 | 特征及建议使用场景 | | --------- | ------- | -| HashMap | 存储具有关联关系的键值对集合，存储元素中键唯一，依据键的hash值确定存储位置。访问速度较快，但不能自定义排序。需要快速存取、插入删除键值对数据时推荐使用。 | -| HashSet | 存储一系列值的集合，存储元素中值唯一，依据值的hash确定存储位置。允许放入null值，但不能自定义排序。需要不重复的集合或需要去重某个集合时可以使用。 | -| TreeMap | 存储具有关联关系的键值对集合，存储元素中键唯一，允许用户自定义排序方法。适用于需要按序存储键值对的场景。 | -| TreeSet | 存储一系列值的集合，存储元素中值唯一，允许用户自定义排序方法，但不建议放入null值。适用于需要按序存储集合的场景。 | -| LightWeightMap | 存储具有关联关系的键值对集合，存储元素中键唯一，底层采用更加轻量级的结构，空间占用小。需要存取键值对数据且内存不充足时推荐使用。 | -| LightWeightSet | 存储一系列值的集合，存储元素中值唯一，底层采用更加轻量级的结构，空间占用小。适用于不重复的集合或去重某个集合的场景。 | -| PlainArray | 存储具有关联关系的键值对集合，存储元素中键唯一，底层与LightWeightMap一样采用更加轻量级的结构，且键固定为number类型。适用于存储键为number类型键值对的场景。 | +| HashMap | 存储具有关联关系的键值对集合。键唯一，依据键的hash值确定存储位置。访问速度快，但不能自定义排序。推荐用于需要快速存取、插入删除键值对数据时使用。 | +| HashSet | 存储一系列值的集合。值唯一，依据值的hash确定存储位置。允许放入null值，但不能自定义排序。适用于不重复的集合或去重某个集合。 | +| TreeMap | 存储具有关联关系的键值对集合。键唯一，允许用户自定义排序方法。适用于按序存储键值对的场景。 | +| TreeSet | 存储一系列值的集合。值唯一，允许用户自定义排序方法，但不建议放入null值。适用于按序存储集合的场景。 | +| LightWeightMap | 存储具有关联关系的键值对集合。键唯一，底层采用轻量级结构，空间占用小。推荐用于存取键值对数据且内存不充足时。 | +| LightWeightSet | 存储一系列值的集合。值唯一，底层采用轻量级结构，空间占用小。适用于不重复的集合或去重某个集合。 | +| PlainArray | 存储具有关联关系的键值对集合。键唯一，底层与LightWeightMap一样采用轻量级结构，键固定为number类型。适用于存储键为number类型键值对的场景。 | ## HashMap [HashMap](../reference/apis-arkts/js-apis-hashmap.md)可用来存储具有关联关系的key-value键值对集合，存储元素中key是唯一的，每个key会对应一个value值。 -HashMap依据泛型定义，集合中通过key的hash值确定其存储位置，从而快速找到键值对。HashMap的初始容量大小为16，并支持动态扩容，每次扩容为原始容量的2倍。HashMap底层基于HashTable实现，冲突策略采用链地址法。 +HashMap通过泛型定义，利用键的哈希值确定存储位置，实现快速查找。初始容量为16，支持动态扩容，每次扩容为原容量的两倍。底层基于哈希表实现，冲突处理采用链地址法。 -HashMap和[TreeMap](../reference/apis-arkts/js-apis-treemap.md)相比，HashMap依据键的hashCode存取数据，访问速度较快。而TreeMap是有序存取，效率较低。 +HashMap和[TreeMap](../reference/apis-arkts/js-apis-treemap.md)相比，HashMap依据键的hashCode存取数据，访问速度较快。TreeMap则按顺序存取，效率较低。 [HashSet](../reference/apis-arkts/js-apis-hashset.md)基于HashMap实现。HashMap的输入参数由key、value两个值组成。在HashSet中，只处理value对象。 @@ -39,7 +39,7 @@ HashMap支持增、删、改、查操作，常用API如下： | 访问元素 | forEach(callbackFn: (value?: V, key?: K, map?: HashMap) => void, thisArg?: Object) | 遍历访问整个map的元素。 | | 访问元素 | \[Symbol.iterator]():IterableIterator<[K,V]> | 创建迭代器以访问数据。 | | 修改元素 | replace(key: K, newValue: V) | 修改指定key对应的value值。 | -| 修改元素 | forEach(callbackFn: (value?: V, key?: K, map?: HashMap) => void, thisArg?: Object) | 通过遍历修改整个map的元素。 | +| 修改元素 | forEach(callbackFn: (value?: V, key?: K, map?: HashMap) => void, thisArg?: Object) | 遍历并修改整个map的元素。 | | 删除元素 | remove(key: K) | 删除map中匹配到的键值对。 | | 删除元素 | clear() | 清空整个map。 | @@ -47,18 +47,18 @@ HashMap支持增、删、改、查操作，常用API如下： [HashSet](../reference/apis-arkts/js-apis-hashset.md)可用来存储一系列值的集合，存储元素中value是唯一的。 -HashSet依据泛型定义，集合中通过value的hash值确定其存储位置，从而快速找到该值。HashSet初始容量大小为16，支持动态扩容，每次扩容为原始容量的2倍。value的类型满足ECMA标准中要求的类型。HashSet基于[HashMap](../reference/apis-arkts/js-apis-hashmap.md)实现，只对value对象进行处理。底层数据结构与HashMap一致。 +HashSet基于泛型定义，集合中通过value的hash值确定存储位置，从而快速找到该值。初始容量为16，支持动态扩容，每次扩容为原始容量的2倍。value的类型需满足ECMA标准。HashSet基于[HashMap](../reference/apis-arkts/js-apis-hashmap.md)实现，只处理value对象，底层数据结构与HashMap一致。 HashSet和[TreeSet](../reference/apis-arkts/js-apis-treeset.md)相比，HashSet中的数据无序存放，不支持用户指定排序方式，而TreeSet中的数据有序存放，支持用户通过排序函数对元素进行排序。它们集合中的元素都不允许重复，HashSet允许放入null值，但TreeSet不建议存放null值，可能会对排序结果产生影响。 -可以利用HashSet不重复的特性，当需要不重复的集合或需要去重某个集合的时候使用。 +可以利用HashSet的不重复特性，在需要去重或确保集合元素唯一性时使用。 HashSet支持增、删、改、查操作，常用API如下： | 操作 | 方法 | 描述 | | --------- | ------- | ------- | | 增加元素 | add(value: T) | 增加一个值。 | -| 访问元素 | values() | 返回一个迭代器对象，包含set中的所有value值。 | +| 访问元素 | values() | 返回一个迭代器对象，包含set中的所有value。 | | 访问元素 | entries() | 返回一个迭代器对象，包含类似键值对的数组，键值都是value。 | | 访问元素 | forEach(callbackFn: (value?: T, key?: T, set?: HashSet\) => void, thisArg?: Object) | 遍历访问整个set的元素。 | | 访问元素 | \[Symbol.iterator]():IterableIterator<T> | 创建迭代器以进行数据访问。 | @@ -70,13 +70,13 @@ HashSet支持增、删、改、查操作，常用API如下： [TreeMap](../reference/apis-arkts/js-apis-treemap.md)用于存储具有关联关系的key-value键值对集合，存储元素中key是唯一的，每个key对应一个value值。 -TreeMap依据泛型定义，key是有序存储的。底层基于红黑树实现，支持快速的插入和删除，key的类型满足ECMA标准。 +TreeMap的key按照泛型定义有序存储，基于红黑树实现，支持快速插入和删除，key的类型需满足ECMA标准。 TreeMap和[HashMap](../reference/apis-arkts/js-apis-hashmap.md)相比，HashMap依据键的hashCode存取数据，访问速度较快。而TreeMap是有序存取，效率较低。 一般需要存储有序键值对的场景，可以使用TreeMap。 -TreeMap支持增、删、改、查操作，常用API如下： +TreeMap支持增、删、改、查操作，常用 API 如下： | 操作 | 方法 | 描述 | | --------- | ------- | ------- | @@ -98,13 +98,13 @@ TreeMap支持增、删、改、查操作，常用API如下： [TreeSet](../reference/apis-arkts/js-apis-treeset.md)可用来存储一系列值的集合，存储元素中value是唯一的。 -TreeSet依据泛型定义，值是有序存储的，底层基于红黑树实现，支持快速的插入和删除。value的类型满足ECMA标准。 +TreeSet根据泛型定义有序存储值，底层实现基于红黑树，支持快速插入和删除。value的类型符合ECMA标准。 -TreeSet基于[TreeMap](../reference/apis-arkts/js-apis-treemap.md)实现，仅处理value对象。用于存储值的集合，元素中value唯一，并支持按用户定义的排序函数排序。 +TreeSet基于[TreeMap](../reference/apis-arkts/js-apis-treemap.md)实现，仅处理value对象，用于存储值的集合，元素中value唯一，并支持按用户定义的排序函数排序。用于存储值的集合，元素中value唯一，并支持按用户定义的排序函数排序。 -TreeSet和[HashSet](../reference/apis-arkts/js-apis-hashset.md)相比，HashSet中的数据无序存放，而TreeSet是有序存放。两者集合中的元素都不允许重复，HashSet允许放入null值，但TreeSet不建议存放null值，可能会对排序结果产生影响。 +TreeSet和[HashSet](../reference/apis-arkts/js-apis-hashset.md)相比，HashSet无序存放数据，TreeSet有序存放数据。两者元素均不允许重复，HashSet允许null值，但TreeSet不建议存放null值，可能影响排序。 -一般需要存储有序集合的场景，可以使用TreeSet。 +在需要存储有序集合的场景中，可以使用TreeSet。 TreeSet支持增、删、改、查操作，常用API如下： @@ -123,13 +123,13 @@ TreeSet支持增、删、改、查操作，常用API如下： ## LightWeightMap -[LightWeightMap](../reference/apis-arkts/js-apis-lightweightmap.md)可用来存储具有关联关系的key-value键值对集合，存储元素中key是唯一的，每个key会对应一个value值。LightWeightMap依据泛型定义，采用更加轻量级的结构，底层通过hash实现唯一key，冲突策略为线性探测。集合中的key值的查找依赖于hash值以及二分查找算法，通过一个数组存储hash值，然后映射到其他数组中的key值以及value值，key的类型满足ECMA标准。 +[LightWeightMap](../reference/apis-arkts/js-apis-lightweightmap.md)用于存储具有唯一键的键值对集合，存储元素中key是唯一的，每个key会对应一个value值。LightWeightMap依据泛型定义，采用轻量级结构，底层通过hash实现唯一key，冲突策略为线性探测。集合中的key值的查找依赖于hash值以及二分查找算法，通过一个数组存储hash值，然后映射到其他数组中的key值以及value值，key的类型满足ECMA标准。 -初始默认容量为8，每次扩容为原始容量的2倍。 +初始默认容量为8，每次扩容为原容量的2倍。 -LightWeightMap和[HashMap](../reference/apis-arkts/js-apis-hashmap.md)都是用来存储键值对的集合，LightWeightMap占用内存更小。 +LightWeightMap和[HashMap](../reference/apis-arkts/js-apis-hashmap.md)都是用来存储具有关联关系的key-value键值对集合，但LightWeightMap占用内存更小。 -当需要存取key-value键值对时，推荐使用占用内存更小的LightWeightMap。 +当需要存储具有关联关系的key-value键值对集合时，推荐使用占用内存更小的LightWeightMap。 LightWeightMap支持增、删、改、查操作，常用API如下： @@ -156,15 +156,15 @@ LightWeightMap支持增、删、改、查操作，常用API如下： [LightWeightSet](../reference/apis-arkts/js-apis-lightweightset.md)可用来存储一系列值的集合，存储元素中value是唯一的。 -LightWeightSet依据泛型定义，采用更加轻量级的结构，初始默认容量大小为8，每次扩容大小为原始容量的2倍。集合中的value值的查找依赖于hash以及二分查找算法，通过一个数组存储hash值，然后映射到其他数组中的value值，value的类型满足ECMA标准。 +LightWeightSet依据泛型定义，采用更加轻量级的结构，初始默认容量为8，每次扩容为原始容量的2倍。集合中的value值的查找依赖于hash值以及二分查找算法，通过一个数组存储hash值，然后映射到其他数组中的value值，value的类型满足ECMA标准。 -LightWeightSet底层通过hash实现唯一value的标识，冲突策略采用线性探测法，查找策略基于二分查找法。 +LightWeightSet底层通过hash表结构实现value的唯一性，冲突策略采用线性探测法，查找策略基于二分查找法。 -LightWeightSet和[HashSet](../reference/apis-arkts/js-apis-hashset.md)都是用来存储键值的集合，LightWeightSet占用内存更小。 +LightWeightSet和[HashSet](../reference/apis-arkts/js-apis-hashset.md)都是用来存储键值的集合，但LightWeightSet的占用内存更小。 当需要存取某个集合或是对某个集合去重时，推荐使用占用内存更小的LightWeightSet。 -LightWeightSet支持增、删、改、查操作，常用API如下： +LightWeightSet支持增、删、改、查操作。常用API如下： | 操作 | 方法 | 描述 | | --------- | ------- | ------- | @@ -182,15 +182,15 @@ LightWeightSet支持增、删、改、查操作，常用API如下： ## PlainArray -[PlainArray](../reference/apis-arkts/js-apis-plainarray.md)可用来存储具有关联关系的键值对集合，存储元素中key是唯一的，并且对于PlainArray来说，其key的类型为number类型。每个key会对应一个value值，类型依据泛型的定义，PlainArray采用更加轻量级的结构，集合中的key值的查找依赖于二分查找算法，然后映射到其他数组中的value值。 +[PlainArray](../reference/apis-arkts/js-apis-plainarray.md)可用来存储具有关联关系的键值对集合，存储元素中key是唯一的，并且对于PlainArray来说，其key的类型为number类型。每个key会对应一个value值，类型依据泛型的定义，PlainArray采用轻量级的结构，集合中的key值的查找依赖于二分查找算法，然后映射到其他数组中的value值。 -初始默认容量大小为16，每次扩容大小为原始容量的2倍。 +初始默认容量为16，每次扩容为原始容量的2倍。 -PlainArray和[LightWeightMap](../reference/apis-arkts/js-apis-lightweightmap.md)都是用来存储键值对，且均采用轻量级结构，但PlainArray的key值类型仅限于number。 +PlainArray和[LightWeightMap](../reference/apis-arkts/js-apis-lightweightmap.md)都用于存储键值对，且采用轻量级结构。不过，PlainArray的键值类型仅限于number。 -当需要存储key值为number类型的键值对时，可以使用PlainArray。 +当需要存储键为number类型的键值对时，可以使用PlainArray。 -PlainArray支持增、删、改、查操作，常用API如下： +PlainArray支持增、删、改、查操作。常用API如下： | 操作 | 方法 | 描述 | | --------- | ------- | ------- | diff --git a/zh-cn/application-dev/arkts-utils/xml-conversion.md b/zh-cn/application-dev/arkts-utils/xml-conversion.md index 218a9a6a0395c122093c68e97faf0647a63f4b91..41df48df202c9211f763ca13420b3178d4f62daf 100644 --- a/zh-cn/application-dev/arkts-utils/xml-conversion.md +++ b/zh-cn/application-dev/arkts-utils/xml-conversion.md @@ -1,32 +1,32 @@ # XML转换 -将XML文本转换为JavaScript对象便于处理和操作数据，适合在JavaScript应用程序中使用。 +将XML文本转换为JavaScript对象，便于处理和操作数据，适用于JavaScript应用程序。 -语言基础类库提供ConvertXML类将XML文本转换为JavaScript对象，输入为待转换的XML字符串及转换选项，输出为转换后的JavaScript对象。具体转换选项可见[API参考@ohos.convertxml](../reference/apis-arkts/js-apis-convertxml.md)。 +语言基础类库提供ConvertXML类，将XML文本转换为JavaScript对象，输入为待转换的XML字符串及转换选项，输出为转换后的JavaScript对象。具体转换选项可见[API参考@ohos.convertxml](../reference/apis-arkts/js-apis-convertxml.md)。 ## 注意事项 -XML解析及转换需要确保传入的XML数据符合标准格式。 +XML解析及转换需要确保传入的XML数据符合XML标准格式。 ## 开发步骤 -以XML转为JavaScript对象后获取其标签值为例，说明转换效果。 +以XML转换为JavaScript对象为例，说明如何获取标签值。 -1. 引入模块。 +1. 引入所需的模块。 ```ts import { convertxml } from '@kit.ArkTS'; ``` -2. 输入待转换的XML，设置转换选项，支持的转换选项及含义具体可见[ConvertOptions](../reference/apis-arkts/js-apis-convertxml.md#convertoptions)。 +2. 输入待转换的XML，设置转换选项。支持的转换选项及含义，请参见[ConvertOptions](../reference/apis-arkts/js-apis-convertxml.md#convertoptions)。 > **说明：** > - > 传入的XML文本中若包含“&”字符，请使用实体引用“\&”替换。 + > 请确保传入的XML文本符合标准格式，若包含“&”字符，请使用实体引用“\&”替换。 ```ts let xml: string = @@ -64,7 +64,7 @@ XML解析及转换需要确保传入的XML数据符合标准格式。 } ``` -3. 调用转换函数并打印结果。 +3. 调用fastConvertToJSObject函数并打印结果。 ```ts let conv: convertxml.ConvertXML = new convertxml.ConvertXML(); diff --git a/zh-cn/application-dev/arkts-utils/xml-generation.md b/zh-cn/application-dev/arkts-utils/xml-generation.md index a506bc7a380fc9c085e6ede79675db7442262202..5fc25d626e36956471ad053fd022f505fcf0b73b 100644 --- a/zh-cn/application-dev/arkts-utils/xml-generation.md +++ b/zh-cn/application-dev/arkts-utils/xml-generation.md @@ -1,10 +1,10 @@ # XML生成 -XML可以作为数据交换格式，被各种系统和应用程序所支持。例如Web服务，可以将结构化数据以XML格式进行传递。 +XML可以作为数据交换格式，被各种系统和应用程序支持。例如Web服务，可以将结构化数据以XML格式进行传递。 -XML还可以作为消息传递格式，在分布式系统中用于不同节点之间的通信与交互。 +XML还可以作为消息传递格式，用于分布式系统中不同节点的通信。 ## 注意事项 @@ -16,11 +16,11 @@ XML还可以作为消息传递格式，在分布式系统中用于不同节点 ## 开发步骤 -XML模块提供XmlSerializer类来生成XML数据，输入为固定长度的ArrayBuffer或DataView对象，该对象用于存放生成的XML数据。 +XML模块提供XmlSerializer类来生成XML数据，需传入固定长度的ArrayBuffer或DataView对象作为输出缓冲区，用于存储序列化后的XML数据。 -通过调用不同的方法来写入不同的内容，如startElement(name: string)写入元素开始标记，setText(text: string)写入标签值。 +调用不同的方法写入不同的内容，如startElement(name: string)写入元素开始标记，setText(text: string)写入标签值。 -XML模块的API接口可以参考[@ohos.xml](../reference/apis-arkts/js-apis-xml.md)的详细描述，按需求调用对应函数可以生成一份完整的XML数据。 +XML模块的API接口可以参考[@ohos.xml](../reference/apis-arkts/js-apis-xml.md)的详细描述，按需求调用相应的函数可以生成一份完整的XML数据。 1. 引入模块。 @@ -51,7 +51,7 @@ XML模块的API接口可以参考[@ohos.xml](../reference/apis-arkts/js-apis-xml serializer.setDeclaration(); // 写入xml的声明 serializer.startElement('bookstore'); // 写入元素开始标记 serializer.startElement('book'); // 嵌套元素开始标记 - serializer.setAttributes('category', 'COOKING'); // 写入属性及属性值 + serializer.setAttributes('category', 'COOKING'); // 写入属性及其属性值 serializer.startElement('title'); serializer.setAttributes('lang', 'en'); serializer.setText('Everyday'); // 写入标签值 @@ -66,7 +66,7 @@ XML模块的API接口可以参考[@ohos.xml](../reference/apis-arkts/js-apis-xml serializer.endElement(); ``` -4. 使用Uint8Array操作ArrayBuffer，调用TextDecoder对Uint8Array解码后输出。 +4. 使用Uint8Array操作ArrayBuffer，并调用TextDecoder对Uint8Array解码后输出。 ```ts let uint8Array: Uint8Array = new Uint8Array(arrayBuffer); // 使用Uint8Array读取arrayBuffer的数据 diff --git a/zh-cn/application-dev/arkts-utils/xml-overview.md b/zh-cn/application-dev/arkts-utils/xml-overview.md index 66fd700d25988daacf55aaa10a812936c9653bad..5aec0c4f680417e30f44fa8abcd5ea9f52bc361a 100644 --- a/zh-cn/application-dev/arkts-utils/xml-overview.md +++ b/zh-cn/application-dev/arkts-utils/xml-overview.md @@ -1,7 +1,7 @@ # XML概述 -XML（可扩展标记语言）是一种用于描述数据的标记语言，旨在提供一种通用的方式来传输和存储数据，特别是Web应用程序中经常使用的数据。XML并不预定义标记。因此，XML更加灵活，并且可以适用于广泛的应用领域。 +XML（可扩展标记语言）是一种用于描述数据的标记语言，提供通用的数据传输和存储方式。XML不预定义标记，因此更加灵活，适用于广泛的应用领域。 XML文档由元素（element）、属性（attribute）和内容（content）组成。 @@ -14,10 +14,10 @@ XML文档由元素（element）、属性（attribute）和内容（content）组 - 内容则是元素包含的数据或子元素。 -XML可以通过使用XML Schema或DTD（文档类型定义）来定义文档结构。这些机制允许开发人员创建自定义规则以验证XML文档是否符合其预期的格式。 +XML使用XML Schema或DTD（文档类型定义）定义文档结构，开发人员可以利用这些机制创建自定义规则，以验证XML文档的格式是否符合预期规范。 -XML支持命名空间、实体引用、注释和处理指令等特性，使其能够灵活地适应各种数据需求。 +XML支持命名空间、实体引用、注释和处理指令，灵活适应各种数据需求。 语言基础类库提供了XML相关的基础能力，包括：[XML的生成](xml-generation.md)、[XML的解析](xml-parsing.md)和[XML的转换](xml-conversion.md)。 diff --git a/zh-cn/application-dev/arkts-utils/xml-parsing.md b/zh-cn/application-dev/arkts-utils/xml-parsing.md index 77b19e6af0a9df87b64e1fcf12ceed47995b8986..9946dac92f59597b4283e1876bcfcaf354a05ba8 100644 --- a/zh-cn/application-dev/arkts-utils/xml-parsing.md +++ b/zh-cn/application-dev/arkts-utils/xml-parsing.md @@ -4,7 +4,7 @@ 对于以XML作为载体传递的数据，实际使用中需要对相关的元素进行解析，一般包括[解析XML标签和标签值](#解析xml标签和标签值)、[解析XML属性和属性值](#解析xml属性和属性值)、[解析XML事件类型和元素信息](#解析xml事件类型和元素信息)三类操作。如在Web服务中，XML是SOAP（Simple Object Access Protocol）协议的基础，SOAP消息通常以XML格式封装，包含请求和响应参数，通过解析这些XML消息，Web服务可以处理来自客户端的请求并生成相应的响应。 -XML模块提供XmlPullParser类解析XML文本，输入为含有XML文本的ArrayBuffer或DataView，输出为解析结果。 +XML模块提供XmlPullParser类用于解析XML文本，输入为包含XML数据的ArrayBuffer或DataView，输出为结构化的解析结果。 **表1** XML解析选项，其详细介绍请参见[ParseOptions](../reference/apis-arkts/js-apis-xml.md#parseoptions)。 @@ -13,16 +13,16 @@ XML模块提供XmlPullParser类解析XML文本，输入为含有XML文本的Arra | -------- | -------- | -------- | -------- | | supportDoctype | boolean | 否 | 是否解析文档类型，false表示不解析文档类型，true表示解析文档类型，默认false。 | | ignoreNameSpace | boolean | 否 | 是否忽略命名空间，忽略命名空间后，将不会对其进行解析。true表示忽略命名空间，false表示不忽略命名空间，默认false。| -| tagValueCallbackFunction | (name: string, value: string) => boolean | 否 | 获取tagValue回调函数，打印标签及标签值。默认为undefined，表示不解析XML标签和标签值。 | -| attributeValueCallbackFunction | (name: string, value: string) => boolean | 否 | 获取attributeValue回调函数，打印属性及属性值。默认为undefined，表示不解析XML属性和属性值。 | -| tokenValueCallbackFunction | (eventType: EventType, value: ParseInfo) => boolean | 否 | 获取tokenValue回调函数，打印标签事件类型及parseInfo对应属性。默认为undefined，表示不解析XML事件类型。 | +| tagValueCallbackFunction | (name: string, value: string) => boolean | 否 | 获取tagValue回调函数，打印XML标签及标签值。默认为undefined，表示不解析XML标签和标签值。 | +| attributeValueCallbackFunction | (name: string, value: string) => boolean | 否 | 获取attributeValue回调函数，打印XML属性及属性值。默认为undefined，表示不解析XML属性和属性值。 | +| tokenValueCallbackFunction | (eventType: EventType, value: ParseInfo) => boolean | 否 | 获取tokenValue回调函数，打印XML事件类型及parseInfo对应属性。默认为undefined，表示不解析XML事件类型。 | ## 注意事项 - 确保传入的XML数据符合标准格式。 -- 目前不支持按指定节点解析对应的节点值。 +- 目前不支持解析指定节点的值。 ## 解析XML标签和标签值 @@ -35,7 +35,7 @@ XML模块提供XmlPullParser类解析XML文本，输入为含有XML文本的Arra 2. 对XML文本编码后调用XmlPullParser。 - 可以基于ArrayBuffer构造XmlPullParser对象，也可以基于DataView构造XmlPullParser对象（两种构造方式返回结果无区别可任选一种）。 + 可以基于ArrayBuffer创建XmlPullParser对象，也可以基于DataView创建XmlPullParser对象（两种创建方式返回结果无区别可任选一种）。 ```ts let strXml: string = @@ -45,7 +45,7 @@ XML模块提供XmlPullParser类解析XML文本，输入为含有XML文本的Arra 'Work' + ''; let textEncoder: util.TextEncoder = new util.TextEncoder(); - let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml); // 对数据编码，防止包含中文字符乱码 + let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml); // 对数据进行编码，防止中文字符乱码 // 方式1：基于ArrayBuffer构造XmlPullParser对象 let that: xml.XmlPullParser = new xml.XmlPullParser(arrBuffer.buffer as object as ArrayBuffer, 'UTF-8'); @@ -99,7 +99,7 @@ XML模块提供XmlPullParser类解析XML文本，输入为含有XML文本的Arra 1. 引入模块。 ```ts - import { xml, util } from '@kit.ArkTS'; // 需要使用util模块函数对文本编码 + import { xml, util } from '@kit.ArkTS'; // 使用util模块对文本编码 ``` 2. 对XML文本编码后调用XmlPullParser。 @@ -113,11 +113,11 @@ XML模块提供XmlPullParser类解析XML文本，输入为含有XML文本的Arra ' Work' + ''; let textEncoder: util.TextEncoder = new util.TextEncoder(); - let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml); // 对数据编码，防止包含中文字符乱码 + let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml); // 对数据进行编码，防止中文字符乱码 let that: xml.XmlPullParser = new xml.XmlPullParser(arrBuffer.buffer as object as ArrayBuffer, 'UTF-8'); ``` -3. 自定义回调函数，本例直接打印出属性及属性值。 +3. 自定义回调函数，示例直接打印出属性及属性值。 ```ts let str: string = ''; @@ -132,7 +132,7 @@ XML模块提供XmlPullParser类解析XML文本，输入为含有XML文本的Arra ```ts let options: xml.ParseOptions = {supportDoctype:true, ignoreNameSpace:true, attributeValueCallbackFunction:func}; that.parseXml(options); - console.info(str); // 一次打印出所有的属性及其值 + console.info(str); // 打印所有属性及其值 ``` 输出结果如下所示： @@ -146,7 +146,7 @@ XML模块提供XmlPullParser类解析XML文本，输入为含有XML文本的Arra 1. 引入模块。 ```ts - import { xml, util } from '@kit.ArkTS'; // 需要使用util模块函数对文本编码 + import { xml, util } from '@kit.ArkTS'; // 使用util模块函数对文本编码 ``` 2. 对XML文本编码后调用XmlPullParser。 @@ -158,16 +158,16 @@ XML模块提供XmlPullParser类解析XML文本，输入为含有XML文本的Arra 'Play' + ''; let textEncoder: util.TextEncoder = new util.TextEncoder(); - let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml); // 对数据编码，防止包含中文字符乱码 + let arrBuffer: Uint8Array = textEncoder.encodeInto(strXml); // 对数据进行编码，防止中文字符乱码 let that: xml.XmlPullParser = new xml.XmlPullParser(arrBuffer.buffer as object as ArrayBuffer, 'UTF-8'); ``` -3. 自定义回调函数，本例直接打印元素事件类型及元素深度。 +3. 自定义回调函数，示例直接打印元素事件类型及元素深度。 ```ts let str: string = ''; function func(name: xml.EventType, value: xml.ParseInfo): boolean { - str = name + ' ' + value.getDepth(); // getDepth 获取元素的当前深度 + str = name + ' ' + value.getDepth(); // getDepth 获取元素在XML文档中的当前深度 console.info(str); return true; // true:继续解析 false:停止解析 }