使用 Soong 来进行 Android 模块的构建

原文地址:https://android.googlesource.com/platform/build/soong/

Soong 是原基于 make 的构建系统的替代品。它使用 Android.bp 来取代 Android.mk,并使用类似于 JSON 的格式来描述一个模块的构建方案。

Android.bp 文件格式

Android.bp 的设计非常简单,没有条件判断或控制流语句。在 Go 语言中编写的构建逻辑没有任何复杂度。Android.bp 的语法和语义可能也类似于 Bazel BUILD 文件。

模块

模块在 Android.bp 文件中以一个模块类型开始,后面跟着一组属性,以名值对(name: value)表示。基本格式为:

cc_binary {
    name: "gzip",
    srcs: ["src/test/minigzip.c"],
    shared_libs: ["libz"],
    stl: "none",
}

每个模块都必须有一个 name 属性,name 的值在所有的 Android.bp 文件中都必须是唯一的。
有关有效模块类型及其属性的列表,请参阅 $OUT_DIR/soong/.bootstrap/docs/soong_build.html。

变量

Android.bp 文件可以包含顶级变量并赋值:

gzip_srcs = ["src/test/minigzip.c"],
cc_binary {
    name: "gzip",
    srcs: gzip_srcs,
    shared_libs: ["libz"],
    stl: "none",
}

变量的范围被限定为它们声明的文件的剩余部分,以及任何子 blueprint 文件。变量只能够被 += 进行附加赋值,而且只有在被引用之前可变。

注释

Android.bp 文件可以使用 C 风格的多行 /* */ 和 C++ 风格的单行 // 注释。

类型

变量和属性是强类型的,基于第一次被赋值的值动态推定,以及由模块类型决定的静态属性。支持的类型有:

布尔值(true 或 false)
字符串(”string”)
字符串列表([“string1”, “string2”])
Map({key1: “value1”, key2:[“value2”]})

Map 可以包含任意类型的值,包括嵌套的 Map。列表和 Map 允许在最后一个值之后有逗号。

操作符

字符串,字符串列表和 Map 可以使用 + 运算符进行附加。附加 Map 将生成两个 Map 中的键的并集,并且附加两个 Map 中存在的所有键的值。

默认模块

默认模块可以描述在多个模块中被重复的相同属性。例如:

cc_defaults {
    name: "gzip_defaults",
    shared_libs: ["libz"],
    stl: "none",
}
cc_binary {
    name: "gzip",
    defaults: ["gzip_defaults"],
    srcs: ["src/test/minigzip.c"],
}

格式化工具

Soong 包含了一个 blueprint 文件的格式化器,类似于 gofmt。使用以下命令来递归格式化当前目录中的所有 Android.bp 文件:

$ bpfmt -w

标准格式包括 4 个空格的缩进,包含多个元素的列表中,每个元素之后的换行符,并且始终包括列表和 Map 中的逗号。

转换 Android.mk 文件:

androidmk Android.mk > Android.bp

该工具可以转换变量,模块,注释和一些条件,但任何自定义的 Makefile 规则,复杂条件或额外的 include 必须手动转换。

Android.mk和Android.bp之间的差异

Android.mk 文件通常包含了拥有相同名称的多个模块(例如,对于同时拥有静态和动态版本的库,或同时供主机和设备使用的库)。Android.bp 文件要求每个模块拥有唯一的名称,但每个模块可以内置多种变化,例如添加 host_supported: true。 androidmk 转换器将产生多个冲突的模块,必须手动合并到单个模块内的 target: { android: { }, host: { } } 块里。

构建逻辑

构建逻辑使用 Go 语言编写,并使用 blueprint 框架。构建逻辑接收模块定义,并利用反射和构建规则解析为 Go 数据结构。构建规则由 blueprint 收集并写入 ninja 构建文件。

常见问题

如何写一个条件判断?

Soong 故意不支持 Android.bp 文件中的条件。作为替代,复杂的、需要用到条件的构建规则已被 Go 处理,可以使用高级语言特征来跟踪由条件引入的隐式依赖关系。大多数条件将被转换为 Map 属性,Map 中的一个值将被选中并附加到顶级属性。

例如,支持特定架构的文件:

cc_library {
    ...
    srcs: ["generic.cpp"],
    arch: {
        arm: {
            srcs: ["arm.cpp"],
        },
        x86: {
            srcs: ["x86.cpp"],
        },
    },
}

有关产品变量或环境变量的更复杂条件的示例,请参阅 art/build/art.go 或 external/llvm/soong/llvm.go。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,117评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,328评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,839评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,007评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,384评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,629评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,880评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,593评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,313评论 1 243
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,575评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,066评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,392评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,052评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,082评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,844评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,662评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,575评论 2 270

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,569评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 22年12月更新:个人网站关停,如果仍旧对旧教程有兴趣参考 Github 的markdown内容[https://...
    tangyefei阅读 35,127评论 22 257
  • 无戒365极限挑战日更营 早知是这样撕心裂肺的结束,当初又何必满心期待的开始。 一切都是宿命。 当冰冷的机器进入她...
    蓝烟月阅读 642评论 1 6
  • 使用一个很好用的app的时候,或者在一个不起眼的绘本借阅网站上借书的时候,它们虽然不起眼,没有上市创业成功这样的光...
    绿玉阅读 196评论 0 1