您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

用 Cocoapods 創建私有 podspec 的完整指南

編輯:iOS 開發基礎

Cocoapods 是一款非常實用的 iOS 依賴管理工具,用它可以方便地管理與更新項目中所用到的第三方庫,也能把自己的公共組件交由它管理。Cocoapods 的介紹與優點本文不再贅述。我開始使用 Cocoapods 還是在兩年前,那時它剛剛問世,網上資料還非常少,就連它們自己的首頁都相當簡單,我便著手嘗試了一下,用它管理第三方庫確實十分方便順手。後來它有了更強大的功能——自己創建 podspec,更能設置私有的庫。

春節返工後,手頭沒什麼任務,正好項目裡有一些公共組件需要從龐大的項目體系中剝離出來,而且年前項目終於從 SVN 遷移到了 Git,真是可喜可賀、大快人心!這樣一來,項目使用 Cocoapods 就有了條件。趁著這兩天無事,正好學習一下如何創建私有 podspec 並在項目中部署使用,以及 pods 的 subspec 的創建與使用。

整體上,創建一個私有 podspec 包括以下幾個步驟:

  1. 創建並設置一個私有的 Spec Repo。

  2. 創建 Pod 所需的項目工程檔案,並具備可存取的項目版本控制位址。

  3. 創建 Pod 對應的 podspec 檔案。

  4. 本地測試配置好的 podspec 檔案是否可用。

  5. 向私有的 Spec Repo 提交 podspec。

  6. 在個人項目的 Podfile 中引入剛製作好的 Pod 並使用。

  7. 更新與維護 podspec。

在這一連串步驟中,需要創建兩個 Git 倉庫,分別是第一步與第二步(第二步不一定非得是 Git 倉庫,只要能取得相關程式碼檔案即可,也可以是 SVN,甚至是 zip 包,差別在於 podspec 中 source 項填寫的內容不同);而第一步只在初次創建私有 podspec 時才需要,此後創建其他的,從第二步開始即可。本文只介紹 Git 環境下的操作,其他環境與方式暫不贅述。

創建私有 Spec Repo

先說第一步。什麼是 Spec Repo?它是所有 Pods 的一個索引,就是一個容器,所有公開的 Pods 都在其中。它實際上是一個 Git 倉庫,remote 端位於 GitHub 上,但當你使用了 Cocoapods 後,它會被 clone 到本地的 ~/.cocoapods/repos 目錄下。進入這個目錄,就能看到 master 文件夾,它便是官方的 Spec Repo。這個 master 目錄的結構是這樣的:

. ├── Specs     └── [SPEC_NAME]         └── [VERSION]             └── [SPEC_NAME].podspec

因此,我們需要創建一個類似 master 的私有 Spec Repo。這裡可以 fork 官方 Repo,也可以自己創建,個人建議不要 fork——你只是想添加自己的 Pods,沒必要把現有的公開 Pods 都複製一份。所以,創建一個 Git 倉庫,這個倉庫你可以設為私有,也可以設為公開;既然叫「私有 Spec Repo」,那還是建私有倉庫吧。需要注意的是,如果項目有其他同事共同開發,你還要賦予他這個 Git 倉庫的權限。由於 GitHub 的私有倉庫收費,而我還不是付費用戶,所以我用了其他 Git 服務——我使用的是 CODING,當然還有別的可選,比如開源中國、Bitbucket 以及 CSDN Code。

創建完成後,在 Terminal 中執行如下命令:

# pod repo add [Private Repo Name] [GitHub HTTPS clone URL] $ pod repo add WTSpecs https://coding.net/wtlucky/WTSpecs.git

若執行成功,進入 ~/.cocoapods/repos 目錄,就能看到 WTSpecs 這個目錄了。至此,第一步「創建私有 Spec Repo」完成。

PS:若有其他協作者共同使用這個私有 Spec Repo,在他擁有對應 Git 倉庫權限的前提下,執行相同的命令添加這個 Spec Repo 即可。

創建 Pod 項目工程檔案

第二步沒什麼好介紹的。如果已有現成的組件項目,且處於 Git 版本管理之下,那這一步就算完成,可直接進入下一步。

如果你的組件還在你龐大冗餘的項目裡,需要拆分出來,或者需要從零開始創建一個組件庫,那我建議你用 Cocoapods 提供的一個工具,把第二步與第三步結合起來做。

說到這個工具,相關文檔介紹是〈Using Pod Lib Create〉。就拿我創建的 podTestLibrary 為例,具體講一下這裡如何操作:先 cd 到要創建項目的目錄,然後執行:

$ pod lib create podTestLibrary

接著它會問你四個問題:1. 是否需要一個範例工程;2. 選擇一個測試框架;3. 是否基於 View 測試;4. 類的前綴。這四個問題的具體介紹可去看官方文檔。我在這裡選擇的是:1. yes;2. Specta/Expecta;3. yes;4. PTL。問完這四個問題後,它會自動執行 pod install 命令,創建項目並生成依賴。

$ tree PodTestLibrary -L 2 PodTestLibrary ├── Example                                   #demo APP │   ├── PodTestLibrary │   ├── PodTestLibrary.xcodeproj │   ├── PodTestLibrary.xcworkspace │   ├── Podfile                                 #demo APP 的依賴描述文件 │   ├── Podfile.lock │   ├── Pods                                    #demo APP 的依賴文件 │   └── Tests ├── LICENSE                                    #開源協議 默認MIT ├── Pod                                         #組件的目錄 │   ├── Assets                              #資源文件 │   └── Classes                              #類文件 ├── PodTestLibrary.podspec                   #第三步要創建的podspec文件 └── README.md                                #markdown格式的README 9 directories, 5 files

以上是項目生成的目錄結構與相關介紹。

接下來,就是往 Pod 文件夾中添加庫檔案與資源,並配置 podspec 檔案。我把一個網路模塊的公共組件放進 Pod/Classes 中,然後進入 Example 文件夾執行 pod update 命令,再打開項目工程,可以看到剛剛添加的組件已經出現在 Pods 子工程下的 Development Pods/PodTestLibrary 中了。接著編輯 demo 工程、測試組件。我並沒有使用它提供的測試框架來測試,這裡就先不介紹了。

註:這裡需要注意的是,每當你向 Pod 添加新檔案,或以後更新了 podspec 版本,都需要重新執行一遍 pod update 命令。

測試無誤後,需要把該項目添加並推送到遠端倉庫,並編輯 podspec 檔案。

Cocoapods 創建出來的目錄本身就在本地 Git 管理之下,我們要做的就是為它添加遠端倉庫。同樣地,去 GitHub 或其他 Git 服務商那裡創建一個私有倉庫,拿到 SSH 位址,然後 cd 到 PodTestLibrary 目錄:

$ git add . $ git commit -s -m "Initial Commit of Library" $ git remote add origin git@coding.net:wtlucky/podTestLibrary.git                #添加遠端倉庫 $ git push origin master      #提交到遠端倉庫

由於 podspec 檔案在獲取 Git 版本控制的項目時還需要 tag 號,所以我們要打上一個 tag:

$ git tag -m "first release" "0.1.0" $ git push --tags     #推送tag到遠端倉庫

做完這些,就可以開始編輯 podspec 檔案了。它是一個 Ruby 檔案,把編輯器的格式改成 Ruby,就能看到語法高亮。下面我貼上我的 podspec 檔案,並在後面以註釋形式說明每個字段的含義,未涉及到的字段可去官方文檔查閱:

Pod::Spec.new do |s|   s.name             = "PodTestLibrary"    #名稱   s.version          = "0.1.0"             #版本號   s.summary          = "Just Testing."    #簡短介紹,下面是詳細介紹   s.description      = <<-DESC                        Testing Private Podspec.                        * Markdown format.                        * Don't worry about the indent, we strip it!                        DESC   s.homepage          = "https://coding.net/u/wtlucky/p/podTestLibrary"                                      #主頁,這裡要填寫可以訪問到的地址,不然驗證不通過   # s.screenshots     = "www.example.com/screenshots_1", "www.example.com/screenshots_2"                 #截圖   s.license          = 'MIT'                    #開源協議   s.author          = { "wtlucky" => "wtlucky@foxmail.com" }                   #作者信息   s.source          = { :git => "https://coding.net/wtlucky/podTestLibrary.git", :tag => "0.1.0" }        #項目地址,這裡不支持ssh的地址,驗證不通過,只支持HTTP和HTTPS,最好使用HTTPS   # s.social_media_url = 'https://twitter.com/'                       #多媒體介紹地址   s.platform     = :ios, '7.0'                 #支持的平台及版本   s.requires_arc = true                   #是否使用ARC,如果指定具體文件,則具體的問題使用ARC   s.source_files = 'Pod/Classes/**/*'    #代碼源文件地址,**/*表示Classes目錄及其子目錄下所有文件,如果有多個目錄下則用逗號分開,如果需要在項目中分組顯示,這裡也要做相應的設置   s.resource_bundles = {     'PodTestLibrary' => ['Pod/Assets/*.png']   }                                        #資源文件地址   s.public_header_files = 'Pod/Classes/**/*.h'   #公開頭文件地址   s.frameworks = 'UIKit'                  #所需的framework,多個用逗號隔開   s.dependency 'AFNetworking', '~> 2.3'   #依賴關系,該項目所依賴的其他庫,如果有多個需要填寫多個s.dependency end

編輯完 podspec 檔案後,需要驗證一下這個檔案是否可用。若有任何 WARNING 或 ERROR 都不行,那樣它就不能被添加到 Spec Repo 中(不過 Xcode 的 WARNING 是可以存在的)。驗證需要執行以下命令:

$ pod lib lint

當你看到

- PodTestLibrary (0.1.0) PodTestLibrary passed validation.

時,說明驗證通過了。不過這只表明這個 podspec 檔案合格,並不一定說明這個 Pod 可用,我們還需要在本地做一下驗證,這就是第四步的內容了,稍後再說。

創建 podspec 檔案

如果從第二步過來,已經有了現成的項目,那就需要為這個項目創建一個 podspec 檔案。創建它需要執行 Cocoapods 的另一個命令,官方文檔在這裡:

$ pod spec create PodTestLibrary git@coding.net:wtlucky/podTestLibrary.git

執行完之後,就創建了一個 podspec 檔案,其中會包含很多內容,可以按我前面介紹的方式編輯,沒用的刪掉。編輯完成後,用驗證命令驗證一下:

$ pod lib lint

驗證無誤,就可以進入下一步了。

本地測試 podspec 檔案

我們可以創建一個新項目,在這個項目的 Podfile 中直接指定剛剛創建編輯好的 podspec 檔案,看是否可用。在 Podfile 中可以這樣編輯,有兩種方式:

platform :ios, '7.0' pod 'PodTestLibrary', :path => '~/code/Cocoapods/podTest/PodTestLibrary'        #指定路徑 pod 'PodTestLibrary', :podspec => '~/code/Cocoapods/podTest/PodTestLibrary/PodTestLibrary.podspec'  #指定podspec文件

然後執行 pod install 命令安裝依賴,打開項目工程,可以看到庫檔案都被加載到 Pods 子項目中了,不過它們並不在 Pods 目錄下,而是跟測試項目一樣存在於 Development Pods/PodTestLibrary 中——這是因為我們是在本地測試,而沒有把 podspec 檔案添加到 Spec Repo 中的緣故。

在項目中編寫程式碼、測試庫檔案無誤後,就可以開始下一步了:提交 podspec 到 Spec Repo。

向 Spec Repo 提交 podspec

向 Spec Repo 提交 podspec,需要滿足兩點:一是 podspec 必須通過驗證無誤,二是刪掉無用的註釋(這不是必須的,為了規範還是刪掉為好)。向我們的私有 Spec Repo 提交 podspec,只需一條命令:

$ pod repo push WTSpecs PodTestLibrary.podspec  #前面是本地Repo名字 後面是podspec名字

完成之後,這個組件庫就添加進我們的私有 Spec Repo 中了。可以進入 ~/.cocoapods/repos/WTSpecs 目錄下查看:

. ├── LICENSE ├── PodTestLibrary │   └── 0.1.0 │       └── PodTestLibrary.podspec └── README.md

再去看我們的 Spec Repo 遠端倉庫,也多了一次提交,這個 podspec 已經被 Push 上去了。

至此,我們這個組件庫就製作、添加完成了。使用 pod search 命令,就能查到我們自己的庫了:

$ pod search PodTestLibrary - PodTestLibrary (0.1.0)    Just Testing.    pod 'PodTestLibrary', '~> 0.1.0'    - Homepage: https://coding.net/u/wtlucky/p/podTestLibrary    - Source:   https://coding.net/wtlucky/podTestLibrary.git    - Versions: 0.1.0 [WTSpecs repo]

這裡說的是添加到私有 Repo。如果要添加到 Cocoapods 的官方庫,可以使用 trunk 工具,具體可查看官方文檔。

使用製作好的 Pod

在完成這一連串步驟之後,我們就可以在正式項目中使用這個私有 Pod 了,只需在項目的 Podfile 裡添加以下一行程式碼即可:

$ pod 'PodTestLibrary', '~> 0.1.0'

然後執行 pod update 更新庫依賴,再打開項目,可以看到我們自己的庫檔案已經出現在 Pods 子項目的 Pods 子目錄下了,而不再是 Development Pods。

更新與維護 podspec

最後再談一下製作好的 podspec 檔案後續的更新維護工作,比如如何添加新版本、如何刪除 Pod。

我已經製作好了 PodTestLibrary 的 0.1.0 版本,現在對它進行升級。這次我往 PodTestLibrary 中添加了更多模塊,包括工具類、底層 Model 及 UIKit 擴展等,這裡我又嘗試了一下 subspec 功能,給 PodTestLibrary 創建了多個子分支。

具體做法是:先把源檔案添加到 Pod/Classes 中,然後按不同模塊對檔案目錄進行整理。因為我有四個模塊,所以在 Pod/Classes 下又創建了四個子目錄。完成後,繼續編輯之前的 PodTestLibrary.podspec,這次增加了 subspec 特性:

Pod::Spec.new do |s|   s.name             = "PodTestLibrary"   s.version             = "1.0.0"   s.summary             = "Just Testing."   s.description      = <<-DESC                        Testing Private Podspec.                        * Markdown format.                        * Don't worry about the indent, we strip it!                     DESC   s.homepage          = "https://coding.net/u/wtlucky/p/podTestLibrary"   # s.screenshots     = "www.example.com/screenshots_1", "www.example.com/screenshots_2"   s.license          = 'MIT'   s.author          = { "wtlucky" => "wtlucky@foxmail.com" }   s.source          = { :git => "https://coding.net/wtlucky/podTestLibrary.git", :tag => "1.0.0" }   # s.social_media_url = 'https://twitter.com/'   s.platform     = :ios, '7.0'   s.requires_arc = true   #s.source_files = 'Pod/Classes/**/*'   #s.resource_bundles = {   #  'PodTestLibrary' => ['Pod/Assets/*.png']   #}   #s.public_header_files = 'Pod/Classes/**/*.h'   s.subspec 'NetWorkEngine' do |networkEngine|       networkEngine.source_files = 'Pod/Classes/NetworkEngine/**/*'       networkEngine.public_header_files = 'Pod/Classes/NetworkEngine/**/*.h'       networkEngine.dependency 'AFNetworking', '~> 2.3'   end   s.subspec 'DataModel' do |dataModel|       dataModel.source_files = 'Pod/Classes/DataModel/**/*'       dataModel.public_header_files = 'Pod/Classes/DataModel/**/*.h'   end   s.subspec 'CommonTools' do |commonTools|       commonTools.source_files = 'Pod/Classes/CommonTools/**/*'       commonTools.public_header_files = 'Pod/Classes/CommonTools/**/*.h'       commonTools.dependency 'OpenUDID', '~> 1.0.0'   end   s.subspec 'UIKitAddition' do |ui|       ui.source_files = 'Pod/Classes/UIKitAddition/**/*'       ui.public_header_files = 'Pod/Classes/UIKitAddition/**/*.h'       ui.resource = "Pod/Assets/MLSUIKitResource.bundle"       ui.dependency 'PodTestLibrary/CommonTools'   end   s.frameworks = 'UIKit'   #s.dependency 'AFNetworking', '~> 2.3'   #s.dependency 'OpenUDID', '~> 1.0.0' end

因為我們創建了 subspec,所以項目整體的依賴(dependency)、源檔案(source_files)、頭檔案(public_header_files)、資源檔案(resource)等,都移動到了各自的 subspec 中;每個 subspec 之間也可以有相互的依賴關係,比如 UIKitAddition 就依賴於 CommonTools。

編輯完成後,在測試項目裡 pod update 一下,幾個子項目都被加進項目工程了。寫程式碼驗證無誤後,就可以把這個工程 push 到遠端倉庫,並打上新的 tag -> 1.0.0。

最後,再次用 pod lib lint 驗證編輯好的 podspec 檔案,確認沒有自身的 WARNING 或 ERROR 之後,就可以再次提交到 Spec Repo 中了,命令與之前相同:

$ pod repo push WTSpecs PodTestLibrary.podspec

之後再次到 ~/.cocoapods/repos/WTSpecs 目錄下查看:

. ├── LICENSE ├── PodTestLibrary │   ├── 0.1.0 │   │   └── PodTestLibrary.podspec │   └── 1.0.0 │       └── PodTestLibrary.podspec └── README.md 3 directories, 4 files

已經有兩個版本了。使用 pod search 查找到的結果為:

$ pod search PodTestLibrary - PodTestLibrary (1.0.0)    Just Testing.    pod 'PodTestLibrary', '~> 1.0.0'    - Homepage: https://coding.net/u/wtlucky/p/podTestLibrary    - Source:   https://coding.net/wtlucky/podTestLibrary.git    - Versions: 1.0.0, 0.1.0 [WTSpecs repo]    - Sub specs:      - PodTestLibrary/NetWorkEngine (1.0.0)      - PodTestLibrary/DataModel (1.0.0)      - PodTestLibrary/CommonTools (1.0.0)      - PodTestLibrary/UIKitAddition (1.0.0)

完成這些之後,在實際項目中,我們就可以選擇使用整個組件庫,或使用組件庫的某一個部分了。對應的 Podfile 中添加的內容為:

platform :ios, '7.0' pod 'PodTestLibrary/NetWorkEngine', '1.0.0'  #使用某一個部分 pod 'PodTestLibrary/UIKitAddition', '1.0.0' pod 'PodTestLibrary', '1.0.0'   #使用整個庫

最後介紹一下如何刪除一個私有 Spec Repo,只需執行一條命令:

$ pod repo remove WTSpecs

這樣這個 Spec Repo 就在本地刪除了,我們還可以透過

$ pod repo add WTSpecs git@coding.net:wtlucky/WTSpecs.git

再把它加回來。

如果我們要刪除私有 Spec Repo 下的某一個 podspec,該怎麼操作呢?此時無需借助 Cocoapods,只要 cd 到 ~/.cocoapods/repos/WTSpecs 目錄下,刪掉庫目錄:

wtlucky@wtluckydeMacBook-Pro:~/.cocoapods/repos/WTSpecs$ rm -Rf PodTestLibrary

然後把 Git 的變動 push 到遠端倉庫即可:

wtlucky@wtluckydeMacBook-Pro:~/.cocoapods/repos/WTSpecs$ git add --all . wtlucky@wtluckydeMacBook-Pro:~/.cocoapods/repos/WTSpecs$ git ci -m "remove unuseful pods" wtlucky@wtluckydeMacBook-Pro:~/.cocoapods/repos/WTSpecs$ git push origin master

參考資料

Private Pods

Creating a Private CocoaPod

Developing Private In-House Libraries with CocoaPods

(本文作者:wtlucky)

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved