podSpec文件相關知識整理

上一篇文章整理了我用SVN創建私有庫的過程，本文將整理一下有關podSpec文件的相關知識。

podSpec中spec的全稱是“Specification”，說明書的意思。顧名思義，這是用來描述你這個私有pod的說明信息的。
podSpec是cocoapods的一種文件格式，有一套自己的語法，我們可以到cocoapods官網進行詳細了解（https://guides.cocoapods.org/syntax/podspec.html）。

創建podSpec很簡單，只要創建一個以.podSpec為后綴的文件即可，或者直接拷貝別人的進行修改也可以。

它的創建命令是：$pod spec create TestFile

podspec文件的常用配置字段介紹

Pod::Spec.new do|s|

框架名字：框架名字一定要寫對，pod search "框架名"就是搜的這個

   s.name         = "yoowei"

框架版本號

  s.version      = "1.0.0"

框架簡介

  s.summary      = "yoowei框架"

框架的主頁

  s.homepage     = "https://git.oschina.net/yoowei"

框架遵守的開源協議

  s.license      = 'MIT'

框架的作者

  s.author       = { "yoowei" => "yoowei @126.com" }

 

框架的資源路徑：路徑可以指向遠端代碼庫，也可以指向本地項目，例如：

                     1.指向遠端代碼庫： { :git => "[e-mail]:yoowei/yoowei.git", :tag => "1.0.0" }

                     2.指向本地項目：    { :path => 'yoowei', }

  s.source       = { :git => "[e-mail]:yoowei/yoowei.git", :tag => "1.0.0" }

框架被其他工程引入時，會導入yoowei目錄下的.h和.m文件

  s.source_files = 'yoowei/**/*.{h,m}'

框架被其他工程引入時，會導入yoowei/resource目錄下的資源文件

  s.resources     = {

     'yoowei'  => [ 'yoowei/resource/**/*.{storyboard,xcassets,xib,png' ]

   }

框架依賴的framework

  s.framework    = 'CoreData'

框架依賴的其他第三方庫

  s.dependency 'MagicalRecord', :git => ' https://github.com/iiiyu/MagicalRecord.git', :tag => 'sumiGridDiary2.1'

  s.dependency 'MBProgressHUD'

框架是否需要支持ARC

  s.requires_arc = true

框架支持的最低平台版本

  s.platform     = :ios ,  '7.0'

框架公開的頭文件

 s.public_header_files =  'yoowei/**/*.h'   


end

 

大型項目模塊化管理

隨着iOS APP越來越復雜，功能越來越多，對於iOS項目的工程化要求也越來越高了，對於復雜的APP一般都需要對項目進行模塊化管理。

模塊化有幾個方式：

1. 目錄結構管理：這是最原始的方式，僅僅通過目錄結構實現代碼層次的清晰化。但本質上並沒有解決代碼之間的依賴混亂的情況，模塊化划分也非常不清晰。

2. 子工程：通過子工程可以實現代碼依賴管理和模塊化，但是需要引入復雜的設置，不利於管理。

3. 靜態庫：將依賴代碼打包成為靜態庫.a，不過由於不能看到源碼，調試不方便。

自從有了CocoaPods，可以使用它來管理私有庫，從而實現了代碼模塊化管理。例如下圖所示：

 

 

CocoaPods私有庫

1. 創建私有的Specs git庫

　　例如在github上面創建一個空的git庫：https://github.com/xxx/MySpecs

　　將這個git庫加入到CocoaPods庫的列表中：

pod repo add MySpecs [e-mail]:xxx/MySpecs.git

　　此時可以檢查下本地的pod repo

<br class="Apple-interchange-newline">$ pod repo list<br><br>MySpecs

- Type: git (master)- URL: [e-mail]:xxx/MySpecs.git

- Path: /Users/xxx/.cocoapods/repos/mySpecs

master

- Type: git (master)

- URL:  [e-mail]:CocoaPods/Specs.git

- Path: /Users/xxx/.cocoapods/repos/master

　　確定私有庫的Specs已經加到本地pod repo中。 

2. 在私有庫項目中創建podspec文件

在私有庫項目中的根目錄，創建對應的podspec文件，里面會描述這個庫的基本信息。

PodSpec規范可以查看：https://guides.cocoapods.org/syntax/podspec.html

Pod::Spec. new  do  |s|

   s.name         =  "PodName"

   s.version      =  "0.0.1"

   s.summary      =  "A short description of PodName."

   s.homepage     =  "http://github.com/xxx/PodName"

   s.license      = {  :type  =>  "MIT" ,  :text  => <<- LICENSE

     Copyright ©  2016 年 xxx. All rights reserved.

     LICENSE

      }

   s.author       = {  ""  =>  ""  }

   s.source       = {  :git  =>  "[e-mail]:xxx/PodName.git" ,  :tag  =>  "0.0.1"  }

   s.source_files =  "**/*.{h,m,mm,c}"

   s.frameworks   =  "Foundation" ,  "QuartzCore" ,  "UIKit" ,  "WebKit"

   s.libraries    =  "z"

  

   s.dependency  'AFNetworking'

   s.ios.deployment_target =  '6.0'

end

resource: 可以指定資源文件，建議使用bundle以避免資源文件產生沖突。

frameworks: 指定這個pod依賴的系統framework

libraries: 指定這個pod依賴的系統動態庫。注意使用的名字：比如需要引用"libz.dylib", 那么這里只需要寫"z"

 

無論原始項目的目錄結構或者group結構，默認的pod里面的代碼都會平鋪在根目錄里面

如果需要增加目錄層次結構，則需要使用subspec，詳細使用規范：https://guides.cocoapods.org/syntax/podspec.html#subspec

注意：SubSpecs之間不能存在相互依賴關系，只能單向依賴

 

3. 驗證私有庫的合法性

pod lib lint --sources='[e-mail]:xxx/MySpecs.git' --verbose --use-libraries --allow-warnings

sources參數可以指定私有庫的Pod Specs庫的地址。如果能夠通過，說明代碼編譯沒有問題

4. 提交私有庫的版本信息

git tag -m  "first release"  "0.0.1"

$ git push --tags      #推送tag到遠端倉庫

 

 

5. 向Spec Repo提交podspec

pod repo push MySpecs PodName.podspec --sources='[e-mail]:xxx/MySpecs.git' --use-libraries --allow-warnings

這樣就完成了一個CocoaPods的私有庫的提交了，別人就可以在Podfile里面使用這個私有庫了。