iOS 組件化(一)

本文主要講解組件化的兩種方案

組件化

組件化其實(shí)就是將模塊單獨(dú)抽離砸捏、分層竟闪,并指定模塊間的通訊方式景殷,從而實(shí)現(xiàn)解耦的一種方式溅呢,主要運(yùn)用于團(tuán)隊(duì)開發(fā)

為什么需要組件化?

主要有以下四個(gè)原因

  • 1猿挚、模塊間解耦

  • 2咐旧、模塊重用

  • 3、提高團(tuán)隊(duì)協(xié)作開發(fā)效率

  • 4亭饵、單元測試

當(dāng)項(xiàng)目因?yàn)楦鞣N需求休偶,越來越來時(shí),如果此時(shí)的各個(gè)模塊之間互相調(diào)用辜羊,會(huì)造成高耦合的情況踏兜。一旦我們需要對某一塊代碼進(jìn)行修改時(shí),就會(huì)牽一發(fā)而動(dòng)全身八秃,導(dǎo)致項(xiàng)目難以維護(hù)

其問題主要體現(xiàn)在以下幾個(gè)方面:

  • 1碱妆、修改某個(gè)功能時(shí),同時(shí)需要修改其他模塊的代碼昔驱,因?yàn)樵谄渌K中有該模塊的引用疹尾。可以理解為高耦合導(dǎo)致代碼修改困難

  • 2、模塊對外接口不明確纳本,甚至暴露了本不該暴露的私有接口窍蓝,修改時(shí)費(fèi)時(shí)費(fèi)力》背桑可以理解為接口不固定導(dǎo)致的接口混亂

  • 3吓笙、高耦合代碼產(chǎn)生的后果就是會(huì)影響團(tuán)隊(duì)其他成員的開發(fā),產(chǎn)生代碼沖突

  • 4巾腕、當(dāng)模塊需要重用到其他項(xiàng)目時(shí)面睛,難以單獨(dú)抽離

  • 5、模塊間耦合的忌口導(dǎo)致接口和依賴關(guān)系混亂尊搬,無法進(jìn)行單元測試

所以為了解決以上問題叁鉴,我們需要采用更規(guī)范的方式來降低模塊間的耦合度,這就是組件化佛寿,也可以理解為模塊化

但是幌墓,這里還需要說明一點(diǎn),因?yàn)榻M件化也是需要一定成本的狗准,需要花費(fèi)時(shí)間設(shè)計(jì)接口克锣、分離代碼等茵肃,所以并不是所有的項(xiàng)目都需要組件化腔长。如果你的項(xiàng)目有以下這些特征就不需要組件化

  • 1、項(xiàng)目較小验残,模塊間交互簡單捞附,耦合少

  • 2、項(xiàng)目沒有被多個(gè)外部模塊引用您没,只是一個(gè)單獨(dú)的小模塊

  • 3鸟召、模塊不需要重用,代碼也很少被修改

  • 4氨鹏、團(tuán)隊(duì)規(guī)模很小

  • 5欧募、不需要編寫單元測試

如果你的有以下特性,說明你就必須要考慮進(jìn)行組件化了:

  • 1仆抵、模塊邏輯復(fù)雜跟继,多個(gè)模塊之間頻繁互相引用

  • 2、項(xiàng)目規(guī)模逐漸變大镣丑,修改代碼變的越來越困難(這里可以理解為:修改一處代碼舔糖,需要同時(shí)修改其他多個(gè)地方)

  • 3、團(tuán)隊(duì)人數(shù)變多莺匠,提交的代碼經(jīng)常和其他成員沖突

  • 4金吗、項(xiàng)目編譯耗時(shí)較大

  • 5、模塊的單元測試經(jīng)常由于其他模塊的修改而失敗

組件化方案

組件化方案的8條指標(biāo)

一個(gè)項(xiàng)目經(jīng)過組件化后如何來評判,主要有以下幾個(gè)標(biāo)準(zhǔn)

  • 1摇庙、模塊之間沒有耦合旱物,模塊內(nèi)部的修改不會(huì)應(yīng)該其他模塊
  • 2、模塊可以單獨(dú)編譯
  • 3卫袒、模塊間數(shù)據(jù)傳遞明確
  • 4异袄、模塊可以隨時(shí)被另一個(gè)提供了相同功能的模塊替換
  • 5、模塊對外接口清晰且易維護(hù)
  • 6玛臂、當(dāng)模塊接口改變時(shí)烤蜕,此模塊的外部代碼能夠被高效重構(gòu)
  • 7、盡量用最少的修改和代碼迹冤,讓現(xiàn)有的項(xiàng)目實(shí)現(xiàn)模塊化
  • 8讽营、支持OC和Swift,以及混編

前4條主要用于衡量一個(gè)模塊是否真正解耦泡徙,后4條主要用于衡量在項(xiàng)目中實(shí)踐中的易用程度

組件化原則
一個(gè)項(xiàng)目主要分為3層:業(yè)務(wù)層橱鹏、通用層以及基礎(chǔ)層,在進(jìn)行組件化時(shí)堪藐,有以下幾點(diǎn)說明

image
  • 只能上層對依賴莉兰,不能下層對上層的依賴,因?yàn)橄聦邮菍ι蠈拥某橄?/p>

  • 項(xiàng)目公共代碼資源下沉

  • 橫向的依賴盡量少有礁竞,最好下層至通用模塊糖荒,或者基礎(chǔ)模塊

組件化方案
常用的組件化方案主要有兩種:

  • 本地組件化:主要是通過在工程中創(chuàng)建library,利用cocoapodsworkspec進(jìn)行本地管理模捂,不需要將項(xiàng)目上傳git捶朵,而是直接在本項(xiàng)目中以framework的方法進(jìn)行調(diào)用

  • cocoapods組件化:主要是利用cocoapods來進(jìn)行模塊的遠(yuǎn)程管理,需要將項(xiàng)目上傳git(需要注意:這里的組件化模塊分為公有庫私有庫狂男,對公司而言综看,一般是私有庫)

本地組件化

1、創(chuàng)建主工程

  • 首先創(chuàng)建一個(gè)工程

    image
  • 集成cocopods岖食,進(jìn)行本地管理:

$ cd 項(xiàng)目目錄
$ pod init

  • 編輯podfile红碑,并執(zhí)行pod install

2、創(chuàng)建組件

假設(shè)有以下幾個(gè)模塊:

  • 主工程:承載主要的表層業(yè)務(wù)代碼
  • Core:獨(dú)立存在泡垃,應(yīng)用加密析珊、接口請求等敏感代碼
  • Base:基類封裝,拓展兔毙,基本的數(shù)據(jù)處理
  • Service:服務(wù)層唾琼,封裝業(yè)務(wù)工具類,例如網(wǎng)絡(luò)層服務(wù)澎剥、持久化服務(wù)等
  • Pods:三方依賴

其中锡溯,各個(gè)模塊間的關(guān)系如下所示

image

下面赶舆,我們來進(jìn)行模塊的創(chuàng)建,以Core模塊為例:

  • 選擇new -> project -> iOS -> Framework祭饭,新建一個(gè)模塊

    image
  • 選擇正確的GroupWorkSpace(這里需要注意一點(diǎn):創(chuàng)建的library最好放在主工程根目錄下芜茵,否則后續(xù)podfile執(zhí)行pod install時(shí)會(huì)報(bào)錯(cuò))

    image
  • 將創(chuàng)建的libraryBuild Settings -> Mach-O Type修改為靜態(tài)庫 Static Library

    image

3、主工程調(diào)用library

  • 在CJLCore中新建一個(gè)文件倡蝙,并添加如下代碼
//類需要聲明為public
public class CJLCoreSetting: NSObject {
    //屬性需要聲明為public
    public static let SCRET_KEY = "SCRET_KEY"
}

  • Build Phases -> Headers -> Public中將新建的文件添加為public九串,這樣主工程才能訪問該文件

    image
  • 在主工程中,選擇target -> Linked Frameworks Library中添加CJLCore寺鸥,只需要build主工程猪钮,library能夠自動(dòng)聯(lián)編

    image

4、使用

首先import CJLCore胆建,然后使用

image

這里需要注意的是烤低,子library之間的互相調(diào)用,與主工程調(diào)用library類似笆载,主需要添加依賴扑馁、暴露header即可

5、使用cocoapods管理三方依賴

假設(shè)我們需要在CJLCore中封裝網(wǎng)絡(luò)層代碼凉驻,需要用到三方庫Alamofire腻要,在podfile中

platform :ios, '9.0'
inhibit_all_warnings!
use_frameworks!

#配置workspace路徑
workspace 'Modularization.xcworkspace'

################# 三方依賴
# 公有
def workspace_pods
  pod 'SwiftyJSON'
end

# 主工程
def project_only_pods
  pod 'SnapKit'
end

#網(wǎng)絡(luò)
def network_layer_pods
  pod 'Alamofire'
end

################# 模塊
target 'CJLCore' do
  #配置libray路徑
  project 'CJLCore/CJLCore.xcodeproj'

  workspace_pods
  network_layer_pods

end

################# 主工程
target 'Modularization' do

  workspace_pods
  project_only_pods
  network_layer_pods

  target 'ModularizationTests' do
    inherit! :search_paths

  end

  target 'ModularizationUITests' do

  end

end

到此,一個(gè)本地組件化的模塊就配置完成了

cocoapods組件化

除了本地組件化涝登,還可以使用cocoapods雄家,其原理如下圖所示

image

這里還是以本地組件化中的結(jié)構(gòu)為例

1、創(chuàng)建私有倉庫

  • 在github上創(chuàng)建一個(gè)MySpecs倉庫
    具體步驟:登錄github-->點(diǎn)擊右上角“+”-->選擇 new repository-->輸入Repository name為MySpecs缀拭,選擇倉庫類型為 private咳短,點(diǎn)擊Create repository。

  • 將私有倉庫添加至本地~/.cocoapods/repos目錄

pod repo add mySpecs https://github.com/xxx/MySpecs.git

2蛛淋、創(chuàng)建pods 工程,即組件化工程

  • 使用終端創(chuàng)建CJLServices模塊
pod lib create CJLServices

  • 根據(jù)提示依次輸入:ios篡腌、swift褐荷、yes、none嘹悼、no叛甫、CJL

    image
  • 進(jìn)入模塊的目錄,將文件拷貝至CJLServices -> Classes

    image
  • 執(zhí)行pod install,會(huì)將Classes更新至pods中

    image

3杨伙、配置pods工程

修改模塊的配置文件其监,即CJLServices.podspec

  • 如果需要依賴三方庫,需要配置s.dependency
s.dependency 'AFNetworking'

  • 如果模塊間需要相互引用限匣,同樣需要配置s.dependency抖苦,以CJLBase為例,需要引用CJLService
//********1、修改 podspec 文件
s.dependency 'CJLServices'

//********2锌历、修改 podfile 文件
pod 'CJLServices', :path => '../../CJLServices'

  • 如果需要加載資源贮庞,例如圖片、json究西、bundle文件等
    • 1窗慎、在模塊的Assets文件夾 中添加資源文件
    • 2、在specs里配置資源路徑(必須配置B辈摹遮斥!否則無法讀取資源)
    • 3、訪問時(shí)需要指定資源文件路徑
//*****1扇丛、修改 podspec 文件
s.resource_bundles = {
     'CJLBase' => ['CJLBase/Assets/*']
   }

//*****2伏伐、使用
let bundlePath: String = Bundle.init(for: dynamicClass.self).resourcePath! + "/CJLBase.bundle"
let bundle = Bundle(path: bundlePath)
if let path = bundle?.path(forResource: "mouse", ofType: "jpg"){
    self.imgView.image = UIImage(contentsOfFile: path)
}           

同理,模塊中的xib晕拆,json文件的獲取方式也是一樣的

4藐翎、提交至git

這里提交至git的模塊是pods工程才可以,以CJLBase為例

  • 需要在github上創(chuàng)建一個(gè)私有repository实幕,命名為CJLBase

  • 執(zhí)行以下終端命令

$git init
$git add .
$ git commit -am "第一次提交" 
//即第一個(gè)步驟中創(chuàng)建的倉庫地址
$ git remote add origin https://github.com/xxx/CJLBase.git

$ git push origin master 
//一定要有標(biāo)簽吝镣,不然會(huì)有下面的警告
//podspec文件中獲取Git版本控制的項(xiàng)目需要tag號,
$ git tag -m "first release" "0.1.0" 
$ git push --tags 

5昆庇、驗(yàn)證podspec文件

執(zhí)行終端命令 pod spec lint

注意:pod spec相對于pod lib會(huì)更為精確末贾,

  • pod lib相當(dāng)于只驗(yàn)證一個(gè)本地倉庫,
  • pod spec會(huì)同時(shí)驗(yàn)證本地倉庫和遠(yuǎn)程倉庫整吆。

6拱撵、提交到私有倉庫

執(zhí)行以下命令

pod repo push [本地Spec Repo名稱][podspec文件路徑]

//******舉例
$ pod repo push MySpecs CJLBase.podspec

提交成功后,可在本地倉庫中看到提交路徑MySpecs -> CJLBase

7表蝙、使用

  • 新建一個(gè)工程拴测,在項(xiàng)目的podfile里添加
#私有spec倉庫的地址,而不是某個(gè)pod倉庫的地址
source 'https://github.com/xxx/MySpecs'
pod 'CJLBase'
  • 執(zhí)行pod install即可
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末府蛇,一起剝皮案震驚了整個(gè)濱河市集索,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌汇跨,老刑警劉巖务荆,帶你破解...
    沈念sama閱讀 218,284評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異穷遂,居然都是意外死亡函匕,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評論 3 395
  • 文/潘曉璐 我一進(jìn)店門蚪黑,熙熙樓的掌柜王于貴愁眉苦臉地迎上來盅惜,“玉大人中剩,你說我怎么就攤上這事】峥” “怎么了咽安?”我有些...
    開封第一講書人閱讀 164,614評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長蓬推。 經(jīng)常有香客問我妆棒,道長,這世上最難降的妖魔是什么沸伏? 我笑而不...
    開封第一講書人閱讀 58,671評論 1 293
  • 正文 為了忘掉前任糕珊,我火速辦了婚禮,結(jié)果婚禮上毅糟,老公的妹妹穿的比我還像新娘红选。我一直安慰自己,他們只是感情好姆另,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,699評論 6 392
  • 文/花漫 我一把揭開白布喇肋。 她就那樣靜靜地躺著,像睡著了一般迹辐。 火紅的嫁衣襯著肌膚如雪蝶防。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,562評論 1 305
  • 那天明吩,我揣著相機(jī)與錄音间学,去河邊找鬼。 笑死印荔,一個(gè)胖子當(dāng)著我的面吹牛低葫,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播仍律,決...
    沈念sama閱讀 40,309評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼嘿悬,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了染苛?” 一聲冷哼從身側(cè)響起鹊漠,我...
    開封第一講書人閱讀 39,223評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎茶行,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體登钥,經(jīng)...
    沈念sama閱讀 45,668評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡畔师,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,859評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了牧牢。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片看锉。...
    茶點(diǎn)故事閱讀 39,981評論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡姿锭,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出伯铣,到底是詐尸還是另有隱情呻此,我是刑警寧澤,帶...
    沈念sama閱讀 35,705評論 5 347
  • 正文 年R本政府宣布腔寡,位于F島的核電站焚鲜,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏放前。R本人自食惡果不足惜忿磅,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,310評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望凭语。 院中可真熱鬧葱她,春花似錦、人聲如沸似扔。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,904評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽炒辉。三九已至豪墅,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間辆脸,已是汗流浹背但校。 一陣腳步聲響...
    開封第一講書人閱讀 33,023評論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留啡氢,地道東北人状囱。 一個(gè)月前我還...
    沈念sama閱讀 48,146評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像倘是,于是被迫代替她去往敵國和親亭枷。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,933評論 2 355

推薦閱讀更多精彩內(nèi)容