一份 iOS 開發實踐檢查清單

回顧即開始

目錄

1. 開始項目
2. 實用公共庫
3. 架構
4. 數據儲存
5. 資源
6. 編碼規範
7. 安全性
8. 診斷

開始項目

Xcode

• Apple 幫助 - Xcode

.gitignore

• Git 添加 .gitignore: Swift or Objective-C

依賴管理

• CocoaPods 文檔

sudo gem install cocoapods # 安裝
pod init # 初始化建立 Podfile
pod install/update # 安裝/更新依賴
複製代碼

• Carthage (Swift) 文檔

brew install carthage # 安裝
carthage bootstrap/update # 安裝或更新依賴
複製代碼

工程目錄結構

• 熟悉並保持合理的目錄結構

AwesomeProject
├─ Assets
│	├─ Info.Plist
│	├─ Localizable.strings
│	├─ R.generated.swift # 可選，R.swift 生成
│	├─ LaunchScreen.storyboard
│	├─ Assets.xcassets
│	├─ ProjectName.entitlements
│	├─ Info.Plist
│	├─ BuildConfigs
│	└─ ···
├─Sources
│	├─ Modules
│   ├─ MyModule
│   │   │   ├─ Models
│   │   │   ├─ Views
│   │   │   └─ Controllers (or ViewModels)
│   │	└─ ···
│   ├─ Stores
│   ├─ Helpers
│   ├─ Utilities
│   ├─ Extentsions
│   ├─ Mediator
│   ├─ Ventors
│   └─ ···
├─Tests
└─ ···
複製代碼

• 字符串本地化（Localization）
  • WWDC 404 - New Localization Workflows in Xcode 10
  • WWDC 401 - Localizing with Xcode 9
  • WWDC 201 - Internationalization Best Practices
• 最小化常量做用域（Constants）

// 全局常量建議採用 Enum 定義
enum Constants {
    static let myConstant = "Just a constant"
}
enum Apprearance {
    enum Sizes {
        static let gutter: CGFloat = 15
        static let cardGutter: CGFloat = 8
        ···
    }
    enum Color {
        static let primaryColor = UIColor(red: 0.22, green: 0.58, blue: 0.29, alpha: 1.0)
    	static let secondaryColor = UIColor.lightGray
        static let background = UIColor.white

        enum Red {
           	// 可視化顏色
            static let medium = #colorLiteral(red: 0.22, green: 0.58, blue: 0.29, alpha: 1.0)
            static let light = #colorLiteral(red: 0.22, green: 0.58, blue: 0.29, alpha: 1.0)
        }
    }
}
複製代碼

• Git 分支模型
  • git-flow 的工做流 - Tower
  • gitflow-avh 拓展

實用公共庫

• Alamofire 網絡庫

• Moya 基於Alamofire 封裝的網絡抽象層

• Reachability.swift 用於網絡情況檢查

• R.swift 自動將各類資源強類型化

• SwiftDate/DateTool 時間日期處理庫

• RxSwift 響應式編程框架 by ReactiveX.io

• LayoutKit 高性能視圖佈局庫

• Kingfisher 輕量級圖片下載緩存庫

• NSLogger 便捷日誌工具

• Willow 輕量級日誌工具 教程

• FLEX/DoraemonKit 應用內 Debug 工具庫

架構

• Model-View-Controller (MVC) in iOS: A Modern Approach
• Introduction to MVVM
• MVVM with Coordinators and RxSwift
• ReactiveCocoa and MVVM, an Introduction

Model

• 保持 Model 不可變性, struct + Codable Apple 文檔
• SwiftyJSON / Argo [可選]

Views

• 採用 AutoLayout 佈局
  • Apple 文檔 - NSLayoutAnchor
  • WWDC 220 - High Performance Auto Layout
  • WWDC 218 - Mysteries of Auto Layout, Part 1
  • WWDC 219 - Mysteries of Auto Layout, Part 2

Controllers

• 避免控制器臃腫
  • 8 Patterns to Help You Destroy Massive View Controller
• 儘可能採用依賴注入而不是單例

let fooViewController = FooViewController(withViewModel: fooViewModel)
複製代碼

數據儲存

• 避免「回調地獄」（callback hell）
• RxSwift 異步響應式編程

func fetchGigs(for artist: Artist) -> Observable<[Gig]> {
    // ...
}
複製代碼

• CoreData 持久化
  • Apple 文檔 - Core Data
  • WWDC 224 - Core Data Best Practices

資源

• 採用 .pdf 矢量圖
• R.swift 自動集中管理圖片、xib、字符串等各項資源
• ImageOptim 圖片優化

編碼規範

• API Design Guidelines for Swift

• LinkedIn's Official Swift Style Guide

• //MARK: + Extension分組結構化代碼

import SomeExternalFramework

class FooViewController : UIViewController {

    let foo: Foo

    private let fooStringConstant = "FooConstant"
    private let floatConstant = 1234.5

    // MARK: Lifecycle

    // Custom initializers go here
	···
}

// MARK: View Lifecycle
extension FooViewController {
    
    override func viewDidLoad() {
        super.viewDidLoad()
        // ...
    }
    
}

// MARK: Layout
extension FooViewController {
    
    private func makeViewConstraints() {
        // ...
    }
    
}

// MARK: User Interaction
extension FooViewController {
   	
    func foobarButtonTapped() {
        // ...
    }
    
}

// MARK: FoobarDelegate
extension FooViewController: FoobarDelegate {
    
    func foobar(foobar: Foobar, didSomethingWithFoo foo: Foo) {
        // ...
    }
    
}

// MARK: Helpers
extension FooViewController {
        
    private func displayNameForFoo(foo: Foo) {
        // ...
    }
    
}

複製代碼

安全性

• Apple 文檔 - iOS Security Guide

數據儲存

• Token、用戶名密碼及部分隱私敏感數據避免採用 UserDefault 或 CoreData 等非加密持久化方式
• 採用 KeyChain 加密儲存敏感數據
  • Apple 文檔 - Storing Keys in the Keychain
  • KeychainAccess

網絡

• 採用 https TLS 加密傳輸

日誌採集

• 設置正確的日誌輸出等級
• 線上環境必定不要打印密碼等敏感信息
• 記錄基本代碼控制流，以便調試

用戶交互

• UITextField 用於密碼等敏感信息輸入時設置secureTextEntry 爲 true
• 必要時清空剪貼板等可能存在的敏感數據
  • applicationDidEnterBackground

診斷

• 重視並儘可能解決編譯器警告
• 靜態分析
  • Product → Analyze
• 調試
  • 開啓 Exception 斷點
  • Reveal 視圖調試
• 性能剖析
  • Apple 幫助 - Instruments

參與貢獻

歡迎指正共建與獲取最新狀態：Github 倉庫 - iOS-Practice-Checklist