iOS项目MVC实践点滴(一) —— 代码划分和注释

前言

近来,对公司的新项目依据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.其次就是常规的代码注释:

参考芳仔小脚印的博客,要相信女孩子整理东西的能力,何况芳仔也是个大神。

三、说说代码规范

这个槽不吐不快,何况我英文很渣;因为英文不好,这个规范对我来说难度有点大。
程序员最头疼的事:命名

然后,最打击我的一句话是:英语学不好,菜鸟当到老;

我只想说一句:就让我静静的彩笔到老吧。

最后,给出自己使用的代码规范。当然前提是先遵循苹果官网的规范。

野生程序员一枚:公司木有代码规范,自己从各个大神博客里学习摘抄,最终自己的项目就形成了这样的代码规范,以后应该会随着学习和技术的提升还有很大改观吧。

如有错误,望批评指正。

最后编辑于
?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,100评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,308评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,718评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,275评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,376评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,454评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,464评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,248评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,686评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,974评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,150评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,817评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,484评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,140评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,374评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,012评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,041评论 2 351

推荐阅读更多精彩内容