iOS組件化 - 制作pod上傳自己的Github

一.前言

  • 隨著公司項目的不斷迭代,業務的天馬行空。工程的代碼量和業務邏輯也越來越復雜,原始的開發模式和架構已經無法滿足我們的業務發展速度,想分離出一個模塊更是困難。直到組件化的誕生,這也是我們為什么要擁抱組件化的原因。
    不得不說組件化帶來的優點還有有目共睹的:
    場景 如:
    • 聰明的產品張三有一天說:我們的IM業務日活、留存數據非常好,所以我們想單獨拆出這個業務做個馬甲包。
    • 大廠~項目管理說我們的項目是否做業務之間隔離了沒有。
    • 隨著業務不斷增加,編譯速度和打包速度越來越慢。
    • 大廠~多個業務多人同時開發,等等。
  • 哈哈!以上都是題外話,下面開始正文。

組件化分類:
共有庫 - 所有人都能使用。(\color{red}{本文以共有庫為例})。
私有庫 - 公司內部擁有特殊權限才能使用。
framework - 公私都有,動態庫靜態庫。只能看到.h文件。

二.步驟

準備工作:
Github賬號一個(上傳組件工程用的)
安裝CocoaPods(創建并驗證pod用的)
安裝Git 命令行 (首次上傳組件工程用的)
安裝Github Desktop或者SourceTree(后續更新組件用的,Git命令使用熟練者忽略此項)


1.創建共有庫

  • 首先在Github創建一個新的Repository。(你的Pods最終是要托管在Github平臺上的,所以先在Github上創建一個空的Repository。)
    \color{red}{注意:“JHIMComponets”名字組成;JH = 項目前綴,Componets = 組件}
    如:JHIMComponets = IM組件化模塊,這個看個人不強制。

    repository.png

  • 下圖為創建成功后的樣子


    JHIMComponets.png

2.注冊Cocoapods賬戶

  • 想要創建一個開源pod庫, 首先我們需要注冊CocoaPods,基于Cocoapods已經安裝好的前提下,這里是使用trunk 方式,只需要在終端執行:
pod trunk register 郵箱地址 '用戶名' --verbose

如: pod trunk register xxxxxx@yeah.com 'JadeXH' --verbose

一般會使用GitHub郵箱和用戶名,當然這個可以自由選擇,注冊之后,在郵箱中會收到確認郵件,在瀏覽器中點擊鏈接確認即注冊成功(小編遇到點擊鏈接地址后顯示:Internal server error 提示,不用理他直接驗證)。成功之后可以終端執行:

pod trunk me    //驗證是否注冊成功

查看注冊信息,以后可以使用該開源Pod庫發布工具,也可以通過此方式查看已經發布過的pods:

yourname@Jade-for-MacBook-Pro podTest % pod trunk me
  - Name:     yourname
  - Email:    yourname@yeah.net
  - Since:    March 28th, 02:32
  - Pods:     None
  - Sessions:
    - March 28th, 02:32 - August 4th, 04:13. IP: 124.126.200.29

3.在本地創建pod庫

  • 利用pod命令創建了名為JHIMComponets的Pod庫
    \color{red}{\normalsize{注意:這個名字要和你Github創建的Repository Name一致}}
cd yourname@Jade-for-MacBook-Pro downloads % 
# cd到downloads目錄下載,這個不強制請隨意。
yourname@Jade-for-MacBook-Pro downloads % pod lib create JHIMComponets
# 執行 pod lib create JHIMComponets
  • 執行完上述命令之后,會問你幾個問題,按需求填寫即可


    pod create.png
# 你想使用哪個平臺?
1、What platform do you want to use?? [ iOS / macOS ]
iOS
# 庫語言選擇?
2、What language do you want to use?? [ Swift / ObjC ]
ObjC
# 是否需要一個demo工程,用于調試Pod?
3、Would you like include a demo application with your library? [ Yes / No ]
Yes
# 你要使用哪個測試框架?
4、Which testing frameworks will you use? [ Specta / Kiwi / None ]
None
# 是否要UI測試?
5、Would you like to do view based testing? [ Yes / No ]
NO
# 類名前綴?
6、What is your class prefix?
JH
  • 到這里pod庫就創建完成了,它會自己打開剛才創建的pod庫。
    目錄結構如下圖:


    pod.png
  • (1)配置podspec
    配置詳解:
Pod::Spec.new do |s| 
  #庫名稱
  s.name             = 'JHIMComponets'
  #版本號
  s.version          = '0.1.0'
  #庫簡短介紹
  s.summary          = 'A short description of JHIMComponets.'
  #開源庫描述 
  s.description      = <<-DESC
TODO: Add long description of the pod here.
                       DESC
  #開源庫地址,或者是博客、社交地址等
  s.homepage         = 'https://github.com/JadeXH/JHIMComponets'
  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
  #開源協議
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  #開源庫作者
  s.author           = { 'yourname' => 'yourname@yeah.net' }
  #源庫資源文件
  s.source           = { :git => 'https://github.com/JadeXH/JHIMComponets.git', :tag => s.version.to_s }
  #社交網址
  # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'
  #開源庫最低支持
  s.ios.deployment_target = '9.0'
  #源庫資源文件
  s.source_files = 'JHIMComponets/Classes/**/*'
  #添加資源文件
  # s.resource_bundles = {
  #   'JHIMComponets' => ['JHIMComponets/Assets/*.png']
  # }

  # s.public_header_files = 'Pod/Classes/**/*.h'
  #依賴的系統庫 多個用逗號隔開
  # s.frameworks = 'UIKit', 'MapKit'
  #引入第三方依賴庫
  # s.dependency 'AFNetworking', '~> 2.3'
end
  • 需要注意如圖:


    podspec.png
  • Readme主要是介紹這個組件的用途和使用的,可以隨時編輯。目前就確認一下自己的名字和郵箱就可以了。


    readme.png
  • 協議文件,也是確認一下自己的名字和郵箱就可以了。


    licence.png
  • (2)添加自己的類
    打開pod庫目錄:

new.png

刪除ReplaceMe -> 創建JHIMComponet簡單類,聲明一個打印函數,方便后續測試。
\color{red}{注意:創建類文件一定要放到class目錄下}


#import "JHIMComponet.h"

@implementation JHIMComponet

- (void)printJHIMComponet {
    NSLog(@"printJHIMComponet*****");
}

@end
  • 這時cd進入Example路徑下執行pod install命令,看看是否能將剛剛添加的庫文件引入到工程中
yourname@Jade-for-MacBook-Pro downloads % cd /Users/yourname/Downloads/JHIMComponets/Example
yourname@Jade-for-MacBook-Pro Example % pod install
pods.png

如果成功會在項目組Pods中看到。

4.項目上傳與發布

cd到你的項目路徑下,將項目上傳到Github中(即剛剛創建的JHIMComponets共有庫中)依次使用下列命令行,不要遺漏。

//
yourname@Jade-for-MacBook-Pro Example % cd /Users/yourname/Downloads/JHIMComponets

# 添加github項目路徑
yourname@Jade-for-MacBook-Pro JHIMComponets % git remote add origin https://github.com/JadeXH/JHIMComponets.git
# 添加文件
yourname@Jade-for-MacBook-Pro JHIMComponets % git add .
# 將暫存區里的改動給提交到本地的版本庫
yourname@Jade-for-MacBook-Pro JHIMComponets % git commit -m "first commit"
# 創建分支main
yourname@Jade-for-MacBook-Pro JHIMComponets % git branch -M main
# 提交版本號并push到main分支
yourname@Jade-for-MacBook-Pro JHIMComponets % git push -u origin main

#注意這里的版本號要與.podspec中的版本號保持一致
yourname@Jade-for-MacBook-Pro JHIMComponets % git tag 0.1.0
yourname@Jade-for-MacBook-Pro JHIMComponets % git push origin 0.1.0

在執行git push -u origin main的時候如果遇到需要輸入用戶名和密碼:

Username for 'https://github.com': JadeXH
Password for 'https://JadeXH@github.com': 

\color{red}{\normalsize{需要注意的是:}}這個密碼不是你Github的登錄密碼,而是需要生成一個access tokens。

生成token步驟:需要在Github個人設置頁 -> Settings -> Developer settings -> Personal access tokens 中創建一個token。


settings.png

1.設置token的有效期,訪問權限等
2.選擇要授予此令牌token的范圍或權限。
3.要使用token從命令行訪問倉庫,請選擇repo。
4.要使用token從命令行刪除倉庫,請選擇delete_repo
5.其他根據需要進行勾選


token.png

delete.png

點擊Generate token生成的token(ghp_zR7Zm44QK*************Ui7zikChgv2bxMNZ)。

注意:
記得把你的token保存下來,因為你再次刷新網頁的時候,你已經沒有辦法看到它了。然后把這個token直接粘貼到命令行提示輸入密碼處就ok了。


執行完所有git命令行后打開瀏覽器輸入https://github.com/JadeXH/JHIMComponets就看到你的pod庫已經push上去了。

update.png

5.使用與驗證

  • 新建個帶pod的項目,把我們做好的JHIMComponets加入podfile文件。
# Uncomment the next line to define a global platform for your project
 platform :ios, '9.0'

target 'podTest' do
  # Uncomment the next line if you're using Swift or would like to use dynamic frameworks
  # use_frameworks!

  # Pods for podTest
  pod 'JHIMComponets',:git =>"https://github.com/JadeXH/JHIMComponets.git"
  
  
  target 'podTestTests' do
    inherit! :search_paths
    # Pods for testing
  end

  target 'podTestUITests' do
    inherit! :search_paths
    # Pods for testing
  end
end
  • 執行pod install
yourname@Jade-for-MacBook-Pro podTest % pod install
Analyzing dependencies
Pre-downloading: `JHIMComponets` from `https://github.com/JadeXH/JHIMComponets.git`
Downloading dependencies
Installing JHIMComponets (0.1.0)
Removing JHComponents
Generating Pods project
Integrating client project
Pod installation complete! There are 9 dependencies from the Podfile and 9 total pods installed.
  • 引入頭文件并打印結果


    import.png
print.png

6.版本更新與維護

  • 現在的JHIMComponets庫已經在Github上托管了,以后維護這個項目就可以了(開始本地創建的JHIMComponets項目就可以刪除了),管理Github倉庫,\color{blue}{兩種方案任選}
  • 也可以使用Github Desktop
    下載Github Desktop登錄你的用戶名密碼,File ->Clone Repository


    Github Desktop.png

    其實Github Desktop更加可視化一些,上面History就是剛才git命令行的記錄。


    desk.png

6.總結

  • 終于寫完了,哇哦!凌晨了。寫這篇文章初心也是為了加深印象,如果碰巧也能幫到您還請點個贊,制作不易。
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,546評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,570評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,505評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,017評論 1 313
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,786評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,219評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,287評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,438評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,971評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,796評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,995評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,540評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,230評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,918評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,697評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,991評論 2 374

推薦閱讀更多精彩內容