项目规范
核心思想
简化一切繁琐代码, 复杂逻辑多方法分类拆分, 风格保持简洁优雅, 严谨易读 杜绝一切不安全情况.
复用封装视情况而定, 可以独立拆分的全部分离, 维护成本最小化, 保持整体工程高内聚低耦合, 业务尽可能模块化管理.
标准StoryBoard构建的ViewController结构示例
关键点
- 名称以
XXXController命名. - 通过
class ViewController<Container: UIView>: UIViewController基类指定相关联的View. - 区别于传统ViewController, C层与V层隔离, 业务逻辑在Controller中完成, 所有视图相关全部在View中完成.
- 代码按特性划分 不可混乱排列.
- 特殊操作需写清注释.
- 每个方法内保持逻辑原子性, 切勿过多混合不同逻辑 可以通过拆分方法.
- 切勿过多创建公共属性, 没有必要的属性可以考虑通过参数和局部变量解决.
- 控制好访问权限, 不需要暴露出来的方法或属性做好私有修饰.
import UIKit
class SettingController: ViewController<SettingView> {
// 各种常量变量声明区域
// 顺序通常为 public -> private -> lazy -> IB -> Other
// 初始化优先使用Then
override func viewDidLoad() {
super.viewDidLoad()
setup()
setupLayout()
setupNotification()
loadData()
}
// 其他IBAction
// 其他重写属性或方法
override var preferredStatusBarStyle: UIStatusBarStyle {
return .default
}
static func instance() -> Self {
return StoryBoard.setting.instance()
}
deinit {
// 释放处理
}
}
extension SettingViewController {
// public方法
}
extension SettingViewController {
private func setup() {
// 设置 添加子视图等
}
private func setupLayout() {
// 设置布局
}
private func setupNotification() {
// 设置通知监听
}
}
extension SettingViewController {
// 事件方法
}
extension SettingViewController {
// 数据请求方法
private func loadData() {
/* ... */
}
}
extension SettingViewController {
// 其他逻辑方法
}
extension SettingViewController {
// 其他代理方法
}
UI布局准则
- 不使有.xib, 全部可视化应在所属模块的Storyboard中进行创建.
- 复杂动态页面优先考虑纯代码布局方案 使用SnapKit.
- 如遇到有输入框页面应在最外层套一层UIScrollView, 方便键盘躲避处理.
- 复杂视图模块应考虑增加容器视图包装, 有利于未来复用移动.
- 充分考虑大小屏幕的等比例适配, 使用AutoInch进行适配.
- 全面屏适配优先考虑SafeArea技术, 切勿依赖设备类型判断, 如必要情况可使用AutoInch进行不同设备适配.
- 能在可视化中处理的UI操作全部可视化, 减少不必要的UI代码可以提高可读性.
图片等资源存储
优先使用Assets.xcassets
颜色 图片使用
推荐
// Color Literal
#colorLiteral(red: 1.0, green: 1.0, blue: 1.0, alpha: 1.0)
// Image Literal
#imageLiteral(resourceName: <#T##String#>)
第三方开源库引入指南
本着纯粹的Geek精神, 尽量减少第三方的使用 (必要级别除外, 同时不要重复造轮子)
如可以自己完成的则自己完成, 完成不了的可以参考某第三方开源项目自己完成, 以上都无法满足再考虑引入.
第三方开源库选择优先级:
- 知名技术团队开源维护
- 良好的活跃度
- 符合所要需求 (需求之外的功能无任何意义)
- 源码易于自身维护和调整
- Swift语言优先
公共组件设计准则
- 良好的可扩展性
- 严谨的逻辑思维
- 严格的访问权限
- 优雅的语法特性
- 合理的接口设计
- 通用的业务兼容
网友评论