MJRefresh 源码解读

MJRefresh是李明杰老师的作品,到现在已经有9800多颗star了,是一个简单实用,功能强大的iOS下拉刷新(也支持上拉加载更多)控件。它的可定制性很高,几乎可以满足大部分下拉刷新的设计需求,值得学习。

该框架的结构设计得很清晰,使用一个基类MJRefreshComponent来做一些基本的设定,然后通过继承的方式,让MJRefreshHeader和MJRefreshFooter分别具备下拉刷新和上拉加载的功能。从继承机构来看可以分为三层,具体可以从下面的图里看出来:

框架组织结构图

首先来看一下该控件的基类:MJRefreshComponent:

MJRefreshComponent

这个类作为该控件的基类,涵盖了基类所具备的一些:状态,回调block等,大致分成下面这5种职能:

有哪些职能?

声明控件的所有状态。

声明控件的回调函数。

添加监听。

提供刷新,停止刷新接口。

提供子类需要实现的方法。

职能如何实现?

1. 声明控件的所有状态

/** 刷新控件的状态 */typedefNS_ENUM(NSInteger, MJRefreshState) {/** 普通闲置状态 */MJRefreshStateIdle =1,/** 松开就可以进行刷新的状态 */MJRefreshStatePulling,/** 正在刷新中的状态 */MJRefreshStateRefreshing,/** 即将刷新的状态 */MJRefreshStateWillRefresh,/** 所有数据加载完毕,没有更多的数据了 */MJRefreshStateNoMoreData};

2. 声明控件的回调函数

/** 进入刷新状态的回调 */typedefvoid(^MJRefreshComponentRefreshingBlock)();/** 开始刷新后的回调(进入刷新状态后的回调) */typedefvoid(^MJRefreshComponentbeginRefreshingCompletionBlock)();/** 结束刷新后的回调 */typedefvoid(^MJRefreshComponentEndRefreshingCompletionBlock)();

3. 添加监听

监听的声明:

- (void)addObservers{NSKeyValueObservingOptionsoptions =NSKeyValueObservingOptionNew|NSKeyValueObservingOptionOld;    [self.scrollView addObserver:selfforKeyPath:MJRefreshKeyPathContentOffset options:options context:nil];//contentOffset属性[self.scrollView addObserver:selfforKeyPath:MJRefreshKeyPathContentSize options:options context:nil];//contentSize属性self.pan =self.scrollView.panGestureRecognizer;    [self.pan addObserver:selfforKeyPath:MJRefreshKeyPathPanState options:options context:nil];//UIPanGestureRecognizer 的state属性}

对于监听的处理:

- (void)observeValueForKeyPath:(NSString *)keyPathofObject:(id)objectchange:(NSDictionary *)changecontext:(void*)context{// 遇到这些情况就直接返回if(!self.userInteractionEnabled)return;// 这个就算看不见也需要处理if([keyPathisEqualToString:MJRefreshKeyPathContentSize]) {        [selfscrollViewContentSizeDidChange:change];    }// 看不见if(self.hidden)return;if([keyPathisEqualToString:MJRefreshKeyPathContentOffset]) {        [selfscrollViewContentOffsetDidChange:change];    }elseif([keyPathisEqualToString:MJRefreshKeyPathPanState]) {        [selfscrollViewPanStateDidChange:change];    }}

4. 提供刷新,停止刷新接口

#pragma mark 进入刷新状态- (void)beginRefreshingWithCompletionBlock:(void (^)())completionBlock{self.beginRefreshingCompletionBlock = completionBlock;    [selfbeginRefreshing];}- (void)beginRefreshing{    [UIView animateWithDuration:MJRefreshFastAnimationDuration animations:^{self.alpha =1.0;    }];self.pullingPercent =1.0;    // 只要正在刷新,就完全显示    if (self.window) {        //将状态切换为正在刷新self.state= MJRefreshStateRefreshing;    } else {        // 预防正在刷新中时,调用本方法使得header inset回置失败        if (self.state!= MJRefreshStateRefreshing) {            //将状态切换为即将刷新self.state= MJRefreshStateWillRefresh;            // 刷新(预防从另一个控制器回到这个控制器的情况,回来要重新刷新一下)            [selfsetNeedsDisplay];        }    }}#pragma mark 结束刷新状态- (void)endRefreshing{self.state= MJRefreshStateIdle;}- (void)endRefreshingWithCompletionBlock:(void (^)())completionBlock{self.endRefreshingCompletionBlock = completionBlock;    [selfendRefreshing];}#pragma mark 是否正在刷新- (BOOL)isRefreshing{    returnself.state== MJRefreshStateRefreshing ||self.state== MJRefreshStateWillRefresh;}

交给子类实现的方法:

- (void)prepareNS_REQUIRES_SUPER;/** 摆放子控件frame */- (void)placeSubviewsNS_REQUIRES_SUPER;/** 当scrollView的contentOffset发生改变的时候调用 */- (void)scrollViewContentOffsetDidChange:(NSDictionary*)changeNS_REQUIRES_SUPER;/** 当scrollView的contentSize发生改变的时候调用 */- (void)scrollViewContentSizeDidChange:(NSDictionary*)changeNS_REQUIRES_SUPER;/** 当scrollView的拖拽状态发生改变的时候调用 */- (void)scrollViewPanStateDidChange:(NSDictionary*)changeNS_REQUIRES_SUPER;

5. 提供子类需要实现的方法

#pragma mark - 交给子类们去实现/** 初始化 */- (void)prepareNS_REQUIRES_SUPER;/** 摆放子控件frame */- (void)placeSubviewsNS_REQUIRES_SUPER;/** 当scrollView的contentOffset发生改变的时候调用 */- (void)scrollViewContentOffsetDidChange:(NSDictionary*)changeNS_REQUIRES_SUPER;/** 当scrollView的contentSize发生改变的时候调用 */- (void)scrollViewContentSizeDidChange:(NSDictionary*)changeNS_REQUIRES_SUPER;/** 当scrollView的拖拽状态发生改变的时候调用 */- (void)scrollViewPanStateDidChange:(NSDictionary*)changeNS_REQUIRES_SUPER;

从上面等结构图可以看出,紧接着这个基类,下面分为MJRefreshHeader和MJRefreshFooter,这里顺着MJRefreshHeader这个分支向下展开:

MJRefreshHeader

MJRefreshHeader继承于MJRefreshComponent,它做了这几件事:

有哪些职能?

初始化。

设置header高度。

重新调整y值。

根据contentOffset的变化,来切换状态(默认状态,可以刷新的状态,正在刷新的状态),实现方法是:scrollViewContentOffsetDidChange:。

在切换状态时,执行相应的操作。实现方法是:setState:。

职能如何实现?

1. 初始化

初始化有两种方法:

+ (instancetype)headerWithRefreshingBlock:(MJRefreshComponentRefreshingBlock)refreshingBlock{    MJRefreshHeader *cmp= [[selfalloc] init];//传入blockcmp.refreshingBlock= refreshingBlock;returncmp;}+ (instancetype)headerWithRefreshingTarget:(id)target refreshingAction:(SEL)action{    MJRefreshHeader *cmp= [[selfalloc] init];//设置self.refreshingTarget和self.refreshingAction[cmpsetRefreshingTarget:target refreshingAction:action];returncmp;}

2. 设置header高度

通过重写prepare方法来设置header的高度:

- (void)prepare{    [superprepare];// 设置用于在NSUserDefaults里存储时间的keyself.lastUpdatedTimeKey = MJRefreshHeaderLastUpdatedTimeKey;// 设置header的高度self.mj_h = MJRefreshHeaderHeight;}

3. 重新调整y值

通过重写placeSubviews方法来重新调整y值:

- (void)placeSubviews{    [superplaceSubviews];// 设置y值(当自己的高度发生改变了,肯定要重新调整Y值,所以放到placeSubviews方法中设置y值)self.mj_y = -self.mj_h -self.ignoredScrollViewContentInsetTop;//self.ignoredScrollViewContentInsetTop 如果是10,那么就向上移动10}

4. 状态切换的代码:

- (void)scrollViewContentOffsetDidChange:(NSDictionary*)change{    [superscrollViewContentOffsetDidChange:change];// 正在刷新的状态if(self.state == MJRefreshStateRefreshing) {if(self.window ==nil)return;//- self.scrollView.mj_offsetY:-(-54-64)= 118 : 刷新的时候,偏移量是不动的。偏移量 = 状态栏 + 导航栏 + header的高度//_scrollViewOriginalInset.top:64 (状态栏 + 导航栏)//insetT 取二者之间大的那一个CGFloatinsetT = -self.scrollView.mj_offsetY > _scrollViewOriginalInset.top ? -self.scrollView.mj_offsetY : _scrollViewOriginalInset.top;//118insetT = insetT >self.mj_h + _scrollViewOriginalInset.top ?self.mj_h + _scrollViewOriginalInset.top : insetT;//设置contentInsetself.scrollView.mj_insetT = insetT;// 记录刷新的时候的偏移量 -54 = 64 - 118self.insetTDelta = _scrollViewOriginalInset.top - insetT;return;    }// 跳转到下一个控制器时,contentInset可能会变_scrollViewOriginalInset =self.scrollView.contentInset;// 记录当前的contentOffsetCGFloatoffsetY =self.scrollView.mj_offsetY;// 头部控件刚好全部出现的offsetY,默认是-64(20 + 44)CGFloathappenOffsetY = -self.scrollViewOriginalInset.top;// 向上滚动,直接返回if(offsetY > happenOffsetY)return;// 从普通 到 即将刷新 的临界距离CGFloatnormal2pullingOffsetY = happenOffsetY -self.mj_h;// -64 - 54 = -118//下拉的百分比:下拉的距离与header高度的比值CGFloatpullingPercent = (happenOffsetY - offsetY) /self.mj_h;if(self.scrollView.isDragging) {//记录当前下拉的百分比self.pullingPercent = pullingPercent;if(self.state == MJRefreshStateIdle && offsetY < normal2pullingOffsetY) {// 如果当前为默认状态 && 下拉的距离大于临界距离(将tableview下拉得很低),则将状态切换为可以刷新self.state = MJRefreshStatePulling;        }elseif(self.state == MJRefreshStatePulling && offsetY >= normal2pullingOffsetY) {// 如果当前状态为可以刷新 && 下拉的距离小于临界距离,则将状态切换为默认self.state = MJRefreshStateIdle;        }    }elseif(self.state == MJRefreshStatePulling) {// 即将刷新 && 手松开// 手松开 && 状态为可以刷新(MJRefreshStatePulling)时 开始刷新[selfbeginRefreshing];    }elseif(pullingPercent <1) {//手松开后,默认状态时,恢复self.pullingPercentself.pullingPercent = pullingPercent;            }}

需要注意三点:

这里的状态有三种:默认状态(MJRefreshStateIdle),可以刷新的状态(MJRefreshStatePulling)以及正在刷新的状态(MJRefreshStateRefreshing)。

状态切换的因素有两个:一个是下拉的距离是否超过临界值,另一个是 手指是否离开屏幕。

注意:可以刷新的状态正在刷新的状态是不同的。因为在手指还贴在屏幕的时候是不能进行刷新的。所以即使在下拉的距离超过了临界距离(状态栏 + 导航栏 + header高度),如果手指没有离开屏幕,那么也不能马上进行刷新,而是将状态切换为:可以刷新。一旦手指离开了屏幕,马上将状态切换为正在刷新。

这里提供一张图来体现三个状态的不同:

三个状态

5. 状态切换时的相应操作:

- (void)setState:(MJRefreshState)state{    MJRefreshCheckStateif(state == MJRefreshStateIdle) {//============== 设置状态为默认状态 =============////如果当前不是正在刷新就返回,因为这个方法主要针对从正在刷新状态(oldstate)到默认状态if(oldState != MJRefreshStateRefreshing)return;//刷新完成后,保存刷新完成的时间[[NSUserDefaultsstandardUserDefaults] setObject:[NSDatedate] forKey:self.lastUpdatedTimeKey];        [[NSUserDefaultsstandardUserDefaults] synchronize];// 恢复inset和offset[UIViewanimateWithDuration:MJRefreshSlowAnimationDuration animations:^{//118 -> 64(剪去了header的高度)self.scrollView.mj_insetT +=self.insetTDelta;// 自动调整透明度if(self.isAutomaticallyChangeAlpha)self.alpha =0.0;        } completion:^(BOOLfinished) {self.pullingPercent =0.0;if(self.endRefreshingCompletionBlock) {//调用刷新完成的blockself.endRefreshingCompletionBlock();            }        }];    }elseif(state == MJRefreshStateRefreshing) {//============== 设置状态为正在刷新状态 =============//dispatch_async(dispatch_get_main_queue(), ^{            [UIViewanimateWithDuration:MJRefreshFastAnimationDuration animations:^{CGFloattop =self.scrollViewOriginalInset.top +self.mj_h;//64 + 54 (都是默认的高度)// 重新设置contentInset,top = 118self.scrollView.mj_insetT = top;// 设置滚动位置[self.scrollView setContentOffset:CGPointMake(0, -top) animated:NO];            } completion:^(BOOLfinished) {//调用进行刷新的block[selfexecuteRefreshingCallback];            }];        });    }}

这里需要注意两点:

这里状态的切换,主要围绕着两种:默认状态和正在刷新状态。也就是针对开始刷新结束刷新这两个切换点。

从正在刷新状态状态切换为默认状态时(结束刷新),需要记录刷新结束的时间。因为header里面有一个默认的label是用来显示上次刷新的时间的。

MJRefreshStateHeader

这个类是MJRefreshHeader类的子类,它做了两件事:

有哪些职能?

简单布局了stateLabel和lastUpdatedTimeLabel。

根据控件状态的切换(默认状态,正在刷新状态),实现了这两个label显示的文字的切换。

给一张图,让大家直观感受一下这两个控件:

两个Label

职能如何实现?

这个类通过覆盖父类三个方法来实现上述两个实现:

方法1:prepare方法

- (void)prepare{    [superprepare];// 初始化间距self.labelLeftInset = MJRefreshLabelLeftInset;// 初始化文字[selfsetTitle:[NSBundlemj_localizedStringForKey:MJRefreshHeaderIdleText]forState:MJRefreshStateIdle];    [selfsetTitle:[NSBundlemj_localizedStringForKey:MJRefreshHeaderPullingText]forState:MJRefreshStatePulling];    [selfsetTitle:[NSBundlemj_localizedStringForKey:MJRefreshHeaderRefreshingText]forState:MJRefreshStateRefreshing];}

在这里,将每一个状态对应的提示文字放入一个字典里面,key是状态的NSNumber形式

- (void)setTitle:(NSString *)titleforState:(MJRefreshState)state{    if (title == nil) return;self.stateTitles[@(state)] = title;self.stateLabel.text =self.stateTitles[@(self.state)];}

方法2:placeSubviews方法

- (void)placeSubviews{    [super placeSubviews];    if (self.stateLabel.hidden) return;    BOOL noConstrainsOnStatusLabel =self.stateLabel.constraints.count ==0;    if (self.lastUpdatedTimeLabel.hidden) {        //如果更新时间label是隐藏的,则让状态label撑满整个header        if (noConstrainsOnStatusLabel)self.stateLabel.frame =self.bounds;    } else {        //如果更新时间label不是隐藏的,根据约束设置更新时间label和状态label(高度各占一半)        CGFloatstateLabelH =self.mj_h *0.5;        if (noConstrainsOnStatusLabel) {self.stateLabel.mj_x =0;self.stateLabel.mj_y =0;self.stateLabel.mj_w =self.mj_w;self.stateLabel.mj_h =stateLabelH;        }        // 更新时间labelif (self.lastUpdatedTimeLabel.constraints.count ==0) {self.lastUpdatedTimeLabel.mj_x =0;self.lastUpdatedTimeLabel.mj_y =stateLabelH;self.lastUpdatedTimeLabel.mj_w =self.mj_w;self.lastUpdatedTimeLabel.mj_h =self.mj_h -self.lastUpdatedTimeLabel.mj_y;        }    }}

这里主要是对lastUpdatedTimeLabel和stateLabel进行布局。要注意lastUpdatedTimeLabel隐藏的情况。

方法3: setState:方法

- (void)setState:(MJRefreshState)state{    MJRefreshCheckState    // 设置状态文字self.stateLabel.text =self.stateTitles[@(state)];    // 重新设置key(重新显示时间)self.lastUpdatedTimeKey =self.lastUpdatedTimeKey;}

在这里,根据传入的state的不同,在stateLabel和lastUpdatedTimeLabel里切换相应的文字。

stateLabel里的文字直接从stateTitles字典里取出即可。

lastUpdatedTimeLabel里的文字需要通过一个方法来取出即可:

- (void)setLastUpdatedTimeKey:(NSString*)lastUpdatedTimeKey{    [supersetLastUpdatedTimeKey:lastUpdatedTimeKey];// 如果label隐藏了,就不用再处理if(self.lastUpdatedTimeLabel.hidden)return;//根据key,从NSUserDefaults获取对应的NSData型时间NSDate*lastUpdatedTime = [[NSUserDefaultsstandardUserDefaults] objectForKey:lastUpdatedTimeKey];// 如果有block,从block里拿来时间,这应该是用户自定义显示时间格式的渠道if(self.lastUpdatedTimeText) {self.lastUpdatedTimeLabel.text =self.lastUpdatedTimeText(lastUpdatedTime);return;    }//如果没有block,就按照下面的默认方法显示时间格式if(lastUpdatedTime) {// 获得了上次更新时间// 1.获得年月日NSCalendar*calendar = [selfcurrentCalendar];NSUIntegerunitFlags =NSCalendarUnitYear|NSCalendarUnitMonth|NSCalendarUnitDay|NSCalendarUnitHour|NSCalendarUnitMinute;NSDateComponents*cmp1 = [calendar components:unitFlags fromDate:lastUpdatedTime];NSDateComponents*cmp2 = [calendar components:unitFlags fromDate:[NSDatedate]];// 2.格式化日期NSDateFormatter*formatter = [[NSDateFormatteralloc] init];BOOLisToday =NO;if([cmp1 day] == [cmp2 day]) {//今天,省去年月日formatter.dateFormat =@" HH:mm";            isToday =YES;        }elseif([cmp1 year] == [cmp2 year]) {// 今年//今年,省去年,显示月日formatter.dateFormat =@"MM-dd HH:mm";        }else{//其他,年月日都显示formatter.dateFormat =@"yyyy-MM-dd HH:mm";        }NSString*time = [formatter stringFromDate:lastUpdatedTime];// 3.显示日期self.lastUpdatedTimeLabel.text = [NSStringstringWithFormat:@"%@%@%@",                                          [NSBundlemj_localizedStringForKey:MJRefreshHeaderLastTimeText],                                          isToday ? [NSBundlemj_localizedStringForKey:MJRefreshHeaderDateTodayText] :@"",                                          time];    }else{// 没有获得上次更新时间(应该是第一次更新或者多次更新,之前的更新都失败了)self.lastUpdatedTimeLabel.text = [NSStringstringWithFormat:@"%@%@",                                          [NSBundlemj_localizedStringForKey:MJRefreshHeaderLastTimeText],                                          [NSBundlemj_localizedStringForKey:MJRefreshHeaderNoneLastDateText]];    }}

在这里注意两点:

作者通过使用block来让用户自己定义日期现实的格式,如果用户没有自定义,就使用作者提供的默认格式。

在默认格式的设置里,判断了是否是今日,是否是今年的情况。在以后设计显示时间的labe的时候可以借鉴一下。

MJRefreshNormalHeader

有哪些职能?

MJRefreshNormalHeader 继承于 MJRefreshStateHeader,它主要做了两件事:

它在MJRefreshStateHeader上添加了_arrowView和loadingView。

布局了这两个view并在Refresh控件的状态切换的时候改变这两个view的样式。

还是给一张图来直观感受一下这两个view:

两个view

职能如何实现?

同MJRefreshStateHeader一样,也是重写了父类的三个方法:

方法1:prepare

- (void)prepare{    [superprepare];self.activityIndicatorViewStyle =UIActivityIndicatorViewStyleGray;}

方法2:placeSubviews

- (void)placeSubviews{    [super placeSubviews];    // 首先将箭头的中心点x设为header宽度的一半    CGFloat arrowCenterX =self.mj_w *0.5;    if (!self.stateLabel.hidden) {        CGFloatstateWidth =self.stateLabel.mj_textWith;        CGFloat timeWidth =0.0;        if (!self.lastUpdatedTimeLabel.hidden) {            timeWidth =self.lastUpdatedTimeLabel.mj_textWith;        }        //在stateLabel里的文字宽度和更新时间里的文字宽度里取较宽的        CGFloat textWidth = MAX(stateWidth, timeWidth);        //根据self.labelLeftInset和textWidth向左移动中心点x        arrowCenterX -= textWidth /2+self.labelLeftInset;    }    //中心点y永远设置为header的高度的一半    CGFloat arrowCenterY =self.mj_h *0.5;    //获得了最终的center,而这个center同时适用于arrowView和loadingView,因为二者是不共存的。    CGPoint arrowCenter = CGPointMake(arrowCenterX, arrowCenterY);    // 箭头    if (self.arrowView.constraints.count ==0) {        //控件大小等于图片大小self.arrowView.mj_size =self.arrowView.image.size;self.arrowView.center = arrowCenter;    }    // 菊花    if (self.loadingView.constraints.count ==0) {self.loadingView.center = arrowCenter;    }    //arrowView的色调与stateLabel的字体颜色一致self.arrowView.tintColor =self.stateLabel.textColor;}

在这里注意一点:因为stateLabel和lastUpdatedTimeLabel是上下并排分布的,而arrowView或loadingView是在这二者的左边,所以为了避免这两组重合,在计算arrowView或loadingView的center的时候,需要获取stateLabel和lastUpdatedTimeLabel两个控件的宽度并比较大小,将较大的一个作为两个label的‘最宽距离’,再计算center,这样一来就不会重合了。

而对于如何计算宽度,作者给出了一个方案,大家可以在以后的实践中使用:

- (CGFloat)mj_textWith {CGFloatstringWidth =0;CGSizesize =CGSizeMake(MAXFLOAT, MAXFLOAT);if(self.text.length >0) {#if defined(__IPHONE_OS_VERSION_MAX_ALLOWED) && __IPHONE_OS_VERSION_MAX_ALLOWED >= 70000stringWidth =[self.text                      boundingRectWithSize:size                      options:NSStringDrawingUsesLineFragmentOriginattributes:@{NSFontAttributeName:self.font}                      context:nil].size.width;#elsestringWidth = [self.text sizeWithFont:self.font                            constrainedToSize:size                                lineBreakMode:NSLineBreakByCharWrapping].width;#endif}returnstringWidth;}

方法3: setState:

- (void)setState:(MJRefreshState)state{    MJRefreshCheckState// 根据状态更新arrowView和loadingView的显示if(state == MJRefreshStateIdle) {//1. 设置为默认状态if(oldState == MJRefreshStateRefreshing) {//1.1 从正在刷新状态中切换过来self.arrowView.transform =CGAffineTransformIdentity;            [UIViewanimateWithDuration:MJRefreshSlowAnimationDuration animations:^{//隐藏菊花self.loadingView.alpha =0.0;            } completion:^(BOOLfinished) {// 如果执行完动画发现不是idle状态,就直接返回,进入其他状态if(self.state != MJRefreshStateIdle)return;//菊花停止旋转self.loadingView.alpha =1.0;                [self.loadingView stopAnimating];//显示箭头self.arrowView.hidden =NO;            }];        }else{//1.2 从其他状态中切换过来[self.loadingView stopAnimating];//显示箭头并设置为初始状态self.arrowView.hidden =NO;            [UIViewanimateWithDuration:MJRefreshFastAnimationDuration animations:^{self.arrowView.transform =CGAffineTransformIdentity;            }];        }    }elseif(state == MJRefreshStatePulling) {//2. 设置为可以刷新状态[self.loadingView stopAnimating];self.arrowView.hidden =NO;        [UIViewanimateWithDuration:MJRefreshFastAnimationDuration animations:^{//箭头倒立self.arrowView.transform =CGAffineTransformMakeRotation(0.000001- M_PI);        }];    }elseif(state == MJRefreshStateRefreshing) {//3. 设置为正在刷新状态self.loadingView.alpha =1.0;// 防止refreshing -> idle的动画完毕动作没有被执行//菊花旋转[self.loadingView startAnimating];//隐藏arrowViewself.arrowView.hidden =YES;    }}

到此为止,我们已经从MJRefreshComponent到MJRefreshNormalHeader的实现过程看了一遍。可以看出,作者将prepare,placeSubviews以及setState:方法作为基类的方法,让下面的子类去一层一层实现。

而每一层的子类,根据自身的职责,分别按照自己的方式来实现这三个方法:

MJRefreshHeader: 负责header的高度和调整header自身在外部的位置。

MJRefreshStateHeader:负责header内部的stateLabel和lastUpdatedTimeLabel的布局和不同状态下内部文字的显示。

MJRefreshNormalHeader:负责header内部的loadingView以及arrowView的布局和不同状态下的显示。

这样做的好处是,如果想要增加某种类型的header,只要在某一层上做文章即可。例如该框架里的MJRefreshGifHeader,它和MJRefreshNormalHeader属于同一级,都是继承于MJRefreshStateHeader。因为二者都具有相同形式的stateLabel和lastUpdatedTimeLabel,唯一不同的就是左侧的部分:

MJRefreshNormalHeader的左侧是箭头。

MJRefreshGifHeader的左侧则是一个gif动画。

还是提供一张图来直观感受一下:

normalHeader 与 gifHeader

下面我们来看一下的实现:

MJRefreshGifHeader

它提供了两个接口,是用来设置不同状态下使用的图片数组的:

- (void)setImages:(NSArray *)images duration:(NSTimeInterval)durationforState:(MJRefreshState)state{    if (images == nil) return;    //设置不同状态下的图片组和持续时间self.stateImages[@(state)] = images;self.stateDurations[@(state)] = @(duration);    /* 根据图片设置控件的高度 */    UIImage *image = [images firstObject];    if (image.size.height >self.mj_h) {self.mj_h = image.size.height;    } }- (void)setImages:(NSArray *)imagesforState:(MJRefreshState)state{    //如果没有传入duration,则根据图片的多少来计算    [selfsetImages:images duration:images.count *0.1forState:state]; }

有哪些职能?

然后,和MJRefreshNormalHeader一样,它也重写了基类提供的三个方法来实现显示gif图片的职能。

职能如何实现?

1. 初始化和label的间距

- (void)prepare{    [superprepare];// 初始化间距self.labelLeftInset =20;}

2. 根据label的宽度和存在与否设置gif的位置

- (void)placeSubviews{    [super placeSubviews];    //如果约束存在,就立即返回    if (self.gifView.constraints.count) return;self.gifView.frame =self.bounds;    if (self.stateLabel.hidden &&self.lastUpdatedTimeLabel.hidden) {        //如果stateLabel和lastUpdatedTimeLabel都在隐藏状态,将gif剧中显示self.gifView.contentMode = UIViewContentModeCenter;    } else {        //如果stateLabel和lastUpdatedTimeLabel中至少一个存在,则根据label的宽度设置gif的位置self.gifView.contentMode = UIViewContentModeRight;        CGFloatstateWidth =self.stateLabel.mj_textWith;        CGFloat timeWidth =0.0;        if (!self.lastUpdatedTimeLabel.hidden) {            timeWidth =self.lastUpdatedTimeLabel.mj_textWith;        }        CGFloat textWidth = MAX(stateWidth, timeWidth);self.gifView.mj_w =self.mj_w *0.5- textWidth *0.5-self.labelLeftInset;    }}

3. 根据传入状态的不同来设置动画

- (void)setState:(MJRefreshState)state{    MJRefreshCheckState    if (state== MJRefreshStatePulling ||state== MJRefreshStateRefreshing) {        //1. 如果传进来的状态是可以刷新和正在刷新        NSArray *images =self.stateImages[@(state)];        if (images.count ==0) return;        [self.gifView stopAnimating];        if (images.count ==1) {            //1.1单张图片self.gifView.image = [images lastObject];        } else {            //1.2多张图片self.gifView.animationImages = images;self.gifView.animationDuration = [self.stateDurations[@(state)] doubleValue];            [self.gifView startAnimating];        }    } else if (state== MJRefreshStateIdle) {        //2.如果传进来的状态是默认状态        [self.gifView stopAnimating];    }}

Footer类是用来处理上拉加载的,实现原理和下拉刷新很类似,在这里先不介绍了~

总的来说,该框架设计得非常工整:通过一个基类来定义一些状态和一些需要子类实现的接口。通过一层一层地继承,让每一层的子类各司其职,只完成真正属于自己的任务,提高了框架的可定制性,而且对于功能的扩展和bug的追踪也很有帮助,非常值得我们参考与借鉴。

本篇文章已经同步到我个人博客:J_Knight MJRefresh 源码解析

欢迎来参观 ^^

本文已在版权印备案,如需转载请访问版权印。48422928

获取授权

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

推荐阅读更多精彩内容

  • 本文转载自J_Knight 的MJRefresh源码解析 MJRefresh是李明杰的作品,到现在已经有9800多...
    Detective41阅读 636评论 0 1
  • 本篇先带着问题来看MJRefresh,在下拉时MJRefresh是怎么使箭头旋转,又是如何使菊花(或其他动画图片)...
    iOS俱哥阅读 276评论 0 1
  • MJRefresh这个刷新控件是一款非常好用的框架,我们在使用一个框架的同时,最好能了解下它的实现原理,不管是根据...
    老马的春天阅读 1,034评论 1 4
  • MJRefresh是流行的下拉刷新控件,前段时间为了修复一个BUG,读了它的源码,本文总结一下实现的原理 下拉刷新...
    晚安的你我阅读 388评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,097评论 18 139