• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# app_samples部件<a name="ZH-CN_TOPIC_0000001115464207"></a>
2
3## 简介<a name="section1470103520301"></a>
4
5【示例贡献温馨提示】感谢您关注OpenHarmony,如果您希望提交代码样例/示例/Demo,请参考知识体系的[《如何共建开发样例》](https://gitee.com/openharmony-sig/knowledge/blob/master/docs/co-construct_demos/README_zh.md),首先提交到SIG(兴趣组)仓,知识体系SIG仓中的提交也是有效贡献。再次感谢您的关注!
6
7新Sample合入需遵循[Sample编码规范](CodeCommitChecklist.md)。
8
9**内容简介**
10
11为帮助开发者快速熟悉OpenHarmony SDK所提供的API和应用开发流程,我们提供了一系列的应用示例,即Sample。每一个应用示例都是一个独立的DevEco Studio工程项目,开发者可以将工程导入到DevEco Studio开发工具,通过浏览代码、编译工程、安装和运行应用示例来了解应用示例中涉及API的使用方法。
12
13**架构组成**
14
15- Basic
16  - [`Container`:线性容器ArrayList(eTS)(API8)](Basic/Container)
17  - [`Screenshot`:屏幕截图(eTS)(API9)(Full SDK)](Basic/Screenshot)
18- AppSample
19  - [`Chat`:聊天示例应用(eTS)(API8)](AppSample/Chat)
20  - [`Shopping`:购物示例应用(eTS)(API8)](AppSample/Shopping)
21- Account
22  - [`AppAccountManager`:应用帐号管理(eTS)(API8)](Account/AppAccountManager)
23  - [`DistributeAccount`:分布式帐号管理(eTS)(API8)](Account/DistributeAccount)
24- Communication
25  - [`RPC`:RPC连接(eTS)(API8)](Communication/RPC)
26  - [`Wlan`:WLAN(eTS)(API8)(Full SDK)](Communication/Wlan)
27- ability
28  - [`DMS`:分布式Demo(eTS)(API8)(Full SDK)](ability/DMS)
29  - [`JsDistributedMusicPlayer`:分布式音乐播放(JS)(API8)(Full SDK)](ability/JsDistributedMusicPlayer)
30  - [`DataAbility`:DataAbility的创建与访问(eTS)(API8)](ability/DataAbility)
31  - [`ServiceAbility`:ServiceAbility的创建与使用(eTS)(API8)](ability/ServiceAbility)
32  - [`StageCallAbility`:StageCallAbility的创建与使用(eTS)(API9)(Full SDK)](ability/StageCallAbility)
33  - [`FormAbility`:FA模型卡片(eTS)(API8)](ability/FormAbility)
34  - [`FormExtAbility`:Stage模型卡片(eTS)(API9)](ability/FormExtAbility)
35  - [`FormLauncher`:卡片使用方(eTS)(API8)(Full SDK)](ability/FormLauncher)
36  - [`ServiceExtAbility`:StageExtAbility的创建与使用(eTS)(API9)(Full SDK)](ability/ServiceExtAbility)
37  - [`DistributedGraffiti`:分布式涂鸦(eTS)(API8)(Full SDK)](ability/DistributedGraffiti)
38  - [`MissionManager`:系统任务管理(eTS)(API9)(Full SDK)](ability/MissionManager)
39  - [`GalleryForm`:图库卡片(eTS)(API9)](ability/GalleryForm)
40  - [`Launcher`:仿桌面应用(eTS)(API9)(Full SDK)](ability/Launcher)
41  - [`FaModel`:FA模型(eTS)(API9)](ability/FaModel)
42  - [`StageModel`:Stage模型(eTS)(API9)(Full SDK)](ability/StageModel)
43  - [`WindowExtAbility`:窗口扩展(eTS)(API9)(Full SDK)](ability/WindowExtAbility)
44- common
45  - [`Clock`:时钟(JS)(API8)](common/Clock)
46  - [`DistributeCalc`:分布式计算器(JS)(API8)(Full SDK)](common/DistributeCalc)
47  - [`Notification`:通知(eTS)(API8)](common/Notification)
48  - [`ResourceManager`:资源管理器(eTS)(API8)](common/ResourceManager)
49  - [`Runninglock`:运行锁(eTS)(API8)](common/Runninglock)
50  - [`JsHelloWorld`:你好世界(JS)(API8)](common/JsHelloWorld)
51  - [`PowerManager`:系统电源管理(eTS)(API8)(Full SDK)](common/PowerManager)
52  - [`International`:国际化(eTS)(API8)(Full SDK)](common/International)
53- data
54  - [`KvStore`:分布式数据库(eTS)(API8)(Full SDK)](data/Kvstore)
55  - [`LiteStorage`:轻量级存储(eTS)(API8)](data/LiteStorage)
56  - [`DDMQuery`:结果集与谓词(eTS)(API8)](data/DDMQuery)
57  - [`DistributedRdb`:分布式关系型数据库(eTS)(API8)(Full SDK)](data/DistributedRdb)
58  - [`Preferences`:首选项(eTS)(API9)](data/Preferences)
59  - [`DistributedNote`:分布式备忘录(eTS)(API9)(Full SDK)](data/DistributedNote)
60  - [`DistributedDataGobang`:分布式五子棋(eTS)(API9)(Full SDK)](data/DistributedDataGobang)
61  - [`DistributedObjectDms`:分布式跑马灯(eTS)(API9)(Full SDK)](data/DistributedObjectDms)
62- device
63  - [`DeviceManager`:设备管理(eTS)(API8)(Full SDK)](device/DeviceManager)
64  - [`Sensor`:传感器(eTS)(API8)](device/Sensor)
65  - [`Vibrator`:振动(eTS)(API8)](device/Vibrator)
66  - [`DeviceUsageStatistics`:设备使用信息统计(eTS)(API8)(Full SDK)](device/DeviceUsageStatistics)
67  - [`Browser`:浏览器(eTS)(API9)(Full SDK)](device/Browser)
68  - [`Screen`:屏幕属性(eTS)(API9)(Full SDK)](device/Screen)
69  - [`USBManager`:USB管理(eTS)(API8)](device/USBManager)
70  - [`Bluetooth`:蓝牙(eTS)(API9)(Full SDK)](device/Bluetooth)
71  - [`Location`:位置服务(eTS)(API9)](device/Location)
72- Graphics
73  - [`JsWebGL`:WebGL(JS)(API8)](Graphics/JsWebGL)
74  - [`Window`:窗口(eTS)(API9)](Graphics/Window)
75- media
76  - [`JsAudioPlayer`:音频播放和管理(JS)(API8)](media/JsAudioPlayer)
77  - [`JsVideo`:视频播放(JS)(API8)](media/JsVideo)
78  - [`Recorder`:录音机(eTS)(API8)(Full SDK)](media/Recorder)
79  - [`MultiMedia`:相机和媒体库(eTS)(API9)(Full SDK)](media/MultiMedia)
80  - [`VideoPlayer`:视频播放(eTS)(API9)(Full SDK)](media/VideoPlayer)
81  - [`Image`:图片处理(eTS)(API9)](media/Image)
82  - [`GamePuzzle`:拼图(eTS)(API9)](media/GamePuzzle)
83  - [`Scan`:媒体库相机(eTS)(API9)](media/Scan)
84  - [`VideoShow`:媒体库视频(eTS)(API9)](media/VideoShow)
85  - [`ImageShow`:图片显示(eTS)(API9)](media/ImageShow)
86  - [`MediaCollections`:媒体管理合集(eTS)(API9)(Full SDK)](media/MediaCollections)
87- DFX
88  - [`JsDotTest`:测试打点(JS)(API8)](DFX/JsDotTest)
89  - [`FaultLogger`:故障日志获取(eTS)(API8)](DFX/FaultLogger)
90  - [`Logger`:日志打印(eTS)(API9)](DFX/Logger)
91  - [`Debug`:Debug(eTS)(API9)](DFX/Debug)
92- Safety
93  - [`Cipher`:加解密(eTS)(API8)](Safety/Cipher)
94  - [`AbilityAccessCtrl`:访问权限控制(eTS)(API8)(Full SDK)](Safety/AbilityAccessCtrl)
95- Telephony
96  - [`Call`:拨打电话(eTS)(API8)](Telephony/Call)
97  - [`Message`:短信服务(eTS)(API8)(Full SDK)](Telephony/Message)
98  - [`RadioTech`:网络搜索(eTS)(API8)](Telephony/RadioTech)
99  - [`SimManager`:SIM卡管理(eTS)(API8)](Telephony/SimManager)
100  - [`MobileNetwork`:蜂窝数据(eTS)(API9)](Telephony/MobileNetwork)
101  - [`Observer`:Observer(eTS)(API9)](Telephony/Observer)
102  - [`Contact`:Contact(eTS)(API8)](Telephony/Contact)
103- thread
104  - [`JsWorker`:启动一个worker(JS)(API8)](thread/JsWorker)
105- CompleteApps
106  - [`KikaInput`:轻量级输入法(JS)(API9)(Full SDK)](CompleteApps/KikaInput)
107  - [`FlipClock`:翻页时钟(eTS)(API8)(Full SDK)](CompleteApps/FlipClock)
108- EngineeringCapability
109  - [`Npm`:npm的使用(eTS)(API9)](EngineeringCapability/Npm)
110- ETSUI
111  - [`Canvas`:画布组件(eTS)(API8)](ETSUI/Canvas)
112  - [`CustomComponent`:组件化(eTS)(API8)](ETSUI/CustomComponent)
113  - [`Process`:进程信息(eTS)(API9)(Full SDK)](ETSUI/Process)
114  - [`BuildCommonView`:创建简单视图(eTS)(API8)](ETSUI/BuildCommonView)
115  - [`DefiningPageLayoutAndConnection`:页面布局和连接(eTS)(API8)](ETSUI/DefiningPageLayoutAndConnection)
116  - [`Drag`:拖拽事件(eTS)(API8)](ETSUI/Drag)
117  - [`ArkUIAnimation`:动画(eTS)(API8)](ETSUI/ArkUIAnimation)
118  - [`MediaQuery`:媒体查询(eTS)(API8)](ETSUI/MediaQuery)
119  - [`MouseEvent`:鼠标事件(eTS)(API8)](ETSUI/MouseEvent)
120  - [`Web`:Web(eTS)(API8)](ETSUI/Web)
121  - [`Gallery`:组件集合(eTS)(API8)](ETSUI/Gallery)
122  - [`BringApp`:拉起系统应用(eTS)(API8)(Full SDK)](ETSUI/BringApp)
123  - [`Game2048`:2048游戏(eTS)(API8)](ETSUI/Game2048)
124  - [`Lottie`:Lottie(eTS)(API8)(Full SDK)](ETSUI/Lottie)
125  - [`TransitionAnimation`:转场动画(eTS)(API9)](ETSUI/TransitionAnimation)
126  - [`PatternLock`:图案密码锁组件(eTS)(API9)](ETSUI/PatternLock)
127  - [`Search`:Search组件(eTS)(API9)](ETSUI/Search)
128  - [`QRCode`:二维码(eTS)(API9)(Full SDK)](ETSUI/QRCode)
129  - [`UpgradePopup`:自定义弹窗(eTS)(API9)](ETSUI/UpgradePopup)
130  - [`HealthyDiet`:健康饮食(eTS)(API9)](ETSUI/HealthyDiet)
131- FileManager
132  - [`FileIo`:文件管理(eTS)(API8)](FileManager/FileIo)
133- Notification
134  - [`CommonEvent`:订阅公共事件(eTS)(API8)](Notification/CommonEvent)
135  - [`Emitter`:处理进程内事件(eTS)(API8)](Notification/Emitter)
136  - [`AlarmClock`:后台代理提醒(eTS)(API8)](Notification/AlarmClock)
137  - [`Notification`:订阅、发送通知(eTS)(API9)(Full SDK)](Notification/Notification)
138- Network
139  - [`Http`:数据请求(eTS)(API9)](Network/Http)
140  - [`Socket`:Socket 连接(eTS)(API8)](Network/Socket)
141  - [`WebSocket`:WebSocket(eTS)(API9)](Network/WebSocket)
142  - [`UploadDownload`:上传下载(eTS)(API8)](Network/UploadDownload)
143- Preset
144  - [`Clock`:简单时钟(eTS)(API9)](Preset/Clock)
145  - [`DistributeCalc`:分布式计算器(eTS)(API8)(Full SDK)](Preset/DistributeCalc)
146  - [`DistributedMusicPlayer`:分布式音乐(eTS)(API9)(Full SDK)](Preset/DistributedMusicPlayer)
147- PackageManagement
148  - [`ZipLib`:压缩与解压(eTS)(API8)](PackageManagement/ZipLib)
149- ResourcesSchedule
150  - [`Flybird`:小鸟避障游戏(eTS)(API8)](ResourcesSchedule/Flybird)
151  - [`BackgroundTaskManager`:后台任务管理(eTS)(API8)](ResourcesSchedule/BackgroundTaskManager)
152  - [`WorkScheduler`:延迟任务调度(eTS)(API9)](ResourcesSchedule/WorkScheduler)
153- UI
154  - [`AtomicLayout`:原子布局(JS)(API8)](UI/AtomicLayout)
155  - [`Badge`:事件标记控件(JS)(API8)](UI/Badge)
156  - [`International`:国际化(JS)(API8)](UI/International)
157  - [`JsFA`:FA示例应用(JS)(API8)](UI/JsFA)
158  - [`JsShopping`:购物示例应用(JS)(API8)](UI/JsShopping)
159  - [`JSMenu`:菜单(JS)(API8)](UI/JSMenu)
160  - [`JSUICustomComponent`:自定义组件(JS)(API8)](UI/JSUICustomComponent)
161  - [`JsAnimation`:动效示例应用(JS)(API8)](UI/JsAnimation)
162  - [`JsAnimationStyle`:动画与自定义字体(JS)(API8)](UI/JsAnimationStyle)
163  - [`JsBasicComponents`:基础组件(JS)(API8)](UI/JsBasicComponents)
164  - [`JsBrightness`:设置屏幕亮度(JS)(API8)](UI/JsBrightness)
165  - [`JsCanvas`:画布组件(JS)(API8)](UI/JsCanvas)
166  - [`JsDevice`:设备信息(JS)(API8)](UI/JsDevice)
167  - [`JsDialog`:页面弹窗(JS)(API8)](UI/JsDialog)
168  - [`JsGrid`:栅格布局(JS)(API8)](UI/JsGrid)
169  - [`JsList`:商品列表(JS)(API8)](UI/JsList)
170  - [`JsPanel`:内容展示面板(JS)(API8)](UI/JsPanel)
171  - [`JsRouter`:页面路由(JS)(API8)](UI/JsRouter)
172  - [`JsSvg`:可缩放矢量图形(JS)(API8)](UI/JsSvg)
173  - [`JsTimer`:定时器与系统时间设置(JS)(API8)](UI/JsTimer)
174  - [`Picker`:滑动选择器(JS)(API8)](UI/Picker)
175  - [`Popup`:气泡(JS)(API8)](UI/Popup)
176  - [`RefreshContainer`:下拉刷新容器(JS)(API8)](UI/RefreshContainer)
177  - [`Slider`:滑动条(JS)(API8)](UI/Slider)
178  - [`Stack`:堆叠容器(JS)(API8)](UI/Stack)
179  - [`StepNavigator`:步骤导航器(JS)(API8)](UI/StepNavigator)
180  - [`Swiper`:内容滑动容器(JS)(API8)](UI/Swiper)
181  - [`Tabs`:页签容器(JS)(API8)](UI/Tabs)
182  - [`Toolbar`:工具栏(JS)(API8)](UI/Toolbar)
183  - [`chart`:图表组件(JS)(API8)](UI/chart)
184  - [`JsAdaptivePortalList`:多设备自适应的效率型首页(JS)(API8)](UI/JsAdaptivePortalList)
185  - [`JsAdaptivePortalPage`:多设备自适应的FA页面(JS)(API8)](UI/JsAdaptivePortalPage)
186  - [`JsImage`:基本动画(JS)(API8)](UI/JsImage)
187  - [`JsGallery`:图库示例应用(JS)(API8)](UI/JsGallery)
188  - [`JSComponments`:Js组件(JS)(API8)](UI/JSComponments)
189  - [`JsUserRegistration`:用户注册(JS)(API8)](UI/JsUserRegistration)
190  - [`JsAdaptiveServiceWidget`:多设备自适应服务卡片(JS)(API8)](UI/JsAdaptiveServiceWidget)
191  - [`JsAnimator`:动画(JS)(API8)](UI/JsAnimator)
192- Util
193  - [`UtilBase64Codec`:Base64编解码(eTS)(API8)](Util/UtilBase64Codec)
194  - [`UtilScope`:范围判断(eTS)(API8)](Util/UtilScope)
195  - [`UtilStringCodec`:字符串编解码(eTS)(API8)](Util/UtilStringCodec)
196  - [`UtilLruBuffer`:缓冲区(eTS)(API8)](Util/UtilLruBuffer)
197  - [`UtilRationalNumber`:有理数(eTS)(API8)](Util/UtilRationalNumber)
198  - [`UtilTypeCheck`:内置对象类型检查(eTS)(API8)](Util/UtilTypeCheck)
199  - [`UtilUrlString`:URL字符串解析(eTS)(API8)](Util/UtilUrlString)
200  - [`XmlTextConvert`:xml文本转换(eTS)(API8)](Util/XmlTextConvert)
201- MultiDeviceAppDev
202  - [`AdaptiveCapabilities`:多设备自适应能力(eTS)(API9)](MultiDeviceAppDev/AdaptiveCapabilities)
203  - [`JsAdaptiveCapabilities`:多设备自适应能力(JS)(API8)](MultiDeviceAppDev/JsAdaptiveCapabilities)
204  - [`AppMarket`:一多应用市场首页(eTS)(API9)](MultiDeviceAppDev/AppMarket)
205  - [`Vegetable`:一多蔬菜百科主页(eTS)(API9)](MultiDeviceAppDev/Vegetable)
206  - [`Weather`:一多天气(eTS)(API9)](MultiDeviceAppDev/Weather)
207  - [`MusicAlbum`:一多音乐专辑主页(eTS)(API9)](MultiDeviceAppDev/MusicAlbum)
208- Share
209  - [`Share`:分享(eTS)(API9)(Full SDK)](Share/Share)
210
211## 目录<a name="sectionMenu"></a>
212
213Sample仓下所展示的组件能力:
214
215```
216app_samples
217|---ability                # 页面能力
218|---Account                # 账号管理
219|---AppSample              # 示例应用
220|---Basic                  # 基础组件
221|---common                 # 公共能力
222|---Communication          # 通信与连接
223|---CompleteApps           # 完整应用
224|---data                   # 数据管理
225|---device                 # 设备管理
226|---DFX                    # 日志打印
227|---EngineeringCapability  # 工程能力
228|---ETSUI                  # eTS UI能力
229|---FileManager            # 文件管理
230|---Graphics               # 图像绘制
231|---media                  # 媒体
232|---MultiDeviceAppDev      # 一多应用
233|---Native                 # 调用C++能力
234|---Notification           # 消息通知
235|---PackageManagement      # 包管理
236|---Preset                 # 预设应用
237|---ResourcesSchedule      # 资源调度
238|---Safety                 # 安全
239|---Share                  # 分享
240|---Telephony              # 电话功能
241|---thread                 # 线程操作
242|---UI                     # Js UI能力
243|---Util                   # 基础工具类
244```
245
246
247
248## 约束<a name="section18841871178"></a>
249
250安装应用示例之前,请先查看"README_zh.md"文件来确认应用示例是否为stage模型,若为Stage模型需要查看entry/src/main路径下的module.json5文件中的"deviceType"字段来确认该应用支持的设备类型;否则为FA模型,查看entry/src/main路径下的config.json文件中的"deviceType"字段来确认该应用示例支持的设备类型,两种模型都可尝试通过修改该字段使其可以在相应类型的设备上运行。
251
252
253## 使用方法<a name="section17988202503116"></a>
254
2551.  将独立的应用示例工程导入DevEco Studio进行编译构建及运行调试。
2562.  部分应用示例中含有多个模块,开发者可以选择对单个模块进行编译构建,生成一个HAP应用安装包,也可以对整个工程进行编译构建,生成多个HAP应用安装包。
2573.  安装运行后,即可在设备上查看应用示例运行效果,以及进行相关调试。
258
259## Changlog<a name="section17988202503117"></a>
260
261应用修改记录:[changelog](changelog.md)
262
263## releasenote
264
265应用发布版本分支说明:[releasenote](releasenote.md)
266
267## 相关仓<a name="section17988202503118"></a>
268
2691. [app_sample](https://gitee.com/openharmony/app_samples) 已废弃
2702. [applications_app_sample](https://gitee.com/openharmony/applications_app_samples)
271
272