【入门到实战】OpenHarmony南向开发:编译构建-部件编译构建规范

【OH】openHarmony整仓代码下载 本文章主要介绍基于linux环境openHarmony整仓代码下载步骤。 阅读详情

往期鸿蒙5.0全套实战文章必看:(文中附带全栈鸿蒙5.0学习资料)


部件编译构建规范

目的

编译构建是部件化设计落地的切入点,一个优秀的部件在编译态应该具备可维护、可移植、低耦合的特征。本规范用于引导部件开发人员编写符合部件化设计的编译脚本,使得部件在编译态依赖合理、可配置、可复用、可裁剪。

基本概念

部件

部件是OpenHarmony系统能力的基本单元,以源码为划分依据,具有独立的仓和目录,在不同的设备上可实例化为不同的库或二进制文件。

特性

部件特性为编译态可配置的编译选项,可供产品在编译时按需配置。不同的特性配置,编译出部件的不同形态,使得部件可以适应不同形态产品的差异化需求。部件特性的配置只影响部件内部功能的实现差异,不能影响部件的Public API(部件对应用提供的接口)以及inner api(部件间的接口)。

依赖

在编译态,部件的依赖分为:

  • 有条件依赖:在特定场景下可裁剪的依赖,有条件的依赖裁剪后不影响部件的Public API 和inner api。比如音频对蓝牙的依赖。
  • 强依赖:部件间合理的必要的依赖,不可裁剪。比如syscap部件对安全库函数的依赖。

总体原则

部件编译构建应遵循以下几个原则:

独立自治

部件编译态应内聚,新增外部依赖时应慎重,尽量减少编译时的静态依赖。

合理依赖

部件间的依赖都应基于部件间的接口,禁止依赖其他部件内部的模块和头文件。

产品无关

部件在编译态应是多产品通用的,禁止在编译脚本中使用产品名称。

约定

规则: 必须遵守的约定。

建议: 必须加以考虑的约定。

看护手段

为了维护部件编译构建规范,门禁会对构建配置文件做一些检查。

预编译检查:指在预编译阶段进行检查,检测到错误将报错并停止编译。

静态检查:指检查工具对配置文件进行扫描检查,非编译手段。

例外

在不违背总体原则,经过充分考虑,有充足的理由的前提下,可以适当违背规范中约定。

例外破坏了代码的一致性,请尽量避免。“规则”的例外应该是极少的。

命名

编译脚本中的变量、编译目标(target)、模板,gni文件,以及部件描述文件中的对象和数据的命名都应采用内核风格(unix_like),单词全小写,用下划线分割。如:“startup_init”。

规则1.1 部件名格式须统一

  • 名词形式,需体现部件的功能。
  • 在系统内全局唯一。
  • 不超过63个有效英文字符。
  • 使用小写加下划线的内核风格命名,例如:unix_like。

例外: 三方开源软件的使用对应社区的原生命名方式,比如:cJson。

规则1.2 特性名为部件名前缀+特性名称

特性是部件声明的可配置的编译选项,加上部件名前缀可避免系统内特性重名。示例:

declare_args() {
  dsoftbus_conn_p2p = true  # dsoftbus 为部件名, conn_p2p 为特性名称
  dsoftbus_conn_ble = false # dsoftbus 为部件名, conn_ble 为特性名称
}

看护手段:预编译检查

建议1.1 编译目标名以部件名为前缀+模块名称

一个部件可能有多个编译目标(即模块),以“{部件名}_{模块名}”的方式命名可以根据编译产物(库、可执行文件)快速定位归属部件和避免重名。

反例:

ohos_shared_library("data") # Bad: 不精确,过于通用,系统内易重名

正例:

ohos_shared_library("cellular_data_napi") # Good

描述文件

bundle.json是定义部件的描述文件,包含了部件的根目录、名称、功能描述、版本号、接口定义和编译入口等信息,须保证其准确性。

规则2.1 部件描述文件中字段须准确

字段类型看护手段
namestring。部件的HPM(OpenHarmony包管理器)包名称,必填。命名规则:@{organization}/{component_name}。"component_name"为部件的名称,须满足规则1.1。静态检查
versionstring。部件版本号,必填,命名和升级跟随OpenHarmony版本号。静态检查
destPathstring。部件源码的根目录,必填。部件的根目录须独立唯一,不允许存在多个根目录。静态检查
component:namestring。部件名,必填。须满足规则1.1。静态检查
component:subsystemstring。部件归属的子系统名称,必填,子系统名为小写英文字母组合、不使用下划线。静态检查
component:syscapstring list。系统能力的描述,可选。命名规则:大驼峰,“SystemCapability.Subsystem.部件能力.子能力(可选)”,如SystemCapability.Media.Camera,SystemCapability.Media.Camera.Front。静态检查
component:featuresstring list,部件可配置的特性,可选,命名须满足规则1.2。静态检查
component:adapted_system_typestring list。部件适用的系统类型,必填,值为mini、small和standard,可同时支持多种。静态检查
component:romstring。ROM基线值,必填,单位默认为KByte。静态检查
component:ramstring。RAM基线值,必填,单位默认为KByte。静态检查
component:depsstring list。deps对象描述了部件的外部依赖,必填,包括其他部件和三方开源软件,应该与部件编译脚本中依赖一致。预编译检查

建议2.1 部件的描述文件应存放在部件根目录下

部件目录是独立的,应将bundle.json文件存放到部件根目录下。

变量

编译目标(target)的内置变量赋值决定了编译内容、依赖和打包等信息,与实现部件化设计强相关。

规则3.1 部件编译脚本中只允许引用本部件的路径,禁止引用其他部件的绝对或相对路径

部件间的依赖都必须使用"externel_deps",部件编译目标的变量sources、include_dirs、configs、public_configs、deps、public_deps引用其他部件的相对和绝对路径属于非法引入依赖:

  • sources

    sources只允许包含本部件的源码,包含其他部件的源码破坏了部件源码目录独立的原则。

  • include_dirs

    include_dirs只允许引用本部件的头文件搜索路径,编译单元对其他部件的接口的依赖都通过externel_deps自动导入。

  • configs

    configs只允许引用本部件的配置路径,引用其他部件的configs可能会引入接口依赖。

  • pulic_configs

    pulic_configs只允许引用本部件的配置路径,引用其他部件的configs可能会引入接口依赖。

  • deps

    deps只允许用于部件内模块的依赖,直接引用其他部件的模块可能会导致依赖其他部件的内部模块和接口。

    例:

    base/foos/foo_a/BUILD.gn

    deps = [ "//base/foo/foo_b:b" ] # Bad, 绝对路径依赖其他部件
    deps = [ "../../foo_b:b" ] # Bad, 相对路径依赖其他部件
    deps = [ "a" ] # Good, 依赖当前部件内的其他模块
    

    例外: 对三方开源软件的引用除外。

  • public_deps

    public_deps只允许用于部件内模块的依赖,直接引用其他部件的模块可能会导致依赖其他部件的内部模块和接口。

    例外: 对三方开源软件的引用除外。

看护手段:静态检查

规则3.2 部件编译目标必须指定部件和子系统名

部件的编译单元ohos_shared_library、ohos_static_library、ohos_executable_library、ohos_source_set都必须指定"part_name"和"subsystem_name"。

以developtools/syscap_codec/BUILD.gn的ohos_shared_library编译单元为例:

ohos_shared_library("syscap_interface_shared") {
  include_dirs = [
    "include",
    "src",
  ]
  public_configs = [ ":syscap_interface_public_config" ]
  sources = [
    "./interfaces/inner_api/syscap_interface.c",
    "./src/endian_internal.c",
    "./src/syscap_tool.c",
  ]
  deps = [
    "//third_party/bounds_checking_function:libsec_static",
    "//third_party/cJSON:cjson_static",
  ]

  subsystem_name = "developtools" # 必须指定subsystem_name
  part_name = "syscap_codec" # 必须指定part_name
}

看护手段:静态检查

建议3.1 部件内部的引用使用相对路径

部件内的引用使用相对路径的优点:

  • 脚本更简洁

  • 部件的编译脚本与部件的根目录解耦。

例:

base/foos/foo_a/BUILD.gn

include_dirs = [
    "./include", # Good, 相对路径引用
    "//base/foo/foo_a/include" # Bad, 绝对路径引用
]

deps = [
    "sub_module:foo", # Good, 相对路径引用
    "base/foo/foo_a/sub_moudule:foo" # Bad, 绝对路径引用
]

看护手段:静态检查

建议3.2 部件内部模块的可见度设置为部件内可见

部件内部的模块应使用"visibility"字段标识,防止被其他部件依赖。示例:

base/foos/foo_a/BUILD.gn

ohos_shared_library("foo_a") {
    visibility = [ "./*" ] # foo_a只在base/foo/foo_a及其子目录下可见
}

ohos_shared_library("foo_a") {
    visibility = [ ":*" ] # foo_a只在本BUILD.gn可见
}

其他

规则4.1 部件编译脚本中禁止使用产品名称变量

部件是通用的系统能力,与特定产品无关。编译脚本中使用产品名称,将导致部件功能与产品绑定,不具备通用性。部件不同产品形态上的差异应抽象为特性或者运行时的插件。

例外: vendor和device目录下三方厂商部件的编译脚本例外。

看护手段:静态检查

建议4.1 避免import其他部件目录下的gni文件

部件内的gni文件用于声明部件内部编译变量和模板,import其他部件的gni文件等同于使用其他部件内部的变量和模板,即引入对其他部件的依赖。影响多个部件的变量、args和模板应定义在编译框架的gni文件中。

例外: build目录下编译框架定义全局的编译选项的gni可以被所有部件import。

看护手段:静态检查

建议4.2 部件使用统一的编译单元模板

轻量、小型和标准的系统的编译单元都应使用ohos定义的模板,比如ohos_shared_library、ohos_static_library、ohos_executable、ohos_source_set等以"ohos_"为前缀的模板。

例如:

  executable("foundation") { # Bad, 不推荐使用内置的模板
    ...
  }

  ohos_executable("foundation") { # Good, 推荐使用ohos定制模板
    ...
  }

鸿蒙OpenHarmony【部件编译构建规范】子系统 编译构建是部件化设计落地的切入点,一个优秀的部件在编译态应该具备可维护、可移植、低耦合的特征。本规范用于引导部件开发人员编写符合部件化设计的编译脚本,使得部件在编译态依赖合理、可配置、可复用、可裁剪。 阅读详情

相关推荐

2. OpenHarmony源码下载

现在的 OpenHarmony 4.0 源码已经有了,在 https://gitee.com/openharmony 地址中,描述了源码获取的方式。下来先写下 windows 的获取方式,再写 ubuntu 的获取方式。获取源码前,还需要的准备工作是在 gitee 上添加 ssh 公钥来保证 PC 可以正确发起请求并下载。具体的生成 ssh 公钥方式,在 gitee 官网上按照步骤操作就可以了。

Zen@sz 博客 3020

OpenHarmony 源码下载和编译

OpenHarmony源码下载和编译

他晓 1859

鸿蒙南向设备开发(OpenHarmony)构建系统编译规范最佳实践

gn是generate ninja的缩写,它是一个元编译系统(meta-build system),是ninja的前端,gn和ninja结合起来,完成OpenHarmony操作系统的编译任务。

WEZC156465的博客 922

【开源鸿蒙】OpenHarmony 5.0.0 发布了,速来下载最新代码

2024年09月29日,OpenHarmony发布了v5.0.0-Release版本,这是最新的一个稳定版本,带来了很多新特性,本文将介绍如何下载OpenHarmony v5.0.0-Release版本的源代码。

码工许师傅 8159

OpenHarmony开发资料归档

OpenHarmony入门看这里

@_南先生的博客 9000

OpenHarmony(鸿蒙南向)——HDF驱动开发流程

HDF(Hardware Driver Foundation)驱动框架,为驱动开发者提供驱动框架能力,包括驱动加载、驱动服务管理、驱动消息机制和配置管理。并以组件化驱动模型作为核心设计思路,让驱动开发和部署更加规范,旨在构建统一的驱动架构平台,为驱动开发者提供更精准、更高效的驱动管理的开发环境,力求做到一次开发,多系统部署。

weixin_44796857的博客 1010

​OpenHarmony子系统开发 - 部件编译构建规范​

编译构建是部件化设计落地的切入点,一个优秀的部件在编译态应该具备可维护、可移植、低耦合的特征。本规范用于引导部件开发人员编写符合部件化设计的编译脚本,使得部件在编译态依赖合理、可配置、可复用、可裁剪。

__Benco的博客 1377

【鸿蒙南向开发】—— TEST测试:OpenHarmony unittest单元测试的编写

程序开发与单元测试二者密不可分,是每个开发人员的基本业务。当功能性代码开发完成后,要自行测试其是否满足设计预期,如果不满足就要回去完善代码,满足则可以提交功能代码及测试用例。

pengjiadashaoye的博客 1343

OpenHarmony学习笔记——南向开发环境搭建

此系列主要是记录笔者基于Hi3861的OpenHarmony学习笔记。

qq_41954556的博客 1万+

【鸿蒙南向开发】—— OpenHarmony HDF驱动开发流程

HDF(Hardware Driver Foundation)驱动框架,为驱动开发者提供驱动框架能力,包括驱动加载、驱动服务管理、驱动消息机制和配置管理。并以组件化驱动模型作为核心设计思路,让驱动开发和部署更加规范,旨在构建统一的驱动架构平台,为驱动开发者提供更精准、更高效的驱动管理的开发环境,力求做到一次开发,多系统部署。

pengjiadashaoye的博客 1212

鸿蒙5.0南向开发:HiLog日志系统开发规范

HiLog是OpenHarmony日志系统,提供给系统框架、服务、以及应用打印日志,记录用户操作、系统运行状态等。

2401_89119947的博客 1099

【入门到实战】OpenHarmony南向子系统开发:AI框架开发指南

AI业务子系统是OpenHarmony提供原生的分布式AI能力的子系统。

Androidbye的博客 1091

【鸿蒙开发实战】OpenHarmony编译框架解析:从GN到Ninja的构建之旅

本文深入解析了OpenHarmony的现代编译框架,详细阐述了其如何采用GN(Generate Ninja)作为构建描述语言,并结合Ninja构建工具实现高效的系统编译。文章从源码目录结构入手,通过产品配置、子系统管理、GN语法实战及构建流程拆解,揭示了从GN脚本到Ninja指令的完整构建之旅,并探讨了部件化编译与特性裁剪等高级话题,为开发者掌握鸿蒙系统构建提供了清晰指南。

weixin_28455801的博客 489

鸿蒙南向开发从零到一:OpenHarmony设备移植实战

本文详细介绍了OpenHarmony南向设备开发的完整流程,从开发环境搭建、芯片移植适配、源码编译烧录到调试验证,手把手带你完成第一个鸿蒙设备的移植实战。文章基于OpenHarmony 5.0/6.0版本,涵盖小型系统和标准系统移植的核心技术要点,帮助开发者快速掌握鸿蒙南向开发的关键技能。

fox0329的博客 2021

Windows下OpenHarmony南向开发环境搭建避坑实录:从DevEco Device Tool到Hi3861编译成功

本文详细记录了在Windows平台搭建OpenHarmony南向开发环境的完整过程,从DevEco Device Tool安装到Hi3861编译成功的实战经验。针对环境搭建中的常见问题如SDK获取、工程导入、编译配置等提供了具体解决方案,帮助开发者高效避坑,顺利完成OpenHarmony南向开发环境配置。

weixin_30952535的博客 554

OpenHarmony 南向开发环境对比:Hi3861小熊派 vs 传智元气派 2方案实测

本文对比了OpenHarmony南向开发环境中Hi3861小熊派与传智元气派两种主流方案的实测表现。从环境搭建效率、开发工具链、社区支持到长期维护考量,详细分析了两者的优缺点,帮助开发者根据项目需求选择最适合的开发环境。小熊派方案适合快速入门和简单开发,而传智元气派方案则更适合长期投入和多平台支持。

weixin_34393428的博客 579

【鸿蒙南向开发】—— PREPARE工作准备:OpenHarmony 代码上库

到达这一步好比临门一脚,意义很大!您的代码被合入 OpenHarmony 平台,这是最后的一道关口,保证合入的是正确的,并且不会对系统造成意外。

pengjiadashaoye的博客 1157

PPT高清导出秘籍:如何轻松设置600dpi图片分辨率

本文详细解析了PPT导出图片模糊的根本原因,并提供了通过修改Windows注册表将导出分辨率从默认的96dpi提升至600dpi的完整教程。该方法能显著提升图片清晰度,满足学术出版与高质量印刷需求,文中还包含效果对比、进阶设置及常见问题解答。

a0b1c2d3的专栏 1321

openharmony源码构建开发基础之编译指令-T指定详解

build <输出target>: <rule> <输入依赖...><输出target>:这个字符串就是 Ninja 的target 名(可被构建/被依赖)。<rule>:使用哪个规则来生成它。rule里会有很多rule xxx,比如编译 C/C++ 的、链接 so 的等。在“判断目标类型/行为”时,更关键的是build 行里使用的 rule 名字phony聚合/别名 target,它本身不产生文件,只是把依赖串起来。其他(例如cxxccalinksolinkstamp等):一般对应真实动作。

她的吻让他 840

适配adv7280m相机到rk3588的安卓平台

Kernel-5.10/arch/arm64/configs/firefly_defconfig里面增加配置CONFIG_VIDEO_ADV7180=y。出现一次开不了机器的情况,接调试口发现,在set_fmt里面用s_ctrl对mipi的频率进行设置会出现异常。设备树修改kernel-5.10/arch/arm64/boot/dts/rockchip/13.dts。把MEDIA_ENT_F_ATV_DECODER改回MEDIA_ENT_F_CAM_SENSOR。第二次编译,仅仅刷新boot.img。

chenyq14的专栏 2449

硬件原理图:从软件思维到硬件接口的嵌入式开发破局指南

本文为软件开发者提供了读懂硬件原理图的嵌入式开发破局指南。文章将硬件原理图类比为“硬件系统的架构图”,引导读者将软件API调用思维迁移到硬件接口理解上,详细解析了电阻、电容、二极管等常见元器件的“硬件API”功能与选型逻辑,并通过实战电路拆解,阐述了从原理图分析到驱动代码编写的完整思维链条,帮助开发者建立软硬件协同的系统级视角。

lg888的博客 497
上一篇: 【入门到实战】OpenHarmony南向开发:编译构建-部件配置规则
下一篇: 【入门到实战】OpenHarmony南向开发:编译构建-芯片解决方案
懂你的大海
博客等级 码龄6年 9049粉丝 1381原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值