MJRefresh 是 iOS 上最廣泛使用的下拉/上拉刷新庫之一。它只有幾行 API,內部卻用到了 KVO、runtime、繼承與 GCD。本文拆開來看它到底做了什麼。

MJRefreshComponent 是所有刷新控件的基類,它在這裡完成了三件事:
contentOffset、contentSize 與 pan 手勢狀態。prepare 方法,負責設定文字、gif 圖片、風格等初始狀態。placeSubviews 方法,負責調整子控件的佈局。KVO 觸發後的響應在 MJRefreshHeader 與 MJRefreshFooter 中實作,主要就是設定 state;而各個子類再覆寫 setState:,依不同狀態做不同變化。子類的 prepare 與 placeSubviews 都會先呼叫父類版本,再補上自己的行為。
繼承鏈是:MJRefreshNormalHeader → MJRefreshStateHeader → MJRefreshHeader → MJRefreshComponent。
MJRefreshNormalHeader *header = [MJRefreshNormalHeader headerWithRefreshingBlock:^{
[self reloadData];
[self.tableView.mj_header endRefreshing];
}];
self.tableView.mj_header = header;mj_header 定義在 UIScrollView+MJRefresh.h 這個分類裡:
#import <UIKit/UIKit.h> #import "MJRefreshConst.h" @class MJRefreshHeader, MJRefreshFooter; @interface UIScrollView (MJRefresh) /** 下拉刷新控件 */ @property (strong, nonatomic) MJRefreshHeader *mj_header; /** 上拉刷新控件 */ @property (strong, nonatomic) MJRefreshFooter *mj_footer; - (NSInteger)mj_totalDataCount; @end
分類本身不能加實例變量,所以作者用 runtime 的關聯物件技巧,為 UIScrollView 加上屬性,並把刷新控件插入到 scrollView 的子視圖鏈中:
- (void)setMj_header:(MJRefreshHeader *)mj_header {
if (mj_header != self.mj_header) {
// 刪除舊的,添加新的
[self.mj_header removeFromSuperview];
[self insertSubview:mj_header atIndex:0];
// 存儲新的,並發出 KVO 通知
[self willChangeValueForKey:@"mj_header"];
objc_setAssociatedObject(self, &MJRefreshHeaderKey, mj_header,
OBJC_ASSOCIATION_ASSIGN);
[self didChangeValueForKey:@"mj_header"];
}
}所以 self.tableView.mj_header = header; 其實就是給 tableView 掛上一個頭部刷新控件。
headerWithRefreshingBlock: 是父類 MJRefreshHeader 的類別方法:
+ (instancetype)headerWithRefreshingBlock:(MJRefreshComponentRefreshingBlock)refreshingBlock {
MJRefreshHeader *cmp = [[self alloc] init];
cmp.refreshingBlock = refreshingBlock;
return cmp;
}而 init 會走到 MJRefreshComponent 的初始化,順序是「prepare → 設定初始 state」:
- (instancetype)initWithFrame:(CGRect)frame {
if (self = [super initWithFrame:frame]) {
// 準備工作
[self prepare];
// 默認是普通狀態
self.state = MJRefreshStateIdle;
}
return self;
}注意:MJRefreshComponent 的 prepare 會被所有子類呼叫,每個子類的 prepare 都先呼叫父類版本,再補上自己特有的設定。
物件被加到 scrollView 上時,會觸發 willMoveToSuperview::
- (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;
// 記錄最初的 contentInset
_scrollViewOriginalInset = _scrollView.contentInset;
// 添加監聽
[self addObservers];
}
}監聽的目標一共三個:
- (void)addObservers {
NSKeyValueObservingOptions options = NSKeyValueObservingOptionNew | NSKeyValueObservingOptionOld;
[self.scrollView addObserver:self
forKeyPath:MJRefreshKeyPathContentOffset
options:options
context:nil];
[self.scrollView addObserver:self
forKeyPath:MJRefreshKeyPathContentSize
options:options
context:nil];
self.pan = self.scrollView.panGestureRecognizer;
[self.pan addObserver:self
forKeyPath:MJRefreshKeyPathPanState
options:options
context:nil];
}下拉必然使 contentOffset 改變,於是觸發 MJRefreshHeader 的響應方法。核心邏輯是算出「臨界點」——scrollView 的 Inset.top 加上刷新控件的高度——再依拖動程度切換 state:
- (void)scrollViewContentOffsetDidChange:(NSDictionary *)change {
[super scrollViewContentOffsetDidChange:change];
// 在刷新的 refreshing 狀態
if (self.state == MJRefreshStateRefreshing) {
if (self.window == nil) return;
// sectionheader 停留的解決方案
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;
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;
}
}每一次 state 改變,MJRefreshHeader 都會調整 inset 與 offset:
- (void)setState:(MJRefreshState)state {
MJRefreshCheckState
if (state == MJRefreshStateIdle) {
if (oldState != MJRefreshStateRefreshing) return;
// 保存刷新時間
[[NSUserDefaults standardUserDefaults] setObject:[NSDate date]
forKey:self.lastUpdatedTimeKey];
[[NSUserDefaults standardUserDefaults] synchronize];
// 恢復 inset 和 offset
[UIView animateWithDuration:MJRefreshSlowAnimationDuration animations:^{
self.scrollView.mj_insetT += self.insetTDelta;
if (self.isAutomaticallyChangeAlpha) self.alpha = 0.0;
} completion:^(BOOL finished) {
self.pullingPercent = 0.0;
if (self.endRefreshingCompletionBlock) {
self.endRefreshingCompletionBlock();
}
}];
}
else if (state == MJRefreshStateRefreshing) {
dispatch_async(dispatch_get_main_queue(), ^{
[UIView animateWithDuration:MJRefreshFastAnimationDuration animations:^{
CGFloat top = self.scrollViewOriginalInset.top + self.mj_h;
// 增加滾動區域 top
self.scrollView.mj_insetT = top;
// 設置滾動位置
[self.scrollView setContentOffset:CGPointMake(0, -top) animated:NO];
} completion:^(BOOL finished) {
[self executeRefreshingCallback];
}];
});
}
}#pragma mark - 重寫父類的方法
- (void)prepare {
[super prepare];
self.activityIndicatorViewStyle = UIActivityIndicatorViewStyleGray;
}
- (void)placeSubviews {
[super placeSubviews];
// 箭頭的中心點
CGFloat arrowCenterX = self.mj_w * 0.5;
if (!self.stateLabel.hidden) {
CGFloat stateWidth = self.stateLabel.mj_textWith;
CGFloat timeWidth = 0.0;
if (!self.lastUpdatedTimeLabel.hidden) {
timeWidth = self.lastUpdatedTimeLabel.mj_textWith;
}
CGFloat textWidth = MAX(stateWidth, timeWidth);
arrowCenterX -= textWidth / 2 + self.labelLeftInset;
}
CGPoint arrowCenter = CGPointMake(arrowCenterX, self.mj_h * 0.5);
// 箭頭
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;
}
self.arrowView.tintColor = self.stateLabel.textColor;
}
- (void)setState:(MJRefreshState)state {
MJRefreshCheckState
if (state == MJRefreshStateIdle) {
if (oldState == MJRefreshStateRefreshing) {
self.arrowView.transform = CGAffineTransformIdentity;
[UIView animateWithDuration:MJRefreshSlowAnimationDuration animations:^{
self.loadingView.alpha = 0.0;
} completion:^(BOOL finished) {
// 動畫結束時若已不是 idle,直接返回
if (self.state != MJRefreshStateIdle) return;
self.loadingView.alpha = 1.0;
[self.loadingView stopAnimating];
self.arrowView.hidden = NO;
}];
} else {
[self.loadingView stopAnimating];
self.arrowView.hidden = NO;
[UIView animateWithDuration:MJRefreshFastAnimationDuration animations:^{
self.arrowView.transform = CGAffineTransformIdentity;
}];
}
}
else if (state == MJRefreshStatePulling) {
[self.loadingView stopAnimating];
self.arrowView.hidden = NO;
[UIView animateWithDuration:MJRefreshFastAnimationDuration animations:^{
self.arrowView.transform = CGAffineTransformMakeRotation(0.000001 - M_PI);
}];
}
else if (state == MJRefreshStateRefreshing) {
self.loadingView.alpha = 1.0;
// 防止 refreshing -> idle 的動畫完畢動作沒有被執行
[self.loadingView startAnimating];
self.arrowView.hidden = YES;
}
}總結一下這條鏈路:KVO 監聽 offset → 算出臨界點 → 切換 state → setState 調整 inset/offset 與動畫 → 觸發 refreshingBlock。理解這個流程之後,要自己客製化一個刷新動畫,只需繼承適當的類別並覆寫 prepare 與 setState: 即可。