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）