热门搜索 :
考研考公
首页 热点资讯 义务教育 高等教育 出国留学 考研考公
您的当前位置：首页正文

iOS 基于MVC设计模式的基类设计

来源：东饰资讯网
前言
概述
  • 这里笔者还是以微信为例，利用笔者常用的基于MVC设计模式的开发套路开发出微信的基本骨架。当然这里需要特别申明：以下内容都是笔者在日常开发中比较常用的基于MVC设计模式的开发套路，希望大家借鉴学习，也欢迎大家说说自己的基于MVC设计模式的开发套路，也让笔者借鉴学习学习。
  • 本篇文章内容主要侧重基类的设计和使用，当然笔者会详细的介绍各个基类的头文件暴露出来的属性和API的使用以及具体的使用场景。首先，基类的出现是为了聚合大量共有的常用业务逻辑，这样能极大程度的减少开发者冗余代码的产生，且让开发者更加专注于自身模块的开发。其次，基类提供API让其子类去重写，这样一定程度上保证了开发规范，让各个开发者写出易读、易懂的代码。
  • 此次，笔者设计的基类依然采用的是继承的方式来开发微信的基本骨架，当然，很多小伙伴会问，为何不用协议的方式？笔者个人认为，协议过于分散，而继承则比较单一。萝卜白菜，各有所爱，大家完全可以参考完笔者的基类设计后，可以自行DIY，写出自己习惯的套路来即可。
代码结构

  1. 结构


    CodeArchitecture.png
  2. 说明
    • Utils：存放工具类和管理类。例如：分类Category...
    • Vendor：存放第三方框架。例如：MJRefresh...
    • Macros：存放常量。例如：宏(#define)定义常量，const常量，枚举(NS_ENUM)常量，inline函数，URL路径常量。
    • Resource：存放资源文件。例如：图片，Data，SQL，Plist，Json等文件。
    • Other： 公有的Model，View，Controller。例如：MHTextField...
    • BaseClass 全局基类View，Model，ViewController。用于继承。
BaseClass
BaseClass.png
CMHViewController

CMHViewController 是整个项目中所有自定义的视图控制器(ViewController)的基类，继承于UIViewController。CMHViewController主要任务是为其子类提供一些基础的配置和API，方便子类去配置和重写，来满足不同的业务场景。详情请查看CMHViewController.h文件内容。CMHViewController.h的使用示例都放在MainFrame文件夹中。划重点 开发者只需要在其子类重写init方法，然后配置一些属性即可，代码如下：

/// 重写init方法，配置你想要的属性
- (instancetype)init
{
    self = [super init];
    if (self) {
        
        /// (是否取消掉当前控制器左滑pop到上一层的功能（栈底控制器无效），NO: 不取消<默认>，YES: 禁止侧滑左侧返回)
        self.interactivePopDisabled = YES;
        
        /// 禁止侧滑场景：
        /// 1. 主要是防止一些当前控制器的手势与侧滑手势冲突，比如图片浏览器，图片贴纸 ...等
        /// 2. 不希望侧滑返回上一层，比如点击右上角返回按钮，返回到根视图
    }
    return self;
}

CMHViewController.h属性的使用：

/// FDFullscreenPopGesture
/// (是否取消掉左滑(侧滑)pop到上一层的功能（栈底控制器无效），默认为NO，不取消)
@property (nonatomic, readwrite, assign) BOOL interactivePopDisabled;

/// FDFullscreenPopGesture
/// 是否隐藏该控制器的导航栏 默认是不隐藏 (default is NO)
@property (nonatomic, readwrite, assign) BOOL prefersNavigationBarHidden;

该属性控制当前控制器的导航栏的显示或隐藏功能。正常情况下我们常见的显示或隐藏导航栏代码无非是下面👇的代码：

- (void)viewWillAppear:(BOOL)animated{
    [super viewWillAppear:animated];
    /// 隐藏导航栏
    [self.navigationController setNavigationBarHidden:YES animated:YES];
}

- (void)viewWillDisappear:(BOOL)animated{
    [super viewWillAppear:animated];
    /// 显示导航栏
    [self.navigationController setNavigationBarHidden:NO animated:YES];
}

/// 是否隐藏该控制器的导航栏底部的分割线 默认不隐藏 （NO）
@property (nonatomic, readwrite, assign) BOOL prefersNavigationBarBottomLineHidden;

该属性控制当前控制器导航栏底部的分割线的显示或隐藏，首先系统的导航栏底部本身自带一个高度为.5f的分割线，但是平常开发我们大多数会自定义这条分割线的颜色，来满足产品样式开发的统一基调。关于这部分的定义和显示隐藏逻辑，请参照CMHNavigationController.h/m文件的实现。其示例代码请参照:MainFrame/Example02。

/// IQKeyboardManager
/// 是否让IQKeyboardManager的管理键盘的事件 默认是YES（键盘管理）
@property (nonatomic, readwrite, assign) BOOL keyboardEnable;
/// 是否键盘弹起的时候，点击其他区域键盘掉下 默认是 YES
@property (nonatomic, readwrite, assign) BOOL shouldResignOnTouchOutside;
/// To set keyboard distance from textField. can't be less than zero. Default is 10.0.
/// 键盘顶部距离当前响应的textField的底部的距离，默认是10.0f，前提得 `keyboardEnable = YES` 且数值不得小于 0。
@property (nonatomic, readwrite, assign) CGFloat keyboardDistanceFromTextField;


/// 截图（Push/Pop Present/Dismiss 过度过程中的缩略图）主要用在过渡动画里面
@property (nonatomic, readwrite, strong) UIView *snapshot;

/** should request data when viewController videwDidLoad . default is YES*/
/** 是否需要在控制器viewDidLoad后调用`requestRemoteData` default is YES*/
@property (nonatomic, readwrite, assign) BOOL shouldRequestRemoteDataOnViewDidLoad;

该属性控制是否在当前控制器viewDidLoad方法调用后，是否需要自动调用requestRemoteData方法（PS：该API下面会说到）。默认情况是YES，而当前控制器只需要重写基类的- requestRemoteData方法即可，无需再在当前控制器viewDidLoad方法调用后手动调用，如果设置为NO，那开发者需要手动调用- requestRemoteData方法，具体看使用场景。其示例代码请参照:MainFrame/Example06。

/// The callback block. 当Push/Present时，通过block反向传值
@property (nonatomic, readwrite, copy) void (^callback)(id);

该属性主要用于反向传值，这里使用block来代替delegate，增加其简洁性。反向传值的场景有很多，具体看实际使用场景。

当然正向传值一般采用- (instancetype)initWithParams:(NSDictionary *)params;创建控制器并向其传值（param），以及结合以下👇常用的key来达到获取传过来的的值（param）。 其示例代码请参照:MainFrame/Example07。

/// The base map of 'params'
/// The `params` parameter in `-initWithParams:` method.
/// Key-Values's key
/// 传递唯一ID的key：例如：商品id 用户id...
FOUNDATION_EXTERN NSString *const CMHViewControllerIDKey;
/// 传递数据模型的key：例如 商品模型的传递 用户模型的传递...
FOUNDATION_EXTERN NSString *const CMHViewControllerUtilKey;
/// 传递webView Request的key：例如 webView request...
FOUNDATION_EXTERN NSString *const CMHViewControllerRequestKey;

CMHViewController.hAPI的使用：

/// ------------ Method ------------
/// Initialization method. This is the preferred way to create a new Controller.
///
/// params   - The parameters to be passed to Controller. can be nil
///
/// Returns a new Controller.
- (instancetype)initWithParams:(NSDictionary *)params;

/// 基础配置 （PS：子类可以重写，但不需要在ViewDidLoad中手动调用，但是子类重写必须要调用 [super configure]）
- (void)configure;

/// 请求远程数据
/// sub class can override ， 但不需要在ViewDidLoad中手动调用 ，依赖`shouldRequestRemoteDataOnViewDidLoad = YES` 且不用调用 super， 直接重写覆盖
- (void)requestRemoteData;

/// fetch the local data
/// sub class can override ，且不用调用 super， 直接重写覆盖
/// Returns a local data.
- (id)fetchLocalData;

这几个API的使用和说明完全可以看注释， 但是这几个API的设计的作用，主要是规范子类API。子类完全可以根据实际的业务逻辑，去重写和覆盖基类的API，比如：当前控制器需要获取远程数据，则只需要在当前控制器重写- (void)requestRemoteData;方法，如果当前控制器不需要获取远程数据，你就不要去重写- (void)requestRemoteData;方法呗。当然写了也不会怀孕。。其示例代码请参照:MainFrame/Example06。

CMHTableViewController

CMHTableViewController 是整个项目中所有需要显示列表（UITableView）的自定义的视图控制器(ViewController)的基类，继承于CMHViewController。CMHTableViewController主要作用是提供了一个全屏大小的UITableView，且懒加载一个数据源dataSource，提供了一系列的属性和API，来满足现实开发中的常用场景，且使用度非常之高，比如：控制是否支持下拉刷新和上拉加载，以及暴露下拉刷新事件和上拉加载事件，子类只需配置相关的属性和重写相关的API即可满足，省去了大量的冗余代码，方便开发者专注于模块功能的开发。详情请查看CMHTableViewController.h文件内容。CMHTableViewController.h的使用例子都放在Contacts文件夹中。

CMHTableViewController.h属性的使用：

/// The table view for tableView controller. <自带全屏tableView,子类可以重新布局其frame>
/// tableView
@property (nonatomic, readonly, weak) UITableView *tableView;

/// The data source of table view <数据源懒加载>
@property (nonatomic, readonly, strong) NSMutableArray *dataSource;

/// 当前页 defalut is 1
@property (nonatomic, readwrite, assign) NSUInteger page;
/// 每一页的数据 defalut is 20
@property (nonatomic, readwrite, assign) NSUInteger perPage;

首先基类内部提供一个全屏的tableView，子类完全可以根据自身的业务场景，定制该tableView，比如设置其大小，改变其背景色...等。同时基类懒加载了一个dataSource，给子类使用。 page和perPage就具体按照自己后台规定即可，这里就无需多言了哈。其示例代码请参照:Contacts文件夹任意一个示例。

/// `tableView` 的内容缩进，default is UIEdgeInsetsMake(64或者88,0,0,0)，you can override it
@property (nonatomic, readonly, assign) UIEdgeInsets contentInset;

/// tableView‘s style defalut is UITableViewStylePlain , 只适合 UITableView 有效
@property (nonatomic, readwrite, assign) UITableViewStyle style;

contentInset主要影响tableView.contentInset罢了，这里是一个只读（readonly）属性，所以子类需要重写其get方法即可。默认值是：如果是iPhone X ，则为UIEdgeInsetsMake(88,0,0,0)，若不是，则为UIEdgeInsetsMake(64,0,0,0)。其示例代码请参照:Contacts/Example12。

style则主要影响的是tableView的样式，即：UITableView *tableView = [[UITableView alloc] initWithFrame:[UIScreen mainScreen].bounds style:self.style];这里也笔者不过多介绍了。其示例代码请参照:Contacts/Example11。

/// 是否数据是多段 (It's effect tableView's dataSource 'numberOfSectionsInTableView:') defalut is NO，但是跟组头组尾数据没任何关联
@property (nonatomic, readwrite, assign) BOOL shouldMultiSections;

shouldMultiSections主要影响tableView的UITableViewDataSource代理方法，即：- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView。但是这里必须强调的是：它跟组头组尾的数据显示没有关联，也就是他只能保证UITableViewCell是多组的，所以dataSource里面的每一个元素都是一个数组（NSArray）。比如微信的 ：发现界面，我的界面，设置界面..。等。其示例代码请参照:Contacts/Example15。

/// 需要支持下来刷新 defalut is NO
@property (nonatomic, readwrite, assign) BOOL shouldPullDownToRefresh;
/// 是否默认开启自动刷新， YES : 系统会自动调用`tableViewDidTriggerHeaderRefresh` NO : 开发人员可以在适当时机手动调用 `tableViewDidTriggerHeaderRefresh`
@property (nonatomic, readwrite, assign) BOOL shouldBeginRefreshing;
/// 需要支持上拉加载 defalut is NO
@property (nonatomic, readwrite, assign) BOOL shouldPullUpToLoadMore;
/// 是否在上拉加载后的数据,dataSource.count < perPage 提示没有更多的数据.default is YES 否则 隐藏mi_footer 。 前提是` shouldMultiSections = NO `才有效。
@property (nonatomic, readwrite, assign) BOOL shouldEndRefreshingWithNoMoreData;

CMHTableViewController.hAPI的使用：

/// sub class can override 且 不需要调用 [super ....] , 也可以直接调用不需要重写
/// reload tableView data , sub class can override , 等效于 [self.tableView reloadData]
- (void)reloadData;

/// dequeueReusableCell <复用cell> 子类需重写，无须调用 [super xxx]
- (UITableViewCell *)tableView:(UITableView *)tableView dequeueReusableCellWithIdentifier:(NSString *)identifier forIndexPath:(NSIndexPath *)indexPath;

/// configure cell with data <为cell配置模型 , 等效于 cell.model = object> 子类需重写，无须调用 [super configureCell:atIndexPath:withObject:]
- (void)configureCell:(UITableViewCell *)cell atIndexPath:(NSIndexPath *)indexPath withObject:(id)object;

/// 下拉刷新事件 子类需重写，无须调用 [super tableViewDidTriggerHeaderRefresh]
- (void)tableViewDidTriggerHeaderRefresh;
/// 上拉加载事件 子类需重写，无须调用 [super tableViewDidTriggerFooterRefresh]
- (void)tableViewDidTriggerFooterRefresh;
///brief 加载结束 这个方法  子类只需要在 `tableViewDidTriggerHeaderRefresh`和`tableViewDidTriggerFooterRefresh` 结束刷新状态的时候直接调用即可，不需要重写，当然如果不喜欢内部的处理逻辑，你直接重写即可
///discussion 加载结束后，通过参数reload来判断是否需要调用tableView的reloadData，判断isHeader来停止加载
///param isHeader   是否结束下拉加载(或者上拉加载)
///param reload     是否需要重载TabeleView
- (void)tableViewDidFinishTriggerHeader:(BOOL)isHeader reload:(BOOL)reload;

基类笔者提供以上👆几个API，主要涉及到界面的刷新，复用Cell的创建，Cell显示的模型配置，下拉刷新的事件，上拉加载的事件，以及结束刷新控件的刷新状态等方法，结合注释和示例程序，相信小伙伴会很快上手，强烈大家去看看CMHTableViewController.m的实现和注释，这样能更好的理解上述的属性和API使用场景。关于这几个API的使用示例代码请参照Contacts/Example13 ，Contacts/Example14 ，Contacts/Example15，Contacts/Example16。

CMHCollectionViewController

CMHCollectionViewController 是整个项目中所有需要显示UICollectionView的自定义的视图控制器(ViewController)的基类，继承于CMHViewController。CMHCollectionViewController主要作用是提供了一个全屏大小的UICollectionView，且懒加载一个数据源dataSource，提供了一系列的属性和API，来满足现实开发中的常用场景。这里CMHCollectionViewController的API和属性跟CMHTableViewController的属性和API设计的及其类似，且使用也类似，这里笔者就不再复述了。详情请查看CMHCollectionViewController.h文件内容。关于CMHCollectionViewController.h的使用例子都放在Discover文件夹中。当然这里着重讲的就是那个布局（collectionViewLayout）属性。

/// collectionView 的布局，默认是 `UICollectionViewFlowLayout`
@property (nonatomic, readwrite, strong) UICollectionViewLayout *collectionViewLayout;

首先，我们非常清楚UICollectionView最核心的内容也就是其布局，当然我们在创建UICollectionView的时候，即：- (instancetype)initWithFrame:(CGRect)frame collectionViewLayout:(UICollectionViewLayout *)layout，必须得传一个布局进去，否则就会Crash。所以，系统已经为我们提供了一个流水布局UICollectionViewFlowLayout给我们使用，这样已经完全可以解决大部分的使用场景。当然，一些场景需要自定义布局，来满足产品的需求开发，比如瀑布流布局，电影卡片布局...等等。这里笔者就提供了三套布局来证明该CMHCollectionViewController的可行性。只需要在子类里面重写init方法，并将自定义布局创建好，赋值给collectionViewLayout属性即可，示例核心代码如下：

/// 重写init方法，配置你想要的属性
- (instancetype)init
{
    self = [super init];
    if (self) {
        
        /// create collectionViewLayout
        CHTCollectionViewWaterfallLayout *layout = [[CHTCollectionViewWaterfallLayout alloc] init];
        layout.sectionInset = UIEdgeInsetsMake(10, 15, 10, 15);
        layout.headerHeight = 0;
        layout.footerHeight = 0;
        layout.minimumColumnSpacing = 10;
        layout.minimumInteritemSpacing = 10;
        
        self.collectionViewLayout = layout;
        
        self.perPage = 10;
        
        /// 支持上下拉加载和刷新
        self.shouldPullUpToLoadMore = YES;
        self.shouldPullDownToRefresh = YES;
        
    }
    return self;
}
CMHWebViewController

CMHWebViewController 是整个项目中所有需要显示WKWebView的自定义的视图控制器(ViewController)的基类，继承于CMHViewController。CMHWebViewController主要作用是提供了一个全屏大小的WKWebView，用来加载一些H5界面，当然笔者也提供了一系列的属性和API，来满足现实开发中的常用场景。详情请查看CMHWebViewController.h文件内容。关于CMHWebViewController.h的使用例子都放在Profile文件夹中。

/// webView
@property (nonatomic, weak, readonly) WKWebView *webView;
/// 内容缩进 (64,0,0,0)
@property (nonatomic, readonly, assign) UIEdgeInsets contentInset;

/// web url quest
@property (nonatomic, readwrite, copy) NSURLRequest *request;

/// 下拉刷新 defalut is NO
@property (nonatomic, readwrite, assign) BOOL shouldPullDownToRefresh;
/// 是否默认开启自动刷新， YES : 系统会自动调用下拉刷新事件。  NO : 开发人员手动调用需要手动拖拽 默认是YES
@property (nonatomic, readwrite, assign) BOOL shouldBeginRefreshing;

/// 是否取消导航栏的title等于webView的title。默认是不取消，default is NO
@property (nonatomic, readwrite, assign) BOOL shouldDisableWebViewTitle;

/// 是否取消关闭按钮。默认是不取消，default is NO
@property (nonatomic, readwrite, assign) BOOL shouldDisableWebViewClose;

contentInset、shouldPullDownToRefresh、shouldBeginRefreshing跟CMHTableViewController使用场景一模一样，这里笔者就讲讲shouldDisableWebViewTitle和shouldDisableWebViewClose两个属性的作用和使用场景。
shouldDisableWebViewTitle: 是否取消导航栏的title等于webView的title。默认做法是MHWebViewController及其子类的导航栏title为WebView的title，而不是MHViewModel的title属性。即控制器通过KVO的形式监听WKWebView的title属性，从而设置导航栏的title，self.navigationItem.title = self.webView.title。但是可能有几个H5界面想要设置导航栏的title为MHViewModel的title属性，正所谓需求拉动生成，所以就产生了该属性。
shouldDisableWebViewClose：是否导航栏左侧取消关闭按钮，默认是不取消。这主要是为了解决点击网页里面的链接继续加载另一个网页，如果重复前面的步骤几次，则网页层次就会非常的深（A - B - C - D - E ...）。如果我们点击MHWebViewController导航栏的左侧的返回按钮，其默认做法是返回到上一个网页（[self.webView goBack]），这样由于前面的步骤，导致网页层次过深，我们需要点击多次返回按钮，才能返回到最初的网页，继而才能返回上一个界面，这样用户操作过多，用户体验下降（PS：干着程序猿的活，抄着产品经理的心）。

总结

以上内容就是笔者在产品开发中，若使用MVC设计模式来开发产品的前提下，比较常用一套开发套路。首先，这只是笔者喜爱的开发套路，并不能满足所有开发者的业务场景，大家只需要把有用或有效的内容拿过来参照参照，且能够完美运用到自身项目的架构中去，这样笔者就非常欣慰了。其次，如果大家有许多好点子或建议，请及时反馈（评论or私信）给笔者，看能否加在基类里面，更好的去造福于广大初学的开发者。最后，整体项目的基类设计，无论在属性命名，还是API设计都有比较强的逻辑性和指向性，当然笔者能力有限，并没有设计成非常的高大上，而是非常的易读易懂，大家可以结合注释以及使用示例更好的去理解和使用，争取早日上手和拓展使用。

当然这里主要讲的基类的头文件的内容，具体的实现逻辑还是需要大家去基类的实现文件.m去学习和理解，当然大家主要看那些笔者用CoderMikeHe Fixed Bug标识的部分，大家也可以全局搜索CoderMikeHe Fixed Bug字段，这些修复Bug的内容，才是整篇基类的核心所在，当然，笔者依然不敢保证还是否有Bug的出现。有问题，及时交流即可。

最后讲讲关于开发者在自定义控制器时，基类继承的选取问题，建议如下。

  • 如果你自定义的控制器不需要显示tableView、collectionView、webView，只想一个简简单单控制器，那么就直接继承于CMHViewController即可，比如微信登录模块。
  • 如果你自定义的控制器需要使用到tableView来展示列表数据，那么就直接继承于CMHTableViewController即可，比如微信发现模块。
  • 如果你自定义的控制器需要collectionView来展示类似九宫格的数据，那么就直接继承于CMHCollectionViewController即可，比如自定义手机相册模块。
  • 如果你自定义的控制器需要加载H5页面，那么就直接继承于CMHWebViewController即可或者没有H5交互的情况直接使用CMHWebViewController，比如微信使用帮助模块。
  • 究竟继承哪个基类，请根据自身模块的使用场景，灵活选取即可。
期待
  1. 文章若对您有点帮助，请给个喜欢❤️，毕竟码字不易；若对您没啥帮助，请给点建议💗，切记学无止境。
  2. 针对文章所述内容，阅读期间任何疑问；请在文章底部批评指正，我会火速解决和修正问题。
  3. GitHub地址：
  4. 源码地址：
    <特别强调： 使用前请全局搜索 CMHDEBUG 字段并将该宏置为 1即可，默认是0 >

Copyright © 2019- huatuoyibo.cn 版权所有
湘ICP备2023022426号-1

Top