自定義 Cocoapods 庫

姜家志發表於2017-05-22

做iOS開發時常常會使用Cocoapods來管理第三方依賴庫，指定好依賴之後，自動下載依賴即可。
關於Cocoapods的安裝可以參考這篇文章CocoaPods安裝和使用教程。
現在有一個場景：有2個專案，需要提取一個出一個公共的庫提供給兩個專案使用，如何使用Cocoapods解決使用公共庫的問題呢？
通過自定義一個Cocoapods的庫可以解決這個問題，自定義一個公共Cocoapods庫的好處：可以封裝公共程式碼，提高程式碼的複用，減少程式碼的維護。
自定義Cocoapods庫，可以通過pod命令進行建立。

建立Cocoapods庫

podspec是Cocoapods類庫的配置檔案(Ruby語法)
可以使用命令列建立Cocoapods類庫，命令如下：

pod lib create MyLibrary

執行完命令之後需要選擇語言已經測試程式碼等，按照自己的專案需求選擇即可：

To get you started we need to ask a few questions, this should only take a minute.

If this is your first time we recommend running through with the guide:
 - http://guides.cocoapods.org/making/using-pod-lib-create.html
 ( hold cmd and click links to open in a browser. )
What language do you want to use?? [ Swift / ObjC ]
 > Swift
Would you like to include a demo application with your library? [ Yes / No ]
 > Yes
Which testing frameworks will you use? [ Quick / None ]
 > Quick
Would you like to do view based testing? [ Yes / No ]
 > Yes
Running pod install on your new library.複製程式碼

安裝完依賴之後，會得到一個pod-library.podspec檔案，他的內容一般都是下面這樣的:

    Pod::Spec.new do |s|
  s.name             = 'pod-library'
  s.version          = '0.1.0'
  s.summary          = 'A short description of pod-library.'
  ...
  s.description      = <<-DESC
TODO: Add long description of the pod here.
                       DESC

  s.homepage         = 'https://github.com/jjz/pod-library'
  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  s.author           = { 'jjz' => 'woaf1003@gmail.com' }
  s.source           = { :git => 'https://github.com/jjz/pod-library.git', :tag => s.version.to_s }
  s.ios.deployment_target = '8.0'
  s.source_files = 'pod-library/Classes/**/*'
 ...
end複製程式碼

這段Ruby程式碼的意思是建立一個Spec的配置，該專案釋出之後可以被Pod直接引用，其中一些選項的意義如下：

  • source_files 指定類庫中的原始碼
    在source_files中指定要釋出的原始碼檔案，這個專案的原始碼都是在pod-library(專案)目錄下，在這裡指定了獲取pod-library/Classes/**/*目錄下的所有檔案。
    也可以分別指定不同的檔案，比如需要使用swift就需要指定目錄下面的.swift檔案，有c++原始碼的還可以指定.mm檔案。
    多個目錄使用,分割類似於下面的配置：

    'pod-library/.{h,m}’，'pod-library/utils/.{h,m}’

  • dependency指定類庫中的依賴庫
    這個語法和podfile檔案裡面的pod檔案很像，s.dependency後面指定類庫名稱和版本，如果加其他類庫的話需要再新起一行，比如新增OpenSSL的類庫：

    s.dependency 'OpenSSL', '1.0.110'

  • 指定類庫中的資原始檔
    指定類庫中的資原始檔，我們可以抽象出來一些公用的控制元件，比如progress，alert，prompt 等，這些控制元件需要使用資原始檔。一般我們有可能打包的資源有聲音，圖片，xib...，有兩種指定資原始檔的方式：

    resources 和 resource_bundles

resources 指定的資源在呼叫類庫的專案中可以直接呼叫，和呼叫專案內的資源一樣。
而resource_bundles把需要呼叫的資源編譯到bundle來呼叫，
在這裡我使用的是resources定義資原始檔。

  • name 類庫的名稱
  • version 指定版本
  • license 開源協議
  • description 簡單描述
  • homepage 個人主頁
  • author 作者資訊
  • source 指定git地址
  • platform 指定iOS版本
  • requires_arc 指定支援arc
  • vendored_frameworks 本地的frameworks
  • frameworks 指定需要使用的系統frameworks
  • preserve_paths 本地的.a庫

使用上面的配置可以完成把一個專案配置成Cocoapods類庫，在專案中有些只是配置成一個類庫並不能滿足需求，有可能會需要一個以上的類庫，例如一個是core核心類庫，一個是logic業務邏輯類庫，還可以使用subspec實現上述目的。

subspec

subspec是pod的一個屬性，用來指定pod類庫中的子類庫。配置subspec首先需要指定一個子類庫，之後再指定子類庫對於的配置即可。配置如下：

s.subspec "Core" do |core|
    core.source_files="pod-library/Core/**/*"
  end複製程式碼

在定義一個自類庫，該類庫依賴上面定義的子類庫Core，定義如下：

s.subspec "Logic" do |logic|
    logic.dependency 'pod-library/Core'
    logic.source_files="pod-library/Logic/**/*"
  end複製程式碼

這樣就完成了兩個子類庫的定義，在呼叫的時候直接指定對應的類庫即可，例如:

pod 'pod-library/Core', :path => '../'

以上是定義類庫的內容，下面再看下如何在其他專案中呼叫已定義的類庫。

在專案中呼叫pod-library

建立一個和pod-library同級的目錄，命名為pod-project,用來呼叫pod-library。
在pod-project目錄中新增Podfile。
指定對pod-library的依賴：

  platform :ios, '8.0'
  target "pod-project" do
      pod 'pod-library', :path => 'pod-library'
      use_frameworks! 
  end複製程式碼

注意，這裡必須使用use_frameworks!，Pod中使用Swift的類庫必須使用其標識，不然會出現錯誤:

Pods written in Swift can only be integrated as frameworks; this feature is still in beta. Add `use_frameworks!` to your Podfile or target to opt into using it.複製程式碼

這裡需要使用了path來指定本地的目錄作為庫的地址，這樣的作用是可以在pod-project專案中直接更新pod-library中的程式碼,執行安裝命令：

pod install

可以看到pod先去下載pod-library，然後再下載pod-library的依賴。
在pod-project如何更改pod-library的程式碼呢？
下載完依賴庫之後，開啟pod-project.xcworkspace檔案，會看到pods多了一個development pods的目錄，這個目錄下有pod-library專案的程式碼以及資源。可以在這裡直接編輯pod-library裡的程式碼，然後就可以直接提交程式碼了，這是和其他的pods裡的檔案最大的區別，不加path的檔案修改之後的檔案在執行pod install或pod update之後就會被重新覆蓋掉。
（這裡pod-library使用的是git submodule的形式包含在專案中的）

參考 :
making cocoa pods
Using Pod Lib Create

開源地址：
pod-library
pod-project

相關文章