通過CocoaPods創建開源庫、私有庫,最關鍵的是*.podspec
的編寫。
如果電腦上還未安裝CocoaPods,可以參考:新版CocoaPods的安裝。
創建項目和.podspec
文件
如果你已經有了項目代碼,可以使用pod命令創建.podspec
:
# 項目路徑下
pod spec create 'KMPinHeaderLayout'
如果還沒有項目,可以使用:
pod lib create 'KMPinHeaderLayout'
根據命令行的提示和引導,會為你創建一個模板工程和.podspec
文件、README.md文件、MIT LICENSE文件等。
編輯.podspec
文件
文件內容可以根據模板和注釋來修改和填寫,對其中一些內容進行記錄說明:
-
s.source_files
指明哪些源文件會被包含進去,比如s.source_files = "KMPinHeaderLayout/Classes/**/*.{h,m}"
,多條之間用逗號,
分隔,用**
表示匹配所有子目錄,用*
表示匹配所有文件,.{h,m}
表示匹配其中的.h和.m文件。其中的路徑是以.podspec
所在目錄為根目錄。
-
s.exclude_files
規則同上,指定不被包含的文件、目錄。
-
s.license
,一般寫法有s.license = 'MIT'
或s.license = { :type => 'MIT', :file => 'LICENSE' }
,LICENSE
對應.podspec
所在目錄下的名為LICENSE文件。
- 指定可用平臺和版本,
s.platform = :ios, "7.0"
,s.ios.deployment_target = '7.0'
。如果支持多個平臺應該使用后者,并指定其他平臺的版本如s.osx.deployment_target = "10.7"
。
-
s.public_header_files
,公開的頭文件,如果指定,在pod lint
驗證時,會以framework的形式驗證,一般可以不用這個配置。
-
s.framework(s)
、s.libraries
,指定依賴的系統庫。兩者內容都需要去除后綴,其中s.libraries
需要去除前綴lib
,如靜態庫依賴是libz.tbd
,則s.libraries = 'z'
。
-
s.vendored_libraries
、s.vendored_frameworks
如果開源庫中是一個靜態庫,使用這個指定靜態庫。如微博的podspec
中s.vendored_libraries = 'libWeiboSDK/libWeiboSDK.a'
-
s.xcconfig
指定項目配置,如HEADER_SEARCH_PATHS
、OTHER_LDFLAGS
等,e.gs.xcconfig = { "OTHER_LDFLAGS" => "-ObjC" }
-
s.resource(s)
指定包含的資源文件。
-
s.dependency
指定依賴,如s.dependency = 'AFNetworking'
-
s.source
指定源,s.source = { :git => 'https://github.com/sleepEarlier/PinHeaderLayout.git', :tag => s.version.to_s }
更多信息可以查閱官方:http://guides.cocoapods.org/syntax/podspec.html
示例:
Pod::Spec.new do |s|
s.name = "KMPinHeaderLayout"
s.version = "0.1.0"
s.summary = "Float header for collectionview, support both vertical and horizon."
s.description = <<-DESC
A custom UICollectionViewFlowLayout support float header just like UITablebiew section header does.
DESC
s.homepage = "https://github.com/sleepEarlier/PinHeaderLayout"
s.license = { :type => "MIT", :file => "LICENSE"}
s.author = { "sleepEarlier" => "xxx@qq.com" }
s.platform = :ios, "7.0"
s.source = { :git => "https://github.com/sleepEarlier/PinHeaderLayout.git", :tag => s.version }
s.source_files = "CollectionView/*Layout.{h,m}"
s.ios.deployment_target = "7.0"
s.framework = "UIKit"
s.requires_arc = true
end
驗證podspec
驗證命令:
pod lib lint KMPinHeaderLayout.podspec --verbose
--verbose
會給出詳細的信息。
--allow-warnings
允許警告,默認有警告的podspec
會驗證失敗。
--fail-fast
遇到錯誤馬上停止,默認會完成全過程再停止。
--use-libraries
如果項目中引用了.a
、.framework
,在驗證和提交時需要加。
--sources
如果此podspec
依賴了其他不包含在官方specs里的pod,則用它來指明源,比如依賴了某個私有庫。多個值以逗號分隔。
由于我們在podspec
的source中指定了tag
,因此一般需要先打tag并push,再來驗證:
# tag 0.1.0
git tag 0.1.1
# push tag
git push --tags
但是這樣有一個問題,如果驗證失敗了,這個tag相當于無效了,我們需要刪除tag重打:
# 刪除本地tag 0.1.0
git tag -d 0.1.0
# 刪除遠端tag 0.1.0
git push origin --delete tag 0.1.0
當多次驗證失敗時上面的步驟就略顯繁瑣,因此,我們可以先在.podspec
中不指定tag:
s.source = { :git => "https://github.com/sleepEarlier/PinHeaderLayout.git", }
這樣會在驗證時,產生一個沒有tag的警告,我們使用
--allow-warnings
來允許警告
pod lib lint KMPinHeaderLayout.podspec --verbose --allow-warnings
等驗證通過后,我們再編輯podspec
中的tag,并打tag然后push到遠端。
最好在push tag后再進行一次驗證,以防萬一。由于已經打了tag,所以這一次驗證不需要加--allow-warnings
。
發布podspec
查看當前PC是否注冊:
pod trunk me
如已注冊,會顯示相關信息,否則進行注冊:
pod trunk register xxx@example.com "some description" --verbose
命令會向CocoaPods注冊一個賬號,如果切換電腦需要重新執行命令注冊,注冊命令中的description可以用來區分不同的設備。
發布podspec
pod trunk push KMPinHeaderLayout.podspec
如果在驗證時,使用了--allow-warnings
、--use-libraries
,則在發布時也需要加上相同的選項。
搜索自己的pod
發布成功后,會把podspec更新到官方的repo中,也可以在CocoaPods官網搜索到自己的pod。
也可以執行下面的命令來搜索:
pod search KMPinHeaderLayout
但是...有時候你發現,在官網搜到了,但是你在終端執行pod search...
時結果卻是:
pod search KMPinHeaderLayout
[!] Unable to find a pod with name, author, summary, or description matching `KMPinHeaderLayout`
由于pod search
是在本地的~/.cocoapods/repos/master/Specs
中進行搜索的,上面的結果可能是由于
①. 本地的Specs不是最新的,我們可以進行更新,然后重新搜索:
pod repo update --verbose
②. 還是搜不到?可能是因為搜索的緩存導致,刪除緩存重新搜索:
# delete cached index
rm ~/Library/Caches/CocoaPods/search_index.json
# search again
$ pod search KMPinHeaderLayout
私有倉庫
創建私有倉庫與上面的步驟類似,區別是:
創建倉庫
需要先創建倉庫:
pod repo add 'repoName' 'repo URL'
# e.g
pod repo add 'KMPinHeaderLayout' 'http://internal.git.com/sleepEarlier/PinHeaderLayout.git'
編輯podspec
方法與上文中一樣。
驗證podspec
方法與上文中一樣,如果依賴了其他私有庫,需要使用--sources
指定source。
注意,依賴關系不能出現閉環,比如A依賴B,B依賴C,C依賴A。
pod lib lint PinHeaderLayoutpodspec --sources=https://github.com/CocoaPods/Specs.git,http://interal.git.com/sleepEarlier/Specs.git
發布podspec
pod repo push 'KMPinHeaderLayout' KMPinHeaderLayout.podspec
如果依賴了其他私有庫,需要使用--sources
指定source。
使用私有庫
可以直接在Podfile中使用
platform :ios, '10.3'
target 'PointerTest' do
# Pods for PointerTest
pod 'PinHeaderLayout', :git => 'http://internal.git.com/xxx/PinHeaderLayout.git'
end
必要時,可以在Podfile中列出source
source 'http://interal.git.com/sleepEarlier/Specs.git'
platform :ios, '10.3'
target 'PointerTest' do
# Pods for PointerTest
pod 'PinHeaderLayout', :git => 'http://internal.git.com/xxx/PinHeaderLayout.git'
end
很多時候,在開發過程中,我們希望在開發私有庫的過程中,修改代碼后不用一直打tag并執行pod update
,我們可以這樣寫Podfile:
# 本地路徑
pod 'PinHeaderLayout', :path => '~/Desktop/PinHeaderLayout'
這樣在普通的修改代碼時,不需要重新打tag并pod update
,但是當工程結構有變化(文件移動,增刪等)、podspec修改,最好執行一次pod update
。
參考文章: