CocoaPods 原理

最新推荐文章于 2020-08-15 08:01:43 发布

TimerYJ

最新推荐文章于 2020-08-15 08:01:43 发布

阅读量935

点赞数

分类专栏： iOS开发笔记文章标签： iOS CocoaPods

本文链接：https://blog.csdn.net/yj54088/article/details/76067113

版权

iOS开发笔记专栏收录该内容

5 篇文章 0 订阅

订阅专栏

CocoaPods 原理

一、CocoaPods 简介

CocoaPods 是一个 OC 依赖管理库，而本身是由 Ruby 的依赖管理 gem 进行构建的。

二、核心组件

这里写图片描述

1、Podfile

定义项目所需要使用的第三方库，高度定制。Podfile官方指南

2、podspec

该文件描述了一个库是怎样被添加到工程中，支持的功能有列出源文件、framework、编译选项和某个库所需依赖等。

3、CocoaPods/Xcodeproj

这个 gem 组件负责所有工程文件的整合。可以创建并修改 .xcodeproj 和 .xcworkspace 文件。也可以作为单独的一个 gem 包使用。如果你想要写一个脚本来方便的修改工程文件，那么可以使用这个 gem。

三、pod install

pod install (--verbose)

pod install 语句的执行过程如下。

1、读取 Podfile

首先弄清楚显式 / 隐式的声明了哪些第三方库。在加载 podspec 过程中，CocoaPods 就建立了包括版本信息在内的所有的第三方库的列表。podspecs 被存储在本地路径 ~/.cocoapods 中。

Finding Podfile changes
  - AFNetworking

2、版本控制和冲突

CocoaPods使用了语义版本控制命名约定来解决对版本的依赖。

由于冲突解决系统建立在非重大变更的补丁版本之间，这使得解决依赖关系变得容易很多。例如，两个不同的 pods 依赖于 CocoaLumberjack 的两个版本，假设一个依赖于 2.3.1，另一个依赖于 2.3.3，此时冲突解决系统可以使用最新的版本 2.3.3，因为这个可以向后与 2.3.1 兼容。

但这并不总是有效。有许多第三方库并不使用这样的约定，这让解决方案变得非常复杂。

当然，总会有一些冲突需要手动解决。如果一个库依赖于 CocoaLumberjack 的 1.2.5，另外一个库则依赖于 2.3.1，那么只有最终用户通过明确指定使用某个版本来解决冲突。

Downloading dependencies

-> Using AFNetworking (1.2.1)

3、加载源文件

每个 .podspec 文件都包含一个源代码的索引，这些索引一般包裹一个 git 地址和 git tag。它们以 commit SHAs 的方式存储在 ~/Library/Caches/CocoaPods 中。这个路径中文件的创建是由 Core gem 负责的。

CocoaPods 将依照 Podfile、.podspec 和缓存文件的信息将源文件下载到 Pods 目录中。

Generating Pods project
  - Creating Pods project
  - Adding source files to Pods project
  - Adding frameworks to Pods project
  - Adding libraries to Pods project
  - Adding resources to Pods project
  - Linking headers

4、生成 Pods.xcodeproj

每次 pod install 执行，如果检测到改动时，CocoaPods 会利用 Xcodeproj gem 组件对 Pods.xcodeproj 进行更新。如果该文件不存在，则用默认配置生成。否则，会将已有的配置项加载至内存中。

5、安装第三方库

当 CocoaPods 往工程中添加一个第三方库时，不仅仅是添加代码这么简单，还会添加很多内容。由于每个第三方库有不同的 target，因此对于每个库，都会有几个文件需要添加，每个 target 都需要：

一个包含编译选项的 .xcconfig 文件
一个同时包含编译设置和 CocoaPods 默认配置的私有 .xcconfig 文件
一个编译所必须的 prefix.pch 文件
另一个编译必须的文件 dummy.m

- Installing libraries
  - Installing target `Pods-AFNetworking` iOS 6.0
    - Adding Build files
    - Adding resource bundles to Pods project
    - Generating public xcconfig file at `Pods/Pods-AFNetworking.xcconfig`
    - Generating private xcconfig file at `Pods/Pods-AFNetworking-Private.xcconfig`
    - Generating prefix header at `Pods/Pods-AFNetworking-prefix.pch`
    - Generating dummy source file at `Pods/Pods-AFNetworking-dummy.m`

一旦每个 pod 的 target 完成了上面的内容，整个 Pods target 就会被创建。这增加了相同文件的同时，还增加了另外几个文件。如果源码中包含有资源 bundle，将这个 bundle 添加至程序 target 的指令将被添加到 Pods-Resources.sh 文件中。还有一个名为 Pods-environment.h 的文件，文件中包含了一些宏，这些宏可以用来检查某个组件是否来自 pod。最后，将生成两个认可文件，一个是 plist，另一个是 markdown，这两个文件用于给最终用户查阅相关许可信息。

- Installing target `Pods` iOS 6.0
      - Generating xcconfig file at `Pods/Pods.xcconfig`
      - Generating target environment header at `Pods/Pods-environment.h`
      - Generating copy resources script at `Pods/Pods-resources.sh`
      - Generating acknowledgements at `Pods/Pods-acknowledgements.plist`
      - Generating acknowledgements at `Pods/Pods-acknowledgements.markdown`
      - Generating dummy source file at `Pods/Pods-dummy.m`

6、写入磁盘

直到现在，许多工作都是在内存中进行的。为了让这些成果能被重复利用，我们需要将所有的结果保存到一个文件中。

- Writing Xcode project file to `Pods/Pods.xcodeproj`
- Writing Lockfile in `Podfile.lock`
- Writing Manifest in `Pods/Manifest.lock`

1）Podfile.lock

这是 CocoaPods 创建的最重要的文件之一。它记录了需要被安装的 pod 的每个已安装的版本。如果你想知道已安装的 pod 是哪个版本，可以查看这个文件。推荐将 Podfile.lock 文件加入到版本控制中，这有助于整个团队的一致性。

2）Manifest.lock

这是每次运行 pod install 命令时创建的 Podfile.lock 文件的副本。如果你遇见过这样的错误沙盒文件与 Podfile.lock 文件不同步 (The sandbox is not in sync with the Podfile.lock)，这是因为 Manifest.lock 文件和 Podfile.lock 文件不一致所引起。由于 Pods 所在的目录并不总在版本控制之下，这样可以保证开发者运行 app 之前都能更新他们的 pods，否则 app 可能会 crash，或者在一些不太明显的地方编译失败。

3）xcproj

如果你已经依照我们的建议在系统上安装了 xcproj，它会对 Pods.xcodeproj 文件执行一下 touch 以将其转换成为旧的 ASCII plist 格式的文件。为什么要这么做呢？虽然在很久以前就不被其它软件支持了，但是 Xcode 仍然依赖于这种格式。如果没有 xcproj，你的 Pods.xcodeproj 文件将会以 XML 格式的 plist 文件存储，当你用 Xcode 打开它时，它会被改写，并造成大量的文件改动。