CocoaPods三重奏（三） 之 發(fā)布開源框架到Cocoapods
前言
Cocoapods 不僅是一個(gè)很好的iOS依賴管理工具，同時(shí)也可以使用Cocoapods 進(jìn)行組件化開發(fā)，把項(xiàng)目中比較穩(wěn)定，獨(dú)立性強(qiáng)的模塊抽離出來進(jìn)行組件化，而本篇文章介紹的是如何發(fā)布開源框架到Cocoapods，讓更多的人使用你的開源框架。
背景
開發(fā)過程中，經(jīng)常會(huì)使用一些比較好用的第三方開源框架（例如AFNetworking，JSONModel等），我們通過
Cocoapods就可以輕松的安裝使用。所以當(dāng)你自己編寫一個(gè)開源框架想讓別人通過Cocoapods使用時(shí)該怎么做？
基于以上背景，接下來我會(huì)一步一步介紹如何通過Cocoapods發(fā)布開源框架。
操作步驟
- 創(chuàng)建pod工程（本文以DYNetwork為例），并提交遠(yuǎn)程git托管平臺
- 創(chuàng)建、修改并驗(yàn)證
podspec文件 - 使用Cocoapods trunk 發(fā)布開源庫
- 使用開源庫
- 更新維護(hù)開源庫
- 問題總結(jié)
創(chuàng)建pod工程
PS:如果你已經(jīng)有一個(gè)工程，并且在git版本管理下，那么可以直接跳過第一步，直接進(jìn)行第二步，為項(xiàng)目創(chuàng)建podspec文件官方文檔，而進(jìn)行第一步的前提是你沒有創(chuàng)建過pod工程。
至于創(chuàng)建pod工程，你可以在github創(chuàng)建一個(gè)項(xiàng)目（默認(rèn)不會(huì)包含podspec文件），也可以通過Cocoapods的create工具官方文檔創(chuàng)建一個(gè)項(xiàng)目（會(huì)默認(rèn)幫你創(chuàng)建一個(gè)podspec文件），下面主要介紹通過create工具創(chuàng)建項(xiàng)目，具體步驟如下：
- 先cd到你要?jiǎng)?chuàng)建項(xiàng)目的目錄下
- 執(zhí)行創(chuàng)建命令
pod lib create DYNetwork
之后會(huì)問你五個(gè)問題，具體問題看下面截圖，問完問題后自動(dòng)調(diào)用pod install創(chuàng)建項(xiàng)目并生產(chǎn)依賴
PS: 新版創(chuàng)建命令，會(huì)默認(rèn)引入一些框架，例如FBSnapshotTestCase等，不用管，但是當(dāng)你用新版xcode打開項(xiàng)目的時(shí)候，提示你是否切換swift到最新版本（按照流程切換到最新swift版本就行了），因?yàn)槭沁@些默認(rèn)的框架內(nèi)部用了swift語言。
創(chuàng)建完成后通過 tree PrivatePodTest -L 2 命令查看目錄結(jié)果
PS:如果找不到tree命令，可以通過homebrew安裝tree
? DYNetwork tree DYNetwork -L 2
DYNetwork
├── DYNetwork
│ ├── Assets
│ └── Classes
├── DYNetwork.podspec
├── Example
│ ├── DYNetwork
│ ├── DYNetwork.xcodeproj
│ ├── DYNetwork.xcworkspace
│ ├── Podfile
│ ├── Podfile.lock
│ ├── Pods
│ └── Tests
├── LICENSE
├── README.md
└── _Pods.xcodeproj -> Example/Pods/Pods.xcodeproj
10 directories, 5 files
我們可以看到，通過Cocoapods的create工具創(chuàng)建的項(xiàng)目，會(huì)默認(rèn)給你生成一個(gè)podspec文件。
接下來向DYNetwork文件中添加代碼和資源，然后修改podspec文件，我把一個(gè)“網(wǎng)絡(luò)處理”的模塊放入DYNetwork/Classes中，然后進(jìn)入Example文件夾執(zhí)行pod update命令，再打開項(xiàng)目工程可以看到，剛剛添加的組件已經(jīng)在Pods子工程下Development Pods/DYNetwork中了，然后編輯demo工程，測試網(wǎng)絡(luò)模塊。
PS:這里需要注意的是每當(dāng)你向Pod中添加了新的文件或者以后更新了podspec的版本都需要重新執(zhí)行一遍pod update命令?；蛘吣愦蜷_demo項(xiàng)目，直接把文件拖到對應(yīng)的目錄下。
項(xiàng)目代碼測試無誤后，將本地項(xiàng)目添加并推送到遠(yuǎn)端倉庫，因?yàn)橥ㄟ^Cocoapods創(chuàng)建的項(xiàng)目本身在“本地”的git管理控制下，所以如果你想讓別人用，就需要把它推到遠(yuǎn)端。同理在github創(chuàng)建一個(gè)git項(xiàng)目，然后拿到ssh地址。
拿到ssh地址后，切換到DYNetwork目錄下,添加并推送到遠(yuǎn)端git。
git add .
git commit -m "initial commit"
git remote add origin git@github.com:guodongyangwen/DYNetwork.git
git push origin master
因?yàn)閜odspec文件中獲取Git版本控制的項(xiàng)目還需要tag號，所以我們要打上一個(gè)tag,并推送tag到遠(yuǎn)端。
git tag 0.0.1
git push --tags
創(chuàng)建、修改、驗(yàn)證pod工程對應(yīng)podspec文件
創(chuàng)建podspec文件
PS:如果通過第一步Cocoapod的create工具創(chuàng)建的項(xiàng)目，上面可以看到Cocoapods會(huì)默認(rèn)為pod工程創(chuàng)建一個(gè)podspec文件，如果你是為github上已存在的項(xiàng)目創(chuàng)建一個(gè)對應(yīng)的podspec文件，那么你需要執(zhí)行下面步驟。
1、切換到項(xiàng)目目錄（這里作為演示，項(xiàng)目名為DYFileManager）
2、提交代碼，并打上tag（因?yàn)閯?chuàng)建podspec文件需要）
3、執(zhí)行以下命令
pod spec create DYFileManager
我們可以看到，create命令創(chuàng)建了一個(gè)podspec文件
修改podspec文件
上面介紹了兩種創(chuàng)建pod工程的方式，兩個(gè)方式分別對應(yīng)不同的podspec文件創(chuàng)建方式（一個(gè)默認(rèn)創(chuàng)建，一個(gè)手動(dòng)創(chuàng)建）?，F(xiàn)在我們創(chuàng)建了pod工程（DYNetwork），并創(chuàng)建了對應(yīng)的podspec文件（DYNetwork.podspec)
接下來開始編輯podspec文件了，它是一個(gè)Ruby的文件，把編輯器的格式改成Ruby就能看到語法高亮，下面我貼上我的podspec文件，并在后面以注釋的形式說明每個(gè)字段的含義，沒有涉及到的字段可以去官方文檔查閱
Pod::Spec.new do |s|
s.name = 'DYNetwork' #項(xiàng)目名稱
s.version = '0.0.1' #當(dāng)前版本
s.summary = 'network library' #簡要信息
#項(xiàng)目描述
s.description = <<-DESC
this is a network library.
DESC
s.homepage = 'http://m.itdecent.cn/u/d1a569b086e4' #主頁
s.license = 'MIT' #開源協(xié)議
s.author = { 'guodongyang' => 'guodongyangw@163.com' } #作者信息
s.source = { :git => 'https://github.com/guodongyangwen/DYNetwork.git', :tag => "0.0.1" } #項(xiàng)目git地址（注：必須是http或者h(yuǎn)ttps，不然驗(yàn)證不通過）
s.ios.deployment_target = '8.0' #部署平臺
s.requires_arc = true #是否需要arc
s.source_files = 'DYNetwork/Classes/**/*' #項(xiàng)目源代碼路徑
# s.resource_bundles = {
# 'PrivatePodTest' => ['DYNetwork/Assets/*.png']
# } #項(xiàng)目資源文件路徑
s.public_header_files = 'DYNetwork/Classes/**/*.h' #項(xiàng)目頭文件路徑
s.frameworks = 'UIKit' #引用的框架
# s.dependency 'AFNetworking', '~> 2.3' #依賴的第三方庫
end
驗(yàn)證podspec文件
編輯完podspec文件后，需要對其進(jìn)行驗(yàn)證，如果有者ERROR都是不可以的，它就不能被添加到Cocoapods開源庫中，不過xcode的WARNING是可以存在的，驗(yàn)證需要執(zhí)行一下命令
//命令1 （不予許警告和錯(cuò)誤）
pod lib lint
//命令2 （允許警告）
pod lie lint --allow-warnings
//命令3 （驗(yàn)證執(zhí)行spec）
pod spec lint DYNetwork.podspec
當(dāng)出現(xiàn)下面信息，代表驗(yàn)證通過,如果出現(xiàn)錯(cuò)誤它只會(huì)直接一句紅色的話The spec did not pass validation, due to 1 error.告訴你的有多少個(gè)error和warning，而不會(huì)具體的指出你的錯(cuò)誤出在哪里，這時(shí)候你可以在這句指令后面加上參數(shù)--verbose 這樣就會(huì)告訴你具體的錯(cuò)誤信息。這樣根據(jù)它提示你的錯(cuò)誤信息去解決就可以了
-> DYNetwork (0.0.1)
DYNetwork passed validation.
Cocoapods Trunk發(fā)布自己的pods
PS:在cocoapods使用了trunk之后，CocoaPods 需要0.33以上版本，用 pod --version查看版本，如果版本低，需要更新。
注冊Trunk
注冊時(shí)需要添加自己的郵箱和用戶名，成功后會(huì)提示你通過郵箱驗(yàn)證，點(diǎn)擊郵箱中的連接驗(yàn)證一下。
如圖代表你驗(yàn)證成功，接下來進(jìn)行注冊
pod trunk me
如果你的pod是多人維護(hù)的，你可以添加其他維護(hù)者：
pod trunk add-owner 用戶名 郵箱
Trunk Push
pod trunk push 命令會(huì)首先驗(yàn)證你本地的podspec文件(是否有錯(cuò)誤)，之后會(huì)上傳spec文件到trunk，最后會(huì)將你上傳的podspec文件轉(zhuǎn)換為需要的json文件。在工程根目錄(包含有.podspec)下執(zhí)行命令：
pod trunk push
看到這個(gè)信息證明你已經(jīng)發(fā)布成功了,也可以查看一下本地的~/.cocoapods/repos/master/Specs目錄下看到轉(zhuǎn)換之后的json文件
這時(shí)候你可以通過pod search進(jìn)行搜索，搜不到看下面問題總結(jié)
使用開源庫
開源庫的podspec文件已經(jīng)添加到遠(yuǎn)端Cocoapods倉庫，這時(shí)候就可以像使用其他開源庫一樣使用了。
創(chuàng)建一個(gè)demo工程，創(chuàng)建Podfile文件，添加依賴如下
pod 'DYNetwork' ,'~>0.0.1'
然后執(zhí)行pod update或者pod install安裝依賴庫，就可以正常使用了。
更新維護(hù)podspec
更新維護(hù)就是你后續(xù)可能修改代碼，或者添加新的功能，或者你不在需要這個(gè)組件庫然后需要?jiǎng)h除。
上面我們已經(jīng)創(chuàng)建了一個(gè)0.0.1版本，現(xiàn)在進(jìn)行升級到0.0.2。具體步驟如下:
- 建源文件添加到classess目錄下，或者從該目錄下刪除文件等修改。
- 修改之后提交并推送到遠(yuǎn)端，打上新的tag（比如0.0.2）。
- 修改之后編輯podspec文件，改為新的tag，或者修改源文件引用路徑等信息。
- pod spec lint DYNetwork.podspec驗(yàn)證podspec文件
-
驗(yàn)證沒有問題，把新版本推送到Cocoapod倉庫。
pod trunk push
- 添加成功會(huì)顯示新添加的版本
7.搜索組件庫，會(huì)出現(xiàn)兩個(gè)版本
問題總結(jié)：
-
遇到的問題
1、執(zhí)行pod lib create （組件庫） 出錯(cuò)提示錯(cuò)誤：rubygems/core_ext/kernel_require.rb:120:in `require': cannot load such file -- colored2 (LoadError) 解決辦法： 輸入上面提示的colored2的兩條gem命令即可解決問題 sudo gem install colored2 sudo gem update --system2、添加組件庫到私有spec repo倉庫后 執(zhí)行 pod search搜索不到。
方法一：
先確認(rèn)你本地倉庫上面確實(shí)有你新創(chuàng)建的組件庫，這時(shí)候可以先刪除search緩存文件
rm ~/Library/Caches/CocoaPods/search_index.json
,刪除后從新執(zhí)行pod search ***
方法二：
1.切換到某個(gè)項(xiàng)目（含有podfile文件）下
2.執(zhí)行pod update（提示不能更新）
3.嘗試 pod repo update —verbose獲取詳細(xì)信息，我記得是提示我刪除一個(gè) index.lock文件，
4.刪除后從新 執(zhí)行 pod repo update —verbose 會(huì)更新本地私有庫和master倉庫
5.執(zhí)行pod search *** 創(chuàng)建search索引，可以搜到
2.其他關(guān)于pod的問題：
Cocoapods環(huán)境配置 ：
http://blog.csdn.net/cbl643966855/article/details/51120497
Cocoapods使用私有庫遇到的坑：
http://m.itdecent.cn/p/1e5927eeb341 http://blog.csdn.net/andanlan/article/details/50515434
Cocoapods安裝或更新出錯(cuò)：
http://blog.csdn.net/lindir/article/details/52980526
Cocoapods search無法搜索：
http://blog.csdn.net/yuanmengong886/article/details/57083919
寫在最后
如何想了解更多關(guān)于Cocoapods的用途，請參考我另外兩篇文章：
Cocoapods的安裝和使用
Cocoapods組件化開發(fā)
最后想說的是，寫了這些關(guān)于Cocoapods使用的文章是因?yàn)樽罱鼘懥艘粋€(gè)文件管理的開源庫，支持各種文件操作，希望大家支持一下，歡迎大家star，如果有問題直接issue我，項(xiàng)目地址：DYFileManager
