CocoaPods的一些知识点

CocoaPods：iOS开发中的依赖管理工具

CocoaPods是一个流行的iOS开发依赖管理工具，可以方便地管理第三方库，简化了开发者的工作流程。

本文将重点介绍CocoaPods的一些基本概念，以及如何使用CocoaPods在iOS项目中管理第三方库。

什么是CocoaPods？

CocoaPods是一个用于iOS和Mac项目的依赖管理工具，类似于npm、pip、gradle等其他平台上的包管理器。它通过提供一个标准的格式来描述项目中需要使用的库，使得开发者可以方便地引入和管理第三方库。

CocoaPods是一个Ruby程序，它可以自动处理依赖关系，并生成一个Xcode工程文件，使得开发者可以更轻松地使用第三方库。

什么是Podfile？

Podfile是一个用于描述iOS项目依赖的Ruby文件，它的格式如下所示：

#source 源路径 共有源 或者 私有源
source 'https://github.com/CocoaPods/Specs.git'
source 'https://www.mstpay.com:1809/ios_repo/YHGitRepo.git'

platform :ios, '9.0'

target 'MyApp' do
  use_frameworks!

  pod 'AFNetworking', '~> 3.0'
  pod 'MBProgressHUD'
end

其中，第一行和第二行分别是CocoaPods默认的共有源和开发者自己的私有源。接下来的platform表示项目的部署目标，target表示需要依赖的项目，pod表示具体需要使用的第三方库。

Podfile.lock和Pods文件夹

执行pod install后，CocoaPods会生成一个Podfile.lock文件和一个Pods文件夹。

Podfile.lock文件记录了安装每个库时使用的精确版本号，这些版本号会被固定在该文件中，以确保不会在下一次安装时更改。

Pods文件夹包含了项目中所需要的所有第三方库，以及CocoaPods自动生成的Xcode工程文件。

Podspec

Podspec文件是用于描述一个CocoaPods库的详细信息的Ruby文件。这个文件可以包含许多有用的信息，如库的名称、版本、依赖项、授权协议、作者、代码文件、资源文件等等。这些信息将帮助CocoaPods系统了解库的结构，以便正确地生成和安装库。

下面示例：

Pod::Spec.new do |s|
# 基本信息，如项目名称、版本号、简述、详细描述、项目主页、开源协议、作者等
  s.name         = "MyLibrary"    #项目名
  s.version      = "0.1.0"            #相应的版本号
  s.summary      = "A short description of MyLibrary."  #简述
  s.description  = <<-DESC#详细描述
                   Test Simple Podspec.
                   DESC
  s.homepage     = "https://example.com/MyLibrary"#项目主页
  s.license      = { :type => 'MIT', :file => 'LICENSE' }#开源协议
  s.author       = { "John Doe" => "john.doe@example.com" }#作者

  #平台信息
  s.platform     = :ios, '7.0'
  s.ios.deployment_target = '7.0'

  #文件配置项，库的文件配置包括源代码、资源文件、框架和静态库等。下面是一个示例：
  s.source       = { :git => "https://github.com/MyLibrary/MyLibrary.git", :tag => s.version.to_s }
  s.requires_arc = true    #arc和mrc选项
  s.libraries = 'z', 'sqlite3'    #预先加载的静态库和framework
  s.frameworks = 'UIKit', 'CoreFoundation','QuartzCore','CoreGraphics','Accelerate','Photos','AssetsLibrary','AVFoundation','CoreText','CoreData','SystemConfiguration','CoreTelephony'
 #依赖的三方.a文件
  s.vendored_library    = 'YHMenu/Classes/**/*.a'  
  #头文件和实现文件，有c的也可以
  s.source_files            = 'YHMenu/Classes/*.h','YHMenu/Classes/**/*.{h,m}','YHMenu/Classes/**/**/*.{h,m}' 
#资源文件 xib bundle xcassets
  s.resources               = ['YHMenu/Community/**/*.xib','YHMenu/*.bundle','YHCommunity/Assets.xcassets','YHMenu/Community/**/*.gif'] 
#预编译头文件 #依赖的项目内容 可以多个 s.dependency 'YYModel' s.dependency 'YHNative' '0.1.0'#并且可以指定版本
  s.prefix_header_file      = 'YHMenu/PrefixHeader.pch 
 end 

说明

s.source拿出来特别说明一下

• 没有tag 和 没有branch 的时候，source是指向master分支的最后一次更新。
• :tag source指向改该tag所在的提交。该tag以后的内容不会被包含进来。
• :branch source指向的是该branch的最后一次提交,无视source内容

其他内容

本文约定： #{NAME}这个是一个标示具体要替换为你自己的库

• 名词解释：

  • 私有仓库YHGitRepo:项目版本管理的地方，放置各个版本的podspec文件的仓库。
  • pod repo add YHRepo git@192.168.11.239:ios_repo/YHGitRepo.git #这个命令可以添加一个私有仓库
  • 可以使用pod repo update YHRepo 去更新你本地的私有仓库
  • 本地仓库的地址 ~/.cocoapods/repos

• pod install 过程：

  • 更新本地的私有仓库(Option?)
  • 解析Podfile跟podfile.lock文件，查找不同
  • 解析不同的项目，从本地的仓库地址查找最合适的podspec文件
  • 解析podspec文件，根据其podspec中的内容，下载或查找本地的依赖。
    • 查找本地的意思并不是找你本地的项目，而是pod的缓存
    • 可以使用pod cache list 去查找一下你本地缓存的路径
  • 查找或下载好依赖的工程文件，拷贝到主项目的Pods文件夹下面
  • 安装项目中podspec的依赖关系
  • 配置xcode的一些依赖参数

Podfile

什么是podfile

项目三方或二方库依赖的配置文件,本质就是个Ruby文件。

#source 源路径 共有源 或者 死有源
source 'https://github.com/CocoaPods/Specs.git'
source 'https://www.mstpay.com:1809/ios_repo/YHGitRepo.git

platform :ios, '9.0'  #平台版本
inhibit_all_warnings! #是否消除所有警告
use_frameworks!       #使用framework代替静态库
#set_arc_compatibility_flag! 开启arc和mrc的开关，加-fobjc-arc的标签，没用过先注着

target 'MyApp' do     #目标Target
  pod 'ObjectiveSugar', '~> 0.5'
  target "MyAppTests" do
    inherit! :search_paths #继承关系的使用，固定写法
    pod 'OCMock', '~> 2.0.1'
  end
end

#hooker 钩子，注意是全局的，不跟随target走，例如想关闭pod中所有bitcode这个参数就可以在这边管
post_install do |installer|
  installer.pods_project.targets.each do |target|
    puts "#{target.name}"
  end
end

日常注意点 pod 'Name'的本质就是在寻找podspec文件，并加载配置。 pod 'YHKit' 这个命令后面可以加什么

• 什么都不加的情况。区分pod install 和 pod update。
  • pod install的时候，如果本地存在podfile.lock文件，并且里面是有YHKit的，那么pod install 不会去更新YHKit这个仓库。
  • pod update 的时候，会无视podfile.lock文件，从~/.cocoapods目录下查找YHKit的最新的podspec文件
• :path
  • 举个🌰 pod 'TestCI', :path => '/Users/hongzhizhao/Documents/WeiYi/Code/TestCI' 该目录下必须包含podspec文件
  • 这个参数是用来在本地开发的时候使用的，这个命令会无视你s.source后面的内容，从本地加载除了s.source外其他的参数，比如:s.source_files、s.resources等
  • 这个对于后续做组件开发联调的时候非常有用,因为其实本地加载。所以就可以省掉提交的操作了。
  • Note：因为是本地开发，最好不要把path这种后缀提交到主工程，因为别人本地并没有。
• tag号
  • pod 'YHKit' '1.0.1'
  • 上述的是指定了YHKit版本为1.0.1 版本号标准定义管理
• :podspec
• 举个🌰
  pod 'YHReact', :podspec => '/Users/hongzhizhao/Documents/WeiYi/Code/react-native/YHReact.podspec'
  • 加载指定的podspec文件，可以是本地文件，也可以是网络文件。
  • 在没有搭建私有仓库前，我们的项目是用这种方式来维护的。
  • 目前常用来，测试一个podspec合法，即加载的文件和资源是否正确
• branch
  • 指定加载某个分支上最后一次提交的podspec文件。