DZNEmptyDataSet框架閱讀
前段時間使用公司封裝的空白頁佔位檢視工具，是對DZNEmptyDataSet框架的封裝。這個框架在許多專案也都用過，卻沒有認真閱讀過原始碼，真的很遺憾。現在趁五一放假有空，將DZNEmptyDataSet框架學習了一遍，收穫滿滿。
重要感悟如下：
1.程式碼使用簡單：主要邏輯UIScrollView+EmptyDataSet分類中完成。使用時只需要設定控制器為其資料來源和代理，並實現相應的代理方法。
2.對runtime合理使用：利用runtime的關聯功能實現分類中屬性的getter、setter；利用runtime的method的IMP指標重置功能進行reloadData等方法交換。
3.提出了以前使用runtime方法交換的隱藏缺陷，並給出解決方案。
4.修改對空白列表佔位檢視的響應鏈傳遞路徑。
5.採用NSLayoutConstraint+VFL（Visual Format Language）“視覺化格式語言”進行設定約束，重溫Apple原生方法的魅力。
使用入口
1.匯入UIScrollView分類UIScrollView+EmptyDataSet
#import <DZNEmptyDataSet/UIScrollView+EmptyDataSet.h>
2.設定tableView的資料來源物件和代理物件
self.tableView.emptyDataSetSource = self; self.tableView.emptyDataSetDelegate = self;
核心思想和重要方法
核心思想
1.在客戶端呼叫屬性設定時進行方法交換，監聽reloadData方法
self.tableView.emptyDataSetSource = self;
在設定方法setEmptyDataSetSource 內部，通過runtime進行reloadData的方法交換。
通過監聽reloadData的資料來源個數，來決定是否顯示空白頁佔位檢視。
2.runtime中提出傳統IMP Swizzle的缺陷和隱藏問題，並給出了新的解決方案。
OC方法的底層實現是C語言的執行時函式Runtime函式預設的前兩個引數是id, SEL。
OBJC_EXPORT id _Nullable objc_msgSend(id _Nullable self, SEL _Nonnull op, ...) OBJC_AVAILABLE(10.0, 2.0, 9.0, 1.0, 2.0);
平時用的runtime函式交換方法會改變原始函式的方法名對應的C函式就是SEL。
void method_exchangeImplementations（方法m1，方法m2）
如果原始函式在底層根據SEL做了邏輯操作，那麼無意間就會修改了系統底層的原始邏輯，這是很危險的！
DZNEmptyDataSet中給出的解決方案是：
在程式碼中定義C函式並將其強轉(IMP)dzn_original_implementation
互動原來的實現IMP為新的C函式 method_setImplementation(method, (IMP)dzn_original_implementation);
儲存原來舊的實現IMP到全域性搜尋表 _impLookupTable
全域性搜尋表 _impLookupTable在整個生命週期內記錄UITableView,UICollectionView,UIScrollView只為互動一次
重要方法
1.資料來源setter方法
- (void)setEmptyDataSetSource:(id<DZNEmptyDataSetSource>)datasource
{
if (!datasource || ![self dzn_canDisplay]) {
[self dzn_invalidate];
}
objc_setAssociatedObject(self, kEmptyDataSetSource, [[DZNWeakObjectContainer alloc] initWithWeakObject:datasource], OBJC_ASSOCIATION_RETAIN_NONATOMIC);
// We add method sizzling for injecting -dzn_reloadData implementation to the native -reloadData implementation
[self swizzleIfPossible:@selector(reloadData)];
// Exclusively for UITableView, we also inject -dzn_reloadData to -endUpdates
if ([self isKindOfClass:[UITableView class]]) {
[self swizzleIfPossible:@selector(endUpdates)];
}
}
DZNWeakObjectContainer：用來包裹外部傳遞過來的資料來源物件
swizzleIfPossible：對reloadData方法進行runtime交換
2.reload交換方法：
static NSMutableDictionary *_impLookupTable;
static NSString *const DZNSwizzleInfoPointerKey = @"pointer";
static NSString *const DZNSwizzleInfoOwnerKey = @"owner";
static NSString *const DZNSwizzleInfoSelectorKey = @"selector";
- (void)swizzleIfPossible:(SEL)selector
{
// Check if the target responds to selector
if (![self respondsToSelector:selector]) {
return;
}
// Create the lookup table
if (!_impLookupTable) {
_impLookupTable = [[NSMutableDictionary alloc] initWithCapacity:3]; // 3 represent the supported base classes
}
// We make sure that setImplementation is called once per class kind, UITableView or UICollectionView.
for (NSDictionary *info in [_impLookupTable allValues]) {
Class class = [info objectForKey:DZNSwizzleInfoOwnerKey];
NSString *selectorName = [info objectForKey:DZNSwizzleInfoSelectorKey];
if ([selectorName isEqualToString:NSStringFromSelector(selector)]) {
if ([self isKindOfClass:class]) {
return;
}
}
}
//1.根據target 返回對應的類class
Class baseClass = dzn_baseClassToSwizzleForTarget(self);
//2.根據class名和selector，建立一個dzn_implement組合key
NSString *key = dzn_implementationKey(baseClass, selector);
//3.根據class名和selector組合key,拿到交換的implement指標。
NSValue *impValue = [[_impLookupTable objectForKey:key] valueForKey:DZNSwizzleInfoPointerKey];
// If the implementation for this class already exist, skip!!
if (impValue || !key || !baseClass) {
return;
}
// Swizzle by injecting additional implementation
Method method = class_getInstanceMethod(baseClass, selector);
//4.將C函式dzn_original_implementation設定成Selector的新的IMP，並返回舊的IMP指標。
IMP dzn_newImplementation = method_setImplementation(method, (IMP)dzn_original_implementation);
// Store the new implementation in the lookup table（原始碼註解錯誤，應該是old implementation,可以點選函式method_setImplementation檢視驗證）
// 儲存舊的reload涵數指標IMP到全域性查詢表_impLookupTable （正確註釋）
NSDictionary *swizzledInfo = @{DZNSwizzleInfoOwnerKey: baseClass,
DZNSwizzleInfoSelectorKey: NSStringFromSelector(selector),
DZNSwizzleInfoPointerKey: [NSValue valueWithPointer:dzn_newImplementation]};
[_impLookupTable setObject:swizzledInfo forKey:key];
}
_impLookupTable儲存在app的資料儲存區，整個app週期只儲存一份資料，所以可以保證整個app生命週期UITableView, UICollectionView, UIScrollView只能交換一次。
在C函式dzn_original_implementation中注入自定義操作，並將函式指標強轉成IMP，繫結給原始Method上。
將舊的，原始的函式指標IMP(如：reloadData)存貯到全域性查詢列表_impLookupTable中，對應的key為：DZNSwizzleInfoPointerKey。
3.自定義注入C函式：
void dzn_original_implementation(id self, SEL _cmd)
{
// Fetch original implementation from lookup table
Class baseClass = dzn_baseClassToSwizzleForTarget(self);
NSString *key = dzn_implementationKey(baseClass, _cmd);
NSDictionary *swizzleInfo = [_impLookupTable objectForKey:key];
NSValue *impValue = [swizzleInfo valueForKey:DZNSwizzleInfoPointerKey];
IMP impPointer = [impValue pointerValue];
// We then inject the additional implementation for reloading the empty dataset
// Doing it before calling the original implementation does update the 'isEmptyDataSetVisible' flag on time.
[self dzn_reloadEmptyDataSet];
// If found, call original implementation
if (impPointer) {
((void(*)(id,SEL))impPointer)(self,_cmd);
}
}
將self和_cmd組合成key, 從全域性查詢表_impLookupTable拿到原始IMP函式指標
然後，執行自定義方法[self dzn_reloadEmptyDataSet]
然後，執行原始IMP函式
4.空白檢視新增方法
- (void)dzn_reloadEmptyDataSet
//空白檢視新增方法
if (!view.superview) {
// Send the view all the way to the back, in case a header and/or footer is present, as well as for sectionHeaders or any other content
if (([self isKindOfClass:[UITableView class]] || [self isKindOfClass:[UICollectionView class]]) && self.subviews.count > 1) {
[self insertSubview:view atIndex:0];
}
else {
[self addSubview:view];
}
}
//更新內部子檢視約束
[view setupConstraints];
對於UITableView，UICollectionView，存在子檢視的容器View，將佔位檢視新增到層級為0的位置。
對於一般的單純View,則直接新增。
5.更新內部子檢視約束
- (void)setupConstraints
{
// First, configure the content view constaints
// The content view must alway be centered to its superview
NSLayoutConstraint *centerXConstraint = [self equallyRelatedConstraintWithView:self.contentView attribute:NSLayoutAttributeCenterX];
NSLayoutConstraint *centerYConstraint = [self equallyRelatedConstraintWithView:self.contentView attribute:NSLayoutAttributeCenterY];
[self addConstraint:centerXConstraint];
[self addConstraint:centerYConstraint];
[self addConstraints:[NSLayoutConstraint constraintsWithVisualFormat:@"H:|[contentView]|" options:0 metrics:nil views:@{@"contentView": self.contentView}]];
// When a custom offset is available, we adjust the vertical constraints' constants
if (self.verticalOffset != 0 && self.constraints.count > 0) {
centerYConstraint.constant = self.verticalOffset;
}
DZNEmptyDataSet採用的是NSLayoutConstraint+VFL（Visual Format Language），“視覺化格式語言”。
我們平時用的比較多是Monsary，對於蘋果原生的使用反而不多，在學習此框架的同時，可以趁機回顧一下原生的魅力。
6.修改響應鏈
- (UIView *)hitTest:(CGPoint)point withEvent:(UIEvent *)event
{
UIView *hitView = [super hitTest:point withEvent:event];
// Return any UIControl instance such as buttons, segmented controls, switches, etc.
if ([hitView isKindOfClass:[UIControl class]]) {
return hitView;
}
// Return either the contentView or customView
if ([hitView isEqual:_contentView] || [hitView isEqual:_customView]) {
return hitView;
}
return nil;
}
對於點選事件的處理，DZNEmptyDataSetView採用的是定向響應傳遞。
如果點選的範圍在_contentView,_customView,UIControl型別，就直接返回，不在繼續向下尋找。
重要角色
1.工具類
UIView (DZNConstraintBasedLayoutExtensions)，作用：
快速為當前檢視的子檢視生成一個約束。
DZNWeakObjectContainer : NSObject，作用：
Weak物件容器
2.空白頁展示檢視View
DZNEmptyDataSetView : UIView，作用：
建立空白頁展示檢視的UI控制元件，新增手勢事件，控制元件的垂直偏移和距離。
更新子檢視約束
修改響應鏈
3.核心邏輯類
UIScrollView (DZNEmptyDataSet)，作用：
UIScrollView分類屬性（DataSource, Delegate, emptyDataSetView）儲存，利用runtime的objc_getAssociatedObject進行getter, setter 。
監聽reloadData方法，endUpdates方法並進行方法交換，利用runtime方法method_setImplementation(method, (IMP)dzn_original_implementation);
另：在分類下新增擴充套件UIScrollView () <UIGestureRecognizerDelegate>，增加了私有屬性emptyDataSetView。
靜態類結構
