1# 获取源码
2
3
4## OpenHarmony介绍
5
6OpenHarmony是由开放原子开源基金会(OpenAtom Foundation)孵化及运营的开源项目,目标是面向全场景、全连接、全智能时代,搭建一个智能终端设备操作系统的框架和平台,促进万物互联产业的繁荣发展。
7
8
9
10开源代码仓库地址:[https://openharmony.gitee.com](https://openharmony.gitee.com)11
12
13## 获取源码概述
14
15本文档将介绍如何获取OpenHarmony源码并说明OpenHarmony的源码目录结构。OpenHarmony的代码以[组件](../hpm-part/hpm-part-about.md)的形式开放,开发者可以通过如下其中一种方式获取:
16
17- **获取方式1**:从码云代码仓库获取。通过repo或git工具从代码仓库中下载,此方式可获取最新代码。
18
19- **获取方式2**:通过[DevEco Marketplace](https://repo.harmonyos.com/#/cn/home)网站获取。访问[DevEco Marketplace](https://repo.harmonyos.com/#/cn/home)网站,查找满足需求的开源发行版,直接下载(或者定制后下载),再通过hpm-cli命令工具将所需的组件及工具链下载、安装到本地。
20
21- **获取方式3**:从镜像站点下载归档后的发行版压缩文件。如果要获取旧版本的源码,也可通过此方式获取,此方式下载速度较快。
22
23- **获取方式4**:从github代码仓库获取。通过repo或git工具从代码仓库中下载,此方式可获取最新代码。
24
25
26## 获取方式1:从码云仓库获取
27
28
29### 适用场景
30
31- 基于OpenHarmony的稳定分支建立自己的基线,分发下游客户。
32
33- 已经完成自身软件与OpenHarmony的对接,需要进行OpenHarmony官方认证。
34
35- 芯片/模组/app通过OpenHarmony官方认证后,贡献代码到OpenHarmony社区。
36
37- 修复OpenHarmony的问题。
38
39- 学习OpenHarmony的源码。
40
41
42### 前提条件
43
441. 注册码云gitee帐号。
45
462. 注册码云SSH公钥,请参考[码云帮助中心](https://gitee.com/help/articles/4191)47
483. 安装[git客户端](https://git-scm.com/book/zh/v2/%E8%B5%B7%E6%AD%A5-%E5%AE%89%E8%A3%85-Git)和[git-lfs](https://gitee.com/vcs-all-in-one/git-lfs?_from=gitee_search#downloading)并配置用户信息。
49
50   ```shell
51   git config --global user.name "yourname"
52   git config --global user.email "your-email-address"
53   git config --global credential.helper store
54   ```
55
564. 执行如下命令安装码云repo工具。
57
58   下述命令中的安装路径以"~/bin"为例,请用户自行创建所需目录。
59
60   ```shell
61   mkdir ~/bin
62   curl https://gitee.com/oschina/repo/raw/fork_flow/repo-py3 -o ~/bin/repo
63   chmod a+x ~/bin/repo
64   pip3 install -i https://repo.huaweicloud.com/repository/pypi/simple requests
65   ```
66
675. 将repo添加到环境变量。
68
69   ```shell
70   vim ~/.bashrc               # 编辑环境变量
71   export PATH=~/bin:$PATH     # 在环境变量的最后添加一行repo路径信息
72   source ~/.bashrc            # 应用环境变量
73   ```
74
75
76### 操作步骤
77
78
79> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br>
80>
81> 发布版本代码相对比较稳定,开发者可基于发布版本代码进行商用功能开发。Master主干为开发分支,开发者可通过Master主干获取最新特性。
82
83- **OpenHarmony发布版本代码获取**
84
85  OpenHarmony发布版本获取源码方式请参考[Release Notes](../../release-notes/Readme.md)。
86
87- **OpenHarmony主干代码获取**
88
89  方式一(推荐):通过repo + ssh下载(需注册公钥,请参考[码云帮助中心](https://gitee.com/help/articles/4191))。
90
91  ```shell
92  repo init -u git@gitee.com:openharmony/manifest.git -b master --no-repo-verify
93  repo sync -c
94  repo forall -c 'git lfs pull'
95  ```
96
97  方式二:通过repo + https下载。
98
99
100  ```shell
101  repo init -u https://gitee.com/openharmony/manifest.git -b master --no-repo-verify
102  repo sync -c
103  repo forall -c 'git lfs pull'
104  ```
105
106
107## 获取方式2:从DevEco Marketplace获取
108
109
110### 适用场景
111
112对于刚接触OpenHarmony的新用户,希望能够参考一些示例解决方案从而进行快速开发。可以在[DevEco Marketplace](https://repo.harmonyos.com/#/cn/home)网站获取下载开源发行版,也可以在开源发行版的基础上定制(添加或删除组件)。然后通过包管理器命令行工具(hpm-cli)将需要的组件及相关的编译工具链全部下载、安装到本地。
113
114
115### 前提条件
116
117先要在本地安装Node.js和hpm命令行工具,安装步骤如下:
118
1191. 安装Node.js120
121   官网下载并在本地安装Node.js122
123   [Node.js](https://nodejs.org/)版本需不低于12.x (包含npm 6.14.4),推荐安装LTS版本。
124
1252. 通过Node.js自带的npm安装hpm命令行工具。
126
127   打开CMD,执行以下命令:
128
129   ```shell
130   npm install -g @ohos/hpm-cli
131   ```
132
1333. 安装完成后执行如下命令,显示hpm版本,即安装成功。
134
135   ```shell
136   hpm -V 或 hpm --version
137   ```
138
1394. 如果升级hpm的版本,请执行如下命令:
140
141   ```shell
142   npm update -g @ohos/hpm-cli
143   ```
144
145
146### 操作步骤
147
1481. 查找发行版。
149   1. 访问[DevEco Marketplace](https://repo.harmonyos.com/#/cn/home),设定搜索的对象为设备组件,并在左侧边栏选择开源发行版,如下图所示。
150   2. 在搜索框输入关键字搜索,如“摄像头”。
151   3. 结果中显示与关键字匹配的发行版,可以进一步根据组件类别等过滤条件(如:OS版本,适配的开发板,内核)精确筛选。
152   4. 查找合适的发行版,点击查看发行版的详情介绍。
153
154         **图1** 包管理
155
156         ![zh-cn_image_0000001168212170](figures/zh-cn_image_0000001168212170.png)
157
1582. 了解发行版详情。
159   1. 仔细阅读发行版的说明信息,以了解使用场景、特性、组件构成、使用方法以及如何进行定制化,如下图所示。
160   2. 当前支持两种下载方式:
161      - 点击「直接下载」,将发行版下载到本地。
162      - 点击「设备组件裁剪」,将对发行版包含的组件进行定制(添加/删除)。
163
164         **图2** 发行版示例
165
166         ![zh-cn_image_0000001167734854](figures/zh-cn_image_0000001167734854.png)
167
1683. 定制组件。
169   1. 进入发行版的定制页面,如下图所示。
170   2. 添加和删除组件。
171      - 点击“可定制组件”后的添加按钮,在弹出的“添加组件”窗口中进行所需组件的添加。
172      - 在“可定制组件”下拉列表中,点击待删除组件后方的删除按钮,将该组件删除。
173   3. 在右边填写您的项目基本信息,包括名称、版本、描述等信息。
174   4. 点击页面右下角的「下载」,系统会根据您的选择,生成相应的OpenHarmony代码结构文件(如my_cust_dist.zip),保存至本地文件。
175
176         **图3** 组件定制
177
178         ![zh-cn_image_0000001167743458](figures/zh-cn_image_0000001167743458.png)
179
1804. 安装组件。
181   1. 解压下载的压缩文件,用命令行工具CMD(Linux下的Shell终端)。
182   2. 在解压后的文件目录下执行hpm install指令,系统会自动下载并安装组件。安装窗口显示“Install successful”表示组件下载及安装成功。
183   3. 下载的组件将保存在工程目录下的ohos_bundles文件夹中(部分组件安装后会将源码复制到指定目录下)。
184
185
186## 获取方式3:从镜像站点获取
187
188为了获得更好的下载性能,您可以选择从以下站点的镜像库获取源码或者对应的解决方案。
189
190本部分只提供OpenHarmony LTS最新版本和最新发布版本的源码获取方式, 其他版本获取源码方式以及具体版本信息请参考[Release Notes](../../release-notes/Readme.md)。
191
192  **表1** 获取源码路径
193
194| **LTS版本源码** | **版本信息** | **下载站点** | **SHA256校验码** | **软件包容量** |
195| -------- | -------- | -------- | -------- | -------- |
196| 全量代码(标准、轻量和小型系统) | 3.0 | [站点](https://repo.huaweicloud.com/openharmony/os/3.0/code-v3.0-LTS.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.0/code-v3.0-LTS.tar.gz.sha256) | 7.0 GB |
197| 标准系统解决方案(二进制) | 3.0 | [站点](https://repo.huaweicloud.com/openharmony/os/3.0/standard.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.0/standard.tar.gz.sha256) | 973.7 MB |
198| Hi3861解决方案(二进制) | 3.0 | [站点](https://repo.huaweicloud.com/openharmony/os/3.0/hispark_pegasus.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.0/hispark_pegasus.tar.gz.sha256) | 16.5 MB |
199| Hi3518解决方案(二进制) | 3.0 | [站点](https://repo.huaweicloud.com/openharmony/os/3.0/hispark_aries.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.0/hispark_aries.tar.gz.sha256) | 158.1 MB |
200| Hi3516解决方案-LiteOS(二进制) | 3.0 | [站点](https://repo.huaweicloud.com/openharmony/os/3.0/hispark_taurus.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.0/hispark_taurus.tar.gz.sha256) | 248.9 MB |
201| Hi3516解决方案-Linux(二进制) | 3.0 | [站点](https://repo.huaweicloud.com/openharmony/os/3.0/hispark_taurus_linux.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/3.0/hispark_taurus_linux.tar.gz.sha256) | 418.1 MB |
202| RELEASE-NOTES | 3.0 | [站点](https://gitee.com/openharmony/docs/blob/OpenHarmony-3.0-LTS/zh-cn/release-notes/OpenHarmony-v3.0-LTS.md) | - | - |
203| **最新发布版本源码** | **版本信息** | **下载站点** | **SHA256校验码** | **软件包容量** |
204| 全量代码(标准、轻量和小型系统)        | 4.1 Release    | [站点](https://repo.huaweicloud.com/openharmony/os/4.1-Release/code-v4.1-Release.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/4.1-Release/code-v4.1-Release.tar.gz.sha256) | 31.6 GB |
205| Hi3861解决方案(二进制)        | 4.1 Release    | [站点](https://repo.huaweicloud.com/openharmony/os/4.1-Release/hispark_pegasus.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/4.1-Release/hispark_pegasus.tar.gz.sha256) | 29.2 MB |
206| Hi3516解决方案-LiteOS(二进制) | 4.1 Release    | [站点](https://repo.huaweicloud.com/openharmony/os/4.1-Release/hispark_taurus_LiteOS.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/4.1-Release/hispark_taurus_LiteOS.tar.gz.sha256) | 318.7 MB |
207| Hi3516解决方案-Linux(二进制)  | 4.1 Release    | [站点](https://repo.huaweicloud.com/openharmony/os/4.1-Release/hispark_taurus_Linux.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/4.1-Release/hispark_taurus_Linux.tar.gz.sha256) | 215.8 MB |
208| RK3568标准系统解决方案(二进制)        | 4.1 Release    | [站点](https://repo.huaweicloud.com/openharmony/os/4.1-Release/dayu200_standard_arm32.tar.gz) | [SHA256校验码](https://repo.huaweicloud.com/openharmony/os/4.1-Release/dayu200_standard_arm32.tar.gz.sha256) | 8.4 GB |
209| RELEASE-NOTES | 4.1 Release   | [站点](../../release-notes/OpenHarmony-v4.1-release.md) | - | - |
210| **编译工具链** | **版本信息** | **下载站点** | **SHA256校验码** | **软件包容量** |
211| 编译工具链获取清单 | - | [站点](https://repo.huaweicloud.com/openharmony/os/2.0/tool_chain/) | - | - |
212
213
214## 获取方式4:从github镜像仓库获取
215
216> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br>
217> 镜像仓库每日23:00(UTC +8:00)同步。
218
219
220方式一(推荐):通过repo + ssh下载(需注册公钥,请参考[GitHub帮助中心](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account))。
221
222```shell
223repo init -u git@github.com:openharmony/manifest.git -b master --no-repo-verify
224repo sync -c
225repo forall -c 'git lfs pull'
226```
227
228方式二:通过repo + https下载。
229
230
231```shell
232repo init -u https://github.com/openharmony/manifest.git -b master --no-repo-verify
233repo sync -c
234repo forall -c 'git lfs pull'
235```
236
237
238## 源码目录简介
239
240下表是OpenHarmony源码目录:
241
242  **表2** 源码目录
243
244| 目录名 | 描述 |
245| -------- | -------- |
246| applications | 应用程序样例,包括camera等 |
247| base | 基础软件服务子系统集&amp;硬件服务子系统集 |
248| build | 组件化编译、构建和配置脚本 |
249| docs | 说明文档 |
250| domains | 增强软件服务子系统集 |
251| drivers | 驱动子系统 |
252| foundation | 系统基础能力子系统集 |
253| kernel | 内核子系统 |
254| prebuilts | 编译器及工具链子系统 |
255| test | 测试子系统 |
256| third_party | 开源第三方组件 |
257| utils | 常用的工具集 |
258| vendor | 厂商提供的软件 |
259| build.py | 编译脚本文件 |
260