MJRefresh 源碼解讀 + 使用

MJRefresh這個刷新控件是一款非常好用的框架,我們在使用一個框架的同時,最好能了解下它的實現原理,不管是根據業務要求在原有的基礎上修改代碼,還是其他的目的,弄明白作者的思路和代碼風格,會受益匪淺。

前言

隨著開發經驗的不斷積累,個人的能力也會不斷提高。每個人的進步都會有一個過程,這個過程就好比登山。一個框架對我們的意義從開始的簡單實用,慢慢的就會過渡到了解,最終讓它成為你大腦的一部分。這篇文章不會對代碼進行逐行解讀,最重要的目的是讓朋友們明白 MJRefresh 是怎么做到刷新的,我們還能如何擴展它的功能。

原理部分

我們在 MJRefreshMJRefresh Github 上拿到了下邊這張圖:


正如這張圖片所說的,所有的功能的實現都基于 MJRefreshComponent 這個刷新組件。MJRefreshComponent 有兩個分支 MJRefreshHeader(給了下拉刷新的能力) MJRefreshFooter(給了上拉刷新的能力)。

在進行下邊的代碼分析之前,我們來看看刷新的整個過程(我們以頭部刷新為例):

  1. 看這張圖片上的代碼,能夠tableView.mj_header這樣使用,說明tableview有mj_header這個屬性。然后我們看一下UIScrollView+MJRefresh這個文件。原理是給這個scrollview添加了一個控件,代碼如下
  2. 我看了下MJRefreshHeader的這個文件的頭文件,對我們理解原理并沒有幫助,由于它是繼承MJRefreshComponent的,所以我們打開MJRefreshComponent的頭文件來看。
  3. 這幾個狀態非常關鍵,是使用整個框架的核心思路。為什么這么說?如果我們在滑動的過程中,狀態也會改變,那么必然會調用狀態的setter方法,我們就利用這個方法,顯示自己想要的效果。

  4. 到這里基本上就很明白了。由于MJRefreshComponent是一個UIView,因此我們可以隨意往上添加控件,我們在prepare中添加控件,在placeSubviews中布局,通過scrollViewContentOffsetDidChange:方法指導contentOffset改變了。然后就能自定義事件了。
  5. 最終我們在我們最需要的狀態上綁定事件就ok了。

MJRefreshComponent

MJRefreshComponent 這個類是最最基礎能力的搭建了。除了暴露出業務接口外。值得注意的有兩點:

  1. 上邊UIScrollView+MJRefresh中提到把mj_header這個view加到了scrollview上,那么MJRefreshComponent是如何獲取scrollview的呢?
  2. 如何監聽我們需要的變化?比如說contentOffSet。。。

示例代碼:

- (void)willMoveToSuperview:(UIView *)newSuperview
{
    [super willMoveToSuperview:newSuperview];
    
    // 如果不是UIScrollView,不做任何事情
    if (newSuperview && ![newSuperview isKindOfClass:[UIScrollView class]]) return;
    
    // 舊的父控件移除監聽
    [self removeObservers];
    
    if (newSuperview) { // 新的父控件
        // 設置寬度
        self.mj_w = newSuperview.mj_w;
        // 設置位置
        self.mj_x = 0;
        
        // 記錄UIScrollView
        _scrollView = (UIScrollView *)newSuperview;
        // 設置永遠支持垂直彈簧效果
        _scrollView.alwaysBounceVertical = YES;
        // 記錄UIScrollView最開始的contentInset
        _scrollViewOriginalInset = _scrollView.contentInset;
        
        // 添加監聽
        [self addObservers];
    }
}

當一個控價被添加到另一個控件上的時候,就會調用這個方法,這這個方法中我們就獲取到了scrollview,并且設置了監聽事件,監聽事件這里就不寫了。

MJRefreshHeader

MJRefreshHeader 這個類提供了刷新的核心功能,這個類并沒有像UIImageview,UILabel這樣的控件。所以說他同樣是一個基礎類,我們使用中只需繼承這個類,添加需要的UI控件就行了。

示例代碼:

- (void)scrollViewContentOffsetDidChange:(NSDictionary *)change
{
    [super scrollViewContentOffsetDidChange:change];
    
    // 在刷新的refreshing狀態
    if (self.state == MJRefreshStateRefreshing) {
        if (self.window == nil) return;
        
        // sectionheader停留解決
        NSLog(@"%f , %f",self.scrollView.mj_offsetY,_scrollViewOriginalInset.top);
        CGFloat insetT = - self.scrollView.mj_offsetY > _scrollViewOriginalInset.top ? - self.scrollView.mj_offsetY : _scrollViewOriginalInset.top;
        insetT = insetT > self.mj_h + _scrollViewOriginalInset.top ? self.mj_h + _scrollViewOriginalInset.top : insetT;
        self.scrollView.mj_insetT = insetT;
        
        self.insetTDelta = _scrollViewOriginalInset.top - insetT;
        return;
    }
    
    // 跳轉到下一個控制器時,contentInset可能會變
     _scrollViewOriginalInset = self.scrollView.contentInset;
    
    // 當前的contentOffset
    CGFloat offsetY = self.scrollView.mj_offsetY;
    // 頭部控件剛好出現的offsetY
    CGFloat happenOffsetY = - self.scrollViewOriginalInset.top;
    
    // 如果是向上滾動到看不見頭部控件,直接返回
    // >= -> >
    if (offsetY > happenOffsetY) return;
    
    // 普通 和 即將刷新 的臨界點
    CGFloat normal2pullingOffsetY = happenOffsetY - self.mj_h;
    CGFloat pullingPercent = (happenOffsetY - offsetY) / self.mj_h;
    
    if (self.scrollView.isDragging) { // 如果正在拖拽
        self.pullingPercent = pullingPercent;
        if (self.state == MJRefreshStateIdle && offsetY < normal2pullingOffsetY) {
            // 轉為即將刷新狀態
            self.state = MJRefreshStatePulling;
        } else if (self.state == MJRefreshStatePulling && offsetY >= normal2pullingOffsetY) {
            // 轉為普通狀態
            self.state = MJRefreshStateIdle;
        }
    } else if (self.state == MJRefreshStatePulling) {// 即將刷新 && 手松開
        // 開始刷新
        [self beginRefreshing];
    } else if (pullingPercent < 1) {
        self.pullingPercent = pullingPercent;
    }
}

這個是通過contentOffSet計算狀態的核心方法。由于代碼注釋很詳細,就不做解釋了,只要一行一行理解就能行了。

MJRefreshAutoFooter

MJRefreshAutoFooter 提供了當滑到底部時,自動加載的功能,我們來看看代碼:

- (void)scrollViewContentOffsetDidChange:(NSDictionary *)change
{
    [super scrollViewContentOffsetDidChange:change];
    
    if (self.state != MJRefreshStateIdle || !self.automaticallyRefresh || self.mj_y == 0) return;
    
    if (_scrollView.mj_insetT + _scrollView.mj_contentH > _scrollView.mj_h) { // 內容超過一個屏幕
        // 這里的_scrollView.mj_contentH替換掉self.mj_y更為合理
        if (_scrollView.mj_offsetY >= _scrollView.mj_contentH - _scrollView.mj_h + self.mj_h * self.triggerAutomaticallyRefreshPercent + _scrollView.mj_insetB - self.mj_h) {
            // 防止手松開時連續調用
            CGPoint old = [change[@"old"] CGPointValue];
            CGPoint new = [change[@"new"] CGPointValue];
            if (new.y <= old.y) return;
            
            // 當底部刷新控件完全出現時,才刷新
            [self beginRefreshing];
        }
    }
}

演示案例

我們就簡單演示 轉轉 的下拉加載效果。由于代碼改動比較小,在這里下載:轉轉下拉效果

總結

有時間寫一個類似知乎刷新那樣的效果。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容