# 源码获取
- [OpenHarmony介绍](#section6370143622110)
- [源码获取概述](#section12763342204)
- [获取方式1:从镜像站点获取](#section1186691118430)
- [获取方式2:从HPM(包管理器)组件式获取](#section463013147412)
- [适用场景](#section123926431441)
- [前提条件](#section42627508156)
- [操作步骤](#section1781916234118)
- [获取方式3:从代码仓库获取](#section537312010229)
- [适用场景](#section1492115412228)
- [准备](#section1076962313239)
- [操作](#section17162735266)
- [源码目录简介](#section1072115612811)
## OpenHarmony介绍
OpenHarmony是HarmonyOS的开源版,由华为捐赠给开放原子开源基金会(OpenAtom Foundation)开源。第一个开源版本支持在128KB\~128MB的设备上运行,欢迎参加开源社区一起持续演进。
代码仓库地址:[https://openharmony.gitee.com](https://openharmony.gitee.com)
>![](public_sys-resources/icon-note.gif) **说明:**
>当前的OpenHarmony源代码仅支持在Linux环境下编译,如果在Windows下使用,可能会出现异常。
>例如,某些组件在下载安装时需要调用Linux命令来设置环境变量,如果在Windows环境下操作可能就会报错。遇到此问题时可以尝试先将hpm 的 shell改为第三方的shell,例如改为git的sh.exe,可通过执行以下命令修改shell:
>hpm config set shellPath 'C:\\Program Files\\Git\\bin\\sh.exe'
## 源码获取概述
本文档将介绍如何获取OpenHarmony源码并说明OpenHarmony的源码目录结构。OpenHarmony的代码以[组件](../bundles/概述.md)的形式开放,开发者可以通过如下其中一种方式获取:
- **获取方式1**:从镜像站点下载归档后的发行版压缩文件。如果要获取旧版本的源码,也可通过此方式获取(推荐)
- **获取方式2**:通过HPM包管理器获取。在[HPM](https://hpm.harmonyos.com)网站,查找满足需求的开源发行版,直接下载(或者定制后下载),再通过hpm-cli命令工具将所需的组件及工具链下载、安装到本地。
- **获取方式3**:从代码仓库获取。通过repo或git工具从代码仓库中下载。
## 获取方式1:从镜像站点获取
为了获得更好的下载性能,您可以选择从以下站点的镜像库获取源码或者对应的解决方案。
>![](public_sys-resources/icon-note.gif) **说明:**
>- 本部分只提供**OpenHarmony** Master最新版本和LTS最新版本的源码获取方式, 其他版本源码获取方式请参考版本[Release-Notes](https://gitee.com/openharmony/docs/blob/master/zh-cn/release-notes/OpenHarmony-Release-Notes.md)
>- 当前Master 1.0版本已经不再维护,推荐使用LTS版本。
**表 1** 源码获取路径
## 获取方式2:从HPM(包管理器)组件式获取
## 适用场景
对于刚接触OpenHarmony的新用户,希望能够参考一些示例解决方案从而进行快速开发。可以在[HPM](https://hpm.harmonyos.com)获取下载开源发行版,也可以在开源发行版的基础上定制(添加或删除组件)。
然后通过包管理器命令行工具(hpm-cli)将需要的组件及相关的编译工具链全部下载、安装到本地。
## 前提条件
先要在本地安装Node.js和hpm命令行工具,安装步骤如下:
1. 安装Node.js。
官网下载并在本地安装Node.js.
推荐安装 [Node.js](https://nodejs.org/) 12.x \(包含 npm 6.14.4\)或更高版本 \(推荐 12.13.0+\)。
2. 通过Node.js自带的npm安装hpm命令行工具。
打开CMD,执行以下命令:
```
npm install -g @ohos/hpm-cli
```
3. 安装完成后执行如下命令,显示hpm版本,即安装成功。
```
hpm -V 或 hpm --version
```
4. 如果升级hpm的版本,请执行如下命令:
```
npm update -g @ohos/hpm-cli
```
## 操作步骤
1. 查找发行版。
1. 打开包管理页面[HPM](https://hpm.harmonyOS.com),设定搜索的对象为“发行版“,如下图所示。
2. 自搜索框输入关键字搜索,如"摄像头"。
3. 结果中显示与关键字匹配的发行版,可以进一 步根据组件类别等过滤条件\(如:适配的开发板,内核)精确筛选。
4. 查找合适的发行版,点击查看发行版的详情介绍。
**图 1** 包管理
![](figures/zh-cn_image_0000001086781056.png)
2. 了解发行版详情。
1. 仔细阅读发行版的说明信息,以了解使用场景、特性、组件构成、使用方法以及如何进行定制化,如下图所示。
2. 点击「直接下载」,将发行版下载到本地。
3. 点击「定制组件」,将对发行版包含的组件进行定制(添加/删除)。
**图 2** 发行版示例
![](figures/zh-cn_image_0000001086461836.png)
3. 定制组件。
1. 进入发行版的定制页面,如下图所示。
2. 通过关闭开关移除可选组件,或者通过“添加组件”增加新的组件。
3. 在右边填写您的项目基本信息,包括名称、版本、描述等信息。
4. 点击“下载“,系统会根据您的选择,生成相应的OpenHarmony代码结构文件\(如my\_cust\_dist.zip\),保存至本地文件。
**图 3** 组件定制
![](figures/zh-cn_image_0000001133359093.png)
4. 下载安装组件。
1. 解压下载的压缩文件,用命令行工具CMD(Linux下的Shell终端)
2. 在解压后的文件目录下执行hpm install指令
3. 下载的组件存在工程目录下的ohos\_bundles文件夹中(部分组件安装后会将源码复制到指定目录下)。
## 获取方式3:从代码仓库获取
## 适用场景
- 基于OpenHarmony的稳定分支建立自己的基线,分发下游客户。
- 已经完成自身软件与OpenHarmony的对接,需要进行OpenHarmony官方认证。
- 芯片/模组/app通过OpenHarmony官方认证后,贡献代码到OpenHarmony生态。
- 修复OpenHarmony的问题。
- 学习OpenHarmony的源码。
## 准备
1. 注册码云gitee账号。
2. 注册码云SSH公钥,请参考码云帮助中心的公钥管理:[https://gitee.com/help/articles/4181](https://gitee.com/help/articles/4181)
3. 安装git客户端并配置用户信息。
```
git config --global user.name "yourname"
git config --global user.email "your-email-address"
git config --global credential.helper store
```
4. 安装码云repo工具,可以执行如下命令。
```
curl https://gitee.com/oschina/repo/raw/fork_flow/repo-py3 > /usr/local/bin/repo
chmod a+x /usr/local/bin/repo
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple requests
```
## 操作
>![](public_sys-resources/icon-note.gif) **说明:**
>主干代码为开发分支,开发者可通过主干代码获取最新特性。分支代码相对比较稳定,开发者可基于分支代码进行商用功能开发。
- **OpenHarmony主干代码获取**
方式一(推荐):通过repo下载
```
repo init -u https://gitee.com/openharmony/manifest.git -b master --no-repo-verify
repo sync -c
```
方式二:通过git clone单个代码仓库
进入[代码仓库主页](https://gitee.com/openharmony),选择需要克隆的代码仓库,执行命令,如:
```
git clone https://gitee.com/openharmony/manifest.git -b master
```
- **OpenHarmony release 分支代码获取**
通过repo下载
```
repo init -u https://gitee.com/openharmony/manifest.git -b OpenHarmony_1.0.1_release --no-repo-verify
repo sync -c
```
- **OpenHarmony** 其他版本源码获取方式请参考版本[Release-Notes](https://gitee.com/openharmony/docs/blob/master/zh-cn/release-notes/OpenHarmony-Release-Notes.md)。
## 源码目录简介
下表是OpenHarmony源码的目录及简单说明:
**表 2** 源码目录的说明
目录名
|
描述
|
applications
|
应用程序样例,包括wifi-iot,camera等
|
base
|
基础软件服务子系统集&硬件服务子系统集
|
build
|
组件化编译、构建和配置脚本
|
docs
|
说明文档
|
domains
|
增强软件服务子系统集
|
drivers
|
驱动子系统
|
foundation
|
系统基础能力子系统集
|
kernel
|
内核子系统
|
prebuilts
|
编译器及工具链子系统
|
test
|
测试子系统
|
third_party
|
开源第三方组件
|
utils
|
常用的工具集
|
vendor
|
厂商提供的软件
|
build.py
|
编译脚本文件
|