CocoaPods安裝使用及配置私有庫
- 如何安裝?
1.安裝ruby環境,添加淘寶ruby鏡像
$ gem sources --remove https://rubygems.org/
//等有反應之後再敲入以下指令
$ gem sources -a https://ruby.taobao.org/
2.檢視是否設定成功:
3.然後安裝cocoapods:
$ sudo gem install cocoapods
4.檢視cocoapods是否支援某個類庫
$ pod search 類庫名,支援模糊查詢(如:AFNetworking)
如何使用?
- 在項目根目錄下建立一個“Podfile”的檔案(記住一定得叫這個名兒,而且木有字尾)
注:Podfile也可以放在任何位置,但是需要在Podfile頂部使用”xcodeproj”關鍵字指定工程的路徑,如下:
但是執行pod install指令後,生成的檔案放在了Podfile所在的目錄.
- 編輯Podfile檔案輸入以下資訊
platform :iOS, ‘7.0’\\所有庫支援的IOS最低版本
pod ‘AFNetworking’, ‘~> 2.0’\\版本号
注:有些第三方庫需要指明:platform 支援的IOS最低版本,否則在pod install時會報錯,如下圖,提示AFNetworking最低支援IOS6.0和OS X 10.8
- 然後在項目podfile所在目錄下運作:(會在你目前項目中導入podfile所配置的庫,是以要在項目目錄下運作)
$ pod install
注意上述指令運作完畢後終端輸出的最後一段話,意思就是以後打開項目就用CocoaPodsDemo.xcworkspace 打開,而不是之前的.xcodeproj檔案。
[!] From now on use `CocoaPodsDemo.xcworkspace`.
經過以上步驟後,我們現在可以打開CocoaPodsDemo.xcworkspace啟動我們的新工程了.新工程中已經通過cocoapods引入并配置好了我們剛在podfile寫的需要依賴的第三方庫了.
引入第三方庫後找不到頭檔案?
在項目的Targe-Build Settings-Search Paths-User Header Searcj Paths中添加
${SRCROOT} 值為 recursive
如下圖:
如何編譯從github上checkout下來的一個已包含CocoPods類庫的項目?
打開終端進入你所下載下傳項目的根目錄,執行以下指令,後會得到上面的那句話:
$ pod update
等待指令運作完畢後,同樣最後會輸出
[!] From now on use `xxxxx.xcworkspace`.
如何删除cocopods?
- 1.删除工程檔案夾下的Podfile、Podfile.lock及Pods檔案夾
- 2.删除xcworkspace檔案
- 3.使用xcodeproj檔案打開工程,删除Frameworks組下的Pods.xcconfig及libPods.a引用
-4. 在工程設定中的Build Phases下删除Check Pods Manifest.lock及Copy Pods Resources
CocoaPods常用指令
1、pod install
根據Podfile檔案指定的内容,安裝依賴庫,如果有Podfile.lock檔案而且對應的Podfile檔案未被修改,則會根據Podfile.lock檔案指定的版本安裝。
每次更新了Podfile檔案時,都需要重新執行該指令,以便重新安裝Pods依賴庫。
等其執行完畢,即可完成第三方庫的安裝
其中還可以調用pod update方法, 也可以達到第三方庫安裝的目的, 并且會更新版本
在pod install或者pod update過程中會執行podspec索引的更新,需要等待很久,是以為了提升速度可以執行如下指令, 關掉索引的更新
并且在安裝過程中, 我們不知道cocoapods做了什麼, 還可以添加一個參數,用來提示我們,cococapods做了哪些操作
- 清單内容
2、pod update
若果Podfile中指定的依賴庫版本不是寫死的,當對應的依賴庫有了更新,無論有沒有Podfile.lock檔案都會去擷取Podfile檔案描述的允許擷取到的最新依賴庫版本。
3、pod search
指令格式為:
$ pod search 類庫名,支援模糊查詢(如:AFNetworking)
紅框中的資訊為AFNetworking 最新版本,Version中顯示了曆史版本,根據這些資訊來編寫我們的Podfile檔案如:
pod ‘AFNetWorking’, ‘~> 2.2.4′
這句話具體含義是什麼呢?
當我們通過cocopods引入依賴庫時,需要顯示或隐式注明引用的依賴庫版本,具體寫法和表示含義如下
pod ‘AFNetworking’ //不顯式指定依賴庫版本,表示每次都擷取最新版本
pod ‘AFNetworking’, ‘’ //隻使用2.0版本
pod ‘AFNetworking’, ‘> ’ //使用高于2.0的版本
pod ‘AFNetworking’, ‘>= ’ //使用大于或等于2.0的版本
pod ‘AFNetworking’, ‘< ’ //使用小于2.0的版本
pod ‘AFNetworking’, ‘<= ’ //使用小于或等于2.0的版本
pod ‘AFNetworking’, ‘~> ’ //使用大于等于0.1.2但小于0.2的版本
pod ‘AFNetworking’, ‘~>’ //使用大于等于0.1但小于1.0的版本
pod ‘AFNetworking’, ‘~>’ //高于0的版本,寫這個限制和什麼都不寫是一個效果,都表示使用最新版本
4、pod setup
用于跟新本地電腦上的儲存的Pods依賴庫tree。由于每天有很多人會建立或者更新Pods依賴庫,這條指令執行的時候會相當慢,還請耐心等待。我們需要經常執行這條指令,否則有新的Pods依賴庫的時候執行pod search指令是搜不出來的。
①多個target中使用相同的Pods依賴庫
比如,名稱為CocoaPodsTest的target和Second的target都需要使用Reachability、SBJson、AFNetworking三個Pods依賴庫,可以使用link_with關鍵字來實作,将Podfile寫成如下方式:
link_with ‘CocoaPodsTest’, ‘Second’
platform :ios
pod ‘Reachability’, ‘~> .’
pod ‘SBJson’, ‘~> .’
platform :ios, ‘’
pod ‘AFNetworking’, ‘~> ’
這種寫法就實作了CocoaPodsTest和Second兩個target共用相同的Pods依賴庫。
②不同的target使用完全不同的Pods依賴庫
CocoaPodsTest這個target使用的是Reachability、SBJson、AFNetworking三個依賴庫,但Second這個target隻需要使用OpenUDID這一個依賴庫,這時可以使用target關鍵字,Podfile的描述方式如下:
target :’CocoaPodsTest’ do
platform :ios
pod ‘Reachability’, ‘~> ’
pod ‘SBJson’, ‘~> ’
platform :ios, ‘’
pod ‘AFNetworking’, ‘~> ′
end
target :’Second’ do
pod ‘OpenUDID’, ‘~> ’
end
其中,do/end作為開始和結束辨別符。
Podfile.lock檔案
在使用CocoaPods,執行完pod install之後,會生成一個Podfile.lock檔案。這個檔案看起來跟我們關系不大,實際上絕對不應該忽略它。
該檔案用于儲存已經安裝的Pods依賴庫的版本,通過CocoaPods安裝了SBJson、AFNetworking、Reachability三個POds依賴庫以後對應的Podfile.lock檔案内容為:
PODS:
– AFNetworking ():
– AFNetworking/NSURLConnection
– AFNetworking/NSURLSession
– AFNetworking/Reachability
– AFNetworking/Security
– AFNetworking/Serialization
– AFNetworking/UIKit
– AFNetworking/NSURLConnection ():
– AFNetworking/Reachability
– AFNetworking/Security
– AFNetworking/Serialization
– AFNetworking/NSURLSession ():
– AFNetworking/NSURLConnection
– AFNetworking/Reachability ()
– AFNetworking/Security ()
– AFNetworking/Serialization ()
– AFNetworking/UIKit ():
– AFNetworking/NSURLConnection
– Reachability ()
– SBJson ()
DEPENDENCIES:
– AFNetworking (~> )
– Reachability (~> )
– SBJson (~> )
SPEC CHECKSUMS:
AFNetworking: c7d7901a83f631414c7eda1737261f696101a5cd
Reachability: bd76bf6cd8ff2c6fb715fc5f44ef6e4c024f2
SBJson: f3c686806e8e36ab89e020189ac582ba26ec4220
COCOAPODS:
Podfile.lock檔案最大得用處在于多人開發。當團隊中的某個人執行完pod install指令後,生成的Podfile.lock檔案就記錄下了當時最新Pods依賴庫的版本,這時團隊中的其它人check下來這份包含Podfile.lock檔案的工程以後,再去執行pod install指令時,擷取下來的Pods依賴庫的版本就和最開始使用者擷取到的版本一緻。如果沒有Podfile.lock檔案,後續所有使用者執行pod install指令都會擷取最新版本的SBJson,這就有可能造成同一個團隊使用的依賴庫版本不一緻,這對團隊協作來說絕對是個災難!
在這種情況下,如果團隊想使用目前最新版本的SBJson依賴庫,有兩種方案:
- 1.更改Podfile,使其指向最新版本的SBJson依賴庫;
- 2.執行pod update指令;
鑒于Podfile.lock檔案對團隊協作如此重要,我們需要将它添加到版本管理中。
如何制作自己的Cocopods庫
1.在github上建立一個工程
license類型
正規的倉庫都應該有一個license檔案,Pods依賴庫對這個檔案的要求更嚴,是必須要有的。是以最好在這裡讓github建立一個,也可以自己後續再建立。我使用的license類型是MIT。
把項目clone到本地然後在根目錄下建立MyPodDemo.podspec
或使用指令
Spec檔案編寫:
Pod::Spec.new do |s|
s.name = "MyPodDemo"
s.version = "0.0.1"
s.summary = "A short description of MyPodDemo."
s.description = <<-DESC
A longer description of MyPodDemo in Markdown format.
* Think: Why did you write this? What is the focus? What does it do?
* CocoaPods will be using this to generate tags, and improve search results.
* Try to keep it short, snappy and to the point.
* Finally, don't worry about the indent, CocoaPods strips it!
DESC
s.homepage = "https://github.com/goingta/MyPodDemo"
s.license = "MIT"
s.author = { "goingta" => "[email protected]" }
s.source = { :git => "https://github.com/goingta/MyPodDemo.git", :tag => "0.0.1" }
s.source_files = "MyPodDemo/Src", "MyPodDemo/Src/**/*.{h,m}"
s.requires_arc = true
# s.framework = "SomeFramework"
# s.frameworks = "SomeFramework", "AnotherFramework"
# s.library = "iconv"
# s.libraries = "iconv", "xml2"
# s.dependency "JSONKit", "~> 1.4"
# s.dependency "AFNetworking", "~> 2.2.4"
end
自解析:
name: 導入pod後的目錄名
version: 目前版本号
deployment_target: 配置的target
prefix_header_file: 預編譯頭檔案路徑,将該檔案的内容插入到Pod的pch檔案内
source: 來源的具體路徑,是http連結還是本地路徑
requires_arc: 是否需要arc
source_files: 指定該目錄下包含哪些檔案
其他可選參數還包括:
dependency: 指定依賴,如果依賴的庫不存在或者依賴庫的版本不符合要求将會報錯
libraries: 指定導入的庫,比如sqlite3
frameworks: 指定導入的framework
weak_frameworks: 弱連結,比如說一個項目同時相容iOS6和iOS7,但某一個framework隻在iOS7上有,這時候如果用強連結,那麼在iOS7上運作就會crash,使用weak_frameworks可以避免這種情況。
整個podspec文法是一個嵌套結構從Pod::Spec.new do |s|到最後一個end是最大的循環,表示整個podspec導入的檔案。中間每一個subspec到end結束是一個子目錄,Pods會為每個subspec建立一個邏輯目錄,相當于Xcode的group概念。|**|中間是subspec的名字,可以随便命名,但後面使用的名稱必須一緻。
通配符說明
a{bb,bc}def.{h,m}表示四個檔案abbdef.h abbdef.m abcdef.h abcdef.m
*.{h,m,mm}表示所有的.h .m .mm檔案
Class/**/*.{h,m}表示Class目錄下的所有.h .m檔案
寫完podspec檔案後使用pod spec lint驗證spec是否合格,有error則需要修改
上傳代碼至github
上傳podspec檔案到CocoaPods倉庫(fork一下,修改完成後在push上去等待稽核)
将我們剛剛生成的MyPodDemo.spec 檔案上傳到Cocoapods官方specs倉庫中 :
連結為:https://github.com/CocoaPods/Specs
私有庫實作,編寫podfile
如果由于某些原因我們編寫的庫不能公開,但是又想使用pods來進行管理,要怎麼辦呢?
首先我們要将我們剛剛在github上建的倉庫改為Private(不然還用Public搞毛啊)
然後修改我們項目的podfile,與已加入Cocopods倉庫的公有庫相比我們隻需要指明私有庫低git位址,如下:
platform :ios, '6.0'
pod 'MyPodDemo', :git => 'https://github.com/goingta/MyPodDemo.git' //私有庫
pod 'CocoaLumberjack'//公有庫
版本控制和沖突(引用自http://objccn.io/issue-6-4/)
CocoaPods 使用語義版本控制 – Semantic Versioning 命名約定來解決對版本的依賴。由于沖突解決系統建立在非重大變更的更新檔版本之間,這使得解決依賴關系變得容易很多。例如,兩個不同的 pods 依賴于 CocoaLumberjack 的兩個版本,假設一個依賴于2.3.1,另一個依賴于 2.3.3,此時沖突解決系統可以使用最新的版本 2.3.3,因為這個可以向後與 2.3.1 相容。
但這并不總是有效。有許多第三方庫并不使用這樣的約定,這讓解決方案變得非常複雜。
當然,總會有一些沖突需要手動解決。如果一個庫依賴于 CocoaLumberjack 的 1.2.5,另外一個庫則依賴于 2.3.1,那麼隻有最終使用者通過明确指定使用某個版本來解決沖突。
配置非ARC檔案(8.5号補充)
前幾天項目中由于曆史原因,導緻有一個私有的pods庫中某幾個檔案是在非ARC時代寫的,如果要進行修改工程量浩大,于是乎要對這幾個檔案單獨處理,這幾個檔案不使用arc其他檔案使用arc,網上查了一些資料,隻需要對source_file進行修改并排除那幾個不使用ARC的檔案就可以了,大緻修改如下:
Pod::Spec.new do |s|
s.name = "MyPodDemo"
s.version = "0.0.1"
s.summary = "A short description of MyPodDemo.
s.homepage = "https://github.com/goingta/MyPodDemo"
s.license = "MIT"
s.author = { "goingta" => "[email protected]" }
s.source = { :git => "https://github.com/goingta/MyPodDemo.git", :tag => "0.0.1" }
s.source_files = "MyPodDemo"
non_arc_files = 'MyPodDemo/NoArcFile1.{h,m}','MyPodDemo/NoArcFile2.{h,m}'
s.requires_arc = true
s.exclude_files = non_arc_files
s.subspec 'no-arc' do |sna|
sna.requires_arc = false
sna.source_files = non_arc_files
end
end
回退Cocoapods曆史版本(2015.3.17号補充)
檢視目前安裝了哪些版本
gem list --local | grep cocoapods
如果你安裝了多個版本(如0.35和0.20.2)那麼你将看到
cocoapods (, .)
cocoapods-core (, .)
cocoapods-downloader (., .)
先删除已經裝過的版本(可能有幾個,解除安裝的時候會讓你輸入1,2..n選擇解除安裝那個版本
sudo gem uninstall cocoapods
或者強制解除安裝某一個版本
安裝某一個版本
sudo gem install cocoapods -v .
處理 Use the
$(inherited)
flag 異常(2015.6.03補充)
有時候在pod update之後會遇到下面錯誤:
- Use the `$(inherited)` flag, or
- Remove the build settings from the target.
雖然對項目編譯沒什麼影響,但是看着還是挺不舒服的.解決辦法就是
找到工程的 targets 點選工程名 Build Settings -> Other linker flags -> 添加 $(inherited)