iOS開發—— CocoaPods

CocoaPods

什么是 CocoaPods

CocoaPods 是基于Ruby編寫的一應用級別的依賴管理器,其中涵蓋了4.5萬個庫
https://cocoapods.org/

CocoaPods 組成

  • CocoaPods/CocoaPod
    這是是一個面向用戶的組件,每當執行一個 pod 命令時,這個組件都將被激活。該組件包括了所有使用 CocoaPods 涉及到的功能,并且還能通過調用所有其它的 gems 來執行任務。

  • CocoaPods/Core
    Core 組件提供支持與 CocoaPods 相關文件的處理,文件主要是 Podfile 和 podspecs。

  • Podfile
    Podfile 是一個文件,用于定義項目所需要使用的第三方庫。

  • Podspec
    .podspec 也是一個文件,該文件描述了一個庫是怎樣被添加到工程中的。它支持的功能有:列出源文件、framework、編譯選項和某個庫所需要的依賴等。

  • CocoaPods/Xcodeproj
    這個 gem 組件負責所有工程文件的整合。它能夠對創建并修改 .xcodeproj 和 .xcworkspace 文件。它也可以作為單獨的一個 gem 包使用。如果你想要寫一個腳本來方便的修改工程文件,那么可以使用這個 gem。

什么是 Ruby

Ruby 是一種開源的面向對象程序設計的服務器端腳本語言,OS X已自帶Ruby
Podfile就是通過Ruby腳本解析的

安裝 CocoaPods

sudo gem install cocoapods

Gem 是 Ruby 模塊 (叫做 Gems) 的包管理器。其包含包信息,以及用于安裝的文件。

安裝問題

  1. 國內網絡環境無法連接源

    ERROR:  While executing gem ... (Gem::RemoteFetcher::FetchError)
    Errno::ECONNRESET: Connection reset by peer - SSL_connect
    

    解決方法:替換國內鏡像源

    gem sources --remove https://rubygems.org/
    gem sources -a https://gems.ruby-china.com/
    
  2. Ruby環境版本過低

    Unable to resolve dependencies: cocoapods requires cocoapods-core (=0.35.0),
    claide (~> 0.7.0), xcodeproj (~> 0.20.2), cocoapods-downloader (~> 0.8.0)
    

    解決方法:升級Ruby

    sudo gem update  --system
    

    輸入后出現

    ERROR:  While executing gem ... (Gem::FilePermissionError)  
    You don't have write permissions for the /usr/bin directory.
    

    因缺少權限需要更換安裝目錄

    sudo gem install cocoapods -n /usr/local/bin
    

使用 CocoaPods

pod常用命令

#從本地倉庫記錄搜索
pod search  
#初始化、更新倉庫信息                     
pod setup
#更新倉庫信息     
pod repo update
#為項目創建Podfile       
pod init
#根據Podfile安裝第三方庫
pod install
#根據Podfile更新第三方庫
pod update
#根據Podfile安裝/更新第三方庫,同時不更新倉庫信息
pod install --verbose --no-repo-update
pod update --verbose --no-repo-update

查詢Pod庫也可直接從官網搜索

集成 CocoaPods

  1. 創建Podfile

    終端進入工程目錄輸入

    pod init
    

    即可創建Podfile,若為Swift項目

        # use_frameworks!
    

    此句會自動取消注釋,表明依賴的庫編譯生成.frameworkds,而不是.a
    若項目中有多個Target則一個Podfile中會生成多段模板

      # Uncomment the next line to define a       global platform for your project
      # platform :ios, '9.0'
    
      target 'TargetName' do
      # Uncomment the next line if you're using Swift or would like to    use dynamic frameworks
      # use_frameworks!
    
      # Pods for TargetName
    
       end
    

    消除第三方庫警告

    platform :ios, '9.0'
    # 隱藏所有警告
    inhibit_all_warnings!
    
    target 'TargetName' do
       # 不要隱藏ReactiveObjC的警告,也可以用此方法只隱藏指定pod警告。
       pod 'xxx', '~> 1.0.0', :inhibit_warnings => false
    
    end
    
  2. 編輯Podfile

    pod 'xxx' : 使用倉庫記錄的最新版本。
    pod 'xxx', '1.0' : 使用1.0版本。
    pod 'xxx', '~>1.0': 則表示使用的版本范圍是 1.0 <= 版本 < 2.0
    若為是~>1.0.0, 那么則表示使用的版本范圍是 1.0.0 <= 版本 < 1.1.0
    pod 'xxx', '>1.0': 使用大于1.0的版本
    pod 'xxx', '>=1.0': 使用1.0及以上的版本
    pod 'xxx', '<1.0': 使用小于1.0的版本
    pod 'xxx', '<=1.0': 使用小于等于1.0的版本
    pod 'xxx', :path => '本地代碼倉庫的路徑/xxx.podspec' #使用該方式可以指定本地存在的依賴路徑(podspec文件稍后會結介紹到)。
    pod 'xxx', :git => 'git倉庫地址' #可以通過git倉庫地址來加載相關依賴。
    pod 'xxx', :git => '本地代碼倉庫的路徑', :tag => '2.2.2' :#后方可以跟:tag參數來指定相關的tag號。當然后邊還可以通過:branch => '分支號'來指定依賴于某個分支,通過:commit => 'commit號'來指定那個提交。
    

    若使用多個私有庫則可直接在Podfile開始添加source,但必須添加所有需要的source,否則無法找到目標庫
    CocoaPods 公共庫索引地址

    source 'https://github.com/CocoaPods/Specs.git'
    
  1. 安裝/更新第三方庫

    pod install
    pod update
    

    安裝完成后會創建 Pods目錄、Podfile.lock文件、和.xcworkspace文件
    以后項目都從.xcworkspace打開
    Pods目錄下下載了第三方庫,此目錄需要加入.gitignore文件中,避免隨git提交/Pods
    執行install命令時會檢查Podfile.lock文件,若沒有則會創建一個
    Podfile.lock記錄了創建時所安裝的依賴庫版本,當目錄下有Podfile.lock文件時pod會依據Podfile.lock中記錄的版本安裝,否則就安裝Podfile中指定版本或最新版本
    update指令則會對未指定版本的庫進行更新,并更新Podfile.lock
    所以當協作開發時,每當一人更新了依賴庫版本,也要提交Podfile.lock,其他人拉取后使用install指令而非update對Pod依賴庫進行更新,方便統一版本
    當發現無法更新到最新版本庫時,執行pod setup更新本地倉庫索引

刪除 CocoaPods

  1. Target->Build Phases,刪除 [CP]Check Pods Manifest.lock 和 [CP]Copy Pods Resources
  2. 刪除項目Pod相關引用
  3. 刪除項目目錄下Pod文件

制作 CocoaPods 倉庫

  1. 創建框架工程并建立git倉庫

  2. 編輯工程打tag

  3. 創建私有Repo git倉庫

  4. 創建Pod配置文件

    pod spec create XXX
    

    生成.podspec文件,內容如下

     name:框架名
     version:當前版本,后續更新了新版本,需要修改此處,需要有對應git tag
     summary:簡要描述,在pod search時會顯示該信息。
     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::Spec.new do |spec|  
    spec.name             = 'Reachability'
    spec.version          = '3.1.0'
    spec.license          = { :type => 'BSD' }
    spec.homepage         = 'https://github.com/tonymillion/Reachability'
    spec.authors          = { 'Tony Million' => 'tonymillion@gmail.com' }
    spec.summary          = 'ARC and GCD Compatible Reachability Class for iOS and macOS.'
    spec.source           = { :git => 'https://github.com/tonymillion/Reachability.git', :tag => 'v3.1.0' }
    spec.source_files     = 'Reachability.h,m'
    spec.framework        = 'SystemConfiguration'
    spec.requires_arc     = true
    end
  1. 校驗配置文件
    可用該指令進行本地校驗合法性

    pod lib lint
    

    更多詳細配置方式可上官網
    在push repo時會自動進行校驗,但如果校驗有warning或error則不能push,可添加--allow-warnings忽略警告

  2. 添加/推送repo

    pod repo add [repo名] [repo git地址]
    pod repo push [repo名] [podspec文件路徑]
    

    推送完成使用pod spec lint進行網絡校驗,校驗source是否由指定tag

CocoaPod 工作原理

操作過程
  1. 分析依賴項
  2. 檢查工程target
  3. 查找Podfile變化
  4. 解析Podfile
  5. 比較詳情文件
  6. 下載依賴項
  7. 安裝依賴項
  8. 創建Pod工程
    • 創建工程
    • 添加依賴源文件
    • 添加framework
    • 添加libraries
    • 添加資源文件
    • 鏈接頭文件
    • 安裝依賴項target
    • 寫入pod工程文件
    • 寫lockfile
    • 寫manifest
  9. 整合工程
  10. 整合target
索引目錄結構
~/.cocoapods/repos
.
├── Specs
    └── [SPEC_NAME]
        └── [VERSION]
            └── [SPEC_NAME].podspec
工程結構
Demo
├── Demo
│   ├── Demo
│   ├── Demo.xcodeproj
│   ├── DemoTests
│   └── DemoUITests
├── Demo.xcworkspace
├── PodFile
├── Podfile.lock
└── Pods
    ├── AFNetworking
    │    ├── Source Files
    │    └── Support Files
    │         ├── AFNetworking-dummy.m
    │         ├── AFNetworking-prefix.pch
    │         └── AFNetworking.xcconfig
    ├── Headers
    ├── Manifest.lock
    ├── Pods.xcodeproj
    └── Target Support Files
         ├── Pods-Demo-acknowledgements.markdown
         ├── Pods-Demo-acknowledgements.plist
         ├── Pods-Demo-dummy.m
         ├── Pods-Demo-frameworks.sh
         ├── Pods-Demo-resources.sh
         ├── Pods-Demo.debug.xcconfig
         └── Pods-Demo.release.xcconfig
  1. target support files

    • .xcconfig 配置環境變量
    CONFIGURATION_BUILD_DIR = ${PODS_CONFIGURATION_BUILD_DIR}/SDWebImage
    GCC_PREPROCESSOR_DEFINITIONS = $(inherited) COCOAPODS=1
    HEADER_SEARCH_PATHS = $(inherited) "${PODS_ROOT}/Headers/Private" 
    "${PODS_ROOT}/Headers/Private/SDWebImage" "${PODS_ROOT}/Headers/Public" 
    "${PODS_ROOT}/Headers/Public/SDWebImage"
    OTHER_LDFLAGS = -framework "ImageIO"
    PODS_BUILD_DIR = ${BUILD_DIR}
    PODS_CONFIGURATION_BUILD_DIR = ${PODS_BUILD_DIR}/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)
    PODS_ROOT = ${SRCROOT}
    PODS_TARGET_SRCROOT = ${PODS_ROOT}/SDWebImage
    PRODUCT_BUNDLE_IDENTIFIER = org.cocoapods.${PRODUCT_NAME:rfc1034identifier}
    SKIP_INSTALL = YES
    
    CONFIGURATION_BUILD_DIR : buid location  
    GCC_PREPROCESSOR_DEFINITIONS : Clang preprocess  
    OTHER_LDFLAGS : link binary with libraries
    PRODUCT_BUNDLE_IDENTIFIER : packaging
    SKIP_INSTALL 
    
    • -dummy.m
      compile source
      輔助純分類庫編譯實現編譯
  1. Pod target support files
    • -acknowledgement聲明文件
    • -framewrok.sh 安裝framework腳本
    • -resource.sh 資源文件拷貝腳本
  2. check pods manifest.lock
    運行時檢查安裝清單和下載清單是否一致
  3. copy pods resoources
    執行resource拷貝
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,578評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,701評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,691評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,974評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,694評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,026評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,015評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,193評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,719評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,442評論 3 360
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,668評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,151評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,846評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,255評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,592評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,394評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,635評論 2 380

推薦閱讀更多精彩內容