這篇有點(diǎn)亂,簡(jiǎn)潔版請(qǐng)點(diǎn)擊CocoaPods建立私有倉(cāng)庫(kù) spec repo 整理篇
介紹
好多項(xiàng)目里都有公共的組件,copy來,copy去很容易出錯(cuò),而且不容易維護(hù),所以就想到用用cocoapods 建自己的私有庫(kù),Carthage用法雖然相對(duì)簡(jiǎn)單,但是它是把公共組件都放在framework里不容易單步調(diào)試,所以我還是選擇用Cocoapods 來建立私有倉(cāng)庫(kù)
參考使用Cocoapods創(chuàng)建私有podspec
用法
1. 創(chuàng)建私有Spec Repo
先來說第一步,什么是Spec Repo?它是所有的Pods的一個(gè)索引,就是一個(gè)容器,所有公開的Pods都在這個(gè)里面,它實(shí)際是一個(gè)Git倉(cāng)庫(kù)remote端在GitHub上,但是當(dāng)你使用了Cocoapods后它會(huì)被clone到本地的~/.cocoapods/repos目錄下,可以進(jìn)入到這個(gè)目錄看到master文件夾就是這個(gè)官方的Spec Repo了。這個(gè)master目錄的結(jié)構(gòu)是這個(gè)樣子的
├── Specs
└── [SPEC_NAME]
└── [VERSION]
└── [SPEC_NAME].podspec
因此我們需要?jiǎng)?chuàng)建一個(gè)類似于master的私有Spec Repo,這里我們可以fork官方的Repo,也可以自己創(chuàng)建,個(gè)人建議不fork,因?yàn)槟阒皇窍胩砑幼约旱腜ods,沒有必要把現(xiàn)有的公開Pods都copy一份。所以創(chuàng)建一個(gè) Git倉(cāng)庫(kù),這個(gè)倉(cāng)庫(kù)你可以創(chuàng)建私有的也可以創(chuàng)建公開的,不過既然私有的Spec Repo,還是創(chuàng)建私有的倉(cāng)庫(kù)吧,需要注意的就是如果項(xiàng)目中有其他同事共同開發(fā)的話,你還要給他這個(gè)Git倉(cāng)庫(kù)的權(quán)限。因?yàn)镚itHub的私有倉(cāng)庫(kù)是收費(fèi)的,我還不是GitHub的付費(fèi)用戶,所以我使用了其他Git服務(wù),我使用的是CODING,當(dāng)然還有其他的可供選擇開源中國(guó)、Bitbucket以及CSDN Code.
創(chuàng)建完成之后在Terminal中執(zhí)行如下命令
# pod repo add [Private Repo Name] [GitHub HTTPS clone URL]
$ pod repo add Specs-Repo https://github.com/lizhi0123/Specs-Repo.git
此時(shí)如果成功的話進(jìn)入到~/.cocoapods/repos目錄下就可以看到Specs-Repo(只是個(gè)名字,會(huì)根據(jù)你設(shè)置的名稱而不同) 這個(gè)目錄了。至此第一步創(chuàng)建私有Spec Repo完成。
如下圖所示 ↓,但是剛開始的時(shí)候你的Specs-Repo應(yīng)該是空的,只是多個(gè)Specs-Repo文件夾而已
執(zhí)行 pod repo list 查看repo列表
$pod repo list
PS:如果有其他合作人員共同使用這個(gè)私有Spec Repo的話在他有對(duì)應(yīng)Git倉(cāng)庫(kù)的權(quán)限的前提下執(zhí)行相同的命令添加這個(gè)Spec Repo即可。
2. 創(chuàng)建Pod項(xiàng)目工程文件
參考CocoaPods私有庫(kù)配置筆記
說白了,就是你項(xiàng)目所用的公共類,你以后項(xiàng)目里所要引用的,類似于AFNetworking
這個(gè)我已經(jīng)建好了 UIButton-Vertical (UIButton title 和image 垂直顯示)
你步就是根據(jù)你們自己的需要,自己設(shè)置了。(__) 嘻嘻……
如果是有現(xiàn)有的組件項(xiàng)目,并且在Git的版本管理下,那么這一步就算完成了,可以直接進(jìn)行下一步了。
如果你的組件還在你冗余龐大的項(xiàng)目中,需要拆分出來或者需要自己從零開始創(chuàng)建一個(gè)組件庫(kù),那么我建議你使用Cocoapods提供的一個(gè)工具將第二步與第三步結(jié)合起來做。
現(xiàn)在來說一下這個(gè)工具,相關(guān)的文檔介紹是Using Pod Lib Create 就拿我創(chuàng)建的podTestLibrary為例子具體講一下這里是如何操作的,先cd到要?jiǎng)?chuàng)建項(xiàng)目的目錄然后執(zhí)行
$ pod lib create UIButton-Vertical
之后他會(huì)問你四個(gè)問題,1.是否需要一個(gè)例子工程;2.選擇一個(gè)測(cè)試框架;3.是否基于View測(cè)試;4.類的前綴;4個(gè)問題的具體介紹可以去看官方文檔,我這里選擇的是1.yes;2.Specta/Expecta;3.yes;4.PTL。 問完這4個(gè)問題他會(huì)自動(dòng)執(zhí)行pod install命令創(chuàng)建項(xiàng)目并生成依賴。
$ tree PodTestLibrary -L 2
PodTestLibrary
├── Example
demo APP
│ ├── PodTestLibrary
│ ├── PodTestLibrary.xcodeproj
│ ├── PodTestLibrary.xcworkspace
│ ├── Podfile
demo APP 的依賴描述文件
│ ├── Podfile.lock
│ ├── Pods
demo APP 的依賴文件
│ └── Tests
├── LICENSE
開源協(xié)議 默認(rèn)MIT
├── Pod
組件的目錄
│ ├── Assets
資源文件
│ └── Classes
類文件
├── PodTestLibrary.podspec
第三步要?jiǎng)?chuàng)建的podspec文件
└── README.md
markdown格式的README
9 directories, 5 files
以上是項(xiàng)目生成的目錄結(jié)構(gòu)及相關(guān)介紹。
接下來就是向Pod文件夾中添加庫(kù)文件和資源,并配置podspec文件,我把一個(gè)網(wǎng)絡(luò)模塊的共有組件放入Pod/Classes中,然后進(jìn)入Example文件夾執(zhí)行pod update命令,再打開項(xiàng)目工程可以看到,剛剛添加的組件已經(jīng)在Pods子工程下Development Pods/PodTestLibrary中了,然后編輯demo工程,測(cè)試組件,我并沒有使用提供的測(cè)試框架進(jìn)行測(cè)試,這里就先不介紹了。
注:這里需要注意的是每當(dāng)你向Pod中添加了新的文件或者以后更新了podspec的版本都需要重新執(zhí)行一遍pod update命令。
測(cè)試無誤后需要將該項(xiàng)目添加并推送到遠(yuǎn)端倉(cāng)庫(kù),并編輯podspec文件。
通過Cocoapods創(chuàng)建出來的目錄本身就在本地的Git管理下,我們需要做的就是給它添加遠(yuǎn)端倉(cāng)庫(kù),同樣去GitHub或其他的Git服務(wù)提供商那里創(chuàng)建一個(gè)私有的倉(cāng)庫(kù),拿到SSH地址,然后cd到PodTestLibrary目錄
$ git commit -s -m
"Initial Commit of Library"
$ git remote add origin git@coding.net:wtlucky/podTestLibrary.git #添加遠(yuǎn)端倉(cāng)庫(kù)
$ git push origin master #提交到遠(yuǎn)端倉(cāng)庫(kù) ```
因?yàn)閜odspec文件中獲取Git版本控制的項(xiàng)目還需要tag號(hào),所以我們要打上一個(gè)tag,
```$ git tag -m
"first release"
"0.1.0"
$ git push --tags #推送tag到遠(yuǎn)端倉(cāng)庫(kù)```
做完這些就可以開始編輯podspec文件了,它是一個(gè)Ruby的文件,把編輯器的格式改成Ruby就能看到語(yǔ)法高亮,下面我貼上我的podspec文件,并在后面以注釋的形式說明每個(gè)字段的含義,沒有涉及到的字段可以去[官方文檔](http://guides.cocoapods.org/syntax/podspec.html)查閱
Pod::Spec.new do |s|
s.name = 'UIButton-Vertical' #名稱
s.version = '0.1.0' #版本號(hào)
s.summary = 'UIButtom 垂直顯示Title 和 Image' #簡(jiǎn)短介紹
s.description = <<-DESC
OC,UIButtom 垂直顯示Title 和 Image,
DESC
s.homepage = 'https://github.com/lizhi0123/UIButton-Vertical' #主頁(yè)
s.license = { :type => 'MIT', :file => 'LICENSE' } #開源協(xié)議
s.author = { 'lizhi0123' => 'zhang_zhi_li@163.com' } #作者信息
s.source = { :git => 'https://github.com/lizhi0123/UIButton-Vertical.git', :tag => s.version.to_s } #git地址
s.ios.deployment_target = '8.0' #最低支持的ios版本
s.source_files = 'UIButton-Vertical/Classes/*/' #開源類
end
編輯完podspec文件后,需要驗(yàn)證一下這個(gè)文件是否可用,如果有任何WARNING或者ERROR都是不可以的,它就不能被添加到Spec Repo中,不過xcode的WARNING是可以存在的,驗(yàn)證需要執(zhí)行一下命令
$ pod lib lint
當(dāng)你看到
-> PodTestLibrary (0.1.0)
PodTestLibrary passed validation.
時(shí),說明驗(yàn)證通過了,不過這只是這個(gè)podspec文件是合格的,不一定說明這個(gè)Pod是可以用的,我們需要在本地做一下驗(yàn)證。
> 驗(yàn)證遠(yuǎn)程庫(kù)
pod spec lint
#### 3.創(chuàng)建podspec文件
**[3分鐘讓你的框架支持cocoapods,podspec文件講解 ](http://www.lxweimin.com/p/8a7b9232cbab)** 我們需要執(zhí)行此博客的 第1-7步,就可以了,不需要執(zhí)行第8,9,10步。
##### ①.創(chuàng)建.podspec
然后cd到你項(xiàng)目的目錄,執(zhí)行命令 `你也可以使用vim創(chuàng)建,只要?jiǎng)?chuàng)建就可以了 `
// 注 UIButton-Vertical 這個(gè)是你框架的名稱
$ pod spec create UIButton-Vertical
##### ②.編輯.podspec
創(chuàng)建好后打開,刪除注釋, 前面有#的為注釋,如果你想知道每個(gè)東西的含義可以了解一下整理之后的文件
Pod::Spec.new do |s|
s.name = 'UIButton-Vertical' #名稱
s.version = '0.1.0' #版本號(hào)
s.summary = 'UIButtom 垂直顯示Title 和 Image' #簡(jiǎn)短介紹
s.description = <<-DESC
OC,UIButtom 垂直顯示Title 和 Image,
DESC
s.homepage = 'https://github.com/lizhi0123/UIButton-Vertical' #主頁(yè)
s.license = { :type => 'MIT', :file => 'LICENSE' } #開源協(xié)議
s.author = { 'lizhi0123' => 'zhang_zhi_li@163.com' } #作者信息
s.source = { :git => 'https://github.com/lizhi0123/UIButton-Vertical.git', :tag => s.version.to_s } #git地址
s.ios.deployment_target = '8.0' #最低支持的ios版本
s.source_files = 'UIButton-Vertical/Classes/*/' #開源類
end
接下來講解一下每行代碼的含義
s.name:名稱,pod search 搜索的關(guān)鍵詞,注意這里一定要和.podspec的名稱一樣,否則報(bào)錯(cuò)
s.version:版本號(hào)
s.ios.deployment_target:支持的pod最低版本
s.summary: 簡(jiǎn)介
s.homepage:項(xiàng)目主頁(yè)地址
s.license:許可證
s.author:作者
s.social_media_url:社交網(wǎng)址,這里我寫的微博默認(rèn)是Twitter,如果你寫Twitter的話,你的podspec發(fā)布成功后會(huì)@你
s.source:項(xiàng)目的地址
s.source_files:需要包含的源文件
s.resources: 資源文件
s.requires_arc: 是否支持ARC
s.dependency:依賴庫(kù),不能依賴未發(fā)布的庫(kù)
s.dependency:依賴庫(kù),如有多個(gè)可以這樣寫
例如
s.dependency = 'AFNetworking'
> s.license= { :type => "MIT", :file => "LICENSE" }
> 這里建議大家這樣寫,如果寫別的會(huì)報(bào)警告,導(dǎo)致后面一直提交失敗,這里軍哥已經(jīng)跳了很多坑
* source_files:寫法及含義建議
大家寫第一種或者第二種
"YJSettingTableView/*"
"YJSettingTableView/YJSettingTableView/*.{h,m}"
"YJSettingTableView/**/*.h"
* “*” 表示匹配所有文件
* “*.{h,m}” 表示匹配所有以.h和.m結(jié)尾的文件
* “**” 表示匹配所有子目錄
* **s.source 常見寫法**
s.source = { :git => "https://github.com/coderYJ/YJSettingTableView.git", :commit => "68defea" }
s.source = { :git => "https://github.com/coderYJ/YJSettingTableView.git", :tag => 1.0.0 }
s.source = { :git => "https://github.com/coderYJ/YJSettingTableView.git", :tag => s.version }
* commit => "68defea" 表示將這個(gè)Pod版本與Git倉(cāng)庫(kù)中某個(gè)commit綁定
* tag => 1.0.0 表示將這個(gè)Pod版本與Git倉(cāng)庫(kù)中某個(gè)版本的comit綁定
* tag => s.version 表示將這個(gè)Pod版本與Git倉(cāng)庫(kù)中相同版本的comit綁定
##### ③.創(chuàng)建LICENSE(許可證/授權(quán))文件,此文件必須要有
軍哥在這里被坑過,創(chuàng)建一個(gè)文件名字命名為L(zhǎng)ICENSE,內(nèi)容為:只需要把前面的版權(quán)改一下就行了,后面的都一樣
> Copyright (c) 2011-2016 YJSettingTableView Software Foundation (https://github.com/coderYJ/YJSettingTableView/)Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS INTHE SOFTWARE.
##### ④.上傳到Git
將包含配置好的 .podspec, LICENSE 的項(xiàng)目提交 Git
##### ⑤.打tag
> 因?yàn)閏ocoapods是依賴tag版本的,所以必須打tag,以后再次更新只需要把你的項(xiàng)目打一個(gè)tag然后修改.podspec文件中的版本接著提交到cocoapods官方就可以了,提交命令請(qǐng)看下面
執(zhí)行命令//
```為git打tag, 第一次需要在前面加一個(gè)vgit tag "v1.0.0"
//將tag推送到遠(yuǎn)程倉(cāng)庫(kù)
git push --tags```
7.驗(yàn)證.podspec文件
* 到此檢查一下你工程下面的文件, 你的項(xiàng)目, .podspec文件, LICENSE文件
* 驗(yàn)證會(huì)先測(cè)試本地 .podspec 文件是否存在語(yǔ)法錯(cuò)誤.文件目錄
然后執(zhí)行命令
// --verbose 如果驗(yàn)證失敗會(huì)報(bào)錯(cuò)誤信息
pod spec lint UIButton-Vertical.podspec --verbose
驗(yàn)證過程中:
-> UIButton-Vertical
驗(yàn)證成功后:UIButton-Vertical.podspec passed validation.
如圖
驗(yàn)證失敗:[!] The spec did not pass validation, due to 1 error.
這個(gè)過程會(huì)出現(xiàn)很多錯(cuò)誤,這里不一一列舉,大家按照錯(cuò)誤信息自行修改,不過一般不會(huì)出現(xiàn)錯(cuò)誤,只要你按照軍哥說的做,基本上是沒有問題的,因?yàn)檐姼缱哌^的坑已經(jīng)告訴你們了
#### 4.本地測(cè)試podspec文件
我們可以創(chuàng)建一個(gè)新的項(xiàng)目,在這個(gè)項(xiàng)目的Podfile文件中直接指定剛才創(chuàng)建編輯好的podspec文件,看是否可用。 在Podfile中我們可以這樣編輯,有兩種方式
platform :ios, '7.0'
pod 'UIButton-Vertical', :path => '~/code/Cocoapods/podTest/UIButton-Vertical' #指定路徑
pod 'UIButton-Vertical', :podspec => '~/Desktop/lizhi0123Github/UIButton-Vertical/UIButton-Vertical.podspec' #指定podspec文件
然后執(zhí)行pod install命令安裝依賴,打開項(xiàng)目工程,可以看到庫(kù)文件都被加載到Pods子項(xiàng)目中了,不過它們并沒有在Pods目錄下,而是跟測(cè)試項(xiàng)目一樣存在于Development Pods/PodTestLibrary中,這是因?yàn)槲覀兪窃诒镜販y(cè)試,而沒有把podspec文件添加到Spec Repo中的緣故。
在項(xiàng)目中編寫代碼,測(cè)試庫(kù)文件無誤后就可以開始下一步了,提交podspec到Spec Repo中。
#### 5.向Spec Repo提交podspec
向Spec Repo提交podspec需要完成兩點(diǎn)一個(gè)是podspec必須通過驗(yàn)證無誤,在一個(gè)就是刪掉無用的注釋(這個(gè)不是必須的,為了規(guī)范還是刪掉吧)。 向我們的私有Spec Repo提交podspec只需要一個(gè)命令
$ pod repo push Specs-Repo UIButton-Vertical.podspec #前面是本地Repo名字 后面是podspec名字
完成之后這個(gè)組件庫(kù)就添加到我們的私有Spec Repo中了,可以進(jìn)入到~/.cocoapods/repos/Specs-Repo目錄下查看
> ├── LICENSE
> ├── UIButton-Vertical
> │ └── 0.1.0
> │ └── UIButton-Vertical.podspec
> └── README.md
再去看我們的Spec Repo遠(yuǎn)端倉(cāng)庫(kù),也有了一次提交,這個(gè)podspec也已經(jīng)被Push上去了。
至此,我們的這個(gè)組件庫(kù)就已經(jīng)制作添加完成了,使用pod search命令就可以查到我們自己的庫(kù)了
$ pod search UIButton-Vertical
-> UIButton-Vertical (0.1.0)
Just Testing.
pod
'UIButton-Vertical'
,
'~> 0.1.0'
- Homepage: https:
//coding.net/u/wtlucky/p/podTestLibrary
- Source: https:
//coding.net/wtlucky/podTestLibrary.git
- Versions: 0.1.0 [WTSpecs repo]
這里說的是添加到私有的Repo,如果要添加到Cocoapods的官方庫(kù)了,可以使用trunk工具,具體可以查看[官方文檔](http://guides.cocoapods.org/making/getting-setup-with-trunk.html)。
#### 6. 使用制作好的Pod
在完成這一系列步驟之后,我們就可以在正式項(xiàng)目中使用這個(gè)私有的Pod了只需要在項(xiàng)目的Podfile里增加以下一行代碼即可
source 'https://github.com/CocoaPods/Specs.git'
私有Spec Repo
source 'https://github.com/lizhi0123/Specs-Repo.git'
pod 'MBProgressHUD', '~> 0.9'
pod 'AFNetworking', '~> 3.1.0'
私有庫(kù)
pod 'UIButton-Vertical', '~> 0.0.1'
注意:
`source 'https://github.com/CocoaPods/Specs.git' #必須寫要不然search的時(shí)候找不到cocoapods里的庫(kù)`
然后執(zhí)行`pod update`,更新庫(kù)依賴,然后打卡項(xiàng)目可以看到,我們自己的庫(kù)文件已經(jīng)出現(xiàn)在Pods子項(xiàng)目中的Pods子目錄下了,而不再是Development Pods。
pod update 更新所有的庫(kù),有時(shí)不需要更新master 庫(kù),可以用 `
$ pod repo update [NAME]`
然后再執(zhí)行 pod search 時(shí) 就會(huì)顯示 你自己建的庫(kù)
常用命令
把庫(kù)文件QKChineseVerifyCode.podspec添加到 Specs-Repo 私有庫(kù)中
$ pod repo push Specs-Repo QKChineseVerifyCode.podspec --allow-warnings
source 'https://github.com/lizhi0123/Specs-Repo.git'
source 'https://github.com/CocoaPods/Specs.git'