CocoaPods 项目 “模块化” 实战

96
KentonYu
0.7 2016.06.27 21:00* 字数 1110

文题套用了现在系统设计中最火的词汇之一 —— 模块化,当然下文中的 “模块化” 只是杀鸡用牛刀了,不过在我的理解里大致意思差不多吧。

模块化设计是指在对一定范围内的不同功能或相同功能不同性能、不同规格的产品进行功能分析的基础上,划分并设计出一系列功能模块,通过模块的选择和组合可以构成不同的产品,以满足市场的不同需求的设计方法。 —— WIKI

起源

原来项目的基础库和一些基于第三方库封装的 UI 控件都是通过 Copy 文件来实现复用的,这算是最原始的一种方式吧。其实在这之前也考虑过直接用 framework 来打包基础库,但是这两种方式都存在一些缺点 :

  1. 代码更新维护比较困难;
  2. framework 在 debug 阶段比较难调试 (基础库也不能排除 bug );
  3. 代码的前后兼容不容易确定;

因此,最近我调研了一部分这方面东西,发现 CocoaPods 可以胜任。当然不少大神也一定尝试过甚至正在使用这样的方式来管理自己的项目,希望可以指点一下。
如果你的项目只需要支持 iOS 8 + ,那么可以考虑去试试 Carthage 。

正文

安装、使用 CocoaPods

  • 安装/更新 CocoaPods (没有挂 VPN 的同学可以加上 --verbose 查看进度,不然 Terminal 一直都是黑屏 QAQ )
sudo gem install cocoapods    
sudo gem update cocoapods  
  • 拉取 Spec Repo
pod setup

解释一个概念,什么是Spec Repo?它是所有的Pods的一个索引,也就是一个容器(集合),所有公开的Pods都在这个里面。实际上就是一个 Git 仓库 remote 端,当你使用了 Cocoapods,这个仓库会被 clone 到本地的 ~/.cocoapods/repos 目录下,进入到这个文件下可以看到 master 文件夹,就是官方的 Spec Repo 了。当你 pod search 的时候就在 master 这个文件下面查找的。

  • 为项目建立 Podfile
    进入工程目录,执行<code> pod init </code>, 将会生成 Podfile 文件,然后通过编辑这个文件就可以管理依赖库了。
platform :ios, "7.0"
target "TestPod" do
      pod 'SDWebImage', '~> 3.2' 
      pod 'CocoaLumberjack'
      pod 'MyKit',   :git => 'git@github.com:demo/MyKit.git'
      pod 'RSA',     :path => 'libs/Sources/RSA'
end

具体的配置参数可以参见官方文档

  • 安装/更新依赖库
pod install    // 安装依赖库,如存在 Podfile.lock 文件,则安装里面的版本
pod update     // 更新依赖库,会将依赖库更新到最新版本,并更新 Podfile.lock   
pod install --no-repo-update    // 不更新本地 Spec 源,直接 clone 依赖库
pod update --no-repo-update

这两个命令有一定的区别,具体可以自行 Google
安装完之后就可以通过 .xcworkspace 文件来打开你的工程。

建立私有 Spec Repo

  • 新建一个 Git 库
    可以使用 Github、Coding、GitLab 等创建一个 Git 库作为私有 Pods 库的 Spec 源。

  • 将私有 Spec Repo 添加到本地 repo 目录

pod repo add SpecRepoName git@github.com/demo/PrivatePods.git

创建私有库

  • 建立 Pods 开发工程
pod lib create YourPodsLibName

按提示进行配置选择,然后打开项目,工程目录如下:

Image1.png

Podspec Metadata 中的 .podspec 文件是这个私有库的配置文件,可以进行编译配置。以下是我目前用到的一些配置参数(Ruby):

Pod::Spec.new do |s|
s.name             = 'PodsRepo'
s.version          = '0.1.0'
s.summary          = '管理公司项目中通用代码的 Pods 库'
s.homepage         = 'http://www.demo.com/'
s.license          = { :type => 'MIT', :file => 'LICENSE' }   # 开源协议
s.author           = { 'KentonYu' => 'demo@163.com' }
s.source           = { :git => 'http://172.0.0.0/iOS/DTPodsRepo.git', :tag => s.version.to_s }   # Pods 库的地址
s.ios.deployment_target = '7.0'   # Pods 库支持的系统版本

s.prefix_header_contents = '#import "DTBaseKit.h"'    # Pods 库中需要预编译的头文件


# subspec 是 Spec 中的子类
s.subspec 'BaseKit' do |sub|
sub.source_files = 'PodsRepo/BaseKit/*.{h,m}', 'PodsRepo/BaseKit/**/*.{h,m}'
sub.public_header_files = 'PodsRepo/BaseKit/*.h', 'PodsRepo/BaseKit/**/*.h'
end

s.subspec 'NetworkingKit' do |sub|
sub.source_files = 'PodsRepo/NetworkingKit/*.{h,m}'
sub.public_header_files = 'PodsRepo/NetworkingKit/*.h'
sub.dependency 'AFNetworking', '~> 3.1.0'
sub.dependency 'PodsRepo/BaseKit'    # 可以依赖同一个 Pods 库中的 subspec
end

# s.resource_bundles = {    # 依赖的资源路径
#   'PodsRepo' => ['PodsRepo/Assets/*.png']
# }

# s.frameworks = 'UIKit', 'MapKit'   # 依赖的系统库
end

这一部分的详细介绍可以 看这里

注意:在你像 Pods 目录中的 Development Pods 里添加文件后,需要执行下 <code>pod install</code>,才能在 Example 工程中被识别出来。

  • 验证是否能通过编译
pod lib lint     // Pods 能否成功编译
pod lib lint --allow-warnings   // 允许警告

通过验证后,就可以将 Pods 库 Push 到 Git 上,并打上 tag (对应 .podspec 中的 version )。

  • 验证 .podspec
pod spec lint   
pod spec lint --allow-warnings //同 pod lib lint

这一步会从 Spec 中指定的 s.source 和 s.version 拉取 Git 中的代码进行编译。

  • Push 到私有 Spec 源
pod repo push YourPodSpecName Name.podspec
  • 测试私有库
    使用 <code>pod search</code> , 能不能查询到自己 Pods,可以那就进入下一步。
    创建一个 demo,podfile 设置如下
source 'https://github.com/CocoaPods/Specs.git' #官方仓库地址
source ‘https://github.com/demo/PodSpec.git’  #私有仓库地址
# use_frameworks!  # 引入 swift 库时需要
target 'TestPodDemo'  do
pod ‘YourPod’, '~> 0.1.0'
end

执行 <code>pod install</code> ;

小结

在调研这个过程中,遇到了很多问题,不过大多数都可以通过 Google 或者 Github Issue 里找到答案。
利用 CocoaPods 我们可以将项目中的基础库,公有库抽离出来,通过 Pods 来管理,方便复用的同时,增强代码的可维护性。
最后我建立了一个私有 Pods 库,通过 subspec 进行基础库的“模块化”。

如有不对望指正,给个喜欢以示支持。

日记本