Swift 开发编码规范

主要是参考和保留一些 Objective-C 开发编码规范的一些规则

一. 开发使用到的语言

  1. 主要使用 Swift
  2. Objective-C

二. 项目结构说明

项目的第三方库以CocoaPods工具管理，安装好CocoaPods后使用.xcworkspace打开项目

一级目录说明

  1. Class: 存放源代码
  2. Default: 存放宏定义/静态参数
  3. Bridge: 存放桥接文件, Swift 与 Objective-C 的桥接文件
  4. Resource: 存放资源文件,图片、音频、plist 等
  5. ThirdPart: 存放第三方资源（某些不能通过cocoapods管理的库）
  6. Localizable.strings 代码字符串本地化
  7. InfoPlist.strings 应用名称本地化

二级目录说明

  1. Class: 存放源代码

    1. ViewController 主要是控制器有关的类
    2. ViewModel 视图模型
    3. View 视图
    4. Model 模型
    5. Extension 所有系统分类(Category)
    6. Protocol 协议、代理
    7. SigleObject 单例对象
    8. Tools 工具类

  2. Defautl 宏定义/ 全局/ 常量 (命名规则: 前缀+作用/位置(+其他))

    • 文字大小 字号 (前缀: font)
    • 尺寸大小 宽/高/间距 (前缀: size)
    • 全局色值 (前缀: color)
    • 图片名称 (前缀: img)
    • URL 接口 (前缀: url)
    • 通知名称 (前缀: notic)

  3. Bridge 桥接文件

    1. Bridge.h 桥接 OC 代码
    2. HJYL.swift 取代 OC 中的 pch 文件的全局宏定义

  4. Resource 图片、音频、plist 等

  5. Localizable.strings 代码字符串本地化

    1. Localizable.strings(English) 英文
    2. Localizable.strings(Simplified) 简体中文
    3. Localizable.strings(Tradtional) 繁體中文

  6. InfoPlist.strings 应用名称本地化

    1. Localizable.strings(English) 英文
    2. Localizable.strings(Simplified) 简体中文
    3. Localizable.strings(Tradtional) 繁體中文

三. 项目命名规则

一.文件命名规则

  1. 控制器: 前缀 NWF_ + 功能/作用 (+ 其他) + 类型

     首页控制器 : NWF_HomeViewController.swift

  2. view: 前缀 NWF_ + 功能/作用(+ 其他) + 类型

      NWF_DoubleTableView.swift

  3. Model: 前缀 NWF_ + 功能/作用(+ 其他) + Model

      NWF_BaseModel.swift

  4. Extension : 类名 + +/- + Extension

      UIButton-Extension.swift
  UIView+Extension.swift

  5. Protocol : 前缀 NWF_ + 类名(+ 其他) + Protocol/Delegate/DataSource

      NWF_DictModelProtocol.swift
  NWF_DoubleTableViewDataSource.swift
  NWF_DoubleTableViewDelegate.swift

二.变量命名规则

  1. 全局变量命名规则: font/size/color/url/img/notic + 位置/作用(+其他)

     字体大小: fontNavTitle
 高度尺寸: sizeNavigationH
 全局背景色: colorAPPBackground
 按钮图标: imgNavLeftBackButton
 通知 : noticHomeTableHeadViewHeightDidChange

  2. 成员属性命名规则: 作用/功能/位置 + 其他 + 类型

      // 懒加载控件 (属性 后面的 +View 表示是 View 类型)
  fileprivate lazy var noticeView : NWF_NoticView = {[weak self] in
  }()

  // 懒加载控制器属性 (后面的 +VC 表示控制器类型)
  lazy var regionVC : NWF_RegionViewController = {[weak self] in
  }()

  // 控件尽量使用 weak 修饰, 上面两个例子都未使用到 weak 修饰, 
  // 通过 XIB 或者 storyboard 加载的控件 (属性名称后面的 +Label 表示对应的类型)
  @IBOutlet weak var subTitleLabel: UILabel!

三.函数/方法命名规则

  1. 函数 命名规则: nwf + Func + 功能作用 + 其他参数 ...

    在很多场合仍然需要用到函数，比如说如果一个对象是一个单例，那么应该使用函数来代替类方法执行相关操作。 函数的命名和方法有一些不同，主要是：

    • 函数名称一般带有缩写前缀，表示方法所在的框架。
    • 前缀后的单词以 “ 驼峰 ” 表示法显示，第一个单词首字母大写。
    • 函数名的第一个单词通常是一个动词，表示方法执行的操作：
     // 前缀 nwfFunc + 功能 Font + 其他 withPx 
 // 通过像素转出文字大小
 func nwfFuncFontWithPx(_ px : CGFloat) -> CGFloat

  2. 方法 命名规则: (nwf +) 功能作用 + 其他参数 ...

      // 设置右边 客服按钮 (带有 set 避免与 setter 方法冲突, 因此要添加 前缀)
  fileprivate func nwfSetRightServiceButton() -> Void

  // 按钮点击事件调用的方法
  命名规则: 按钮名称 + Click 
  传递参数: sender
  @objc fileprivate func rightServiceButtonClick(_ sender : UIButton) -> Void

  3. 注意: 类扩展的方法必须有前缀 nwf 避免与UIKit 框架提供的方法冲突

      // 个原有的 NSString 类型添加 : 根据文字大小计算字符串尺寸的方法
  func nwfSizeWithFont(_ font : UIFont?) -> CGSize {}

四.协议/代理

  1. 协议代理方法

    • 一个类的 Delegate 对象通常还引用着类本身，这样很容易造成引用循环的问题，所以类的 Delegate 属性要设置为弱引用, 可选型.

      // MARK: - 代理属性
weak var delegate : UITableViewDelegate?

    • 当特定的事件发生时，对象会触发它注册的委托方法。委托是 iOS 中常用的传递消息的方式。委托有它固定的命名范式。一个委托方法的第一个参数是触发它的对象，第一个关键词是触发对象的类名，除非委托方法只有一个名为 sender 的参数：

      func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {}
func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {}

    • 根据委托方法触发的时机和目的，使用 should,will,did 等关键词

      func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {}

五.闭包 (Block)

文件中方法要归类

// MARK: - 其他属性

// MARK: - lazy sourceData

// MARK: - lazy componentView

// MARK: - addSubviews

// MARK: - override View Method

// MARK: - buttonClick

// MARK: - notification

// MARK: - other Method

// MARK: - delegate

集成第三方框架

  1. 使用 cocoapods 集成第三方框架
  2. pod 'MJRefresh' # 依然是 OC的代码
  3. pod 'Alamofire' #, '~> 4.0.1' AFNetworking 的 swift 版本 platform :ios, '8.0' +
  4. pod 'SnapKit' #, '~> 3.2.0' Masonry 的 swift 版本 platform :ios, '8.0' +
  5. pod 'Kingfisher' # , '~> 3.1.1' Swift iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+ 取代SDWebImage
  6. (...其他第三方框架, 后续补充)

results matching ""

    No results matching ""