CocoaPods建立自己的Podspec(三)

創建自己的 Pod 十分簡單。只需要創建 .podspec,編輯好 .podspec 的必要信息,提交到 Git,然后就可以在其他項目中使用了。

如果想了解其中的原理,可以查看這篇文章。

如果是 Swift ,可以在此基礎上參考這篇文章。

創建.podspec

首先在你的項目中使用如下命令創建名為 LPPushService 的 LPPushService.podspec(當然你也可以使用vim創建,只是沒有默認文本而已)

$ pod spec create LPPushService

編輯.podspec

創建好的 .podspec 包含大量的注釋說明了每個參數的含義及用法。如果想詳細了解可以仔細閱讀。這里只介紹幾個常用的。

Pod::Spec.new do |s|

  s.name                = "LPPushService"
  s.version             = "1.0.0"
  s.summary             = "integrate APNs rapidly"
  s.homepage            = "https://github.com/xiaofei86/LPPushService"
  s.license             = { :type => "MIT", :file => "LICENSE" }
  s.author             = { "XuYafei" => "xuyafei86@163.com" }
  s.social_media_url   = "http://xuyafei.cn"
  s.platform            = :ios, "7.0"
  s.source              = { :git => "https://github.com/xiaofei86/LPPushService.git", :tag => s.version }
  s.source_files        = "LPPushService/**/*.{h,m}"
  s.resources          = "LPPushService/Images/*.png"
  s.dependency          "BPushSDK", "1.4.1"
  s.requires_arc        = true

end

s.name:名稱,pod search 搜索的關鍵詞
s.version:版本
s.summary:簡介,pod search 搜索的關鍵詞
s.homepage:主頁地址,例如Github地址
s.license:許可證
s.author:作者
s.social_media_url:社交網址
s.platform:平臺
s.source:Git倉庫地址,例如在Github地址后邊加上 .git 就是Git倉庫地址,常見寫法如下
s.source_files:需要包含的源文件,常見的寫法如下
s.resources:需要包含的圖片等資源文件
s.dependency:依賴庫,不能依賴未發布的庫
s.dependency:依賴庫,如有多個可以這樣寫
s.requires_arc:是否要求ARC

s.source_files 常見寫法

"Directory1/*"
"Directory1/Directory2/*.{h,m}"
"Directory1/**/*.h"
  • “*” 表示匹配所有文件
  • “*.{h,m}” 表示匹配所有以.h和.m結尾的文件
  • “**” 表示匹配所有子目錄

s.source 常見寫法

s.source = { :git => "https://github.com/xiaofei86/LPPushService.git", :commit => "68defea" }
s.source = { :git => "https://github.com/xiaofei86/LPPushService.git", :tag => 1.0.0 }
s.source = { :git => "https://github.com/xiaofei86/LPPushService.git", :tag => s.version }
  • commit => "68defea" 表示將這個Pod版本與Git倉庫中某個commit綁定
  • tag => 1.0.0 表示將這個Pod版本與Git倉庫中某個版本的comit綁定
  • tag => s.version 表示將這個Pod版本與Git倉庫中相同版本的comit綁定

按照上述規則編輯完成就制作好了 .podspec(最好使用vim進行編輯)。

上傳到Git

將包含配置好的 .podspec 的項目提交 Git,并給這次提交打上 tag,這時就可以在其他項目中使用 CocoaPods 引入你配置好的 Pod 了。

pod 'LPPushService', :git => 'https://github.com/xiaofei86/LPPushService.git', :tag => '1.0.0'

當然,在給其他項目使用前最好先<a href="##驗證.podspec">驗證.podspec</a>的有效性。

*驗證.podspec

編輯好后最好先驗證 .podspec 是否有有效

$ pod spec lint LPPushService.podspec

驗證過程中:

 -> LPPushService

驗證成功后:

LPPushService.podspec passed validation.

驗證失敗后:

[!] The spec did not pass validation, due to 1 error.

驗證 .podspec 會先測試本地 .podspec 文件是否存在語法錯誤。測試成功再根據 .podspec 文件找到遠端倉庫對應的版本克隆到本地并進行配置。最后測試文件是否能夠編譯成功。

*.podspec驗證失敗錯誤排查

語法錯誤

如果是因為語法錯誤,驗證失敗后會給出錯誤的準確定位

[!] Invalid `LPPushService.podspec` file: no .<digit> floating literal anymore; put 0 before dot
  s.version      = “1.0.0”
                        ^
LPPushService.podspec:5: syntax error, unexpected tFLOAT, expecting '('
  s.version      = “1.0.0”
                           ^

標記“^”的地方即為有語法錯誤的地方。

上述錯誤是因為使用“文本編輯”進行編輯造成的。使用文本編輯有時候英文""引號會自動變成中文“”引號。

[!] Your Podfile has had smart quotes sanitised. To avoid issues in the future, you should not use TextEdit for editing it. If you are not using TextEdit, you should turn off smart quotes in your editor of choice.

使用 vim 將其改為英文的""引號即可。

依賴錯誤

但是,有些非語法錯誤是不會給出錯誤原因的。這個時候可以使用“--verbose”來查看詳細的驗證過程來幫助定位錯誤。

pod spec lint LPPushService.podspec --verbose

如下錯誤通過 --verbose 就可以找到原因。

 -> LPPushService (1.0.0)
    - ERROR | [iOS] Encountered an unknown error (The 'Pods' target has transitive dependencies that include static binaries: (/private/var/folders/jz/b_m3k7ln47524cm__h3__mk00000gn/T/CocoaPods/Lint/Pods/BPushSDK/LibBPush/libBPush.a)) during validation.

這個錯誤是因為依賴庫(s.dependency)包含了.a靜態庫造成的。雖然這并不影響Pod的使用,但是驗證是無法通過的。可以通過 --use-libraries 來讓驗證通過。

pod spec lint LPPushService.podspec --verbose --use-libraries

這種情況下使用 --use-libraries 雖然不會出現錯誤(error),但是有時候會帶來一些警告(waring),警告同樣是無法通過驗證的。這時可以用 --allow-warnings 來允許警告。

pod spec lint LPPushService.podspec --verbose --use-libraries --allow-warnings

安裝錯誤

如果在其他項目 pod install 的過程中,出現包含“undefined method `end_with?' for nil”字樣的報錯。進入“~/.cocoapods/repos”目錄,刪除“master”,并將 master-1 改為 master 即可。

如果出現如下錯誤,而你的驗證可以通過,那么一般更新下版本號就可以解決。

[!] Unable to find a specification for 'LPPushService'.

再次驗證

如果錯誤發生在 .podspec 中。當修改完時,不需要再次提交就可以直接驗證。如果錯誤發生在代碼中,則需要再次提交才能驗證。

發布到CocoaPods

你可以用 .podspec 文件來方便的管理內部代碼,當然,也可以發布自己的 Pod 供其他開發者使用。

CocoaPods 0.33中加入了 Trunk 服務,使用 Trunk 服務可以方便的發布自己的Pod。雖然一開始使用 GitHub Pull Requests 來整理所有公共 pods 效果很好。但是,隨著 Pod 數量的增加,這個工作對于 spec 維護人員 Keith Smiley 來說變得十分繁雜。甚至一些沒有通過 $ pod lint 的 spec 也被提交上來,造成 repo 無法 build。CocoaPods Trunk 服務的引入,解決了很多類似的問題。每次使用 Trunk 服務發布 Pod 時都會通過 $ pod lint 驗證 .podspec 是否有效。要想使用 Trunk 服務,首先需要使用如下命令注冊自己的電腦。這很簡單,只要你指明你的郵箱地址(spec文件中的)和名稱即可。CocoaPods 會給你填寫的郵箱發送驗證郵件,點擊郵件中的鏈接就可通過驗證。

pod trunk register xuyafei86@163.com "XuYafei"

然后就可以發布你的 Pod 了。

pod trunk push LPPushService.podspec

發布時會驗證 Pod 的有效性,如果你在手動驗證 Pod 時使用了 --use-libraries 或 --allow-warnings 等修飾符,那么發布的時候也應該使用相同的字段修飾,否則出現相同的報錯。

pod trunk push LPPushService.podspec --use-libraries --allow-warnings

發布成功后,就可以使用 pod search 搜索到你的 Pod 了!

-> LPPushService (1.0.0)
   integrate APNs rapidly
   pod 'LPPushService', '~> 1.0.0'
   - Homepage: https://github.com/xiaofei86/LPPushService
   - Source:   https://github.com/xiaofei86/LPPushService.git
   - Versions: 1.0.0 [master repo]

由于 pod search 是搜索的本地“~/.cocoapods”,所以在其他設備上可能無法搜到。這時只需要執行 pod install 更新下 pod 倉庫即可(不要加 --no-repo-update)。

版本升級

當需要更新 Pod 版本的時候,修改 .podspec 中的 s.version 為更高的版本號,并修改 s.source 中對應的 Git 版本。提交到Git,并打上對應tag。然后再次執行pod trunk push LPPushService.podspec將新的 .podspec 發布到 CocoaPods。更新完成!

為了更新更加方便,版本控制更加清晰,s.source 建議采用如下寫法:

s.source = { :git => "https://github.com/xiaofei86/LPPushService.git", :tag => s.version }

這樣寫將 Git 的版本與 CocoaPods 的版本進行了綁定。每次提交后再給本次提交打上 tag 就完成了更新。而且在 Git 中就可以清晰的看到哪次提交對應的哪個 CocoaPods 版本。如果與 commit 綁定,則要通過兩次提交才能完成更新,第一次先提交修改代碼,第二次將上一次 commit id 更新到 s.source 然后再次提交。如果直接與固定 tag 綁定,則每次還都要修改 s.source。如果你的 Pod 是私有庫,那么 s.source 其實是無用的。因為在 Podfile 中已經指明了地址和版本(如下)。這時 s.source 可以隨便填寫,但最好還是按照上述規則以便以后發布。

pod 'LPPushService', :git => 'https://github.com/xiaofei86/LPPushService.git', :tag => 1.0.0

博客:xuyafei.cn
簡書:jianshu.com/users/2555924d8c6e
微博:weibo.com/xuyafei86
Github:github.com/xiaofei86

參考資料

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容