applications_app_samples/README_zh.md
2024-07-18 01:48:06 +00:00

33 KiB
Raw Permalink Blame History

app_samples部件

简介

为帮助开发者快速熟悉OpenHarmony SDK所提供的API和应用开发流程我们提供了一系列的应用示例即Sample。每一个应用示例都是一个独立的DevEco Studio工程项目开发者可以将工程导入到DevEco Studio开发工具通过浏览代码、编译工程、安装和运行应用示例来了解应用示例中涉及API的使用方法。

编码规范

社区共建Sample合入要求 代码规范 README编写规范
UI自动化用例编写规范 工程结构规范 PR提交格式规范

架构组成

一级分类 子分类 应用示例
UI 声明式开发范式 ArkTS组件集API 11 横竖屏切换 页面布局和连接 状态管理
类Web开发范式 JS组件集
基础特性 能力增强 基础能力增强 应用启动框架startup
广告 广告标识服务Sample
应用模型 Ability的启动方式 Navigation动态路由
通知 自定义Emitter 自定义通知API 10 公共事件的订阅和发布API 11 自定义通知角标API 10
Web 浏览器 JS注入与执行
媒体 图片显示及处理API 11 媒体库视频 图片裁剪与分割 图片显示
图片编辑 二维码扫描 视频播放API 12 媒体会话——提供方API 10
音视频录制 音频管理API 12 音振 视频播放
相机示例 相机示例JS
安全 加解密 应用帐号管理 通用密钥库系统cryptoFramework 关键资产存储
通用密钥库系统huksAPI 10 支付 证书管理
网络与连接 HttpAPI 10 RPC通信 网络管理-Socket连接UDP WebSocket
Socket连接 蓝牙 上传和下载API 10 VPN连接
数据管理 首选项 标准化数据定义与描述
文件管理 应用接入数据备份恢复API 11 文件管理API 11 文件分享与访问
图像 DisplaySync分级管控
设备管理 位置服务 屏幕探测 设备管理合集API 10 自定义振动API 10
振动 传感器
电话服务 SIM卡管理 联系人 网络和Sim卡状态订阅 网络搜索
蜂窝数据
任务管理 后台代理提醒 长时任务
DFX Debug调试 测试打点 故障日志获取 日志打印
应用故障恢复API 10
资源 资源管理API 10
国际化 国际化
Native 获取Rawfile资源 Native XComponentAPI 10 OpenGL三棱椎API 10 音频管理
Native Drawing Native Window XComponent3D Native RenderNode Drawing
NdkTsDrawing Native QoS XComponent组件对接Vulkan
系统特性(仅对系统应用开放) 能力增强 基础能力增强
应用模型 仿桌面应用API 10 任务管理 静态订阅API 10 无障碍扩展
企业设备管理扩展 跨任务链返回 启动上一次的组件实例 Stage模型API10
自定义分享API 10
自动填充 AutoFill自动填充能力
媒体 截屏 录屏 相机和媒体库API 10 音频管理(仅对系统应用开放)
媒体会话——控制方API 10 音频通话示例API 10 录音机
通知 实况通知推送 通知发布订阅 自定义通知推送API 10
安全 应用访问权限控制 安全控件类型的UI控件API 10 DLP 证书算法库框架
DLPManager
窗口管理 窗口扩展 悬浮窗API 10 窗口管理API 12
网络与连接 WLAN 蓝牙
数据管理 跨应用数据共享
卡片能力增强 ArkTs卡片能力增强
设备管理 存储空间统计API 10 屏幕属性API 10 设备管理合集API 11 鼠标外设API 10
设备信息统计 设备使用信息统计
IDL Ability与ServiceExtensionAbility通信
分布式 分布式帐号API 10 分布式组网认证API 10
文件管理 选择并查看文档与媒体文件API 10 相册API 12 媒体管理合集
资源配置 应用主题切换
电话服务 小鸟避障游戏 短时任务 延迟任务调度
任务管理 短信 拨打电话
国际化 时区和语言设置API 10
卡片 Stage模型卡片 应用主动添加数据代理卡片到桌面
关键特性 一次开发,多端部署 ArkTS一多能力集合API 10 JS一多能力集合 入门示例:天气应用 典型页面场景:健康饮食
典型页面场景:应用市场首页 典型页面场景:音乐专辑页 典型页面场景:设置应用页面 典型页面场景一多分栏控件API 10
典型页面场景一多导航栏API 10 典型页面场景:一多音乐典型场景
分布式 ArkTS分布式音乐播放 JS分布式音乐播放API 10 分布式计算器API 10 JS分布式计算器API 10
分布式对象API 10 分布式关系型数据库API 10 分布式数据管理 分布式文件管理
跨端迁移随手记
卡片 JS多设备自适应服务卡片 Stage模型卡片JS与C++通信API 10 ArkTS卡片Canvas小游戏 ArkTs音乐卡片
ArkTS卡片计算器
行业解决方案 即时通信 聊天实例应用API 10
输入法 轻量级输入法API 10 自绘编辑框API 10 Kika输入法应用API 10
电商 购物示例应用
媒体 仿相机
游戏 游戏2048 Lottie 分布式五子棋
社交 葡萄广场
工具 图案密码锁 翻页时钟 JS时钟API 10 ArkTS时钟
工程能力 应用程序包 多HAP
Test 测试框架
HapBuild 流水线预测试工具
语言基础类库 语言基础类库 语言基础类库API 10 多线程任务 压缩与解压
性能 方舟运行时 N-Body模拟程序API 10
性能提升 性能示例 性能示例renderGroup 接口)

目录

Sample仓下所展示的组件能力

code
|---UI                         # UI开发
  |---ArkTsComponentCollection    # ArkTs组件集
  |---JsComponentCollection       # 类Web开发范式组件集
|---BasicFeature               # 基础特性
  |---Ability                      # 能力增强
  |---Ads                          # 广告
  |---ApplicationModels            # 应用模型
  |---Connectivity                 # 网络与连接
  |---DFX                          # DFX
  |---DataManagement               # 数据管理
  |---DeviceManagement             # 设备管理
  |---FileManagement               # 文件管理
  |---Graphics                     # 图像
  |---International                # 国际化
  |---Media                        # 媒体
  |---Native                       # Native c++
  |---Notification                 # 通知
  |---Resource                     # 资源
  |---Security                     # 安全
  |---TaskManagement               # 任务管理
  |---Telephony                    # 电话服务
  |---Web                          # Web
  |---WindowManagement             # 窗口管理
|---SystemFeature              # 系统特性
  |---Ability                      # 能力增强
  |---ApplicationModels            # 应用模型
  |---ArkTsCard                    # 卡片能力增强
  |---AutoFill                     # 自动填充
  |---Connectivity                 # 网络与连接
  |---DataManagement               # 数据管理
  |---DeviceManagement             # 设备管理
  |---DeviceUsageStatistics        # 设备使用信息
  |---DistributedAppDev            # 分布式
  |---FileManagement               # 文件管理
  |---IDL                          # IDL
  |---Internationalnation          # 国际化
  |---Media                        # 媒体
  |---Notification                 # 通知
  |---ResourceAllocation           # 资源配置
  |---Security                     # 安全
  |---TaskManagement               # 任务管理
  |---Telephony                    # 电话服务
  |---Widget                       # 卡片
  |---WindowManagement             # 窗口管理
|---SuperFeature               # 关键特性
  |---DistributedAppDev            # 分布式
  |---MultiDeviceAppDev            # 一多
  |---Widget                       # 卡片
|---Solutions                  # 行业解决方案
  |---Game                         # 游戏
  |---IM                           # 即时通信
  |---InputMethod                  # 输入法
  |---Media                        # 媒体
  |---Shopping                     # 电商
  |---Social                       # 社交
  |---Tools                        # 工具
|---Project                    # 工程能力
  |---ApplicationHap               # 应用程序包
  |---HapBuild                     # 流水线预测试工具
  |---Test                         # 测试框架
|---LaunguageBaseClassLibrary  # 语言基础类库
  |---ConcurrentModule             # 多线程任务
  |---LaunguageBaseClassLibrary    # 语言基础类库
  |---ZipLib                       # 解压与压缩
|---Performance                # 性能
  |---ArkRuntime                   # 方舟运行时
  |---PerformanceLibrary           # 性能示例
  |---renderGroup                  # 性能示例

约束

安装应用示例之前,请先查看"README_zh.md"文件来确认应用示例是否为stage模型若为Stage模型需要查看entry/src/main路径下的module.json5文件中的"deviceType"字段来确认该应用支持的设备类型否则为FA模型查看entry/src/main路径下的config.json文件中的"deviceType"字段来确认该应用示例支持的设备类型,两种模型都可尝试通过修改该字段使其可以在相应类型的设备上运行。

使用方法

  1. 将独立的应用示例工程导入DevEco Studio进行编译构建及运行调试。
  2. 部分应用示例中含有多个模块开发者可以选择对单个模块进行编译构建生成一个HAP应用安装包也可以对整个工程进行编译构建生成多个HAP应用安装包。
  3. 安装运行后,即可在设备上查看应用示例运行效果,以及进行相关调试。

Changlog

应用修改记录:changelog

releasenote

应用发布版本分支说明:releasenote

相关仓

  1. app_sample 已废弃
  2. applications_app_sample