iOS代碼規範

時間 2019-11-10

標籤 ios 代碼規範欄目 iOS 简体版

原文原文鏈接

編碼規範

項目結構規範

項目結構圖

|-業務1
|   |-業務1的Storyboard
|   |-子業務1
|   |   ｜-controller
|   |   ｜-view
|   |   `-model
|   |-子業務2
|   |   ｜-controller
|   |   ｜-views
|   |   `-models
|-業務2
|   |-業務2的Storyboard
|   |-子業務1
|   |   ｜-controller
|   |   ｜-view
|   |   `-model
|   |-子業務2
|   |   ｜-controller
|   |   ｜-view
|   |   `-model
|-util（工具）
|-lib（第三方庫）
|-ui（自定義的一些基礎view）
|-Images.xcassets（xcode自帶圖片管理文件）
`-Resources（資源文件，包括靜態文件，本地化文件等）

原則

若是對應目錄下有多個相關的類，則controller，view，model的名字相應變爲controllers，views，models
Images.xcassets中的目錄結構要與業務保持一致，從而方便查找和替換圖片

註釋

註釋能夠採用「/* */「和「//「兩種註釋符號，涉及到多行註釋時，儘可能使用「 /* */「
對於一行代碼的註釋可放在前一行及本行上，不容許放在下一行，更不容許在一行語句的中間加入註釋
沒必要每行都加註釋，在3~10行左右的段落作註釋要好於每行都作註釋，顯而易見的代碼不加註釋。例如：數據庫
```
if (!returnValue){      //調用登陸過程失敗          ←無用的註釋
    NSLog(@」登陸失敗」);
}
```

排版格式

代碼的縮進應使用空格（SPACE），不能使用製表符（TAB），而且縮進以2個字符爲單位
括弧遵循緊湊編碼方式，以下：數組
```
for (int i = 0; i < 10 ; i++) {
}
```
空格的使用xcode
- 關鍵字與其後的表達式之間要有空格，如：網絡
```
if (expr)
或
for (expr)
```
- 單目操做符不該與它們的操做數分開（如「!「和「^「等）
- 除「,「外，其它雙目操做符應與它們的操做數用空格隔開，如：架構
```
i=i+1;              //錯誤的寫法，操做符兩端沒有空格
i = i + 1;          //正確的寫法，
if(a>b)             //錯誤的寫法，邏輯判斷符號兩端沒有空格
if(a > b)           //正確的寫法
```
- .h中協議<>前面有一個空格
- .h中成員聲明時，類型與變量之間有至少1個空格。*號靠近變量，不靠近類型
- @property後留1個空格，（）裏面，逗號緊跟前一變量，與後一變量之間留1個空格。（）外面，先留1個空格，再聲明屬性
- 方法的+，-後面與（）之間留1個空格
- 返回類型與之間留1個空格，方法參數中返回類型與之間留1個空格
- 在多參數方法中，每一個參數後面都有1個空格
每行只能有一個語句
關於空行
- .h中的空行
  - 文件說明與頭文件包含(#import)之間空1行
  - 頭文件包含(#import)之間，若是須要分類區別，各種別之間空1行
  - 頭文件包含(#import)與@class之間空2行
  - @interface與@class之間空1行
  - 頭文件{}裏面，空1行開始聲明對象成員，若是須要分類區別，各種別之間空1行
  - 頭文件{}外，空1行書寫屬性，若是須要分類區別，各種別之間空1行
  - 屬性下面空1行開始寫方法，若是須要分類區別，各種別之間空1行
  - 方法完成後，空1行@end
  - 若是須要聲明protocol，空2行接着寫。一般protocol寫在@end後面，可是聲明在@interface以前
- .m中的空行
  - 文件說明與頭文件包含(#import)之間空1行
  - 頭文件包含(#import)之間，若是須要分類區別，各種別之間空1行
  - @implementation和@synthesize之間空1行, 若是須要分類區別，各種別之間空1行
  - @synthesize與方法之間空1行
  - 方法與方法之間空1行
- 方法裏面的空行
  - 變量聲明後須要空1行，若是須要分類區別，各種別之間空1行
  - 條件、循環，選擇語句，整個語句結束，須要空1行
  - 各功能塊之間空1行
  - 最後一個括弧以前不空行
  - 註釋與代碼之間不空行
  - #pragma mark 與方法之間空1行
- 每行代碼最多不得操做100個字。設置以下：Xcode -> Preferences -> TextEditing
  -> Page Guide at column，輸入 100便可

命名規範

文件命名規範

資源文件

資源文件的名字採用第一個單詞首字母小寫，其餘單詞首字母大寫的格式，最後以文件類型結尾，如：
contactImage：表明這是聯繫人圖片
contactInfoDB：表明這是聯繫人數據庫文件
contactLocalizable：表明這是聯繫人業務的本地化文件app

代碼命名規範

方法

方法的名稱應所有使用有意義的單詞組成，且以小寫字母開頭，多單詞組合時，後面的單詞首字母大寫。如：ide
```
-(void)getContactInformation
```
設置類變量的內容的方法應使用set做爲前綴，讀取變量的內容的方法應使用get做爲前綴。如：函數
```
-(void)getContactName;
-(void)setContactName:(NSString *)contactName;
```
方法中的參數：第一個參數名稱要從函數名稱上攜帶出來，第二個參數的首字母小寫，多個單詞組合時，後面單詞首字母大寫。參數有別名時，參數別名與參數名一致，但參數名前綴以_。參數別名與前一參數保留1個空格。參數無別名時，以有意義的字母命名。如：工具
```
-(void)myFunctionWithSizeA:(CGSize)sizeA sizeB:(CGSize)_sizeB;
```

變量

變量必須起有意義的名字，使其餘組員能夠很容易讀懂變量所表明的意義，變量命名能夠採用同義的英文命名，可以使用幾個英文單詞，第一個單詞首字母小寫，其餘單詞首字母大寫。如：ui
```
NSString  *contactName;
```
對於一些特殊類型的變量，命名時要帶上類型，如NSArray 的變量命名爲xxxArray，其餘的如xxxDictionary，xxxSize等。這樣就能夠從名稱上知道是什麼類型的變量。千萬不能將NSArray的變量命名爲xxxDictionary。
對於要和interface builder關聯的的輸出口變量，命名時要後綴以特定的控件名。如：
```
IBOutlet UILabel *contactNameLabel;
```
對於使用c語言形式聲明的變量，一些特定類型可採用必定的簡寫。如：
指針類型：P
結構體類型：Rec
數組類型：Arr
Core Graphic：CG
等。
循環控制變量一般使用單一的字符如：i、j、k等。使用有意義的名字，如objectIndex也是能夠的
儘可能避免使用全局變量，若是必須使用全局變量則必須加前綴「Pub_「，同時應在變量名稱中體現變量的類型
私有實例變量前加一個下劃線，如_myPrivateVarible

枚舉變量也要有相應的前綴來區分不一樣的enum變量。好比蘋果公司的一個enum。如：

typedef enum CGPathDrawingMode CGPathDrawingMode;
/* Drawing modes for text. */

enum CGTextDrawingMode 
{
     kCGTextFill,
     kCGTextStroke,
     kCGTextFillStroke,
     kCGTextInvisible,
     kCGTextFillClip,
     kCGTextStrokeClip,
     kCGTextFillStrokeClip,
     kCGTextClip
};

常量

避免在程序中直接出現常數，使用超過一次的應以宏定義的形式來替代
常數的宏定義應與它實際使用時的類型相一致。如以3.0來定義浮點類型，用3表示整型
常量的命名應當可以表達出它的用途，而且用大寫字母表示。如：
```
#define PI 3.1415926
```

一些常量前加特殊前綴，能夠做爲不一樣常量的區分，如：

UserDefaultsKey的變量前加UDKEY_,
NotificationNameKey前面加NNKEY_,
DictionaryKey前面加DICTKEY_

類

全部的類名前加MB，以區分業務類和引入的第三方類
全部的類名，接口名(Protocol)均以大寫字母開頭，多單詞組合時，後面的單詞首字母大寫。類，接口名必須是有意義的
繼承自UIView的類以View結尾，如：MBContactInfoView，MBLabelView等
繼承自UIViewController的類以ViewController結尾，如：MBContactInfoViewController，MBContactDetailViewController等。

架構規範

總體設計

遵循嚴格的MVC結構設計。
強化View層和Model層的功能，Control層只作調度：
- 界面展現邏輯徹底在View層控制，Control層經過View層提供的一個接口來將數據傳遞給View層，而後由View層來作具體的界面展現控制。
- 數據的加工在Model層實現，Model層經過重寫setter或getter來對數據進行加工。
- Control層負責響應事件和回調，而後發送網絡請求等。
禁止出現功能不明確的類。類必須和具體業務對應

類設計

UIViewController

原則

UIViewController中儘可能不要出現直接設置控件（UIButton，UITextField等）屬性的代碼，而是將控件封裝在單獨的自定義UIView類中，而後在自定義UIView類中設置控件的屬性。以下的代碼最好不要在UIViewController中出現：
```
self.textLabel = [[UILabel alloc] init];
self.textLabel.textColor = [UIColor blackColor];
self.textLabel ... ...
self.textLabel ... ...
self.textLabel ... ...
```
封裝私有initContent和updateContent方法，前者在viewDidLoad中調用，用來初始化全部的自定義UIView，後者在viewWillAppear中調用，用來更新全部的自定義UIView。
全部的生命週期方法都必須調用super方法。

結構

import UIKit

class SwiftController: MBViewController {

    // 屬性

    @IBOutlet weak var queryButton: UIButton!

    @IBOutlet weak var contentView: MBContentView!

    @IBOutlet weak var tableView: UITableView!

    var contactTitle:NSString?

    // 生命週期
    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view.

        // 與界面無關屬性的初始化
        self.contactTitle = "This is Test"

        // 界面的初始化在統一的方法initContent中執行
        self.initContent()
    }

    override func viewWillAppear(animated: Bool) {
        super.viewWillAppear(animated)

        // 界面的更新在統一的方法updateCotent中執行
        self.updateCotent()
    }

    override func viewDidAppear(animated: Bool) {
        super.viewDidAppear(animated)

        // 添加對通知事件的觀察
        NSNotificationCenter.defaultCenter().addObserver(self, selector: Selector("queryFinished:"), name: "queryFinished", object: nil)
    }

    override func viewWillDisappear(animated: Bool) {
        super.viewWillDisappear(animated)
    }

    override func viewDidDisappear(animated: Bool) {
        super.viewDidDisappear(animated)

        // 移除對通知事件的觀察
        NSNotificationCenter.defaultCenter().removeObserver(self, name: "queryFinished", object: nil)
    }

    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // Dispose of any resources that can be recreated.
    }

    // tableView協議
    func numberOfSectionsInTableView(tableView: UITableView) -> Int {
        // #warning Potentially incomplete method implementation.
        // Return the number of sections.
        return 5
    }

    func tableView(tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        // #warning Incomplete method implementation.
        // Return the number of rows in the section.
        return 10
    }

    func tableView(tableView: UITableView, titleForHeaderInSection section: Int) -> String? {
        return String(format: "Section %d", section)
    }

    func tableView(tableView: UITableView, didSelectRowAtIndexPath indexPath: NSIndexPath) {
    }

    func tableView(tableView: UITableView, cellForRowAtIndexPath indexPath: NSIndexPath) -> UITableViewCell {
        let cellIdentifier : String = "cellIdentifier"
        var cell:UITableViewCell? = self.tableView.dequeueReusableCellWithIdentifier(cellIdentifier) as? UITableViewCell
        if cell == nil {
            cell = UITableViewCell(style: UITableViewCellStyle.Subtitle, reuseIdentifier: cellIdentifier)
        }
        cell?.textLabel?.text = String(format: "Cell %d", indexPath.row)
        cell?.detailTextLabel?.text = "Watch out!!! Something AWESOME is coming~~~"
        return cell!
    }

    // 事件響應
    @IBAction func queryPressed(sender: AnyObject) {

    }

    func queryFinished(sender: AnyObject) {

    }

    // 私有方法
    private func initContent() {

        // 若是須要設置多個屬性則爲每一個View封裝單獨的方法來進行View的初始化
        self.initQueryButton()
    }

    private func updateCotent() {
    }

    private func initQueryButton () {
        self.queryButton.setTitle("Query", forState: UIControlState.Normal)
        self.queryButton.setTitle("Query...", forState: UIControlState.Disabled)
    }

    /*
    // MARK: - Navigation
    // In a storyboard-based application, you will often want to do a little preparation before navigation
    override func prepareForSegue(segue: UIStoryboardSegue, sender: AnyObject?) {
        // Get the new view controller using segue.destinationViewController.
        // Pass the selected object to the new view controller.
    }
    */

}

UIView

原則

爲每一個自定義UIView創建xib（xib和UIView類關聯的方式見DEMO），靜態的約束在xib中直接添加，動態的約束使用Masonry在代碼中添加。
儘可能使用Autolayout作界面約束，只有在Autolayout不支持的狀況下才使用設置frame的方法來作界面約束。
展現的邏輯在UIView內部控制，若是UIView中某幾個控件的控制邏輯比較複雜，則須要封裝單獨的處理方法。

結構

import UIKit

class MBContentView: UIView {

    @IBOutlet var contentView: UIView!
    @IBOutlet var imageView: UIImageView!
    @IBOutlet var label: UILabel!

    /*
    // Only override drawRect: if you perform custom drawing.
    // An empty implementation adversely affects performance during animation.
    override func drawRect(rect: CGRect) {
        // Drawing code
    }
    */

    // 生命週期
    // 在該方法中初始化View
    required init(coder aDecoder: NSCoder) {
        super.init(coder: aDecoder)

        // 加載xib內容
        NSBundle.mainBundle().loadNibNamed("ContentView", owner: self, options: nil)
        self.addSubview(self.contentView)

        // 在統一的initConstraint方法中添加約束
        self.initConstraint()
    }

    override func layoutSubviews() {
        super.layoutSubviews()
    }

    // 私有方法
    private func initConstraint(){
        // OC 用 Masonry， Swift 用 SnapKit
        self.contentView.mas_makeConstraints { (MASConstraintMaker) -> Void in
            var make = MASConstraintMaker
            make.edges.equalTo().self
//            make.top.equalTo().self
//            make.bottom.equalTo().self
//            make.leading.equalTo().self
//            make.trailing.equalTo().self
        }
    }

    // 提供接口供ViewController調用
    func setQueryResult(queryResult:MBQueryResult?) {
        self.label.text = queryResult?.contactName
    }

}

Form/Model

原則

數據的加工處理通常放在Form/Model中，以下：

-(void)setPoint:(NSString *)point{
    if ([point isEqualToString:@"null"]){
        _point = @"0";
    }else{
        _point = point;
    }
}

若是須要用到多個Model中的部分屬性，則須要創建新的Model。

Protocol

原則

Portocol的命名要明確且跟具體的業務相關

若是Portocol實現的方法不超過3個，能夠直接定義在協議相關的類中，以下：

@protocol XXXDelegate <NSObject>
-(void)method1:(id)obj;
-(void)method2:(id)obj;
-(void)method3:(id)obj;
@end

@interface XXX : UIView<XXXDelegate>
@property (weak, nonatomic) IBOutlet id<XXXDelegate>delegate;
@end

超過3個則須要單獨創建協議類

Manager

原則

若是Manager須要在應用的生命週期內一直存在，則實現成單例，單例實現方式以下：

class func shareInstance()->XXManager{
    struct MBSingleton{
        static var predicate:dispatch_once_t = 0
        static var instance:XXManager? = nil
    }
    dispatch_once(&MBSingleton.predicate,{
        MBSingleton.instance=XXManager()
        }
    )
    return MBSingleton.instance!
}

命名要和具體業務相關，禁止出現業務不明確的Manager
Manager不對數據進行加工處理，而是交由Form/Model來作，相似下面的代碼不能寫在Manager內部
```
if "zzz" == c.zzz {
    c.zzz = a.xxx+b.yyy
} else {
    c.zzz = a.xxx
}
```