（开源项目）OpenHarmony、社区共建Sample合入要求

news2024/12/23 6:49:13

1.新增Sample功能不能重复于当前已有Sample的功能；

2.新增Sample的工程推荐使用ArkTS语言编写；

3.新增Sample的工程推荐使用Stage模型编写；

4.新增Sample的工程中需要包含UI自动化用例（ohosTest工程模块），覆盖基本的功能场景；

5.新增Sample需要遵循代码提交规范、工程结构规范、PR提交格式规范、ReadMe编写规范和UI自动化用例编写规范；

6.新增Sample的UX设计需要符合一多规范要求 ；
7.新增Sample推荐使用当前最新版本IDE和SDK版本；

8.工程合入时，需要提供测试用例报告(参考示例) ，包括测试场景、操作步骤和测试结果信息，可以附在提交工程中；

代码规范

1.所有文件，包括自动生成的编译文件package.json都要格式化（IDE快捷键Ctrl+Alt+L）；

2.函数命名，C++大驼峰，TS、JS小驼峰，函数命名注意动宾结构；

3.静态常量需使用全大写，文件目录使用全小写（不建议包含特殊字符如"-“和”_"等）；

4.类名使用大驼峰，函数的参数、全局变量和局部变量都使用小驼峰，命名要规范化，见名知意；

5.if语句后必须跟“{”，哪怕只有一行代码；

6.有break或return的条件，先break或return再走其他的逻辑；

7.条件判断，当一个分支达成条件时及时返回，不需要再走其他分支；

8.代码中避免出现魔鬼数字，需补上注释，或者用符合语义的名词常量代替，如下：

// One minute has 60 seconds.
  let time = 60
  const ONE_MINUTE = 60
  let time = ONE_MINUTE

9.字符串拼接使用模板字符串；

10.组件使用，除了宽高属性可以在一行，其他的属性必须换行；

11.TS、JS中关于是否添加";“的问题，风格要统一，建议添加”;"；

12.字符串和图片资源等的使用，支持"r"使用的，全部使用"�"使用的，全部使用"r"引用；

13.新增文件注意开源协议、版权检查；

14.截图要使用真机效果图；

15.readme中使用“.”，不要用“、”，检查错别字；

16.异步方法中需要返回方法的返回值，不用声明变量，直接return，如下：

return await this.mediaTest.getFileAssets(fetchOp)

17.方法中的参数需要类型声明；

18.import 文件顺序，同类型放一起；

19.string.json中description要写简要描述，zh下要用中文；

20.TS、JS语言缩进为2格，C++语言缩进为4格；

21.涉及应用截图时，图片不能包含人物、关键信息、网络等有侵权风险的资源；

22.工程中不要配置签名信息，禁止上传local.properties和package-lock.json等系统自动生成的文件；

23.规范日志格式，统一用[Sample_包名]开头，如时钟日志，使用[Sample_Clock]，日志打印需要使用Hilog接口，建议封装单独的Logger类 ，示例如下：

import hilog from '@ohos.hilog'
...
class Logger {
  private domain: number = 0xFF00
  private prefix: string = '[Sample_Clock]'
  private format: string = '%{public}, %{public}'
  ...
  debug(...args: any[]) {
    hilog.debug(this.domain, this.prefix, this.format, args)
  }
  ...
}

24.注释“//”后要加一个空格；如果注释跟在代码后面，则“//”前要加一个空格；

// 正确示例
  let a = 10
  let a = 10 // 正确示例

25.代码中避免出现中文字符，要使用资源代替，符合国际化开发标准；

26.应用包名统一使用“com.samples.xxx”，“xxx”为特性名称；

ReadMe编写规范

1.标题：以特性名称命名；

2.介绍：介绍sample用了哪些包，具有哪些功能，给出完整包名并附上链接；

3.效果预览：屏幕截屏或者视频，文件不超过4个；

3.1 使用说明：介绍应用的使用说明，具体的操作步骤和用法信息，示例如下：

1.在主界面，可以点击图片、视频、文档、音频等按钮进入对应目录的文件列表浏览界面；

2.在文件列表浏览界面，点击“+”按钮，可以添加文件；

3.在文件列表浏览界面，长按列表项会出现删除图片，点击删除图标可以删除文件；

4.在图片文件列表界面，点击图片可以进入图片预览界面。

4.工程目录：给出项目中关键的目录结构并描述它们的作用，示例如下：

entry/src/main/ets/
|---Application
|---filemanager
|   |---data
|   |   |---FileDataSource.ets             // 懒加载数据格式
|   |---pages
|   |   |---audio
|   |   |   |---AudioFileList.ets          // 音频列表页面
|   |   |---common
|   |   |   |---FileList.ets               // 同类型文件列表展示页面，接收文件类型，展示特定类型的文件列表
|   |   |---document
|   |   |   |---DocumentFileList.ets       // 文档列表页面
|   |   |---image
|   |   |   |---ImageFileList.ets          // 图片列表页面
|   |   |   |---ImagePreview.ets           // 图片预览页面
|   |   |---video
|   |   |   |---VideoFileList.ets          // 视频列表页面
|   |   |---FileManagerHome.ets            // 首页主体内容
|---MainAbility
|---pages
|   |---index.ets                          // 首页
Library/src/main/ets/
|---filemanager
|   |---components
|   |   |---ThumbnailImage.ets             // 缩略图组件
|   |---fileio
|   |   |---FileIoManager.ts               // 文件管理，待开发
|   |---medialibrary
|   |   |---MediaLibraryManager.ts         // 主要封装了mediaLibrary库相关的接口，实现相关功能，如：对文件的增、删、查和图片预览功能
|   |---userfilemanager
|   |   |---UserFileManager.ts             // 封装userFileManager库相关的接口
|   |---FileManager.ts                     // 文件管理接口，统一封装了各模块对外提供的功能接口
|---mock                                   // 本地数据
|---utils                                  // 日志工具

5.具体实现： 先描述功能都在哪个模块，再具体描述如何实现这些功能的，以及在哪里使用他们，附上文件链接；示例如下：

  • 增添文件、删除文件、查找指定类型文件文件和预览图片的功能接口封装在MediaLibraryManager，源码参考：MediaLibraryManager.ts
  • 使用mediaLibrary.getMediaLibrary来获取MediaLibrary对象;
  • 读取每个文件的数据：使用MediaLibrary.getFileAssets读取满足条件的文件集合FetchFileResult，然后调用FetchFileResult.getFirstObject();
  • 创建模拟文件：使用MediaLibrary.getPublicDirectory()获取系统预定的目录，然后使用MediaLibrary.createAsset();
  • 删除指定路径的文件：使用MediaLibrary.deleteAsset();
  • 获取预览图：使用image.createImageSource()创建指定的文件资源ImageSource，然后调用ImageSource.createPixelMap()，接口参考：@ohos.multimedia.image
    。
  • 在Library模块中通过封装FileManager向外提供功能接口，如MediaLibraryManager.getPixelMapByFileAsset()，源码参考：FileManager.ts
  • 如效果预览中的图片列表，读取指定类型的文件：在FileList.ets 中调用FileManager.getFileAssets()；
  • 创建模拟文件：在FileList.ets 中调用FileManager.createTxtFileAsset()；
  • 删除指定路径的文件：在FileList.ets 中调用FileManager.deleteFileAsset()；
  • 获取缩略图：在ThumbnailImage.ets 中调用FileManager.getThumbnail()；
  • 如效果预览中的图片预览，获取预览图：在ImagePreview.ets中调用FileManager.getPixelMapByFileAsset()。

6.相关权限：介绍应用的使用权限，附上链接；

7.依赖： 介绍对其他sample的依赖，附上sample链接；

8.约束与限制：

6.1支持应用运行的操作系统版本和设备，示例如下：

本示例仅支持标准系统上运行，支持设备：RK3568;

6.2 API版本、SDK版本（如果依赖Full SDK，附上替换链接），示例如下：

本示例仅支持APIXX版本SDK，版本号：3.X.X.X；（如果涉及Full SDK还需加上：本涉及涉及使用系统接口：XXX，需要手动替换Full SDK才能编译通过，具体操作可参考[替换指南]。）

6.3 支持的IDE版本，示例如下：

本示例需要使用DevEco Studio 3.0 Beta4 (Build Version: 3.0.0.992, built on July 14, 2022)才可编译运行；

6.4 高等级APL特殊签名说明，示例如下：

本示例涉及[相关权限]为system_basic(或者system_core)级别（相关权限级别可通过[权限定义列表]查看），需要配置高权限签名，可参考[特殊权限配置方法]；

9.下载：给出单独下载本工程的命令，在代码中替换工程目录并以/结尾，如下面示例中的 FileManager/FileManager，示例如下：

如需单独下载本工程，执行如下命令：

git init
git config core.sparsecheckout true
echo FileManager/FileManager/ > .git/info/sparse-checkout
git remote add origin https://gitee.com/openharmony/applications_app_samples.git
git pull origin master

工程结构规范

Sample工程，应该区分开场景业务逻辑和特性相关封装接口，规则如下：

1.包名命名规则为"com.samples.特性名"，工程名命名规则为特性名称，与Readme标题保持一致；

2.特性接口封装放在Library模块下，能够独立编译成har包复用；

3.场景业务逻辑，展示Library模块中特性接口的使用，放在entry目录中；

4.entry/src/main/ets/目录下的pages目录中，只放一个Index.ets，作为入口页面；

5.entry/src/main/ets/目录下创建场景业务目录，存放该场景相关的业务逻辑和页面代码；

6.Library/src/main/ets/目录下创建特性目录，目录下包括components（对外开放的控件目录）、feature（特性封装逻辑目录）、Feature.ts（对外开放的特性接口）等；

以FileManager特性为例，工程示例结构如下：

entry/src/main/ets/ 		// 场景业务逻辑放在entry目录下
|---Application 			// 应用级逻辑
|---MainAbility 			// 元能力组件
|---filemanager 			// 场景业务功能（如果存在多个场景，则放在同级目录下）
|   |---data 				// 场景业务逻辑相关类或数据
|   |---pages 				// 场景业务逻辑相关页面
|---pages 					// UI页面
|   |---Index.ets 			// pages下只保留一个Index.ets，作为入口页面
|---utils 					// 共用的工具类或者模块
Library/src/main/ets/ 		// 特性接口封装放在Library模块下，能够独立编译成har包复用
|---filemanager 			// 特性相关封装类
|   |---components 			// 特性相关UI控件类，需要对外开放（部分特性涉及对外提供复用UI控件）
|   |   |---FileImage.ets
|   |---fileio 				// 封装了特性相关接口，如果存在多个模块，放在多个目录下如fileio、medialibrary、userfilemanager，不对外开放
|   |   |---FileIoManager.ts
|   |---medialibrary
|   |---userfilemanager
|   |---FileManager.ts 		// 对外开放的特性接口，无具体实现（实现在fileio、medialibrary等模块中）
|---mock 					// 模拟数据
|---utils 					// 特性相关工具类

UI自动化用例编写规范

1.用例命名规范为：“包名_测试功能_序号”，如“MyApp_StartAbility_001”，序号表示测试StartAbility功能的第1个用例;

2.用例的开头和结尾都需要有日志打印；

3.打印必须包括用例名称的关键字，用例中每条断言语句前必须添加日志，打印参数信息；

4.DOMAIN设置为0xF811；

5.用例名称中的包名和日志中的包名单独用常量表示，方便包名变更整改；

6.每条用例前需要添加注释；

import hilog from '@ohos.hilog';
  ...
  const TAG = '[Sample_MyApp]'
  const DOMAIN = 0xF811
  const BUNDLE = 'MyApp_'
  ...
  /**
   * 介绍用例测试的功能和场景等信息
   */
  it(BUNDLE + 'StartAbility_001', function() {
    hilog.info(DOMAIN, TAG, BUNDLE + "StartAbility_001, begin")
    ...
	// 介绍单一步骤的功能
    hilog.info(DOMAIN, TAG, BUNDLE + "StartAbility_001, code:" + code)
    expect(0).asserEqual(code)
    ...
    hilog.info(DOMAIN, TAG, BUNDLE + "StartAbility_001, end")
  })

PR提交格式规范

示例如下：

IssueNo: #I56EH7:关联问题
Description: 描述问题.
Sig: sig-systemapplications
Feature or Bugfix: Bugfix
Binary Source: No
Signed-off-by: jiangwensai <jiangwensai@huawei.com>

1.IssueNo管理issue信息；

2.Description描述修改变更内容；

3.Sig统一使用SIG_Sample；

4.Feature or Bugfix，如果是需求选择Feature，问题选择Bugfix；

5.Signed-off-by，注明开发者账号和邮箱；

作为一名合格一线开发程序员，大家心里肯定会有很多疑问！鸿蒙系统这么强大~~

为了能够让大家跟上互联网时代的技术迭代，在这里跟大家分享一下我自己近期学习心得以及参考网上资料整理出的一份最新版的鸿蒙学习提升资料，有需要的小伙伴自行领取，限时开源，先到先得~~~~

领取以下高清学习路线原图请点击→《鸿蒙 (Harmony OS)开发学习手册》纯血鸿蒙HarmonyOS基础技能学习路线图
在这里插入图片描述
 

领取以上完整高清学习路线图，请点击→《鸿蒙基础入门学习指南》小编自己整理的部分学习资料（包含有高清视频、开发文档、电子书籍等）

在这里插入图片描述

以上分享的学习路线都适合哪些人跟着学习？

-应届生/计算机专业
通过学习鸿蒙新兴技术，入行互联网，未来高起点就业。
-0基础转行
提前布局新方向，抓住风口，自我提升，获得更多就业机会。
-技术提升/进阶跳槽
发展瓶颈期，提升职场竞争力，快速掌握鸿蒙技术，享受蓝海红利。

在这里插入图片描述

最后

鸿蒙开发学习是一个系统化的过程，从基础知识的学习到实战技能的锤炼，再到对前沿技术的探索，每一环节都至关重要。希望这份教程资料能帮助您快速入门并在鸿蒙开发之路上步步攀升，成就一番事业。让我们一起乘风破浪，拥抱鸿蒙生态的广阔未来！

如果你觉得这篇内容对你有帮助，我想麻烦大家动动小手给我：点赞，转发，有你们的 『点赞和评论』，才是我创造的动力。

关注我，同时可以期待后续文章ing，不定期分享原创知识。

想要获取更多完整鸿蒙最新VIP学习资料，请点击→《鸿蒙HarmonyOS分布式项目实战》

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1513235.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

Windows11安装NodeJS18并配置环境变量

Windows11安装NodeJS18并配置环境变量

从官网下载&#xff0c;或者从百度网盘下载 解压下载的zip包&#xff1a; 重命名为nodejs&#xff1a; 在nodejs中添加cache和global两个目录&#xff1a; 将nodejs和nodejs\global添加到环境变量&#xff1a; 打开终端&#xff0c;输入&#xff1a; node -v接着配置…
阅读更多...
AI新工具(20240312) Midjourney官方发布角色一致性功能；免费且开源的简历制作工具；精确克隆语调、控制声音风格

AI新工具(20240312) Midjourney官方发布角色一致性功能；免费且开源的简历制作工具；精确克隆语调、控制声音风格

1: Midjourney角色一致性功能 使人物画像在多方面高度一致成为可能。 Midjourney的角色一致性功能的使用方法如下&#xff1a; ⭐在你的输入指令后面加上 --cref URL&#xff0c;其中URL是你选择的角色图像的链接。 ⭐你可以通过 --cw 参数来调整参照的强度&#xff0c;范围…
阅读更多...
基于Spring Boot的校园管理系统 ，计算机毕业设计(带源码+论文)

基于Spring Boot的校园管理系统 ，计算机毕业设计(带源码+论文)

源码获取地址&#xff1a; 码呢-一个专注于技术分享的博客平台一个专注于技术分享的博客平台,大家以共同学习,乐于分享,拥抱开源的价值观进行学习交流http://www.xmbiao.cn/resource-details/1767745870094217218
阅读更多...
高频：spring知识

高频：spring知识

1、bean的生命周期&#xff1f; 主要阶段 初始化 org.springframework.context.support.ClassPathXmlApplicationContext prepareRefresh 信息: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext67424e82: startup date []; root of context hi…
阅读更多...
品牌升级 | 图扑物联正式启用新LOGO

品牌升级 | 图扑物联正式启用新LOGO

为进一步提升品牌形象&#xff0c;提高品牌影响力&#xff0c;2024年&#xff0c;我们迎来了一次重要的品牌升级——LOGO迭代。此次升级&#xff0c;在传承与创新中既保留了公司的核心精神&#xff0c;又融入了新的视觉语言&#xff0c;不仅代表了公司的新形象、新面貌&#xf…
阅读更多...
当运维深陷“困境”，如何“破旧立新”？

当运维深陷“困境”，如何“破旧立新”？

背景 先来看下运维小伙伴们遇到的几种境遇&#xff1a; 投产变更&#xff0c;流程流于形式 投产步骤特别复杂&#xff0c;几百套系统几百种投产方式&#xff0c;公司的测试环境流于形式&#xff0c;经常会有投产文档和真实操作不一致的情况 几百套系统&#xff0c;几十种操作…
阅读更多...
rhce证书含金量高吗？rhce考试包括哪些内容？考完工资多少？

rhce证书含金量高吗？rhce考试包括哪些内容？考完工资多少？

rhce证书含金量 高吗&#xff1f; 随着目前国内IT职业的飞速发展&#xff0c;RHCE已经成为IT职业的首选认证、高薪亮点。Linux人才出现大比例短缺的状况&#xff0c;企业对Linux人才的需求也继续升温。那相关认证RHCE现在具有怎样的含金量呢&#xff0c;本期小编给大家分析分析…
阅读更多...
Docker入门笔记（1）

Docker入门笔记（1）

Docker入门笔记&#xff08;1&#xff09; 容器技术入门 之前我的WIT问卷管理系统在阿里云上部署需要好多配置&#xff0c;各个环境耦合的比较紧密&#xff0c;花了不少时间去做部署和调配。 现在有了Docker以后&#xff0c;我们可以把各种组件配置好&#xff0c;然后打包成…
阅读更多...
docker部署Atheos云IDE平台

docker部署Atheos云IDE平台

Codiad 是一个基于 Web 的 IDE 框架 部署 下载镜像 docker pull hlsiira/atheosvim docker-compose.yaml version: 3 services:atheos:image: hlsiira/atheosports:- 8565:80container_name: atheosrestart: always启动 docker-compose up -d访问 http://x.x.x.x:8565
阅读更多...
【网络安全】 MSF生成木马教程

【网络安全】 MSF生成木马教程

本文章仅用于信息安全学习&#xff0c;请遵守相关法律法规&#xff0c;严禁用于非法途径。若读者因此作出任何危害网络安全的行为&#xff0c;后果自负&#xff0c;与作者无关。 环境准备&#xff1a; 名称系统IP攻击机Kali Linux10.3.0.231客户端Windows 710.3.0.234 一、生…
阅读更多...
1688商品详情数据采集（商品属性，规格，价格，详情图等）

1688商品详情数据采集（商品属性，规格，价格，详情图等）

京东商品详情数据采集是一个复杂但重要的过程&#xff0c;它涉及获取商品的详细信息&#xff0c;包括商品属性、规格、价格以及详情图等。以下是关于如何进行京东商品详情数据采集的基本步骤&#xff1a; 确定采集目标&#xff1a;首先&#xff0c;你需要明确需要采集的商品信…
阅读更多...
#QT（显示组件、日期时间组件）

#QT（显示组件、日期时间组件）

1.IDE&#xff1a;QTCreator 2.实验&#xff1a; 3.记录 4.代码 #include "widget.h" #include "ui_widget.h" #include <QDateTime> #include <QCalendar> #include <QCalendarWidget> Widget::Widget(QWidget *parent): QWidget(pare…
阅读更多...
【Vue3】学习命名路由和嵌套路由

【Vue3】学习命名路由和嵌套路由

&#x1f497;&#x1f497;&#x1f497;欢迎来到我的博客&#xff0c;你将找到有关如何使用技术解决问题的文章&#xff0c;也会找到某个技术的学习路线。无论你是何种职业&#xff0c;我都希望我的博客对你有所帮助。最后不要忘记订阅我的博客以获取最新文章&#xff0c;也欢…
阅读更多...
ARM 汇编指令:(五)CMP指令

ARM 汇编指令:(五)CMP指令

目录 1.CMP比较指令 2.指令条件码 cond 1.CMP比较指令 CMP指令是计算机指令集中的一种比较指令&#xff0c;用于比较两个操作数的大小关系或相等性&#xff0c;并根据比较结果设置或更新条件码寄存器&#xff08;或程序状态字&#xff09;的标志位。 指令格式&#xff1a;C…
阅读更多...
BEVFormer代码运行笔记

BEVFormer代码运行笔记

1. 代码下载 git clone https://github.com/fundamentalvision/BEVFormer.git 2. 环境配置 使用conda创建环境 conda create -n open-mmlab python3.8 -y 进入环境 conda activate open-mmlab 允许使用pip安装依赖库 export PIP_REQUIRE_VIRTUALENVfalse 安装pytorch和…
阅读更多...
【C++算法模板】图的存储-邻接矩阵

【C++算法模板】图的存储-邻接矩阵

文章目录 邻接矩阵洛谷3643 图的存储 邻接矩阵 邻接矩阵相比于上一篇博客邻接表的讲解要简单得多 数据结构&#xff0c;如果将二维数组 g g g 定义为全局变量&#xff0c;那默认初始化应该为 0 0 0 &#xff0c;如果题目中存在自环&#xff0c;可以做特判&#xff0c; m e …
阅读更多...
300分钟吃透分布式缓存-28讲：如何构建一个高性能、易扩展的Redis集群？

300分钟吃透分布式缓存-28讲：如何构建一个高性能、易扩展的Redis集群？

Redis 集群的分布式方案主要有 3 种。分别是 Client 端分区方案&#xff0c;Proxy 分区方案&#xff0c;以及原生的 Redis Cluster 分区方案。 Client 端分区 Client 端分区方案就是由 Client 决定数据被存储到哪个 Redis 分片&#xff0c;或者由哪个 Redis 分片来获取数据。…
阅读更多...
深度解析Kafka分区策略的精妙之处

深度解析Kafka分区策略的精妙之处

欢迎来到我的博客&#xff0c;代码的世界里&#xff0c;每一行都是一个故事 深度解析Kafka分区策略的精妙之处 前言分区的基本概念1. Kafka 分区的定义&#xff1a;2. Kafka 分区的基本原理&#xff1a;3. 为何分区是 Kafka 消息传递的关键组成部分&#xff1a; 分区策略的选择…
阅读更多...
数字化浪潮下的选择：ETU-LINK光模块写码板全新升级至400G

数字化浪潮下的选择：ETU-LINK光模块写码板全新升级至400G

随着光模块市场的蓬勃发展&#xff0c;ETU研发团队致力于不断改进SFP编码工具&#xff0c;以满足日益增长的客户需求。经过不懈努力&#xff0c;我们成功推出了3.0版本的写码板&#xff0c;在硬件和软件方面都进行了全面升级&#xff0c;为用户带来了极大的便利。今天&#xff…
阅读更多...
每日汇评：如果支撑位守住2145美元，黄金可能反弹至纪录高位

每日汇评：如果支撑位守住2145美元，黄金可能反弹至纪录高位

金价在周二因美国CPI数据火爆而暴跌后保持稳定&#xff1b; 美元和美债收益率在美元/日元下跌中暂停反弹&#xff1b; 随着美国CPI的出炉&#xff0c;市场焦点转向周四的零售销售和PPI数据&#xff1b; 金价在2160美元附近盘整&#xff0c;周二从2195美元的纪录高位回调约1%。由…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023