Cocoapods整理(三)——編寫podspec文件

From: https://segmentfault.com/a/1190000012269307

![][1]飛花蝶舞劍發布于 2017-12-04


前言

看到pod上各種形形色色的三方庫,自己肯定也會想要創建一個分享一下。做組件化時也會想要將項目拆分成一個一個的私有庫。而使用pod管理三方庫或私有庫最重要的就是要學會如何寫podsepc文件。 

以下均以我自己寫的一個私有庫ZCPKit去介紹。


目錄

  • 如何創建podspec文件
  • 如何編寫podspec文件
  • 如何實現目錄分層
  • 如何校驗podspec文件
  • 別人寫的例子
  • 補充 校驗時出現的一些問題

1.如何創建podspec文件

創建podspec文件只需要一行命令,在你自己的三方庫的根目錄下輸入下面的命令:

pod spec create XXXKit

例如我自己的ZCPKit

然后在項目目錄下將會生成一個podspec文件

2.如何編寫podspec文件

我們先來打開ZCPKit.podspec文件看看里面的內容。基本都是針對ZCPKit的描述和介紹。

一些常用的信息介紹:

name:框架名
version:當前版本(注意,是當前版本,假如你后續更新了新版本,需要修改此處)
summary:簡要描述,在pod search ZCPKit的時候會顯示該信息。
description:詳細描述
homepage:頁面鏈接
license:開源協議
author:作者
source:源碼git地址
platform:支持最低ios版本
source_files:源文件(可以包含.h和.m)
public_header_files:頭文件(.h文件)
resources:資源文件(配置的文件都會被放到mainBundle中)
resource_bundles:資源文件(配置的文件會放到你自己指定的bundle中)
frameworks:依賴的系統框架
vendored_frameworks:依賴的非系統框架
libraries:依賴的系統庫
vendored_libraries:依賴的非系統的靜態庫
dependency:依賴的三方庫

上面列舉的信息大部分來自pod默認生成的podspec文件中的給的,其中需要重點注意標識黑體的這幾個信息。

你在三方庫中看到的那些文件都是通過這些配置來確定的。當pod install引入三方庫時,只會引入你在podspec中配置的那些文件。

下面我會舉例說明該如何寫podsepc中的每項配置。

目錄結構如下

ZCPKit
┗━━━━Classes
     ┗━━━━ZCPKit.h
     ┗━━━━ZCPKit.m
┗━━━━Frameworks
     ┗━━━━MyFramework.framework
┗━━━━Libraries
     ┗━━━━libZCPKit.a
┗━━━━Resources
     ┗━━━━MyRes.bundle

如圖所示的目錄結構,每個配置項的寫法如下:

source_files:配置三方庫的源文件(.h或.m文件)

寫法:
source_files = 'Classes/ZCPKit.{h,m}' // 直接指定文件名
或:
source_files = 'Classes/*.{h,m}' // Classes文件夾下的所有匹配文件
source_files = 'Classes/**/*.{h,m}' // Classes所有路徑下的所有匹配文件

public_header_files:配置公有的頭文件(.h文件)

寫法:
source_files = 'Classes/ZCPKit.h' // 直接指定文件名
或:
source_files = 'Classes/*.h' // Classes文件夾下的所有匹配文件
source_files = 'Classes/**/*.h' // Classes所有路徑下的所有匹配文件

vendored_frameworks:配置需要引用的非系統框架(****/的寫法后面不再贅述*)

寫法:
vendored_frameworks = 'Frameworks/MyFramework.framework'

frameworks:配置依賴的系統框架

寫法:
frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'

vendored_libraries:配置需要引用的非系統靜態庫(要注意,這里的.a靜態庫名字必須要帶lib前綴,如果引用的靜態庫名字沒lib前綴會導致編譯報錯,只需要重命名加上即可

寫法:
vendored_libraries = 'Frameworks/libZCPKit.a'

libraries:配置依賴的系統庫(要注意,這里的寫法需要忽略lib前綴

寫法:
libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'

resources:配置資源文件(.bundle,.png,.txt等資源文件,這些資源文件會被放到mainBundle中,要注意避免發生命名重復的問題

寫法:
resources = 'Resources/MyRes.bundle'

resource_bundles:配置指定bundle的資源文件(可以解決resources導致的命名沖突問題

寫法:
resource_bundles = {
    'ZCPKitBundle' => ['Resources/MyRes.bundle'],
}

dependency:依賴的三方庫,pod庫或者可以是自身的subspec

寫法:
dependency 'AFNetworking', '~>3.1.0' // pod三方庫
dependency 'Util' // 自身的subspec
或
dependency 'AFNetworking'

附上官網鏈接,可以去看一看:podspec
關于更詳細的podspec文件寫法,可以看這篇文章:Podspec語法參考 v1.2.0.beta.1
關于資源文件更詳細的寫法,可以看這篇文章:給 Pod 添加資源文件

3.如何實現目錄分層

使用subspec來實現目錄分層。
目錄分層的好處:

  • 目錄分層,結構清晰;
  • 使用pod引入一個三方庫時,可以只引入一個subspec而不用將整個三方庫引入。

例如AFNetworking:

下面舉例說明,如圖所示的目錄結構:

ZCPKit
┗━━━━Classes
     ┗━━━━ZCPKit.h
     ┗━━━━ZCPRouter
          ┗━━━━ZCPRouter.h
          ┗━━━━ZCPRouter.m
     ┗━━━━ZCPUtil
          ┗━━━━ZCPUtil.h
          ┗━━━━ZCPUtil.m

寫法如下:

效果:

如果想有多層的目錄結構還可以繼續嵌套下去。

有幾個需要注意的地方:

1.層級不能出現循環依賴。

  • 比如類ZCPUtil.h中 #import "ZCPRouter.h",同時ZCPRouter.h中 #import "ZCPUtil.h"。這樣當寫podspec時就需要在Util層級中寫dependency 'ZCPKit/Router',在Router層級中寫dependency 'ZCPKit/Util'。如此便存在Router與Util層級之間的循環依賴。出現循環依賴時,三方庫是無法成功提交到repo上的,會報依賴錯誤。解決辦法是,層級間要盡量解耦。

2.分層的層級不要太多,層級不要太深。

  • 為了避免出現上述的循環依賴錯誤。

3.source_files使用的是真實的物理路徑,而dependency依賴其他層級時使用的是層級路徑,不是真實的物理路徑

  • 例如:ZCPUtil.h文件的真實路徑是:ZCPKit/Framework/Util,而Util層級是屬于ZCPKit層級下的一個子subspec,所以當寫Router層級依賴Util層級時要寫:dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'

4.如何校驗podspec文件

在podspec寫好之后我們需要驗證一下編寫的內容是否有誤。可以在命令行的三方庫當前路徑下使用下面的命令:

pod lib lint (從本地驗證你的pod能否通過驗證)
pod spec lint (從本地和遠程驗證你的pod能否通過驗證)

pod lib lint --verbose (加--verbose可以顯示詳細的檢測過程,出錯時會顯示詳細的錯誤信息)
pod lib lint --allow-warnings (允許警告,用來解決由于代碼中存在警告導致不能通過校驗的問題)
pod lib lint --help (查看所有可選參數,可選參數可以加多個)

我們目前只是在本地寫的三方庫,所以只需要使用pod lib lint驗證即可(這個過程會較為費時,需要稍微等待)。

我自己加了個循環依賴的錯誤然后再重新檢測一下試試,可以看到檢測到了錯誤(發現有錯誤的時候,建議用加--verbose的命令看詳細錯誤信息):

需要注意的:
在檢測的時候會很經常會出現各種亂七八糟的錯誤,在文件多的情況下不太容易一次通過,并且即使你的代碼在Xcode中編譯通過了,但是也還是會出現很多錯誤。所以你需要盡量去注意下面的幾個問題:

1.當代碼中存在警告時要記得使用--allow-warnings參數。

2.如果引入的文件或分好的層級需要依賴系統庫或三方庫,要記得使用上面介紹的libararies,frameworks等屬性。

3.如果你的三方庫是在一個xcode項目中編寫調試,那么盡量不要用pch。

  • 因為很多類之間的小依賴會被pch給遮掩過去,這會導致在校驗時出現大量錯誤。

4.如果想要分層,那么盡量解耦使模塊能夠單獨存在。

  • 原因是當分層較多層級較深時,很可能產生循環依賴的問題。

5.其他

如果想要了解一些實實在在的例子,你可以把別人的三方庫下載下來,podspec文件一般會跟其放在一起,這樣就能參考別人的podspec文件是怎么寫的。比如AFNetworking:

1>用pod搜索AFNetworking

2>進入AFNetworking的源碼地址

3>下載并查看

6.補充 校驗時出現的一些問題

1.不支持i386編譯的庫無法通過pod lib lint的問題()
解決pod lib lint/repo push不支持i386編譯&只能真機運行的庫

https://github.com/CocoaPods/...

2.在A私有庫中引入了B私有庫,導致pod lib lint不通過的問題

在調用命令時需要添加B私有庫所在的repo源地址。

pod lib lint <文件名>.podspec --sources='<私有庫所在repo的source>,https://github.com/CocoaPods/Specs.git' 

3.報錯 ··· error: include of non-modular header inside framework module ··· [-Werror,-Wnon-modular-include-in-framework-module]

解決辦法:在pod lib lint 或者 pod spec lint 以及 pod repo push ....時候加上 --use-libraries

參考:COCOAPODS創建私有PODS


后續

Cocoapods整理(一)——安裝Cocoapods
Cocoapods整理(二)——使用Cocoapods
Cocoapods整理(四)——搭建Cocoapods私有庫環境

本篇文章的私有庫demo:ZCPKit

個人的repo:zcprepo
私有庫:ZCPKit


參考文章

給 Pod 添加資源文件
解決pod lib lint/repo push不支持i386編譯&只能真機運行的庫
Podspec語法參考 v1.2.0.beta.1


iosgitobjective-cswift

閱讀 23.4k更新于 2 月 22 日

贊9收藏8

本作品系原創,采用《署名-非商業性使用-禁止演繹 4.0 國際》許可協議


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

推薦閱讀更多精彩內容