iOS项目开发文档

项目架构

一、基本配置

  • IDE工具:Xcode
  • 开发语言:object-C
  • iOS系统支持:iOS10.0+
  • iOS机型适配:iPhone6及之后机型(包含min\max\proMax)
  • 开发模式:MVC+MVVM,以MVC为主,

在某些业务量比较多的模块使用MVVM给控制器减重,增强代码的阅读性和可维护性,增强View的功能,数据双向绑定。

二、开发流程

[图片上传失败...(image-b4cce9-1634026127483)]

三、三方框架

1. 三方框架的管理

使用CocoaPods进行三方框架的统一管理,拥有安装、卸载、更新、查看、搜索等很多实用的功能,能快速方便的解决项目的文件依赖和路径管理

2. 具体三方框架

  1. AFNetWorking

  2. SDWebImage

  3. MJExtention/JSONModel

  4. MJRefresh

  5. MBProgressHUD/SVProgressHUD

  6. QMUIkit

  7. YYKit

  8. FMDB

  9. IQKeyBordManager

  10. Masonry/SDAutoLayout

  11. WetCahtOpenSDK

  12. AMapLoction

  13. TZImagePackController

  14. AliyunOSSiOS

四、模块解耦(组件化)

模块化方案MJGRouter
MGJRouter是一个单例类,使用前需要通过注册组件,调用方通过URL调用服务方页面,通过路由表的映射关系进行关联,调用方可以传入复 杂的参数、对象等。
基本跳转主要是注册组件,调用openURl方法,传入参数即可实现。

[MGJRouter registerURLPattern:@"ADM://shop/car" toHandler:^(NSDictionary *routerParameters) {
    NSLog(@"admShopCarModuleRegisted",);
}];

[MGJRouter openURL:@"ADM://shop/car"];
现有功能可以组件化拆分的有:
  • IM
  • 购物车
  • 下单
  • 支付
  • 订单
  • 地址
  • 消息

五、代码规范

、、、

六、项目目录与层级

目录层级划分的三个原则:易读易维护易扩展

模块划分

1. 应用入口

AppDelegate是应用的代理,应用级的事件都委托它处理,包含启动退出、应用前后台状态切换与监听、推送等事件,以及IM、支付等第三方的回调,这使得AppDelegate内代码庞大,错综复杂,十分不利于阅读和维护,因此新增一个AppDelegate+ServerClass类别,用来处理生命周期之外的业务,AppDelegate作为事件入口,具体实现直接调用类别里的方法,只为更清晰。

2. 主代码模块

主代码模块包含了应用内的功能模块,根据底部Tab栏划分并关联实体文件夹。每个模块内使用的是MVC模式,MVC是一种设计思想,并非死套路就三个文件夹,根据实际需求适当增加。

3. 管理模块

Manager的定义是全局基础服务,通常使用类方法或者单例来实现,主要包含对应用、用户的管理和服务,例如网络状态监听,广告页应用介绍页等。

4. 工具类

Tools文件夹内主要包含全局通用工具,来源于对三方框架的二次封装,或是自己写的工具类。

5. 基类

Base文件夹用来存放项目的基类,基类作用包含一些定制化的内容,例如页面样式,空数据页面等,使用基类来实现,可以统一控制,利于维护,减少冗余,也为更清晰。

6. 全局宏定义 &其他文件

全局宏顾名思义是定义了一些全局通用宏。这里定义了四个:

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

推荐阅读更多精彩内容

  • 架构图: 架构原则:易读性、易维护性、易扩展性。 一、思考 做好一件事,花在思考上的时间应该多于执行。 首先根据产...
    Young_LI阅读 712评论 0 1
  • APP项目搭建 上周个人刚搭建完的项目框架,在这分享一下,主要还是采用MVC设计模式,没有使用storyboard...
    深圳张学友阅读 5,085评论 3 44
  • 一:设计模式 1:本项目采用mvvm设计模式,每个模块下分为四个文件夹,分别为:ControllerViewVie...
    MichaelLiu_03df阅读 4,587评论 3 33
  • 一:设计模式 1:本项目采用mvvm设计模式,每个模块下分为四个文件夹,分别为:Controller View ...
    漠醉阅读 4,177评论 0 3
  • 16宿命:用概率思维提高你的胜算 以前的我是风险厌恶者,不喜欢去冒险,但是人生放弃了冒险,也就放弃了无数的可能。 ...
    yichen大刀阅读 6,020评论 0 4