iOS CocoaPods

2019-07-04  本文已影响0人  孔朝阳

一、简介

1、CocoaPods 是开发 OS X 和 iOS 应用程序的第三方库的依赖管理工具
2、CocoaPods是用 Ruby 构建的,并由若干个 Ruby 包 (gems) 构成的
3、项目的依赖项在名为Podfile的文本文件中指定
4、CocoaPods将仓库存储在~/.cocoapods

二、安装

1、升级Gem

Gem是管理Ruby库和程序的标准包,它通过Ruby Gem(如 http://rubygems.org/ )
源来查找、安装、升级和卸载软件包,如果它的版本过低可能导致安装失败

sudo gem update --system

2、查看源路径

gem sources -l

3、安装(更新)Cocoapods

sudo gem install cocoapods
sudo gem install cocoapods -n /usr/local/bin

4、卸载cocoapods

gem uninstall cocoapods

5、查看pod版本

pod --version

6、设置pod仓库

所有的项目的podspec文件都托管在https://github.com/CocoaPods/Specs。第一次执行pod setup时,CocoaPods会将这些podspec索引文件更新到本地的 ~/.cocoapods/目录下,这个索引文件比较大,所以第一次更新时非常慢

pod setup

三、使用

用CocoaPods创建一个新的Xcode项目,需要如下几步:
1、使用Xcode创建新Project
2、打开Terminnal,cd到工程目录
3、运行pod init创建podfile
4、打开podfile,编辑并添加依赖库
5、运行pod install

1、初始化pod,生成Podfile文件

pod init
pod init.png

2、编辑Podfile

Podfile文件描述了Xcode Project中Target的依赖,Podfile初始状态:

# Uncomment the next line to define a global platform for your project
# platform :ios, '9.0'

target 'CocoaPodsTest' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!

  # Pods for CocoaPodsTest

  target 'CocoaPodsTestTests' do
    inherit! :search_paths
    # Pods for testing
  end

  target 'CocoaPodsTestUITests' do
    inherit! :search_paths
    # Pods for testing
  end

end

3、安装pod

1、首次运行pod install,下载并安装新的pod,生成并在Podfile.lock文件中记录每个pod的版本
2、非首次执行pod install,对于Podfile.lock文件中列出的pod,下载且不尝试检查最新版本
3、非首次执行pod install,对于Podfile.lock文件中未列出的pod,搜索Podfile中描述的确切版本

pod install
pod install.png

4、检查pod

1、将列出Podfile.lock文件中pod的最新版本

pod outdated

5、更新pod

1、在符合Podfile中的限制下,更新pod到最新版本
2、将生成新的Podfile.lock
3、运行pod update,更新所有pod

pod update [PodName]

四、幕后发生了什么?

1、创建或更新workspace
2、添加project到workspace
3、添加CocoaPods静态库project到workspace
4、添加libPods.a到target
5、添加CocoaPods Xcode configuration文件到project
6、更改target configurations基于CocoaPods
7、添加script 复制pods中的资源到app bundle中

五、Podfile

1、Podfile文件语法:

#pod 'AFNetworking' //不显式指定依赖库版本,表示每次都获取最新版本
#pod 'AFNetworking', '2.0' //只使用2.0版本
#pod 'AFNetworking', '>2.0′ //使用高于2.0的版本
#pod 'AFNetworking', '>=2.0′ //使用大于或等于2.0的版本
#pod 'AFNetworking', '<2.0′ //使用小于2.0的版本
#pod 'AFNetworking', '<=2.0′ //使用小于或等于2.0的版本
#pod 'AFNetworking', '~>0.1.2′ //使用大于等于0.1.2但小于0.2的版本,相当于>=0.1.2并且<0.2.0
#pod 'AFNetworking', '~>0.1′ //使用大于等于0.1但小于1.0的版本
#pod 'AFNetworking', '~>0′ //高于0的版本,写这个限制和什么都不写是一个效果,都表示使用最新版本

2、Podfile文件引入:

// 本地集成测试
pod 'Name', :path => '~/code/Pods/'
// 远程集成测试,默认master分支
pod 'NAME', :git => 'https://example.com/URL/to/repo/NAME.git'
// 指定branch
pod 'AFNetworking', :git => 'https://github.com/gowalla/AFNetworking.git', :branch => 'dev'
// 指定tag
pod 'AFNetworking', :git => 'https://github.com/gowalla/AFNetworking.git', :tag => '0.7.0'
// 指定commit
pod 'AFNetworking', :git => 'https://github.com/gowalla/AFNetworking.git', :commit => '082f8319af'
// 
pod 'JSONKit', :podspec => 'https://example.com/JSONKit.podspec'

五、Podfile.lock文件是什么?

1、此文件在第一次运行pod install后生成,记录和跟踪每个pod的版本。
2、每次运行pod install添加新的pod,在Podfile.lock中添加记录。
3、运行pod update会生成新的Podfile.lock
4、由于Podfile.lock,之后在另一台机器上运行pod install,即使有新版本,也会安装Podfile.lock中指定的版本

六、pod install vs. pod update

许多人刚使用CocoaPods时,认为只在安装时使用pod install,最后都使用pod update进行更新,这是错误的。

1、pod install背后做了什么?

pod install --verbose

1、Analyzing dependencies
2、Inspecting targets to integrate
3、Finding Podfile changes
4、Resolving dependencies of Podfile
5、Comparing resolved specification to the sandbox manifest
6、Downloading dependencies
7、Generating Pods project
8、Integrating client project

2、vs

pod install
1、项目第一次安装时使用
2、添加或删除pod时使用
pod update
1、仅在更新pod时使用pod update [PodName]

七、Pods目录是否应该被加入到版本管理中?

首先,Podfile和Podfile.lock文件必须加入版本管理中,建议将Pods目录加入版本管理中,不要将其添加到.gitignore文件中。

加入的优点

1、clone repo 之后,即使机器没有安装cocoapod,该项目也可以运行。不需要运行pod install,也不依赖网络。
2、Pod总是可用的,即使Pod源关闭
3、clone repo 之后,pod与原始相同

不加入的优点

1、repo小而轻
2、sources可用即可重新创建相同的安装
3、merge操作不会冲突

八、CocoaPods私有库

1、制作pod

1、创建pod

pod lib create [pod name]
pod lib create.png
$ tree MyLib -L 2

  MyLib
  ├── .travis.yml
  ├── _Pods.xcproject
  ├── Example
  │   ├── MyLib
  │   ├── MyLib.xcodeproj
  │   ├── MyLib.xcworkspace
  │   ├── Podfile
  │   ├── Podfile.lock
  │   ├── Pods
  │   └── Tests
  ├── LICENSE
  ├── MyLib.podspec
  ├── Pod
  │   ├── Assets
  │   └── Classes
  │     └── RemoveMe.[swift/m]
  └── README.md

Your demo & tests will need to include references to headers using the #import <MyLib/XYZ.h> format.(使用<>方式导入)
[!] Note : Due to a Development Pods implementation detail, when you add new/existing files to Pod/Classes or Pod/Assets or update your podspec, you should run pod install or pod update.(更改源文件后执行install)

2、在Pods下添加实际文件,cd到Example,执行pod install,在Example中测试
!这里有可能遇到头文件找不到的坑,clean下工程,重新运行

3、在集成工程中测试Pod,编辑集成工程Podfile,install,测试

platform :ios, '9.0'

target 'CocoaPodsTest' do
  # Comment the next line if you don't want to use dynamic frameworks
  # use_frameworks!

  # Pods for CocoaPodsTest
  pod 'AFNetworking'
  pod 'JRXFoundation', :path => '/Users/kongzhaoyang/Desktop/CocoaPods/JRXFoundation'

  target 'CocoaPodsTestTests' do
    inherit! :search_paths
    # Pods for testing
  end

  target 'CocoaPodsTestUITests' do
    inherit! :search_paths
    # Pods for testing
  end

end

4、修改podspec,包括version、summary、homepage、source等信息

5、创建远程仓库,关联本地仓库
!创建时选择Public
!创建时不要选择添加一个README文件(添加README文件相当于执行了一次Initial commit,导致不能自动合并,需要强制push)

git add .
git commit -m""
//  关联远程仓库
git remote add origin [Git URL]
git push -u origin master
git push -u origin master -f

6、远程校验,编辑Podfile

pod 'JRXFoundation', :git => [Git URL]

7、校验
So you've got your library ready to go. First you should check if the Podspec lints correctly, as you can't deploy with errors. This can be done with two methods, pod lib lint and pod spec lint. The difference between them is that pod lib lint does not access the network, whereas pod spec lint checks the external repo and associated tag.

//
pod lib lint
pod lib lint --allow-warnings
pod spec lint
pod spec lint --allow-warnings

8、创建Tag并push
!tag与version相同

git tag -m "first release V0.0.1" 0.0.1
git push --tags

9、在集成工程中测试podspec,编辑集成工程Podfile,install,测试

platform :ios, '9.0'

target 'CocoaPodsTest' do
  # Comment the next line if you don't want to use dynamic frameworks
  # use_frameworks!

  # Pods for CocoaPodsTest
  pod 'AFNetworking'
  pod 'JRXFoundation', :podspec => '/Users/kongzhaoyang/Desktop/CocoaPods/JRXFoundation/JRXFoundation.podspec'

  target 'CocoaPodsTestTests' do
    inherit! :search_paths
    # Pods for testing
  end

  target 'CocoaPodsTestUITests' do
    inherit! :search_paths
    # Pods for testing
  end

end

总结创建源码Pod步骤如下:
1、Create Lib
2、Add File
3、Local Test
4、Edit Podspec
5、Git Remote
6、Git Test
7、Pod Lint
8、Push Tag
9、Podspec Test

2、制作spec库

1、创建远程仓库
!创建时选择Public
!创建时选择添加一个README文件

2、将spec repo添加到CocoaPods目录

pod repo add [Spec Repo Name] [Git URL]

3、检查添加操作是否成功

cd ~/.cocoapods/repos/[Spec Repo Name]
pod repo lint .

4、添加spec到spec repo中

pod repo push [Spec Repo Name] [Podspec Name]

3、使用pod

编辑集成工程Podfile,install,测试

platform :ios, '9.0'

target 'CocoaPodsTest' do
  # Comment the next line if you don't want to use dynamic frameworks
  # use_frameworks!

  # Pods for CocoaPodsTest
  pod 'AFNetworking'
  pod 'JRXFoundation', :source => '[Spec Repo URL]'

  target 'CocoaPodsTestTests' do
    inherit! :search_paths
    # Pods for testing
  end

  target 'CocoaPodsTestUITests' do
    inherit! :search_paths
    # Pods for testing
  end

end

4、升级pod

1、添加或修改文件,并在Demo中测试(如1-2)
2、修改podspec文件,主要修改version(如1-4)
3、提交代码到远端,并打Tag(如1-5)
4、校验pod,pod lib lintpod spec lint(如1-6)
5、添加spec到spec repo中,pod repo push [Spec Repo Name] [Podspec Name(如2-4)
6、集成工程中更新pod,pod update [PodName]

上一篇下一篇

猜你喜欢

热点阅读