編寫高質(zhì)量代碼的52個有效方法(三)—接口與API設(shè)計

image

15.使用前綴避免命名空間沖突

對于做企業(yè)應(yīng)用開發(fā)或游戲SDK的開發(fā)者來說选酗,靜態(tài)庫吠昭、動態(tài)庫的制作和使用英上,客戶或渠道的SDK的接入和使用是平時工作的一部分。這時罚斗、如果能夠做到類名及方法名不重復(fù)虐唠,就可以避免太多的麻煩。沖突的符號文件:

duplicate symbol XXXClass in:
    dir/xxx.o
duplicate symbol XXXClass in:
    dir2/xxx.o

錯誤原因在于惰聂,應(yīng)用程序中的兩份代理都各自實現(xiàn)了名為XXXClass的類疆偿,這導(dǎo)致XXClass所對應(yīng)的類符號和元類符號個定義了兩次。解決方法就是:1.倘若可以修改類名是最好不過的了搓幌;2.倘若是使用了靜態(tài)庫杆故,則編譯靜態(tài)庫時,則需要在Build Phases -> Compile Sources 中去掉改類的.m文件溉愁,不將其編譯進(jìn)靜態(tài)庫处铛。

要點:

  1. 選擇與你的公司饲趋、應(yīng)用程序或二者皆有關(guān)聯(lián)之名稱作為類名的前綴,并在所有代碼中均使用這一前綴撤蟆。需要注意的是:Apple宣稱其保留使用所有“兩字母前綴”的權(quán)利奕塑,所以你自己選用的前綴應(yīng)該是三個字母或以上的。
  2. 若自己所開發(fā)的程序庫中用到了第三方庫家肯,則應(yīng)為其中的名稱加上前綴龄砰。

16.提供全能初始化方法

要點:

  1. 在類中提供一個全能初始化方法,并于文檔中指明讨衣。其他初始化方法均應(yīng)調(diào)用此方法换棚。
  2. 若全能初始化方法與超類不同,則需覆寫超類中的對應(yīng)方法反镇。
  3. 如果超類中的初始化方法不適用于子類固蚤,那么應(yīng)該覆寫這個超類方法,并在其中拋出異常歹茶。

實現(xiàn)description方法

關(guān)于將對象轉(zhuǎn)成NSDictionary的分類實現(xiàn):

#import "NSObject+AGExtension.h"
#import <objc/runtime.h>
#import <objc/message.h>

@implementation NSObject (AGExtension)
- (void)ag_enumeratePropertiesUsingBlock:(void (^)(objc_property_t property, BOOL *stop))block {
    Class cls = self.class;
    BOOL stop = NO;
    
    while (!stop && ![cls isEqual:NSObject.class]) {
        unsigned count = 0;
        objc_property_t *properties = class_copyPropertyList(cls, &count);
        
        cls = cls.superclass;
        if (properties == NULL) continue;
        for (unsigned i = 0; i < count; i++) {
            block(properties[i], &stop);
            if (stop) break;
        }
        free(properties);
    }
}
- (NSDictionary*)ag_toDictionary{
    NSMutableDictionary *propertiesInfo = [NSMutableDictionary dictionary];
    [self ag_enumeratePropertiesUsingBlock:^(objc_property_t property, BOOL *stop) {
        NSString *key = @(property_getName(property));
        id value = [self valueForKey:key];
        if (value) {
            propertiesInfo[key] = value;
        }else{
            propertiesInfo[key] = [NSNull null];
        }
    }];
    return propertiesInfo;
}
@end

使用:

#import "NSObject+AGExtension.h"

- (NSString*)description{
   return [[self ag_toDictionary] description];
}

要點:

  1. 實現(xiàn)description方法返回一個有意義的字符串夕玩,用以描述該實例。我們可以利用運行時先將對象轉(zhuǎn)成NSDictionary對象惊豺,再調(diào)用NSDictionary的description方法打印出對象的信息风秤。當(dāng)然,我們直接重寫description扮叨,打印自定義的信息和格式也是非常好的缤弦。
  2. 若想在調(diào)試時打印出更詳盡的對象描述信息,則應(yīng)實現(xiàn)debugDescription方法彻磁。

18.盡量使用不可變對象

對于設(shè)置了readonly修飾詞的屬性碍沐,依然可以通過“鍵值編碼”(Key-Value Coding,KVC)技術(shù)設(shè)置這些屬性值,使用“setValue:forKey:”方法來修改衷蜓。

要點:

  1. 盡量創(chuàng)建不可變的對象
  2. 若某屬性僅可于對象內(nèi)部修改累提,則在“class-continuation分類”中將其readonly屬性擴展為readwrite屬性
  3. 不要把不可變的collection作為屬性公開,而應(yīng)提供相關(guān)方法磁浇,以此修改對象中的可變collection

19.使用清晰而協(xié)調(diào)的命名方式

雖然說開發(fā)中的命名遵循變量的命名規(guī)則就不會有問題斋陪,但是、為了能讓他人看的明白我們還需要遵循一定的命名規(guī)范置吓。一般而言无虚、遵循蘋果的命名習(xí)慣就好,包括類名衍锚、方法名以及協(xié)議名友题。

要點:

  1. 起名時應(yīng)遵循標(biāo)準(zhǔn)的Objective-C命名規(guī)范,這樣創(chuàng)建出來的接口更容易為開發(fā)者所理解戴质。
  2. 方法名要言簡意賅度宦,從左至右讀起來要像個日常用語中的句子才好
  3. 方法名里不要使用縮略后的類型名稱
  4. 給方法起名時的第一要務(wù)就是確保其風(fēng)格與你自己的代碼或所要集成的框架相符

20.為私有方法加前綴

要點:

  1. 給私有方法的名稱加上前綴踢匣,這樣可以很容易地將其同公共方法區(qū)分開
  2. 不要單用一個下劃線做私有方法的前綴,因為這種做法是預(yù)留給蘋果公司用的戈抄。

21.理解Objective-C的錯誤模型

Java開發(fā)中离唬,調(diào)用許多方法時編譯器都會提示添加異常處理,尤其在讀取IO流時異常用到的特別多划鸽;而OC開發(fā)過程中输莺,我們遇到的更多是錯誤NSError,異常(@htrow)則較少。

異常通常只用于處理嚴(yán)重錯誤(fatal eror,致命錯誤)漾稀,那么對其他錯誤怎么辦呢模闲?在出現(xiàn)“不那么嚴(yán)重的錯誤”(nonfatal error,非致命錯誤)時建瘫,Objective-C語言所用的編程方式為:令方法返回nil/0,或是使用NSError,以表明其中有錯誤發(fā)生崭捍。

- (instancetype)init
{
    if (self = [super init]){
        //Initialize instance
    }
}


//網(wǎng)絡(luò)請求中返回的NSError等等

NSError的用法更加靈活,因為經(jīng)由此對象啰脚,我們可以把導(dǎo)致錯誤的原因回報給開發(fā)者殷蛇。NSError對象里封裝了三條信息:

  1. Error domain(錯誤范圍,其類型為字符串)
  2. Error code (錯誤碼橄浓,其類型為整數(shù))
  3. User info (用戶信息粒梦,其類型為字典)

要點:

  1. 只有發(fā)生了可使整個應(yīng)用程序崩潰的嚴(yán)重錯誤時,才應(yīng)使用異常荸实;
  2. 在錯誤不那么嚴(yán)重的情況下匀们,可以指派“委托方法”(delegate method)來處理錯誤,也可以把錯誤信息放在NSError對象里准给,經(jīng)由“輸出參數(shù)”返回給開發(fā)者泄朴。

22.理解NSCopying協(xié)議

要點:

  1. 若想令自己所寫的對象具有拷貝功能,則需要實現(xiàn)NSCopying協(xié)議
  2. 如果自定義的對象分為可變版本與不可變版本露氮,那么就要同時實現(xiàn)NSCopying與NSMutableCopying協(xié)議
  3. 復(fù)制對象時需決定采用淺拷貝還是深拷貝祖灰,一般情況下應(yīng)該盡量執(zhí)行淺拷貝
  4. 如果你所寫的對象需要深拷貝,那么可考慮新增一個專門執(zhí)行深拷貝的方法畔规。



PDF格式的資料來自iOS開發(fā)交流群局扶、感覺作者的貢獻(xiàn),對于知識的系統(tǒng)歸納總結(jié)很有幫助叁扫。
編寫高質(zhì)量代碼的52個有效方法
編寫高質(zhì)量代碼的52個有效方法(一)—熟悉OC
編寫高質(zhì)量代碼的52個有效方法(二)—對象三妈、消息、運行期
編寫高質(zhì)量代碼的52個有效方法(三)—接口與API設(shè)計
編寫高質(zhì)量代碼的52個有效方法(四)—協(xié)議與分類
編寫高質(zhì)量代碼的52個有效方法(五)—內(nèi)存管理
編寫高質(zhì)量代碼的52個有效方法(六)—塊與大中樞派發(fā)
編寫高質(zhì)量代碼的52個有效方法(七)---系統(tǒng)框架

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末莫绣,一起剝皮案震驚了整個濱河市沈跨,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌兔综,老刑警劉巖饿凛,帶你破解...
    沈念sama閱讀 216,744評論 6 502
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件狞玛,死亡現(xiàn)場離奇詭異,居然都是意外死亡涧窒,警方通過查閱死者的電腦和手機心肪,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,505評論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來纠吴,“玉大人硬鞍,你說我怎么就攤上這事〈饕眩” “怎么了固该?”我有些...
    開封第一講書人閱讀 163,105評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長糖儡。 經(jīng)常有香客問我伐坏,道長,這世上最難降的妖魔是什么握联? 我笑而不...
    開封第一講書人閱讀 58,242評論 1 292
  • 正文 為了忘掉前任桦沉,我火速辦了婚禮,結(jié)果婚禮上金闽,老公的妹妹穿的比我還像新娘纯露。我一直安慰自己,他們只是感情好代芜,可當(dāng)我...
    茶點故事閱讀 67,269評論 6 389
  • 文/花漫 我一把揭開白布埠褪。 她就那樣靜靜地躺著,像睡著了一般挤庇。 火紅的嫁衣襯著肌膚如雪钞速。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,215評論 1 299
  • 那天罚随,我揣著相機與錄音玉工,去河邊找鬼。 笑死淘菩,一個胖子當(dāng)著我的面吹牛遵班,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播潮改,決...
    沈念sama閱讀 40,096評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼狭郑,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了汇在?” 一聲冷哼從身側(cè)響起翰萨,我...
    開封第一講書人閱讀 38,939評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎糕殉,沒想到半個月后亩鬼,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體殖告,經(jīng)...
    沈念sama閱讀 45,354評論 1 311
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,573評論 2 333
  • 正文 我和宋清朗相戀三年雳锋,在試婚紗的時候發(fā)現(xiàn)自己被綠了黄绩。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,745評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡玷过,死狀恐怖爽丹,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情辛蚊,我是刑警寧澤粤蝎,帶...
    沈念sama閱讀 35,448評論 5 344
  • 正文 年R本政府宣布,位于F島的核電站袋马,受9級特大地震影響初澎,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜飞蛹,卻給世界環(huán)境...
    茶點故事閱讀 41,048評論 3 327
  • 文/蒙蒙 一谤狡、第九天 我趴在偏房一處隱蔽的房頂上張望灸眼。 院中可真熱鬧卧檐,春花似錦、人聲如沸焰宣。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,683評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽匕积。三九已至盈罐,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間闪唆,已是汗流浹背盅粪。 一陣腳步聲響...
    開封第一講書人閱讀 32,838評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留悄蕾,地道東北人票顾。 一個月前我還...
    沈念sama閱讀 47,776評論 2 369
  • 正文 我出身青樓,卻偏偏與公主長得像帆调,于是被迫代替她去往敵國和親奠骄。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,652評論 2 354

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