做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