源码获取

    代码仓库地址:

    源码获取概述

    本文档将介绍如何获取OpenHarmony源码并说明OpenHarmony的源码目录结构。OpenHarmony的代码以组件的形式开放,开发者可以通过如下其中一种方式获取:

    • 获取方式1:从镜像站点下载压缩文件(推荐)
    • 获取方式2:从hpm网站组件式获取。通过,查找满足需求的解决方案,挑选/裁剪组件后下载。
    • 获取方式3:用包管理器命令行工具获取。通过HPM的hpm-cli命令行工具,执行命令下载。
    • 获取方式4:从代码仓库获取。通过repo或git工具从代码仓库中下载。

    获取方式1:从镜像站点获取

    为了获得更好的下载性能,您可以选择从以下站点的镜像库获取源码或者对应的解决方案。

    表 1 源码获取路径

    获取方式2:从hpm网站组件式获取

    适用场景

    对于刚接触OpenHarmony的新用户,希望能够参考一些示例解决方案从而进行快速开发。可以在HPM获取推荐的解决方案,以此为基础,增加或裁剪部分组件,快速定制系统。

      1. 打开包管理页面,设定搜索的对象为“解决方案“,如下图所示。
      2. 结果中显示匹配的解决方案,可以进一步根据组件类别等过滤条件(如:适配的开发板,内核)精确筛选。
      3. 查找合适的解决方案,点击查看解决方案详情介绍。

        图 1 包管理

    1. 定制解决方案组件包。

      1. 仔细阅读解决方案的说明,以了解该解决方案的使用场景、特性、使用方法以及如何进行定制化,如下图所示。
      2. 点击「直接下载」,将解决方案下载到本地。
      3. 点击「定制组件」,将对解决方案包含的组件进行定制。

      图 2 解决方案示例

    1. 定制组件。

      1. 进入解决方案定制页面,如下图所示。
      2. 通过关闭开关移除可选组件,或者通过“添加组件”增加新的组件。
      3. 在右边填写您的项目基本信息,包括名称、版本、描述等信息。
      4. 点击“下载“,系统会根据您的选择,生成相应的OpenHarmony代码结构文件(如name.zip),保存至本地文件。

        • 下载的压缩文件并未包含源代码的原始文件,可以在IDE中导入下载的压缩包,解压后执行hpm的安装指令(hpm install),才会将所需要的组件全部下载下来。
        • 下载的组件存在工程目录下的ohos_bundles文件夹中。

          图 3 组件定制

    1. ![](/projects/openharmony-1.0-zh-cn/get-code/figures/zh-cn_image_0000001055679464.png)

    获取方式3:用包管理器命令行获取

    适用场景

    • 用户已通过组件式获取的方式获取源码,需要对源码中的某个或某几个组件进行独立升级。
    • 用户已经比较熟悉OpenHarmony系统的开发并且熟练掌握命令行工具的使用。

    准备

    通过命令行获取,需要先安装Node.js和hpm命令行工具,安装步骤如下:

    1. 安装Node.js。

      官网下载并在本地安装Node.js.

      推荐安装 12.x (包含 npm 6.14.4)或更高版本 (推荐 12.13.0+)。

    2. 通过Node.js自带的npm安装hpm命令行工具。

      打开CMD,执行以下命令:

      1. npm install -g @ohos/hpm-cli
    3. 安装完成后执行如下命令,显示hpm版本,即安装成功。

    操作

    接下来将组件添加到开发项目中,假定要获取的组件名为@ohos/demo,具体操作如下:

    1. 进入开发目录,执行如下命令,采用默认模板创建一个开发项目。

    2. 执行如下命令,安装组件@ohos/demo

      1. hpm install @ohos/demo
    3. 工具会自动从服务器下载所有依赖的组件,下载成功则显示Install successfully!

    适用场景

    • 基于OpenHarmony的稳定分支建立自己的基线,分发下游客户。

    • 已经完成自身软件与OpenHarmony的对接,需要进行OpenHarmony官方认证。

    • 芯片/模组/app通过OpenHarmony官方认证后,贡献代码到OpenHarmony生态。

    • 修复OpenHarmony的问题。

    • 学习OpenHarmony的源码。

    准备

    1. 注册码云gitee账号。
    2. 注册码云SSH公钥,请参考码云帮助中心的公钥管理:https://gitee.com/help/articles/4181
    3. 安装git客户端并配置用户信息。

      1. git config --global user.name "yourname"
      2. git config --global user.email "your-email-address"
    4. 安装码云repo工具,可以执行如下命令。

      1. curl https://gitee.com/oschina/repo/raw/fork_flow/repo-py3 > /usr/local/bin/repo
      2. chmod a+x /usr/local/bin/repo
      3. pip install -i https://pypi.tuna.tsinghua.edu.cn/simple requests

    操作

    方式一(推荐):通过repo下载

    1. repo sync -c

    方式二:通过git clone单个代码仓库

    进入代码仓库主页:

    源码目录简介

    表 2 源码目录的说明

    目录名

    描述

    applications

    应用程序样例,包括wifi-iot,camera等

    base

    基础软件服务子系统集&硬件服务子系统集

    build

    组件化编译、构建和配置脚本

    domains

    增强软件服务子系统集

    drivers

    驱动子系统

    foundation

    系统基础能力子系统集

    kernel

    内核子系统

    prebuilts

    编译器及工具链子系统

    test

    测试子系统

    third_party

    开源第三方组件

    utils

    常用的工具集

    vendor

    厂商提供的软件

    build.py

    编译脚本文件