您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發綜合

iOS 開發規範:命名、檔案組織與程式碼風格約定

編輯:iOS 開發綜合

以下整理 Objective-C 開發中常見的程式碼規範(參考 Apple 官方建議)。雖以 OC 為例,但概念並不限於 OC,換成其他語言時只要把語言特有部分替換成該語言的慣例即可。

一、命名

命名規則對程式碼維護至關重要。Objective-C 的方法名往往很長,但這也有好處——很多註解因此變得多餘。

本文採用駝峰命名法,這也是 Objective-C 社群的標準。駝峰法分為小駝峰(除第一個單字外,其餘單字首字母大寫)與大駝峰(第一個單字首字母也大寫)。

1. 基本原則

清晰:又清晰又簡潔最好,但兩者衝突時,簡潔不如清晰重要。盡量不要使用單字縮寫(非常通用的除外),API 名稱不能有歧義,看到名稱就知道做了什麼事。

一致性:同一件事在程式碼裡就固定用同一個名字,例如 tag、setStringValue。不確定怎麼取名時,可以參考既有慣用命名。

2. 類命名

類名(不含類別與協議)使用大寫開頭的大駝峰命名法,並包含一個或多個名詞來說明這個類做什麼。

在應用層級的程式碼中,盡量不要使用帶前綴的類名,因為每個類都帶相同前綴並不會提升可讀性;但若是撰寫多個應用間共享的程式碼,前綴就是可接受且推薦的做法(例如 JKPhotoBrowser)。

// 一般應用
@interface ImageBrowseView : UIView
@end

// 共享程式碼,加上 JK 前綴
@interface JKPhotoBrowser : UIView
@end

3. 類別(Category)命名

格式為「類名 + 標識 + 擴展功能」,例如 UIImageView+HPWeb:UIImageView 是被擴展的類,HP 是專屬標識,Web 是擴展的功能。

類別的方法應加上前綴(如 hp_setImageWithURLString:),以避免 Objective-C 單一命名空間下的方法衝突。

// UIImageView+HPWeb.h
@interface UIImageView (HPWeb)
- (void)hp_setImageWithURLString:(NSString *)urlStr;
@end

4. 方法命名

方法使用小駝峰命名法。一個規範的方法讀起來應該像一句完整的話,讀完就知道函式作用。執行性的方法以動詞開頭,回傳性的方法以回傳的內容開頭,但前面不要加 get。

- (void)replaceObjectAtIndex:(NSUInteger)index withObject:(id)anObject;
+ (instancetype)arrayWithArray:(NSArray *)array;

有參數時,方法名本身就是第一個參數的提示;多參數時每個參數前也應有提示(一般不加 and)。常見操作應使用約定俗成的動詞,如 initWith、insert、remove、replace、add 等。

5. 變數命名

變數名同樣使用小駝峰,並讓名稱能推測用途、具描述性。別為了少打幾個字母而犧牲可讀性。

成員變數:小駝峰並加上底線前綴。Objective-C 2.0 之後,@property 與 @synthesize 提供了符合規範的做法。

@interface ViewController ()
@property (nonatomic, strong) NSMutableArray *dataArray;
@property (nonatomic, strong) UITableView *tableView;
@end

區域變數:

NSMutableArray *ticketsArray = [NSMutableArray arrayWithCapacity:0];
NSInteger numCompletedConnections = 3;

常量:預定義、列舉、區域常量等以小寫 k 開頭的駝峰法命名,例如 kInvalidHandle、kWritePerm。

#define kRunAnnotationStartPointTitle @"起點"

typedef NS_ENUM(NSInteger, RunGoalTypeE) {
    kRunGoalTypeNone = 0,      // 無目標
    kRunGoalTypeTime = 1,      // 以時間為目標
    kRunGoalTypeDistance = 2,  // 以距離為目標
    kRunGoalTypeCalori = 3,    // 以消耗卡路里為目標
};

NSString *const kGroupInfoName = @"name";

6. 圖片資源命名

先參考新浪微博 App 的資源命名方式:

以功能為組織形式的命名是很值得學習的習慣,能大幅提升資源查找效率。原則如下:

1)採用單字全拼,或公認無歧義的縮寫(如 nav、bg、btn);
2)採用「模塊 + 功能」命名法,模塊分為公共模塊與私有模塊。公共模塊包含統一背景、導航列、標籤、公共按鈕背景、預設圖等;私有模塊依 App 業務劃分,如用戶中心、消息中心。

建議背景圖以 bg 為前綴、按鈕背景以 btn 為前綴(非強制,由專案負責人依團隊特點確定)。

公共模塊示例:

bg_nav_bar@2x.png                    // 導航列背景
bg_nav_back_normal@2x.png            // 導航返回按鈕(常態)
bg_nav_back_selected@2x.png          // 導航返回按鈕(選中)
bg_tabbar_record_normal@2x.png       // 標籤 item 背景(常態)
bg_tabbar_record_selected@2x.png     // 標籤 item 背景(選中)

私有模塊示例(以 Joggers App 的用戶中心為例,uc = user center):

bg_uc_avatar@2x.png       // 用戶中心預設頭像
bg_uc_top_defaut@2x.png   // 用戶中心頂部預設背景
bg_uc_bottom@2x.png       // 用戶中心底部背景

這部分工作瑣碎,容易被視為技術含量低,但命名的嚴謹度同樣反映團隊對細節的追求——細節決定成敗。

二、檔案組織結構

1. 類檔案組織

iOS 工程有物理結構與邏輯結構,建議兩者保持一致以便管理。組織原則有兩條:

・基於 MVC 設計模式,至少保證 controller 與資料處理、網路請求相對獨立;
・基於功能模塊,每個功能模塊包含資料/網路處理與 UI 前端兩部分,資料處理放在對應框架下,而用戶中心、消息中心這類 UI 模塊的 controller、view 放在各自檔案夾中,公共 view 則另外開闢公共檔案夾管理。

實際落地時可由專案負責人結合專案特點靈活調整,但基本原則務必保持。

2. 圖片資源組織

強烈建議使用 Images.xcassets 管理圖片,盡量少用自建檔案夾。除了打包優化等優勢外,從工程管理角度看還有一個實務好處:往 xcassets 添加資源不會改動 project 檔,而直接在檔案夾裡加圖每次都會改動 project 檔,因此前者能顯著減少多人協作時的 project 衝突。

下圖是 Joggers 的檔案組織結構:

可以看到它嚴格遵循上述原則,物理結構與邏輯結構一致,方便團隊查閱程式碼與共享資源。

三、類內部程式碼組織

一個原則:dealloc 最好放在類最上方,第一眼就能看到是否移除了註冊、通知與 KVO,內存釋放是否合理;接著是 controller / view 的生命週期方法,再往下是自行實作的方法;相同或相近功能的方法用 #pragma mark - 標記以便快速定位。

好的程式碼本身就是最好的註解,因此這裡不另外展開註解規範,具體要求由各專案負責人約定。

四、團隊落地清單

程式碼整潔:

・刪除多餘空行:方法與方法之間空 1 行,程式碼塊之間空 1 行;
・刪除多餘註解:註解掉的程式碼、沒有意義的註解;
・刪除多餘方法:未被使用的方法、沒有任何業務邏輯的方法(或補上說明);
・刪除未被使用的資源檔案。

必要註解:

・所有 .h 檔案中的 property 需註解;
・所有自定義方法需註解;
・較大的程式碼塊需註解;
・程式碼中出現的阿拉伯數字需註解;
・加密/解密邏輯處需說明過程。

風格統一:

・「{」不單獨佔一行;
・邏輯運算符與前後程式碼之間空一格;
・「#pragma mark -」與下方程式碼之間不要空行。

通用規則:

・命名見名知意,採駝峰式;
・依資源類型或業務邏輯分組,保持專案結構清晰;
・類名以專案工程名開頭(如 XP、ZJG、SZ),視圖控制器加後綴(ViewController / View / Button / Label);
・單頁程式碼建議控制在 800 行內,單一方法不超過 100 行,超標則重構;
・相同邏輯避免多處定義,公共類與方法應抽離;
・從其他專案複製的程式碼要依當前風格整理並刪除無用部分;
・所有 Group 與檔案名稱(含圖片)不使用中文,優先英文,國內特有名詞可用拼音;
・所有 Group 都對應一個真實目錄,兩者檔案一一對應;
・善用 #pragma mark - Mark Name 分組,例如 View lifeCycle、Init methods、Action methods、UITableViewDelegate Methods 等。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved