原文
耦合是每個程序員都必須面對的話題,也是容易被忽視的存在,怎麼處理耦合關系到我們最後的代碼質量。今天Peak君和大家聊聊耦合這個基本功話題,一起捋一捋iOS代碼中處理耦合的種種方式及差異。
簡化場景
耦合的話題可大可小,但原理都是相通的。為了方便討論,我們先將場景進行抽象和簡化,只討論兩個類之間的耦合。
假設我們有個類Person,需要喝水,根據職責劃分,我們需要另一個類Cup來完成喝水的動作,代碼如下:
//Person.h @interface Person : NSObject - (void)drink; @end //Cup.h @interface Cup : NSObject - (id)provideWater; @end
很明顯,Person和Cup之間要配合完成喝水的動作,是無論如何都會產生耦合的,我們來看看在Objective C下都有哪些耦合的方式,以及不同耦合方式對以後代碼質量變化的影響。
方式一:.m引用
這種方式直接在.m文件中導入Cup.h,同時生成臨時的Cup對象來調用Cup中的方法。代碼如下:
#import "Person.h" #import "Cup.h" @implementation Person - (void)drink { Cup* c = [Cup new]; id water = [c provideWater]; [self sip:water]; } - (void)sip:(id)water { //sip water } @end
這應該是不少同學會選擇的做法,要用到某個類的功能,就import該類,再調用方法,功能完成提交測試一氣呵成。
這種方式初看起來沒什麼毛病,但有個弊端:Person與Cup的耦合被埋進了Person.m文件的方法實現中,而.m文件一般都是業務邏輯代碼的重災區,當Person.m的代碼量膨脹之後,如果Person類交由另一位工程師來維護,那這位新接手的同學無法從Person.h中一眼看出Person類和哪些類之間有交互,即使在Person.m中看drink的聲明也沒有任何線索,要理清楚的話,只能把Person.m文件從頭到尾讀一遍,對團隊效率的影響可想而知。
方式二:.h Property
既然直接在.m中引用會導致耦合不清晰,我們可以將耦合的部分放入Property中,代碼如下:
//Person.h @interface Person : NSObject @property (nonatomic, strong) Cup* cup; - (void)drink; @end //Person.m @implementation Person - (void)drink { id water = [self.cup provideWater]; [self sip:water]; } - (void)sip:(id)water { //sip water } @end
這樣,我們只需要掃一眼Person.h就能明白,Person類對哪些類產生了依賴,比直接在.m中引用清晰多了。
不知道大家有沒有好奇過,為什麼在Objective C中會有.h文件的存在,為什麼不像Java,Swift一樣一個文件代表一個類?使用.h文件有利有弊。
.h文件最大的意義在於將聲明和實現相隔離。聲明是告訴外部我支持哪些功能,實現是支撐這些功能背後的代碼邏輯。在我們閱讀一個類的.h文件的時候,它最主要的作用是透露兩個信息:
我(Person類)依賴了哪些外部元素
我(Person類)提供哪些接口供外部調用
所以.h文件應該是我們代碼耦合的關鍵所在,當我們猶豫一個類的Property要不要放到.h文件中去聲明時,要思考這個Property是不是必須暴露給外部。一旦暴露到.h文件中,就增加了依賴和耦合的幾率。有時候Review代碼,只要看.h文件是否清晰,就大概能猜測這個類設計者的水平。
當我們把Cup類做為Person的Property聲明時,就表明Person與Cup之間存在必要的依賴,我們把這種依賴放到頭文件中來,起到一目了然的效果。這比方式一清晰了不少,但有另一個問題,Cup暴露出去以後,外部元素可以隨意修改,當內部執行drink的時候,可能另一個線程將cup置空了,影響正常的業務流程。
方式三:.h ReadOnly Property
方式二中,Person類在對Cup產生依賴的同時,也承擔了cup隨時被外部修改的風險。當然做直觀的做法是將Cup類作為ReadOnly的property,同時提供一個對外的setter:
//Person.h @interface Person : NSObject @property (nonatomic, strong, readonly) Cup* cup; - (void)setPersonCup:(Cup*)cup; - (void)drink; @end
有同學可能會問,這和上面的做法有什麼區別,不一樣都有讀寫的接口嗎?最大的區別是增加了檢查和干擾的入口。
當我Debug的時候,經常需要檢查某個Propery到底是被誰修改了,Setter中設置一個斷點調試起來方便不少。同時,我們還可以使用Xcode的Caller機制,查看當前Setter都被那些外部類調用了,分析類與類之間的關聯是很有幫助。
Person.m中Setter方法還提供了我們拓展功能的入口,比如我們需要在Setter中增加多線程同步Lock,當Person.m中的其他方法在使用Cup時,Setter必須等待完成才能執行。又比如我們可以在Setter中實現Copy On Write機制:
//Person.m - (void)setPersonCup:(Cup*)cup { Cup* anotherCup = [cup copy]; _cup = anotherCup; }
這樣,Person類就可以避免和外部類共享同一個Cup,杜絕使用同一個水杯的衛生問題 ;)
總之,單獨的Setter方法讓我們對代碼有更大的掌控能力,也為後續接手維護你代碼的同學帶來了方便,利己利人。
方式四:init 注入
使用帶Setter的Property雖然看上去好了不少,但Setter方法可以被任意外部類隨時隨刻調用,對於Person.m中使用Cup的方法來說,多少有些不安心,萬一用著用著被別人改了呢?
為了避免被隨意修改,我們可以采用init注入的方式,Objective C中的designated initializer正是為此而生:
//Person.h @interface Person : NSObject - (instancetype)initWithCup:(Cup*)cup; - (void)drink; @end
去掉Property,將Cup的設置放入init方法中,這樣Person類對外就只提供一次機會來設置Cup,init之後,外部類就沒有其他機會來修改Cup了。
這是使用最多,也是比較推薦的方式。只在對象被創建的時候,去建立與其他對象的關系,把可變性降低到一定程度。那這種方式是否也有什麼缺點呢?
通過init的方式設置cup,杜絕了外部因素的影響,但如果內部持有了cup對象,那麼內部的函數調用依然可以通過各種姿勢與Cup類產生耦合,比如:
//Person.m @interface Person () @property (nonatomic, strong) Cup* myCup; @end @implementation Person - (instancetype)initWithCup:(Cup*)cup { self = [super init]; if (self) { self.myCup = cup; } return self; } - (void)drinkWater { id water = [self.myCup provideWater]; [self sip:water]; } - (void)drinkMilk { id milk = [self.myCup provideMilk]; [self sip:milk]; } @end
Person內部的方法可以通過Cup所有對外的接口來產生耦合,此時我們對於兩個類之間的耦合,就主要靠對Cup.h頭文件來解讀了。如果Cup類設計合理,頭文件結構清晰的話,這其實不算太糟糕的場景。那還有沒有其他方式呢?
方式五:parameter 注入
用Property持有的方式,在Person對象的整個生命周期內,耦合的可能性一直存在,原因在於Property對於.m文件來說是全局可見的。我們可以用另一種方式讓耦合只發生在單個方法內部,即parameter injection:
//Person.h @interface Person : NSObject - (void)drink:(Cup*)cup; @end //Person.m - (void)drink:(Cup*)cup { id water = [cup provideWater]; [self sip:water]; }
這種方式的好處在於:Person和Cup的耦合只發生在drink函數的內部,一旦函數調用結束,Person和Cup之間就結束了依賴關系。從時間和空間的跨度上來說,這種方式比持有Property風險更小。
可要是在Person中存在多處Cup的依賴,比如有drinkWater,drinkMilk,drinkCoffee等等,反而又不如Property直觀方便了。
方式六:單例引用
單例的優劣有很多優秀的技術文章分析過了,Peak君只強調其中一點,也是平時review代碼和Debug發現最多的問題緣由:單例中的狀態共享。
上面的例子中,我們可以把Cup做成單例,代碼如下:
//Person.m - (void)drink { id water = [[Cup sharedInstance] provideWater]; [self sip:water]; }
這種方式產生的耦合不但和方式一同樣隱蔽,而且是最容易導致代碼降級的,隨著版本的不停迭代,我們很有可能會得到下面的一個類關聯圖:
所有的對象都依賴於同一個對象的狀態,所有的對象都對這個對象的狀態擁有讀寫權限,最後的結果很有可能是到處打補丁修Bug,按下葫蘆浮起瓢。
使用單例類似的場景很常見,比如我們在單例中持有某個用戶的信息,在用戶登出之後,忘記清除之前用戶的信息就會導致奇怪的bug,而且單例一旦零散的分布在項目的各個角落,要逐一處理十分困難。
方式七:繼承
繼承是一種強耦合關系,網絡上有不少關於繼承(inheritance)和組合(compoisition)之間優劣的對比文章了,這裡不做贅述。繼承確實能在初期很方便的建立清晰的對象模型,重用和多態看著也很美妙,問題在於這種強耦合關系在理解上很容易產生分歧,比如什麼樣對象之間可以被確立為父子關系,哪些子類的行為可以放到父類中給其他子類使用,在多層繼承的時候這些問題會變得更加復雜。所以Peak君建議盡可能的少用繼承關系來描述對象,除非是一目了然毫無異議的父子關系。
我就不強行來一波父類定義來舉例了,比如什麼ObjectWithCup這類。
方式八:runtime依賴
使用runtime來處理耦合是Objective C獨特的方式,而且耦合度非常之低,甚至可以說感覺不到耦合的存在,比如:
//Person.m - (void)drink:(id)obj { id water = nil; SEL sel = NSSelectorFromString(@"provideWater"); if ([obj respondsToSelector:sel]) { water = [obj performSelector:sel]; } if (water) { [self sip:water]; } }
既不需要導入Cup的頭文件,也不需要知道Cup到底支持哪些方法。這種方式的問題也正是由於耦合度太低了,讓開發者感知不到耦合的存在,感知不到類之間的關系。如果哪天有人把provideWater改寫成getWater,drink方法如果沒有同步到,Xcode編譯時不會提示你,runtime也不會crash,但是業務流程卻沒有正常往下走了。
這也是為什麼我們不推薦用Objective-C runtime的黑魔法去做業務,只是在無副作用的場景下去完成一些數據的獲取操作,比如使用AOP去log日志。
方式九:protocol依賴
這並不是一種獨立的耦合方式,protocol可以結合上述各種耦合方式來進一步降低耦合,也是在復雜類關系設計中推薦的方式,比如我們可以定義這樣一個protocol:
@protocol LiquidContainer (NSObject)(此處圓括號替換尖括號) - (id)provideWater; - (id)provideCoffee; @end //Person.h @interface Person : NSObject - (void)drink:(id(LiquidContainer))container;(此處圓括號替換尖括號) @end
上述的方式中,無論是Property持有還是parameter注入,都可以使用protocol來降低依賴,protocol的好處在於他只規定了方法的聲明,並不限定具體是那個類來實現它,給後期的維護留下更大的空間和可能性。有關protocol的用處和重要性可以單獨開一篇文章來講。
更復雜的場景
以上是一些常見的類耦合方式,描述的兩個類A,B之間的耦合方式。從上面的描述中,我們可以大致感知到兩個類使用不同的方式所導致的耦合的深淺,這種耦合深淺度說白了就是:互相調用函數和訪問狀態的頻次。理解這種耦的深淺可以幫助我們大致去量化兩個對象之間的耦合度,從而在更復雜的場景中去分析一個模塊或者一種架構方式的耦合度。
在更復雜的場景中,比如A,B,C三個類之間也可以采用類似的方法去分析,A,B,C三者可以是如下關系:
分析三個類或者更多類之間的耦合關系的時候,也是先拆解成若干個兩個類分析,比如左邊我們分析AB,BC,AC三組耦合,進而去感知ABC作為一個整體的耦合度。很顯然,右邊的方式看著比左邊的好,因為只需要分析AB和BC。在我們選用設計模式重構代碼的時候,也可以依照類似的方式來分析,從而選擇耦合度最低,最貼合我們業務場景的模式。
我們的原則是:類與類之間調用的方法,依賴的狀態要越少越好,在Objective C這門語言環境下,書寫分類清晰,接口簡潔的頭文件非常重要。
良性的耦合
前面的分析重在嘗試去量化和感知耦合的深淺,但並不是每一次方法調用都是有風險的,有些耦合可以稱作是良性的。
如果將我們的代碼進行高度抽象,所有的代碼都可以被歸為兩類:Data和Action。一個Class中的Property是Data,而Class中的函數則是Action,我之前寫過的一篇關於函數式的文章中提到過,真正讓我們代碼變得危險的是狀態的變化,即改變Data。如果一個函數是純函數,既不依賴於外部狀態,也不修改外部狀態,那麼這個函數無論被調用多少次都是安全的。如果兩個類,比如上面舉例的Person和Cup,二者互相調用的都是純函數,那麼二者之間的耦合可以看做是良性的,並不會導致程序的狀態維護混亂,只是會讓代碼的重構變得困難,畢竟耦合的越深,重構改動的代碼就越多。
所以我們在做設計的時候,應該盡可能使不同元素之間的耦合是良性的,這就涉及到狀態的維護問題,先看下圖中兩種不同的設計方式:
圖中紅色的圓圈代表每個類或者功能單位所持有的狀態。依照圖中上方的設計方式,每個單位各自處理自己的狀態變化,這些狀態之間還互相存在依賴的話,耦合越深,開發調試和重構就越難,代碼就降級越厲害。如果按照圖中下方的方式,將狀態變化的部分全部都集中到一起處理,維護起來就輕松很多了,這也是為什麼很多App都有model layer這一設計的原因,將App狀態(各類model)的變化處理獨立出來作為一個layer,上層(業務層)只是作為model layer的展現和交互的外殼。這種設計技巧,大可以應用於一個App架構的處理,小可以到一個小功能模塊的設計。
結束語
上面總結了我們常用的一些耦合方式,目的在於分析不同代碼的書寫方式,對於我們最後耦合所產生的影響。最後值得一提的是,上面有些耦合方式並沒有絕對的優劣之分,不同的業務場景下可能選擇的方
式也不同,比如有些場景確實需要持有Property,有些場景單例更合適,關鍵在於我們能明白不同方式對於我們代碼後期維護所產生的影響,這篇文章有些地方可能比較抽象,其中很多都是個人感悟和總
結,或有不妥之處,請閱讀之後選擇性的吸收,希望能對大家平常寫代碼處理耦合帶來一些幫助。