From: https://segmentfault.com/a/1190000012269307
![][1]飛花蝶舞劍發(fā)布于 2017-12-04
前言
看到pod上各種形形色色的三方庫，自己肯定也會想要創(chuàng)建一個分享一下。做組件化時也會想要將項目拆分成一個一個的私有庫。而使用pod管理三方庫或私有庫最重要的就是要學會如何寫podsepc文件。
以下均以我自己寫的一個私有庫ZCPKit去介紹。
目錄
- 如何創(chuàng)建podspec文件
- 如何編寫podspec文件
- 如何實現(xiàn)目錄分層
- 如何校驗podspec文件
- 別人寫的例子
- 補充 校驗時出現(xiàn)的一些問題
1.如何創(chuàng)建podspec文件
創(chuàng)建podspec文件只需要一行命令，在你自己的三方庫的根目錄下輸入下面的命令：
pod spec create XXXKit
例如我自己的ZCPKit
然后在項目目錄下將會生成一個podspec文件
2.如何編寫podspec文件
我們先來打開ZCPKit.podspec文件看看里面的內(nèi)容。基本都是針對ZCPKit的描述和介紹。
一些常用的信息介紹：
name：框架名
version：當前版本（注意，是當前版本，假如你后續(xù)更新了新版本，需要修改此處）
summary：簡要描述，在pod search ZCPKit的時候會顯示該信息。
description：詳細描述
homepage：頁面鏈接
license：開源協(xié)議
author：作者
source：源碼git地址
platform：支持最低ios版本
source_files：源文件（可以包含.h和.m）
public_header_files：頭文件(.h文件)
resources：資源文件（配置的文件都會被放到mainBundle中）
resource_bundles：資源文件（配置的文件會放到你自己指定的bundle中）
frameworks：依賴的系統(tǒng)框架
vendored_frameworks：依賴的非系統(tǒng)框架
libraries：依賴的系統(tǒng)庫
vendored_libraries：依賴的非系統(tǒng)的靜態(tài)庫
dependency：依賴的三方庫
上面列舉的信息大部分來自pod默認生成的podspec文件中的給的，其中需要重點注意標識黑體的這幾個信息。
你在三方庫中看到的那些文件都是通過這些配置來確定的。當pod install引入三方庫時，只會引入你在podspec中配置的那些文件。
下面我會舉例說明該如何寫podsepc中的每項配置。
目錄結(jié)構(gòu)如下
ZCPKit
┗━━━━Classes
┗━━━━ZCPKit.h
┗━━━━ZCPKit.m
┗━━━━Frameworks
┗━━━━MyFramework.framework
┗━━━━Libraries
┗━━━━libZCPKit.a
┗━━━━Resources
┗━━━━MyRes.bundle
如圖所示的目錄結(jié)構(gòu)，每個配置項的寫法如下：
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：配置需要引用的非系統(tǒng)框架（****/的寫法后面不再贅述*）
寫法： vendored_frameworks = 'Frameworks/MyFramework.framework'frameworks：配置依賴的系統(tǒng)框架
寫法： frameworks = 'AVFoundation', 'CoreGraphics', 'Security', 'SystemConfiguration'vendored_libraries：配置需要引用的非系統(tǒng)靜態(tài)庫（要注意，這里的.a靜態(tài)庫名字必須要帶lib前綴，如果引用的靜態(tài)庫名字沒lib前綴會導致編譯報錯，只需要重命名加上即可）
寫法： vendored_libraries = 'Frameworks/libZCPKit.a'libraries：配置依賴的系統(tǒng)庫（要注意，這里的寫法需要忽略lib前綴）
寫法： libraries = 'c++', 'sqlite3', 'stdc++.6.0.9', 'z'resources：配置資源文件（.bundle，.png，.txt等資源文件，這些資源文件會被放到mainBundle中，要注意避免發(fā)生命名重復(fù)的問題）
寫法： 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'
附上官網(wǎng)鏈接，可以去看一看：podspec
關(guān)于更詳細的podspec文件寫法，可以看這篇文章：Podspec語法參考 v1.2.0.beta.1
關(guān)于資源文件更詳細的寫法，可以看這篇文章：給 Pod 添加資源文件
3.如何實現(xiàn)目錄分層
使用subspec來實現(xiàn)目錄分層。
目錄分層的好處：
- 目錄分層，結(jié)構(gòu)清晰；
- 使用pod引入一個三方庫時，可以只引入一個subspec而不用將整個三方庫引入。
例如AFNetworking：
下面舉例說明，如圖所示的目錄結(jié)構(gòu)：
ZCPKit
┗━━━━Classes
┗━━━━ZCPKit.h
┗━━━━ZCPRouter
┗━━━━ZCPRouter.h
┗━━━━ZCPRouter.m
┗━━━━ZCPUtil
┗━━━━ZCPUtil.h
┗━━━━ZCPUtil.m
寫法如下：
效果：
如果想有多層的目錄結(jié)構(gòu)還可以繼續(xù)嵌套下去。
有幾個需要注意的地方：
1.層級不能出現(xiàn)循環(huán)依賴。
- 比如類ZCPUtil.h中 #import "ZCPRouter.h"，同時ZCPRouter.h中 #import "ZCPUtil.h"。這樣當寫podspec時就需要在Util層級中寫dependency 'ZCPKit/Router'，在Router層級中寫dependency 'ZCPKit/Util'。如此便存在Router與Util層級之間的循環(huán)依賴。出現(xiàn)循環(huán)依賴時，三方庫是無法成功提交到repo上的，會報依賴錯誤。解決辦法是，層級間要盡量解耦。
2.分層的層級不要太多，層級不要太深。
- 為了避免出現(xiàn)上述的循環(huán)依賴錯誤。
3.source_files使用的是真實的物理路徑，而dependency依賴其他層級時使用的是層級路徑，不是真實的物理路徑
- 例如：ZCPUtil.h文件的真實路徑是：ZCPKit/Framework/Util，而Util層級是屬于ZCPKit層級下的一個子subspec，所以當寫Router層級依賴Util層級時要寫：dependency 'ZCPKit/Util'而不是dependency 'ZCPKit/Framework/Util'
4.如何校驗podspec文件
在podspec寫好之后我們需要驗證一下編寫的內(nèi)容是否有誤。可以在命令行的三方庫當前路徑下使用下面的命令：
pod lib lint （從本地驗證你的pod能否通過驗證）
pod spec lint （從本地和遠程驗證你的pod能否通過驗證）
pod lib lint --verbose （加--verbose可以顯示詳細的檢測過程，出錯時會顯示詳細的錯誤信息）
pod lib lint --allow-warnings (允許警告，用來解決由于代碼中存在警告導致不能通過校驗的問題)
pod lib lint --help （查看所有可選參數(shù)，可選參數(shù)可以加多個）
我們目前只是在本地寫的三方庫，所以只需要使用pod lib lint驗證即可（這個過程會較為費時，需要稍微等待）。
我自己加了個循環(huán)依賴的錯誤然后再重新檢測一下試試，可以看到檢測到了錯誤（發(fā)現(xiàn)有錯誤的時候，建議用加--verbose的命令看詳細錯誤信息）：
需要注意的：
在檢測的時候會很經(jīng)常會出現(xiàn)各種亂七八糟的錯誤，在文件多的情況下不太容易一次通過，并且即使你的代碼在Xcode中編譯通過了，但是也還是會出現(xiàn)很多錯誤。所以你需要盡量去注意下面的幾個問題：
1.當代碼中存在警告時要記得使用--allow-warnings參數(shù)。
2.如果引入的文件或分好的層級需要依賴系統(tǒng)庫或三方庫，要記得使用上面介紹的libararies，frameworks等屬性。
3.如果你的三方庫是在一個xcode項目中編寫調(diào)試，那么盡量不要用pch。
- 因為很多類之間的小依賴會被pch給遮掩過去，這會導致在校驗時出現(xiàn)大量錯誤。
4.如果想要分層，那么盡量解耦使模塊能夠單獨存在。
- 原因是當分層較多層級較深時，很可能產(chǎn)生循環(huán)依賴的問題。
5.其他
如果想要了解一些實實在在的例子，你可以把別人的三方庫下載下來，podspec文件一般會跟其放在一起，這樣就能參考別人的podspec文件是怎么寫的。比如AFNetworking：
1>用pod搜索AFNetworking
2>進入AFNetworking的源碼地址
3>下載并查看
6.補充 校驗時出現(xiàn)的一些問題
1.不支持i386編譯的庫無法通過pod lib lint的問題（）
解決pod lib lint/repo push不支持i386編譯&只能真機運行的庫
https://github.com/CocoaPods/...
2.在A私有庫中引入了B私有庫，導致pod lib lint不通過的問題
在調(diào)用命令時需要添加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
后續(xù)
Cocoapods整理（一）——安裝Cocoapods
Cocoapods整理（二）——使用Cocoapods
Cocoapods整理（四）——搭建Cocoapods私有庫環(huán)境
本篇文章的私有庫demo：ZCPKit
參考文章
給 Pod 添加資源文件
解決pod lib lint/repo push不支持i386編譯&只能真機運行的庫
Podspec語法參考 v1.2.0.beta.1
閱讀 23.4k更新于 2 月 22 日
贊9收藏8
本作品系原創(chuàng)，采用《署名-非商業(yè)性使用-禁止演繹 4.0 國際》許可協(xié)議
