觀“編寫高質量iOS與OC 代碼的52個有效方法”有感(三)· 接口與API設計

iPhone.jpg

我們在寫程序時,都希望其中一部分代碼用于后續項目,又或者把某些代碼發布出來,供他人使用。因此,我們構建項目的要注意:

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

  • 因為Objective-C沒有其他語言那種內置的命名空間機制(namespace)。
    所以我們在起名時要設法避免潛在的命名沖突,否則就容易重名,發生命名沖突,程序鏈接過程就會出錯。比如下面:
命名沖突.png
  • 避免問題:
    變相實現命名空間:為所有名稱都加上適當前綴(一般是與公司或者應用程序有關聯的名字)。命名時要注意:因為Apple宣傳其保留使用所有“兩字母前綴”的權利,那我們自己選的前綴應該是三個字母的。

16、提供“全能初始化方法”

  • 所有對象都要初始化。但是創建類實例的方式有的時候不止一種。
    例如:UITableViewCell,初始化時,需要指明其樣式以及標識符,標識符區分不同類型的單元格。
    這種對象的創建成本比較高,繪制表格的時候可依照標識符復用,提升程序效率。我們把這種可為對象提供必要信息以便能完成工作的初始化方法叫做“全能初始化方法”
  • 試一試
    首先創建一個類“ZSCManager”然后給其添加2個只讀的屬性,這樣外界就無法更改了,再提供初始化方法設置這兩個屬性:
 #import <Foundation/Foundation.h>

@interface ZSCManager : NSObject

@property (nonatomic, readonly, copy) NSString *name;
@property (nonatomic, readonly, copy) NSString *phone;

- (id)initWithManageName:(NSString *)name
                   phone:(NSString *)phone;

@end

//.m的實現
#import "ZSCManager.h"

@implementation ZSCManager


- (id)init {
    return [self initWithManageName:@"未知名字" phone:@"110"];
}


- (id)initWithManageName:(NSString *)name
                   phone:(NSString *)phone {
    if (self = [super init]) {
        _name = name;
        _phone = phone;
    }
    return self;
}

@end
  • 注意:
    設置默認值的那個init方法調用了“全能初始化方法”。
    若是存儲方式變了(比如名字和手機號放在某個結構中),則init與全能初始化方法設置數據的代碼就要修改。
    簡單的情況沒有太大問題,如果類的初始化方法有很多種,而且初始化的數據較為復雜,那么這樣做就麻煩的多。很容易忘記修改某個初始化方法,造成初始化方法之間相互不一致。

  • 假如現在創建個名叫 ZSCLeader 的類,讓其成為 ZSCManager 的子類。那么新類的初始化方法要怎么寫呢?

#import "ZSCManager.h"

@interface ZSCLeader : ZSCManager

- (id)initWithLeaderName:(NSString *)name;

@end

//.m的實現
#import "ZSCLeader.h"

@implementation ZSCLeader

- (id)initWithManageName:(NSString *)name
                   phone:(NSString *)phone {
    return [self initWithLeaderName:name];
}

- (id)initWithLeaderName:(NSString *)name {
    return [super initWithManageName:name phone:nil];
}

@end
  • ZSCLeader類的全能初始化方法調用了超類的全能初始化方法,
    再看 ZSCManager 類的實現,也會發現 ZSCManager 也調用了超類的全能初始化方法,因此說明:全能初始化的方法調用鏈一點要維系。
    調用者創建 ZSCLeader 會通過 initWithLeaderName 或者 init的方法。所以要覆寫超類的全能初始化方法,否則init方法創建就會有問題。

  • 有時候我們不想覆寫超類的全能初始化方法,可以理解為:我們認為這是調用者自己犯錯了。這樣子,我們就需要覆寫超類的全能初始化方法并拋出異常:

- (id)initWithManageName:(NSString *)name
                   phone:(NSString *)phone {
    @throw [NSException exceptionWithName:NSInternalInconsistencyException reason:@"不讓你調用此方法,方法名字:initWithManageName:(NSString *)name phone:(NSString *)phone 或者 init" userInfo:nil];
}
  • 然后調用init 或者超類的方法創建時,程序就會崩潰報錯
    *** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: '不讓你調用此方法,方法名字:initWithManageName:(NSString *)name phone:(NSString *)phone 或者 init'

  • 我們不想程序崩潰也想知道崩潰的原因,可以這樣辦:

    @try {
        // 可能會出現崩潰的代碼
        ZSCLeader *leader = [[ZSCLeader alloc] init];
    }
    @catch (NSException *exception) {
        // 捕獲到的異常exception
        NSLog(@"%@",exception);
        //控制臺的輸出
        //不讓你調用此方法,方法名字:initWithManageName:(NSString *)name phone:(NSString *)phone 或者 init
    }
    @finally {
        // 結果處理
    }
  • 總結:
    • 如果在類中提供一個全能初始化方法,在文檔中指明。其他初始化方法均應調用此方法。
    • 若全能初始化方法與超類不同,則需覆寫超類中的對應方法。
    • 如果超類的初始化方法不適用子類,那么應該覆寫這個超類方法,并在其中拋出異常。

17、實現 description 方法

  • 調試程序時,經常需要打印并查看對象信息。一般都是這樣做
    ZSCManager *manager = [[ZSCManager alloc] init];
    NSLog(@"%@",manager);
    可以看到輸出為:
    <ZSCManager: 0x610000026b40>
    這樣的信息不太有用。只有類的名字和指針地址。

  • 我們在類中覆寫 description 方法。

    - (NSString *)description {
        return [NSString stringWithFormat:@"<%@:%p ,\"name : %@  phone : %@\">",[self class],self,_name,_phone];
    

}

這次的輸出變得不一樣了,對我們也更有用:
      <ZSCManager:0x6080000354e0 ,"name : 未知名字  phone : 110">

- 注意:
  - 實現 description 方法返回一個有意義的字符串,用以描述該實例。
  - 若想在調試時打印出更詳盡的對象描述信息,則應該實現 debugDescription 方法。

#18、盡量使用不可變對象
- 設計類的時候,要充分運用屬性來封裝數據。
屬性默認情況是“既可讀又可寫的”(readWrite)
一般來說,我們有些建模的數據未必需要改變。這樣我們最好把其屬性設置為readonly。
      @property (nonatomic, readonly, copy) NSString *name;
如果想“暴力”修改,那就通過KVC:
      [manager setValue:@"哈哈" forKey:@"name"];

#19、使用清晰而協調的命名方式
 - 方法和變量名使用“駝峰式大小寫命名法”
小寫字母開頭,其后每個單詞首字母大寫。
類名也用駝峰命名法,不過其字母要大寫,而且前面通常有兩三個前綴字母。

- 方法名要言簡意賅,從左至右讀起來要像個日常用語中的句子才好。
- 方法名里不要使用縮略后的類型名稱。
- 給方法起名時的第一要務就是確保其風格與你自己的代碼或所要集成的框架相符。

#20、為私有方法名加前綴
- 一個類所要做的事情通常都要比外面看到的更多。
編寫類的實現代碼時,經常要寫一些只在內部使用的方法。
建議應該為這種方法的名稱加上某些前綴。
1、有助于調試。
2、容易把公共方法和私有方法區別開。
- 不要單用一個下劃線做私有方法的前綴,因為這種做法是預留給蘋果公司用的,建議用p_XXXX這樣。p代表 “private”(私有的)。

#21、理解Objective-C錯誤模型
- 很多編程語言都有“異常”(exception)機制,Objective-C 也不例外。
       @throw [NSException exceptionWithName:NSInternalInconsistencyException reason:@"XXX" userInfo:nil];
OC語言現在采用的方法:只在極其罕見的情況下拋出異常,異常拋出之后,無須考慮恢復問題,應用會立刻退出。不需要編寫“異常安全”代碼。
-  Objective-C在出現“非致命錯誤”時。這樣處理的:
令方法返回 nil/0,或者是使用NSError。
 - 假如調用者發現方法的返回值是nil,就可以確定其中發生了錯誤。就可以采取相對應的措施。
 - NSError 用法靈活。我們可以把導致錯誤的原因匯報給調用者。
NSError domain(錯誤范圍,類型為字符串)
產生錯誤的根源,比如從URL中解析或取得數據時出錯了,就會使用NSURLErrorDomain來表示錯誤范圍。
Error code(錯誤碼,類型為整數)
獨有的錯誤代碼,錯誤情況通常采用 enum 來定義。比如 HTTP 請求出錯時,可能會把HTTP狀態碼設為錯誤碼。
User info (用戶信息,類型為字典)
關于錯誤的額外信息。
- 參考 AFNetworking 中對NSError的使用,直接把錯誤信息放在 NSError 對象里,經由“輸出參數”返回給調用者。

#22、理解 NSCopying 協議
- 使用對象時經常需要拷貝它。
在Objective-C中,如果想令自己的類支持拷貝操作,就要實現 NSCopying 協議。協議里只有一個方法:
      - (id)copyWithZone:(nullable NSZone *)zone
NSZone是什么呢?
以前開發程序時,會把內存分為不同的“區”(zone),對象會創建在某個區里面。
現在不用了,每個程序只有一個“默認區”,不用擔心其中的 zone 參數。
  • (id)copyWithZone:(nullable NSZone *)zone {
    ZSCManager *copy = [[[self class] allocWithZone:zone] initWithManageName:_name phone:_phone];
    return copy;
    }
直接把待拷貝的對象交給“全能初始化方法”,令其執行所有初始化工作。

- 若是自定義的對象分為可變版本和不可變版本,那么就要同時實現 NSCopying 和 NSMutableCopying 協議。
- 復制對象時需要決定采用淺拷貝還是深拷貝,一般情況下執行淺拷貝。
深拷貝:在拷貝自身時,將其底層數據也一并復制過來。
淺拷貝:只拷貝容器對象本身,而不復制其中數據。
注意:容器內的對象未必都能拷貝,調用者也不一定想在拷貝容器的時候一并拷貝其中的每個對象。
因為:沒有專門定義深拷貝的協議。
所以:具體執行方式由每個類來確定,只需要你自己決定自己寫的類是否要提供深拷貝的方法。如果你所寫的對象需要深拷貝,那么可以考慮新增一個專門執行深拷貝的方法。

### 接下來也將會繼續整理。如果覺得有用請點個喜歡!
### 您的支持將是我繼續寫作的動力!謝謝。

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

推薦閱讀更多精彩內容