CocoaPods創建自己的開源庫和私有庫

通過CocoaPods創建開源庫、私有庫,最關鍵的是*.podspec的編寫。
如果電腦上還未安裝CocoaPods,可以參考:新版CocoaPods的安裝

創建項目和.podspec文件

如果你已經有了項目代碼,可以使用pod命令創建.podspec

# 項目路徑下
pod spec create 'KMPinHeaderLayout'

如果還沒有項目,可以使用:

pod lib create 'KMPinHeaderLayout'

根據命令行的提示和引導,會為你創建一個模板工程和.podspec文件、README.md文件、MIT LICENSE文件等。

編輯.podspec文件

文件內容可以根據模板和注釋來修改和填寫,對其中一些內容進行記錄說明:

  1. s.source_files 指明哪些源文件會被包含進去,比如s.source_files = "KMPinHeaderLayout/Classes/**/*.{h,m}",多條之間用逗號,分隔,用**表示匹配所有子目錄,用*表示匹配所有文件,.{h,m}表示匹配其中的.h和.m文件。其中的路徑是以.podspec所在目錄為根目錄。

  2. s.exclude_files 規則同上,指定不被包含的文件、目錄。

  3. s.license,一般寫法有s.license = 'MIT's.license = { :type => 'MIT', :file => 'LICENSE' }LICENSE對應.podspec所在目錄下的名為LICENSE文件。

  4. 指定可用平臺和版本,s.platform = :ios, "7.0"s.ios.deployment_target = '7.0'。如果支持多個平臺應該使用后者,并指定其他平臺的版本如s.osx.deployment_target = "10.7"

  5. s.public_header_files,公開的頭文件,如果指定,在pod lint驗證時,會以framework的形式驗證,一般可以不用這個配置。

  6. s.framework(s)s.libraries,指定依賴的系統庫。兩者內容都需要去除后綴,其中s.libraries需要去除前綴lib,如靜態庫依賴是libz.tbd,則s.libraries = 'z'

  7. s.vendored_librariess.vendored_frameworks如果開源庫中是一個靜態庫,使用這個指定靜態庫。如微博的podspecs.vendored_libraries = 'libWeiboSDK/libWeiboSDK.a'

  8. s.xcconfig 指定項目配置,如HEADER_SEARCH_PATHSOTHER_LDFLAGS等,e.g s.xcconfig = { "OTHER_LDFLAGS" => "-ObjC" }

  9. s.resource(s) 指定包含的資源文件。

  10. s.dependency 指定依賴,如s.dependency = 'AFNetworking'

  11. 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

參考文章:

  1. Cocoapods系列教程(一)——入門
  2. Cocoapods系列教程(二)——開源主義接班人
  3. Cocoapods系列教程(三)——私有庫管理和模塊化管理
  4. 3分鐘讓你的框架支持cocoapods,podspec文件講解
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,732評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,214評論 3 426
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,781評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,588評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,315評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,699評論 1 327
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,698評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,882評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,441評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,189評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,388評論 1 372
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,933評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,613評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,023評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,310評論 1 293
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,112評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,334評論 2 377

推薦閱讀更多精彩內容