這篇有點亂渺杉,簡潔版請點擊CocoaPods建立私有倉庫 spec repo 整理篇
介紹
好多項目里都有公共的組件描姚,copy來瓶珊,copy去很容易出錯,而且不容易維護飘千,所以就想到用用cocoapods 建自己的私有庫堂鲜,Carthage用法雖然相對簡單,但是它是把公共組件都放在framework里不容易單步調試护奈,所以我還是選擇用Cocoapods 來建立私有倉庫
參考使用Cocoapods創(chuàng)建私有podspec
用法
1. 創(chuàng)建私有Spec Repo
先來說第一步缔莲,什么是Spec Repo?它是所有的Pods的一個索引霉旗,就是一個容器酌予,所有公開的Pods都在這個里面磺箕,它實際是一個Git倉庫remote端在GitHub上,但是當你使用了Cocoapods后它會被clone到本地的~/.cocoapods/repos目錄下抛虫,可以進入到這個目錄看到master文件夾就是這個官方的Spec Repo了。這個master目錄的結構是這個樣子的
├── Specs
└── [SPEC_NAME]
└── [VERSION]
└── [SPEC_NAME].podspec
因此我們需要創(chuàng)建一個類似于master的私有Spec Repo简僧,這里我們可以fork官方的Repo建椰,也可以自己創(chuàng)建,個人建議不fork岛马,因為你只是想添加自己的Pods棉姐,沒有必要把現(xiàn)有的公開Pods都copy一份。所以創(chuàng)建一個 Git倉庫啦逆,這個倉庫你可以創(chuàng)建私有的也可以創(chuàng)建公開的伞矩,不過既然私有的Spec Repo,還是創(chuàng)建私有的倉庫吧夏志,需要注意的就是如果項目中有其他同事共同開發(fā)的話乃坤,你還要給他這個Git倉庫的權限。因為GitHub的私有倉庫是收費的沟蔑,我還不是GitHub的付費用戶湿诊,所以我使用了其他Git服務,我使用的是CODING瘦材,當然還有其他的可供選擇開源中國厅须、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
此時如果成功的話進入到~/.cocoapods/repos目錄下就可以看到Specs-Repo(只是個名字,會根據(jù)你設置的名稱而不同) 這個目錄了食棕。至此第一步創(chuàng)建私有Spec Repo完成朗和。
如下圖所示 ↓,但是剛開始的時候你的Specs-Repo應該是空的簿晓,只是多個Specs-Repo文件夾而已
執(zhí)行 pod repo list 查看repo列表
$pod repo list
PS:如果有其他合作人員共同使用這個私有Spec Repo的話在他有對應Git倉庫的權限的前提下執(zhí)行相同的命令添加這個Spec Repo即可眶拉。
2. 創(chuàng)建Pod項目工程文件
參考CocoaPods私有庫配置筆記
說白了,就是你項目所用的公共類抢蚀,你以后項目里所要引用的镀层,類似于AFNetworking
這個我已經建好了 UIButton-Vertical (UIButton title 和image 垂直顯示)
你步就是根據(jù)你們自己的需要,自己設置了皿曲。(__) 嘻嘻……
如果是有現(xiàn)有的組件項目唱逢,并且在Git的版本管理下,那么這一步就算完成了屋休,可以直接進行下一步了坞古。
如果你的組件還在你冗余龐大的項目中,需要拆分出來或者需要自己從零開始創(chuàng)建一個組件庫劫樟,那么我建議你使用Cocoapods提供的一個工具將第二步與第三步結合起來做痪枫。
現(xiàn)在來說一下這個工具织堂,相關的文檔介紹是Using Pod Lib Create 就拿我創(chuàng)建的podTestLibrary為例子具體講一下這里是如何操作的,先cd到要創(chuàng)建項目的目錄然后執(zhí)行
$ pod lib create UIButton-Vertical
之后他會問你四個問題奶陈,1.是否需要一個例子工程易阳;2.選擇一個測試框架;3.是否基于View測試吃粒;4.類的前綴潦俺;4個問題的具體介紹可以去看官方文檔,我這里選擇的是1.yes徐勃;2.Specta/Expecta事示;3.yes;4.PTL僻肖。 問完這4個問題他會自動執(zhí)行pod install命令創(chuà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é)議 默認MIT
├── Pod
組件的目錄
│ ├── Assets
資源文件
│ └── Classes
類文件
├── PodTestLibrary.podspec
第三步要創(chuàng)建的podspec文件
└── README.md
markdown格式的README
9 directories, 5 files
以上是項目生成的目錄結構及相關介紹。
接下來就是向Pod文件夾中添加庫文件和資源臀脏,并配置podspec文件劝堪,我把一個網絡模塊的共有組件放入Pod/Classes中,然后進入Example文件夾執(zhí)行pod update命令谁榜,再打開項目工程可以看到幅聘,剛剛添加的組件已經在Pods子工程下Development Pods/PodTestLibrary中了,然后編輯demo工程窃植,測試組件帝蒿,我并沒有使用提供的測試框架進行測試,這里就先不介紹了巷怜。
注:這里需要注意的是每當你向Pod中添加了新的文件或者以后更新了podspec的版本都需要重新執(zhí)行一遍pod update命令葛超。
測試無誤后需要將該項目添加并推送到遠端倉庫,并編輯podspec文件延塑。
通過Cocoapods創(chuàng)建出來的目錄本身就在本地的Git管理下绣张,我們需要做的就是給它添加遠端倉庫,同樣去GitHub或其他的Git服務提供商那里創(chuàng)建一個私有的倉庫关带,拿到SSH地址侥涵,然后cd到PodTestLibrary目錄
$ git commit -s -m
"Initial Commit of Library"
$ git remote add origin git@coding.net:wtlucky/podTestLibrary.git #添加遠端倉庫
$ git push origin master #提交到遠端倉庫 ```
因為podspec文件中獲取Git版本控制的項目還需要tag號,所以我們要打上一個tag宋雏,
```$ git tag -m
"first release"
"0.1.0"
$ git push --tags #推送tag到遠端倉庫```
做完這些就可以開始編輯podspec文件了芜飘,它是一個Ruby的文件,把編輯器的格式改成Ruby就能看到語法高亮磨总,下面我貼上我的podspec文件嗦明,并在后面以注釋的形式說明每個字段的含義,沒有涉及到的字段可以去[官方文檔](http://guides.cocoapods.org/syntax/podspec.html)查閱
Pod::Spec.new do |s|
s.name = 'UIButton-Vertical' #名稱
s.version = '0.1.0' #版本號
s.summary = 'UIButtom 垂直顯示Title 和 Image' #簡短介紹
s.description = <<-DESC
OC,UIButtom 垂直顯示Title 和 Image蚪燕,
DESC
s.homepage = 'https://github.com/lizhi0123/UIButton-Vertical' #主頁
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文件后娶牌,需要驗證一下這個文件是否可用奔浅,如果有任何WARNING或者ERROR都是不可以的,它就不能被添加到Spec Repo中诗良,不過xcode的WARNING是可以存在的汹桦,驗證需要執(zhí)行一下命令
$ pod lib lint
當你看到
-> PodTestLibrary (0.1.0)
PodTestLibrary passed validation.
時,說明驗證通過了鉴裹,不過這只是這個podspec文件是合格的营勤,不一定說明這個Pod是可以用的,我們需要在本地做一下驗證壹罚。
> 驗證遠程庫
pod spec lint
#### 3.創(chuàng)建podspec文件
**[3分鐘讓你的框架支持cocoapods,podspec文件講解 ](http://www.reibang.com/p/8a7b9232cbab)** 我們需要執(zhí)行此博客的 第1-7步,就可以了,不需要執(zhí)行第8寿羞,9猖凛,10步。
##### ①.創(chuàng)建.podspec
然后cd到你項目的目錄,執(zhí)行命令 `你也可以使用vim創(chuàng)建,只要創(chuàng)建就可以了 `
// 注 UIButton-Vertical 這個是你框架的名稱
$ pod spec create UIButton-Vertical
##### ②.編輯.podspec
創(chuàng)建好后打開,刪除注釋, 前面有#的為注釋,如果你想知道每個東西的含義可以了解一下整理之后的文件
Pod::Spec.new do |s|
s.name = 'UIButton-Vertical' #名稱
s.version = '0.1.0' #版本號
s.summary = 'UIButtom 垂直顯示Title 和 Image' #簡短介紹
s.description = <<-DESC
OC,UIButtom 垂直顯示Title 和 Image绪穆,
DESC
s.homepage = 'https://github.com/lizhi0123/UIButton-Vertical' #主頁
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 搜索的關鍵詞,注意這里一定要和.podspec的名稱一樣,否則報錯
s.version:版本號
s.ios.deployment_target:支持的pod最低版本
s.summary: 簡介
s.homepage:項目主頁地址
s.license:許可證
s.author:作者
s.social_media_url:社交網址,這里我寫的微博默認是Twitter,如果你寫Twitter的話,你的podspec發(fā)布成功后會@你
s.source:項目的地址
s.source_files:需要包含的源文件
s.resources: 資源文件
s.requires_arc: 是否支持ARC
s.dependency:依賴庫,不能依賴未發(fā)布的庫
s.dependency:依賴庫玖院,如有多個可以這樣寫
例如
s.dependency = 'AFNetworking'
> s.license= { :type => "MIT", :file => "LICENSE" }
> 這里建議大家這樣寫,如果寫別的會報警告,導致后面一直提交失敗,這里軍哥已經跳了很多坑
* source_files:寫法及含義建議
大家寫第一種或者第二種
"YJSettingTableView/*"
"YJSettingTableView/YJSettingTableView/*.{h,m}"
"YJSettingTableView/**/*.h"
* “*” 表示匹配所有文件
* “*.{h,m}” 表示匹配所有以.h和.m結尾的文件
* “**” 表示匹配所有子目錄
* **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" 表示將這個Pod版本與Git倉庫中某個commit綁定
* tag => 1.0.0 表示將這個Pod版本與Git倉庫中某個版本的comit綁定
* tag => s.version 表示將這個Pod版本與Git倉庫中相同版本的comit綁定
##### ③.創(chuàng)建LICENSE(許可證/授權)文件,此文件必須要有
軍哥在這里被坑過,創(chuàng)建一個文件名字命名為LICENSE,內容為:只需要把前面的版權改一下就行了,后面的都一樣
> 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 的項目提交 Git
##### ⑤.打tag
> 因為cocoapods是依賴tag版本的,所以必須打tag,以后再次更新只需要把你的項目打一個tag然后修改.podspec文件中的版本接著提交到cocoapods官方就可以了,提交命令請看下面
執(zhí)行命令//
```為git打tag, 第一次需要在前面加一個vgit tag "v1.0.0"
//將tag推送到遠程倉庫
git push --tags```
7.驗證.podspec文件
* 到此檢查一下你工程下面的文件, 你的項目, .podspec文件, LICENSE文件
* 驗證會先測試本地 .podspec 文件是否存在語法錯誤.![](http://upload-images.jianshu.io/upload_images/2384741-992f55282e8aaf21.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)文件目錄
然后執(zhí)行命令
// --verbose 如果驗證失敗會報錯誤信息
pod spec lint UIButton-Vertical.podspec --verbose
驗證過程中:
-> UIButton-Vertical
驗證成功后:UIButton-Vertical.podspec passed validation.
![](http://upload-images.jianshu.io/upload_images/2384741-bdfe04539dbb6fbd.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)如圖
驗證失敗:[!] The spec did not pass validation, due to 1 error.
這個過程會出現(xiàn)很多錯誤,這里不一一列舉,大家按照錯誤信息自行修改,不過一般不會出現(xiàn)錯誤,只要你按照軍哥說的做,基本上是沒有問題的,因為軍哥走過的坑已經告訴你們了
#### 4.本地測試podspec文件
我們可以創(chuà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命令安裝依賴,打開項目工程郊酒,可以看到庫文件都被加載到Pods子項目中了遇绞,不過它們并沒有在Pods目錄下,而是跟測試項目一樣存在于Development Pods/PodTestLibrary中燎窘,這是因為我們是在本地測試摹闽,而沒有把podspec文件添加到Spec Repo中的緣故。
在項目中編寫代碼褐健,測試庫文件無誤后就可以開始下一步了付鹿,提交podspec到Spec Repo中。
#### 5.向Spec Repo提交podspec
向Spec Repo提交podspec需要完成兩點一個是podspec必須通過驗證無誤蚜迅,在一個就是刪掉無用的注釋(這個不是必須的舵匾,為了規(guī)范還是刪掉吧)。 向我們的私有Spec Repo提交podspec只需要一個命令
$ pod repo push Specs-Repo UIButton-Vertical.podspec #前面是本地Repo名字 后面是podspec名字
完成之后這個組件庫就添加到我們的私有Spec Repo中了慢叨,可以進入到~/.cocoapods/repos/Specs-Repo目錄下查看
> ├── LICENSE
> ├── UIButton-Vertical
> │ └── 0.1.0
> │ └── UIButton-Vertical.podspec
> └── README.md
再去看我們的Spec Repo遠端倉庫纽匙,也有了一次提交,這個podspec也已經被Push上去了拍谐。
至此烛缔,我們的這個組件庫就已經制作添加完成了馏段,使用pod search命令就可以查到我們自己的庫了
$ 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的官方庫了践瓷,可以使用trunk工具院喜,具體可以查看[官方文檔](http://guides.cocoapods.org/making/getting-setup-with-trunk.html)。
#### 6. 使用制作好的Pod
在完成這一系列步驟之后晕翠,我們就可以在正式項目中使用這個私有的Pod了只需要在項目的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'
私有庫
pod 'UIButton-Vertical', '~> 0.0.1'
注意:
`source 'https://github.com/CocoaPods/Specs.git' #必須寫要不然search的時候找不到cocoapods里的庫`
然后執(zhí)行`pod update`喷舀,更新庫依賴,然后打卡項目可以看到淋肾,我們自己的庫文件已經出現(xiàn)在Pods子項目中的Pods子目錄下了硫麻,而不再是Development Pods。
pod update 更新所有的庫樊卓,有時不需要更新master 庫拿愧,可以用 `
$ pod repo update [NAME]`
然后再執(zhí)行 pod search 時 就會顯示 你自己建的庫
常用命令
把庫文件QKChineseVerifyCode.podspec添加到 Specs-Repo 私有庫中
$ pod repo push Specs-Repo QKChineseVerifyCode.podspec --allow-warnings
source 'https://github.com/lizhi0123/Specs-Repo.git'
source 'https://github.com/CocoaPods/Specs.git'