基于Telegram二次开发 --- Bazel初探

我们先从 Xcode 来分析,在打包出 ipa 文件时,Xcode 是怎么做的:

手头的材料

代码文件(m/cpp/swift/c/h)、签名、资源文件(xcasset/png/json/html/...)、二进制文件(.a/.framework)

出来的产物

ipa:资源文件、二进制文件

Xcode 就是将手头的材料编译出我们需要的ipa;

进一步拆解 Xcode,会发现编译的过程就是调用 Tool Chains 的过程,Xcode 在编译过程中,调用了组合命令 xcodebuild, Xcode 其实就是一个壳。

将 xcodebuild 进行拆解,我们就可以得到一系列的编译工具,clang/actool/ibtool/... 等等一系列工具,当我们有了这些命令,我们就可以自己对原料进行加工,输出产物;不再依赖于 Xcode 即可进行编译。


而 Bazel 正是一个现代化的多语言构建/测试工具,它由 Google 内部 Blaze 的开源,具有正确、快速、可管理、可扩展的特点。

Bazel 的设计原则:

  1. 效率:多级 Cache,每一层可以做高效的缓存,本地、远程,来支持增量构建
  2. 可扩展性:多种不同的语言可以抽象成一类 Action 进行编译
  3. 灵活性:提供内置规则,基于 starlark 的扩展,可以实现各种用户自定义的 rules
  4. 正确性:文件缓存是基于文件内容的(而 Xcode 是基于文件时间戳的)
  5. 可重复性:有沙盒,不被研发环境影响

Bazel 需要以下支持文件:

- BUILD:描述文件
- WORKSPACE:用于描述项目所需的构建规则

因为是基于 Telegram 二次开发对 Bazel 的探索,所以我们主要研究 - BUILD 描述文件,- WORKSPACE 已经在 Clone 下来的 Telegram-iOS 文件夹目录下配置好了。


Bazel Version : 5.1.0


一、Objective-C 组件包

先打开 Telegram 的 Xcode 工程目录,我们用 third-party 文件下 ZipArchive 来分析

image.png

ZipArchive 分为三部分

BUILD:描述文件
PublicHeaders:需要向外暴露的头文件
Sources:.h .m .c 等实现文件

其实整个项目都是这样以文件夹为单位,一个个组件包组成的,BUILD 就是来描述这个组件包的构成,依赖项的 Starlark 语法的代码文件。

既然是代码文件,那就有对应 Starlark 语法

objc_library() : 描述 Objective-C 规则的函数,此规则会根据给定的 Objective-C 源文件生成一个静态库。

  • name : 组件名称。
  • enable_modules : 启用 clang,为 True 时,可支持系统头文件 import,默认为 False 。
  • module_name : 模块名称,默认名称是模块路径,所有特殊符号都会被替换成 _
  • srcs : 编译源文件;函数 glob() 可以帮助我们匹配满足路径格式的文件。
  • hdrs : 需要暴露出来的头文件。
  • includes : #include / #import 头文件搜索路径文件夹。
  • copts : 需要传递给编译器的额外编译选项:
    -x 编译语言比如 Objective-C
    -arch 编译的架构,比如 arm7
    -f 以 -f 开头的,代表“旗帜”,定义控制代码生成中使用的接口约定
    -W 以 -W 开头的,可以通过这些定制编译警告
    -D 以 -D 开头的,指的是预编译宏,通过这些宏可以实现条件编译
    -iPhoneSimulator10.1.sdk 编译采用的 iOS SDK 版本
    -I 把编译信息写入指定的辅助文件
    -F 需要的 Framework
    -c 标识符指明需要运行预处理器,语法分析,类型检查,LLVM 生成优化以及汇编代码生成 .o 文件
    -o 编译结果
  • sdk_frameworks : 需要依赖的 Framework ;为 iOS、tvOS 和 watchOS 平台构建时,始终包含 "UIKit""Foundation" 。对于 macOS,始终包含 "Foundation"
  • visibility : 可见性,控制此包是否可以在其他包中使用;
    "//visibility:public" : 授予对所有包的访问权限;
    "//visibility:private" : 不授予任何额外的访问权限;只有在这个包中的可以使用;
    "//xxx/xx:__pkg__" : 授予 //xxx/xx 访问权限,但不授予其子包;
    "//xxx/xx:__subpackages__" : 授予 //xxx/xx 及其所有直接,间接子包的访问权限;

二、swift 组件包

若我们的组件包是 swift 包,我们以 submodules 文件夹下的 AccountContext 举例

image.png

AccountContext 分为两部分

BUILD:描述文件
Sources:.swift 实现文件

因为 swiftObjective-C 相比,是没有 .h 头文件的,所以并不需要向外暴露头文件的 PublicHeaders 文件夹;

我们还注意到 BUILD 文件第一行,跟 Objective-C 下的 BUILD 相比,多了一行

load("@build_bazel_rules_swift//swift:swift.bzl", "swift_library")

BUILD 文件第一行的 load 语句表明 swift_library 是一个外部依赖规则,它被定义在 WORKSPACE 中声明的 build_bazel_rules_swift 仓库内部,而 Objective-C 下的 BUILD 里却不需要声明 objc_library 规则,这是因为 objc_libraryBazel 内置规则。

swift_library() : 描述 swift 规则的函数,此规则会根据给定的 swift 源文件生成一个静态库。

里面属性跟 objc_library 是一致的,但因为 AccountContext 依赖了自身以外的其他组件包,所以,使用了属性 deps

  • deps : 需要依赖的其他组件包,格式由 //submodules/TelegramAudio 相对路径 + :TelegramAudio 组件名 组成。

注意:在这里(swift_library())编译选项 copts 填写的 -warnings-as-errorsobjc_library()-Werror),意思是在这个组件包内将所有警告 warning 当成 error 输出。这在 Telegram-iOS 中,几乎在其 所有非第三方(如 third-party 文件夹下的所有第三方依赖)的自定义组件包 内的 BUILD 文件里都存在,所以在日常开发中,没有 ⚠️ 存在,全都被爆红替代,举个例子,我们定义了一个属性,在这个属性 被使用前,Xcode 会一直出现该属性 未被使用 的报错,这让开发变得更加严谨。

后记

前面说到 Xcode 编译是个壳,其实 Xcode 还做了其他的很多事情的,比如说语法提示/高亮、LLDB 调试工具等等功能;平时开发还是离不开 Xcode。

Telegram 使用 tulsi 工具,将 Bazel 的配置文件,逆向生成 .xcodeproj 工程;

但是这个时候的 .xcodeproj 工程其实已经去掉了 Xcode 的编译功能了;这个时候 Xcode 就是个没有编译功能的壳,但是他还是有上面提到的语法提示/高亮、调试工具等一系列工具集合。

对于 Telegram 二次开发来说,只要了解基础的 BUILD 文件格式即可。

由于 BUILD 文件规则比较多,上面只是基于 Telegram 做简单介绍,详情参考:

Starlark:https://github.com/bazelbuild/starlark
Objective-C Rules:https://docs.bazel.build/versions/main/be/objective-c.html
rule_apple:https://github.com/bazelbuild/rules_apple/tree/master/doc
tulsi:https://tulsi.bazel.build/
Apple 应用和 Bazel:https://bazel.google.cn/docs/bazel-and-apple

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

推荐阅读更多精彩内容