前言
近来,对公司的新项目依据MVC架构对代码进行了深度拆分和重新封装,将几千行代码的viewController文件尽量拆分到600行以内;将业务逻辑、网络请求、数据持久化(数据存储)和数据模型单独封装,使代码结构变的清晰、易于维护。其实,iOS开发对MVC架构的实践算是应用的很到位了;只是有时候项目开发周期紧,大家为了方便把所有东西都塞进viewController里面,开发是快了很多,也造成了后面调试和维护浪费很多时间;其次,也因为之前对MVC理解的不够深刻吧。
下面内容基本都是针对唐巧大神"这篇文章"的一次实践,同时也参考了阿里一位大神的这一系列文章iOS应用架构谈(1~4),内容包括:代码注释、View拼凑、VC瘦身、数据模型、网络层、数据持久化封装等;尽量保证代码结构清晰,整洁。
一、MVC内部代码划分:
1.viewController
#pragma mark - 生命周期(业务流程基本在这里展现)
#pragma mark - 代理(包含了UITableView和view的事件代理等)
#pragma mark - 事件处理
#pragma mark - 私有方法(尽量不要出现这个模块)
#pragma mark - getter 和 setter
2.View
View里面基本都是UI的拼接,因此注释相对简单
针对控件的赋值,ViewController会传一个Model过来,在setter里面给所有控件赋值
#pragma mark - 生命周期(基本是控件的创建和初始化)
#pragma mark - 共有方法
#pragma mark - 事件处理(通过代理,代理到VC里面处理)
#pragma mark - 私有方法(针对一些没有必要开新类的处理,用方法封装到这里)
#pragma mark - getter 和 setter(控件的构建基本通过getter方法完成)
3.Model
Model是数据模型,里面声明的变量(或者是属性,因为变量基本是通过属性自动合成)和服务器请求到得数据基本是一一对应的;对于复杂的界面(UITableview或)也许不能使用AutoLayout;因此,这里面多添加了一个类Layout,里面主要计算并存储界面上要显示内容的高度。因此,这里最多的就是私有方法
#pragma mark - 生命周期
#pragma mark - 私有方法
4.Service(MVC里面的业务层)
从ViewController尽可能的抽出所有业务逻辑封装在这里,然后在ViewController持有Service的实例,业务层所有业务都针对ViewController提供接口。因此,这里最多的就是共有接口
#pragma mark - 生命周期
#pragma mark - 公有方法(接口)
5.数据持久化
位于Service层之下,位于Model层之上;一般操作是:
- 业务层通过网络请求数据或者从文件、缓存等处读取数据(文件、缓存等和数据持久化有关);
- 用户操作界面,造成一些改变,变化或通过view代理到ViewController,ViewController操作Service层进行一些业务处理(也就是数据的变化,这里的变化基本上都需要Model的配合),然后写入文件或者写入缓冲,亦或是通过网络发送给远程服务器。
#pragma mark - 生命周期
#pragma mark - 公有方法(接口)
最后说明:这些是个人代码??榈幕趾湍?槟诖氲闹饕掷啵攵韵附谛缘亩骰剐枰菹钅炕蚴导实囊滴窭捶?。
二、代码注释
1.首先给出几个代码注释技巧:
// TODO:待处理(针对没有实现的方法一般会这样注释)
// FIXME:待修改(针对实现效果不好,或代码有问题的这样注释)
// ???:有疑问(针对就项目维护或项目引用开源库,不懂得地方可以使用)
// !!!:重要信息
针对以上的注释,有专门的收集这些注释的开源库,可以根据个人爱好使用。
个人习惯:针对开发要使用的开源库,能不使用尽量不使用。针对调试使用的代码库,能使用的尽量使用(只要它对我有帮助)。
2.其次就是常规的代码注释:
参考芳仔小脚印的博客,要相信女孩子整理东西的能力,何况芳仔也是个大神。
三、说说代码规范
这个槽不吐不快,何况我英文很渣;因为英文不好,这个规范对我来说难度有点大。
程序员最头疼的事:命名
然后,最打击我的一句话是:英语学不好,菜鸟当到老;
我只想说一句:就让我静静的彩笔到老吧。
最后,给出自己使用的代码规范。当然前提是先遵循苹果官网的规范。
野生程序员一枚:公司木有代码规范,自己从各个大神博客里学习摘抄,最终自己的项目就形成了这样的代码规范,以后应该会随着学习和技术的提升还有很大改观吧。
如有错误,望批评指正。