东亚银行、岚图汽车带你解锁 AIGC 时代的数字化人才培养各赛道新模式! 了解详情
写点什么

知乎 iOS 基于 CocoaPods 实现的二进制化方案

  • 2020-03-26
  • 本文字数:3025 字

    阅读完需:约 10 分钟

知乎 iOS 基于 CocoaPods 实现的二进制化方案

背景

随着公司业务规模的增长,iOS 客户端的代码量也越来越大,编译一次项目的时间也越来越长。减少编译时间成了一个不得不面对的问题。


现有的二进制方案如 CarthageRome 等都是在本地生成 framework,没法实现「一次编译,处处使用」的目标。


为了实现这个目标,就需要一个人或者一个 CI Job,把编译好的二进制产物上传到某个的地方,集中化地管理这些二进制形式的依赖。然后在每个人 pod install 的时候,检查该 pod 版本对应的二进制是否存在,如果有就使用,没有就继续采用源码的方式依赖。


上面的方案隐藏了许多细节,比如到底应该如何集中管理这些 pod,如何知道对应的版本是否存在,如何在 pod install 的时候动态地把这些 pod 从源码形式的依赖换成二进制形式的依赖等等。


因为这整个流程涉及生产方(产生二进制)和消费方(使用二进制),我就把整个方案分为两个流程详细介绍一下。

产生二进制

代码结构

产生二进制的流程在一个 CI Job 中,每隔一段时间,它会同步主仓库最新的 dev 分支,然后运行管理此环节的工具,Platypus。


它的结构如下,



Platypus 代码结构


config.yml 是与工程相关联的配置,其中包含了需要二进制化的名单(pod_names),project 文件相关信息,以及工程初始化的 action(prebuild_action)等等。specs_repo 是私有的 podspec 仓库,需要单独创建,负责集中管理已经二进制好的 pod 信息。

具体流程

如下图,



二进制产生流程


下面是各个步骤的详细说明,


  • a) 对于大多数项目来说是 pod install,但如果在不改变 podfile 原有写法的基础上实现此套方案,需要把使用 patch 过后的 pod install 方式,这个在使用二进制这个部分会详细说明。

  • b) 白名单存在的意义有两点,一是有些 pod 本来就是二进制好了的;二是某些 pod 因为头文件没有用 < > 的方式引用在目前阶段没法二进制,否则就会因为找不到头文件编译失败。

  • c) 模拟器和真机的版本都需要编译,最终使用 lipo 把两份二进制合并到一个 .framework 中。如果 pod 中包含 Swift 代码,需要把模拟器和真机的编译产物中的 swiftdocswiftmodule 都合并到一个文件夹中。由于 Swift 版本的原因,由旧版 Xcode 编译生成 Swift 二进制是无法在新版 Xcode 中使用的。

  • f) 通过 CocoaPods 中的 Analyzer 调用 analyzer.analyze.specifications,可以获取当前项目所有依赖 pod 的 podspecs,具体操作可以看这一篇文章。关于如何编辑 podspec,可以使用这个 gem。编辑的内容包括删掉 source_files 字段,把 vendored_frameworks 字段指向 .frameworksource 指向上传生成的 URL, resources 指向对应 .framework 中的资源等等。保存后,作为二进制时依赖使用的 podspec。

  • g) 这一步是为了把项目中依赖的 pod 版本与二进制化后的版本建立起联系。因为项目中依赖的引用方式五花八门,有用 CocoaPods Master Repo 中版本号的,有用 git tag 的,也有用 git commmit 的,针对不同的引用方式,都要有对应的匹配规则,


比如有一个使用 tag 方式引用的组件,把它的 tag 号后面加上 -zhihu-static 作为它在私有 Specs 仓库中的版本号,它在 podfile 中的 external_source 作为 summary 字段,同时确保唯一性。这里的映射关系只要能一一对应起来,随便怎么建立都好。


pod 'A', git: 'git@git.xxx.com:xxx/A.git', tag: '4.24.0.9'
复制代码


所以它被改完版本号后 poddpec 会长成这个样子,


{  "name": "A",  "version": "4.24.0.9-zhihu-static",  "summary": "{:git=>\"git@git.xxx.com:xxx/A.git\", :tag=>\"4.24.0.9\"}"  ...}
复制代码


  • h) Specs 仓库目录结构如下所示,目录均为手动创建,没有使用 CocoaPods 提供的方式更新。


├── A│   └── 4.22.0.8-zhihu-static│       └── A.podspec.json├── B│   ├── 0.2.21-zhihu-static│   │   └── B.podspec.json│   └── 0.2.9-zhihu-static│       └── B.podspec.json├── C│   └── 1.4.0-zhihu-static│       └── C.podspec└── D    └── 2.5.0-zhihu-static        └── D.podspec
复制代码

使用二进制

在触发 pod install 过程之前,需要在本地把私有 Specs 仓库更新到最新,pod repo update xxx


接下来就是 patch pod install 替换依赖的过程了。在不更改 podfile 的情况下,只能模仿 pod install 的过程,自己创建一个脚本来替代这个操作了。整个过程不复杂,可以参考下面这一段带注释的代码,


# 参考 `CocoaPods` 的源码,模拟 `pod install` 执行的过程argv = CLAide::ARGV.new([])cmd = Pod::Command.new(argv)cmd.send :verify_podfile_exists!installer = cmd.send :installer_for_configinstaller.repo_update = falseinstaller.update = false
podfile = installer.podfile
# 获取此次 install 的配置,是全部使用二进制还是全部使用源码# 全部使用二进制时,哪些 pod 依旧使用源码引入use_all_binary, source_pod_list = ZHPodInstallHelper.read_binary_pods_prefuse_all_binary = false if ENV['ALL_SOURCE'] == 'true'unless use_all_binary puts '🐢 pod install with all source' installer.install! exit(0)end
# 为 podfile 添加二进制 Specs 仓库的 sourcepodfile.send(:get_hash_value, 'sources')hash_sources = podfile.send(:get_hash_value, 'sources') || []hash_sources << 'git@git.xxx.com:xxx/E.git'podfile.send(:set_hash_value, 'sources', hash_sources.uniq)
# 遍历 podfile 中的所有 dependenciespodfile.root_target_definitions.each do |root_target_definition| children_definitions = root_target_definition.recursive_children children_definitions.each do |children_definition| dependencies_hash_array = children_definition.send(:get_hash_value, 'dependencies') next if dependencies_hash_array.count.zero? dependencies_hash_array.each do |dependencie_hash_item| next if dependencie_hash_item.class.name != 'Hash' dependencie_hash_item.each do |name, value| next if value[0].is_a?(Hash) && value[0][:path] search_name = name search_name = name.split('/')[0] if name.include?('/')
# 对于想要以源码依赖的 pod,不作修改 next if source_pod_list.include?(search_name)
# 根据 podfile 中引用的源码版本,在私有 Specs 仓库中查找相应二进制的版本 version = ZHPodInstallHelper.get_binary_version(search_name, value[0].to_s) # 存在对应的二进制版本,就替换掉 dependencie_hash_item[name] = [version] if version end end # 替换 podfile 的 dependencies 为修改后的 dependencies children_definition.send(:set_hash_value, 'dependencies', dependencies_hash_array) endend
installer.install!
复制代码

限制

说完了整个方案的流程,我们再来谈谈这个方案存在的一些问题,


  • 需要自定义 pod install 过程,同时修改某些 CocoaPods 中的私有属性

  • 最终的 binary size 会比使用源码的时候大一点,不建议最终上传 Store 的时候使用

  • 缺少一个验证的机制,如果已发布的二进制包不能被项目正常引用,那么会导致所有人的编译失败

  • 由于工程采用的是全部静态库依赖的形式,所以在二进制和源码切换的过程中会对 project 文件产生更改

总结

以上就是知乎 iOS 客户端二进制预编译的方案,有任何问题都欢迎大家留言,写下你的看法


2020-03-26 19:002077

评论

发布
暂无评论
发现更多内容

去中心化薄饼交易所开发|PancakeSwap去中心化交易所搭建方案

Geek_23f0c3

交易所开发 去中心化交易所系统开发 PancakeSwap交易所

校友资料登记平台小程序开发笔记二-云数据库设计

CC同学

校友录小程序 校友资料小程序

带你了解WDR-GaussDB(DWS) 的性能监测报告

华为云开发者联盟

数据库 数据 GaussDB(DWS) WDR 负荷诊断报告

13张图,深入理解Synchronized

程序猿阿星

synchronized java 并发 锁机制 锁升级

WorkPlus高端制造业数字化解决方案—长江存储

WorkPlus

开源 企业 解决方案 即时通讯 私有云

抖音快手seo获客系统开发(可贴牌)

获客I3O6O643Z97

抖音霸屏

Spark 开源新特性:Catalyst 优化流程裁剪

华为云开发者联盟

sql spark 开源 Catalyst 优化器

哪类技术助力了隐私计算的工业化?如何“组装”发挥更大价值?

价值连城 知名深度强化学习Pieter Abbeel的采访 John 易筋 ARTS 打卡 Week 56

John(易筋)

ARTS 打卡计划

腾讯T3大牛手把手教你!三面腾讯,已拿offer

欢喜学安卓

android 程序员 面试 移动开发

记一次真实的JVM性能调优过程

北游学Java

Java JVM 性能调优

经典好文!BAT大厂Android面试真题锦集干货整理

欢喜学安卓

android 程序员 面试 移动开发

SaaS市场百花齐放:厂商数量已达4500家,用户数量已达915万家

海比研究院

Vue进阶(五十八):ES字符串操作:遍历、比较、截取、补全...

No Silver Bullet

Vue ES 字符串 7月日更

ZooKeeper 分布式锁 Curator 源码 04:分布式信号量和互斥锁

程序员小航

Java zookeeper 源码 分布式锁 zookeeper分布式锁

EasyRecovery软件帮你快速恢复图片数据

淋雨

EasyRecovery 文件恢复 硬盘数据恢复

测试开发之系统篇-安装KVM虚拟机

禅道项目管理

虚拟机 测试开发

Go语言:new还是make?到底该如何选择?

微客鸟窝

Go 语言

详解API Gateway流控实现,揭开ROMA平台高性能秒级流控的技术细节

华为云开发者联盟

华为 ROMA 集成平台 ROMA Connect API Gateway

携手生态伙伴亮相InfoComm,英特尔赋能智能协作办公

E科讯

手写Spring框架,是时候撸个AOP与Bean生命周期融合了!

小傅哥

Java spring 小傅哥 aop 代理

开跑!Mobileye自动驾驶汽车路测落地纽约

E科讯

WorkPlus高端制造业数字化解决方案—航天科工

WorkPlus

开源 移动 解决方案 即时通讯 私有云

一周信创舆情观察(7.12~7.18)

统小信uos

Java的这个强大功能,很多人都不知道

华为云开发者联盟

Java c++ jdk 算法 jni

Cassandra的调优总结

林一

分布式数据库 Cassandra

利用亚马逊云科技Direct Connect和Transit Gateway轻松构造企业混合云解决方案

亚马逊云科技 (Amazon Web Services)

校友资料登记平台小程序开发笔记一-系统整体设计

CC同学

校友登记小程序 校友资料小程序

看焱融云CSI动态感知如何扩展Kubernetes Scheduler

焱融科技

云计算 技术 云原生 高性能 分布式存储

应届女生美团Java岗4面,一次性斩offfer,我受到了万点暴击

Java 编程 程序员 架构师 计算机

作为Android开发程序员,已获千赞

欢喜学安卓

android 程序员 面试 移动开发

知乎 iOS 基于 CocoaPods 实现的二进制化方案_文化 & 方法_Xinyu_InfoQ精选文章