【iOS开发】MVVM 模式项目模板

在这几年做 iOS 开发中,做了好几个项目,从最初的 MVC 模式到 MVVM 模式,深切体会到了 MVVM 模式的优点。另外,把 MVVM 模式与响应式编程结合起来,更是能写出高质量的代码。对于一般的项目来说,我觉得使用一个通用的结构就已经足够,所以我整理了一个项目模板,以后要做新项目时,重新把模板命名为新项目的模板即可,从此不需要再做重复性的项目搭建工作。

iOS-MVVM-Template

本项目是参考 kickstarter/ios-oss 编写的一个 iOS 模板项目,这里感谢 Kickstarter 的开源,让我们学习到了如此优秀的 iOS 项目结构。

本项目是根据我自己的项目需求、对 Kickstarter 源码中一些不必要的功能进行精简,并且在一个实际项目中应用后整理出的一个模板。如果想要详细了解 Kickstarter 的源码,请自己去仔细阅读。本人之前在阅读 Kickstarter 项目源码时,也整理了一份笔记,有需要的同学也可以去看下。Kickstarter-iOS 源码分析 - 文集 - 简书

项目地址:Lebron1992/ios-mvvm-template

目录结构

iOS-MVVM-Template
├── Api : 存放网络请求相关的文件
│   ├── Models
│   │   ├── AccessToken.swift : AccessToken 模型
│   │   ├── ErrorCode.swift:错误代码
│   │   ├── ErrorEnvelope.swift : 后台返回的 Error 数据模型
│   │   ├── Templates : 存放数据模型的模板
│   │   └── VoidEnvelope.swift : 后台返回空 json `{}` 数据时的数据模型
│   ├── Extensions
│   │   └── URLSession+RequestHelpers.swift : 使用 ReactiveSwift 对 URLSession 的扩展方法
│   ├── Lib
│   │   ├── RequestMethod.swift : 请求方法
│   │   └── Route.swift : 所有的网络请求
│   ├── EnvironmentType.swift : 应用环境类型
│   ├── MockService.swift : 模拟的 Service
│   ├── ServerConfig.swift : 服务器配置的数据模型
│   ├── Service+RequestHelpers.swift : 对 Service 的扩展,发送网络请求和解析数据的方法
│   ├── Service.swift : Service 类型,负责整个应用的网络请求
│   └── ServiceType.swift : ServiceType 协议,Service 和 MockService 都遵循这个协议
├── Configs
│   ├── Global.swift : 存放全局的常量
│   └── Secrets.swift : 存放应用的一些配置
├── DataModels : 存放数据模型
│   ├── Templates : 存放数据模型的模板
│   └── User.swift : User 数据模型
├── DataSources : 存放 DataSource
│   └── Base
│       ├── ValueCell.swift : ValueCell 协议。想要使用 ValueCellDataSource 作为 UITableView 和 UICollectionView 的数据源,他们对应的 Cell 都需要实现这个协议
│       └── ValueCellDataSource.swift : 实现了 UITableViewDataSource 和 UICollectionViewDataSource,只整理了一些常用的数据处理的方法,有其他需求的可以继续往这里添加
├── Library : 存放在整个应用中比较通用的类型
│   ├── Extensions : 存放对类型的扩展
│   ├── App.swift : App 的相关信息
│   ├── AppEnvironment.swift : 管理应用环境
│   ├── Environment.swift : 应用环境的数据模型
│   ├── Keyboard.swift : 使用 ReactiveSwift 对键盘的弹出和隐藏进行处理
│   ├── Nib.swift : 方便初始化使用 xib 自定义的 View
│   ├── Notifications.swift : 管理应用中用到的通知类型
│   ├── PushRegistration.swift : 使用 ReactiveSwift 对 Push 通知的注册进行处理,实现了 PushRegistrationType 协议
│   ├── PushRegistrationType.swift : PushRegistrationType 协议
│   └── Storyboard.swift : 方便初始化使用 Storyboard 自定义的 ViewController
├── Resources : 存放应用中用到的字体、图标等文件
├── ViewModels : 存放 View Model
└── Views&Controllers : 存放 View 和 Controller

使用到的第三方库

项目重命名

可以参考 stackoverflow 的这个问题:

How do I completely rename an Xcode project (i.e. inclusive of folders)?

有问题可以直接留言,或者加入我管理的Swift开发群:536353151