# ComponentEncapsulation

**Repository Path**: harmonyos_samples/ComponentEncapsulation

## Basic Information

- **Project Name**: ComponentEncapsulation
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 15
- **Created**: 2024-10-29
- **Last Updated**: 2025-06-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 实现组件的封装

### 介绍

本示例通过系统组件的attributeModifier属性、PromptAction对象、wrapBuilder函数，实现公共组件的封装、弹窗组件的封装、全局@Builder。帮助开发者掌握如何优化重复性的组件、布局，使代码简洁，易维护。

### 效果图预览

| 首页                                     | 公用组件封装场景                                | 弹窗组件封装场景                                | 组件工厂类封装场景                                |
|----------------------------------------|-----------------------------------------|-----------------------------------------|------------------------------------------|
| ![image](screenshots/device/index.png) | ![image](screenshots/device/common.png) | ![image](screenshots/device/dialog.png) | ![image](screenshots/device/factory.png) |

##### 使用说明

进入首面，会看到公用组件封装、弹窗组件封装和组件工厂类封装三个按钮，点击按钮会进入对应的封装场景实现的页面，查看效果。

### 工程目录

```
├──entry/src/main/ets/
│  ├──common
│  │  └──CommonConstants.ets         // 公共常量类
│  ├──entryability
│  │  └──EntryAbility.ets            // 程序入口类
│  ├──model
│  │  ├──AttributeModifier.ets       // AttributeModifier接口类
│  │  ├──GetResourceString.ets       // Resource转换String函数
│  │  └──PopViewUtils.ets            // 自定义弹窗类
│  ├──pages
│  │  ├──CommonComponent.ets         // 公共组件封装
│  │  ├──ComponentFactory.ets        // 组件工厂类封装
│  │  ├──DialogComponent.ets         // 弹窗组件封装        
│  │  └──Index.ets                   // 首页
│  └──view
│     ├──CustomImageText.ets         // 自定义图片加文本组件
│     └──FactoryMap.ets              // 组件工厂
└──entry/src/main/resources          // 应用静态资源目录
```

### 具体实现

1. 公用组件封装：系统组件提供了attributeModifier属性方法，通过自定义Class类实现AttributeModifier接口对系统组件属性进行扩展。

2. 弹窗组件封装：通过使用UIContext中获取到的PromptAction对象来实现自定义弹窗封装，使用PromptAction对象中openCustomDialog接口打开弹窗，closeCustomDialog接口关闭弹窗。

3. 组件工厂类封装：使用Map结构将封装的各个组件存入，提供方将需要工厂化的组件通过全局@Builder方法封装，将封装好的全局@Builder方法使用wrapBuilder函数包裹，并将返回值作为组件工厂Map的value值存入，使用时通过Map的key值获取相应组件。

### 相关权限

不涉及。

### 约束与限制

1. 本示例仅支持标准系统上运行，支持设备：华为手机。

2. HarmonyOS系统：HarmonyOS 5.0.4 Release及以上。

3. DevEco Studio版本：DevEco Studio 5.0.4 Release及以上。

4. HarmonyOS SDK版本：HarmonyOS 5.0.4 Release SDK及以上。