# commonlibrary_ets_utils

**Repository Path**: hyq5234/commonlibrary_ets_utils

## Basic Information

- **Project Name**: commonlibrary_ets_utils
- **Description**: js_api_module, used to store the basic class library JSAPI, such as url, uri, etc.| 用于存放基础类库JSAPI，比如url、uri等
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 308
- **Created**: 2023-05-06
- **Last Updated**: 2024-10-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ets_utils组件
- [简介](#简介)
- [目录](#目录)
- [约束](#约束)
- [接口说明](#接口说明)
- [编译构建](#编译构建)
- [相关仓](#相关仓)
- [许可证](#许可证)

## 简介
ets_utils组件旨在为开发者提供实用且高效的工具类函数集合，帮助开发者快速实现需求，提升应用开发效率。</br>

**图 1** ets_utils组件的完整结构图</br>
![输入图片说明](tools/figures/zh-ch_image_ets_utils_structure.jpg)

## 目录
```
/commonlibrary/ets_utils
├─ js_api_module
│  ├─ buffer             # buffer模块相关功能实现及UT用例
│     └── src            # buffer模块的混编文件
│     └── test           # buffer模块的UT文件
│     └── ...
│  ├─ convertxml         # convertxml模块相关功能实现及UT用例    
│  ├─ uri                # uri模块相关功能实现及UT用例
│  ├─ url                # url模块相关功能实现及UT用例
│  ├─ xml                # xml模块相关功能实现及UT用例
├─ js_concurrent_module
│  ├─ common/helper      # 提供封装的基础能力
│  ├─ taskpool           # taskpool模块相关功能实现及UT用例
│  ├─ test               # common/helper中UT用例
│  ├─ utils              # Locks模块和ASON模块相关功能实现及UT用例
│  ├─ worker             # worker模块相关功能实现及UT用例
├─ js_sys_module
│  ├─ console            # console模块相关功能实现及UT用例
│  ├─ dfx                # dfx模块相关功能实现
│  ├─ process            # process模块相关功能实现
│  ├─ test               # process模块UT用例
│  ├─ timer              # timer模块相关功能实现及UT用例
├─ js_util_module
│  ├─ collections        # collections模块相关功能实现及UT用例
│  ├─ container          # container模块相关功能实现
│  ├─ json               # json模块相关功能实现
│  ├─ stream             # stream模块相关功能实现
│  ├─ util               # 提供TextEncoder、TextDecoder、Base64Helper和LRUCache等模块相关功能实现及UT用例
├─ platform              # 提供多平台实现方法
└─ tools                 # 提供ets_utils通用的工具方法
```

## 约束

适用于标准系统。

## 接口说明

- **js_api_module**

| 类  | 功能介绍  | 接口说明  |
|---|---|---|
| Buffer      | 提供固定大小的字节序列存储，是用于二进制数据的缓存管理。| [@ohos.buffer](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-buffer.md) |
| URI         | 提供URI字符串解析的相关功能。  | [@ohos.uri](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-uri.md) |
| URL         | 解析URL字符串和构造URL对象等功能。  | [@ohos.url](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-url.md) |
| XML         | 提供了将XML文本转换为JavaScript对象、以及XML文件生成和解析的一系列接口。  | [@ohos.xml](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-xml.md) |
| ConvertXml  | 提供转换xml文本为JavaScript对象的功能。  | [@ohos.convertxml](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-convertxml.md) |

- **js_sys_module**

| 类  | 功能介绍  | 接口说明  |
|---|---|---|
| Console   | 提供了一个简单的调试控制台，类似于浏览器提供的JavaScript控制台机制。  | [console](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/common/js-apis-logs.md) |
| DFX       | 提供内存与性能分析工具。  | NA |
| Process   | 提供获取进程相关的信息以及进程管理的相关功能。 | [@ohos.process](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-process.md) |
| Timer     | 模块提供基础的定时器能力，支持按照指定的时间执行对应函数。  | [timer](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/common/js-apis-timer.md) |

- **js_concurrent_module**

| 类  | 功能介绍  | 接口说明  |
|---|---|---|
| Locks      | 提供异步锁的能力，解决多并发场景下的数据竞争问题。  |[@arkts.utils](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-arkts-utils.md)  |
| ASON       | 提供开发者解析JSON字符串，并生成共享数据进行跨并发域传输。  | [@arkts.utils](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-arkts-utils.md)  |
| TaskPool   | 提供开发者以任务为维度的多并发能力。  | [@ohos.taskpool](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-taskpool.md)  |
| Worker     | 提供开发者以线程为维度的多并发能力。  | [@ohos.worker](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-worker.md)  |

- **js_util_module**

| 类  | 功能介绍  | 接口说明  |
|---|---|---|
| Collections  | 提供的ArkTS容器集，可以用于并发场景下的高性能数据传递。  | [@arkts.collections](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-arkts-collections.md)  |
| Container    | 提供的ArkTS高性能容器集合。  | [容器类归档](https://gitee.com/openharmony/docs/tree/master/zh-cn/application-dev/reference/apis-arkts) |
| JSON         | 提供将JSON文本转换为JSON对应对象或值，以及将对象转换为JSON字符串等功能。  |[@ohos.util.json](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-json.md)  |
| Stream       | 提供ArkTS基本流类型的处理能力。  | [@ohos.util.stream](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-stream.md)  |
| TextEncoder  | 提供将字符串编码为字节数组，支持多种编码格式。  | [util.textencoder](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#textencoder) |
| TextDecoder  | 提供将字节数组解码为字符串，支持多种编码格式。  | [util.textdecoder](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#textdecoder) |
| Base64Helper | 提供Base64编解码和Base64URL编解码功能。  |[util.base64helper](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#base64helper9)  |
| Aspect       | 提供封装提供切面能力的接口，该接口可以用来对类方法进行前后插桩或者替换实现。  | [util.aspect](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#aspect11)  |
| Types        | 提供为不同类型的内置对象提供类型检查。  |[util.types](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#types8)   |
| UUID         | 提供生成、解析UUID的能力。  |[util.uuid](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#utilparseuuid9)   |
| getHash      | 提供获取对象的Hash值的能力。  | [util.gethash](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#utilgethash12) |
| RationalNumber | 提供对有理数进行比较，获取对象中分子分母等能力。  |  [util.rationalnumber](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#rationalnumber8) |
| ScopeHelper  | 提供创建具有指定下限和上限的对象的能力，同时该对象必须具有可比性。  | [util.rationalnumber](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#scopehelper9) |
| StringDecoder| 提供将二进制流解码为字符串的能力。  | [util.stringdecoder](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#stringdecoder12) |
| LRUCache     | 提供在预设的缓存空间不够的时候，将近期最少使用的数据替换为新数据的能力。  |[util.LRUCache](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis-arkts/js-apis-util.md#lrucache9)  |

## 编译构建

- **编译部件**

```
./build.sh --product-name rk3568 --build-target ets_utils
```

- **编译UT**
```
./build.sh --product-name rk3568 --build-target {ohos_unittest_name}
```
ohos_unittest_name: 所测试模块的UT目录下build\.gn文件中ohos_unittest的名称。

## 相关仓
[arkcompiler_ets_runtime](https://gitee.com/openharmony/arkcompiler_ets_runtime/blob/master/README_zh.md)</br>
[arkui_ace_engine](https://gitee.com/openharmony/arkui_ace_engine/blob/master/README_zh.md)</br>
[arkui_napi](https://gitee.com/openharmony/arkui_napi/blob/master/README_zh.md)</br>
[ets_utils](https://gitee.com/openharmony/commonlibrary_ets_utils/blob/master/README.md)</br>
[ArkTS开发指南](https://gitee.com/openharmony/docs/tree/master/zh-cn/application-dev/arkts-utils)</br>

## 许可证
js_api_module子模块在[Mozilla许可证](https://www.mozilla.org/en-US/MPL/)下可用，有关完整的许可证文本，请参见[许可证](https://gitee.com/openharmony/commonlibrary_ets_utils/blob/master/js_api_module/mozilla_docs.txt)。</br>
js_util_module子模块在[Mozilla许可证](https://www.mozilla.org/en-US/MPL/)下可用，有关完整的许可证文本，请参见[许可证](https://gitee.com/openharmony/commonlibrary_ets_utils/blob/master/js_util_module/mozilla_docs.txt)。</br>
js_concurrent_module子模块在[Mozilla许可证](https://www.mozilla.org/en-US/MPL/)下可用，有关完整的许可证文本，请参见[许可证](https://gitee.com/openharmony/commonlibrary_ets_utils/blob/master/js_concurrent_module/mozilla_docs.txt)。</br>
js_sys_module子模块在[Mozilla许可证](https://www.mozilla.org/en-US/MPL/)下可用，有关完整的许可证文本，请参见[许可证](https://gitee.com/openharmony/commonlibrary_ets_utils/blob/master/js_sys_module/mozilla_docs.txt)。