源码学习 - DZNEmptyDataSet

简要介绍

DZNEmptyDataSet 是APP在展示列表类数据功能,出现空数据情况下,给用户直观提示的UI控件。其特点及详细介绍图见前面超链接。

DZNEmptyDataSetUIScrollView+EmptyDataSet 类别来实现所有功能逻辑,个人认为正适合此功能逻辑规模,不至于拆分成其他文件略显拖沓,单文件代码少。项目主要使用代理模式完成代码内部逻辑和外部调用者之间的通信,内部主要使用 runtime( Method Swizzling、get set AssociatedObject)Custome ViewAuto-Layout技术和其他重要逻辑实现。

DZNEmptyDataSet 头文件代码注释很详细,就不再赘述了。具体使用也可看此文章DZNEmptyDataSet——空白数据集显示框架

实现文件中类结构为:
DZNWeakObjectContainer : NSObject --- manage weak delegate

DZNEmptyDataSetView : UIView --- custom view

UIScrollView+EmptyDataSet <category> --- functional logic

UIView+DZNConstraintBasedLayoutExtensions --- auto layout logic util

代码学习

  • #pragma mark - Method Swizzling代码块
    此代码块主要展示了如何将UITableView/UICollectionView/UIScrollView中的@selector(reloadData)方法和@selector(endUpdates)方法与自定义C方法void dzn_original_implementation(id self, SEL _cmd)进行正确的 Swizzling(交换)

1.创建一个符合IMP定义的C函数(更具体地说,是我们要Swizzling的自定义方法的签名)

void dzn_original_implementation(id self, SEL _cmd) {
   //注入额外的方法:dzn_reloadEmptyDataSet(刷新空数据展示视图-DZNEmptyDataSetView、调用其他业务逻辑)
  [self dzn_reloadEmptyDataSet];
  //调用原始方法:
  //Fetch original implementation from lookup table
   IMP impPointer = //Fetch code ...
  // If found, call original implementation
  if (impPointer) {
        ((void(*)(id,SEL))impPointer)(self,_cmd);
    }
}
  1. 正确使用method_setImplementation进行Swizzling的注意点:

将要Swizzling的函数转换为IMP:

IMP swizzleImp = (IMP)dzn_original_implementation;

将此IMP传递给method_setImplementation()方法,并且此方法会返回原始方法的IMP-original IMP

IMP originalImp =  method_setImplementation(method, (IMP)dzn_original_implementation);

那么使用得到的originalImp 可以调用原始的实现方法:

originalImp(self,_cmd);

另外,如果IMP调用返回一个空值,您可能不得不对其进行处理。
这是因为ARC假定所有的imp都返回一个id,并尝试retain void和基本类型。
IMP anImp; //represents objective-c function
          // -UIViewController viewDidLoad;
((void(*)(id,SEL))anImp)(self,_cmd); //call with a cast to prevent
                                     // ARC from retaining void.
  1. DZNEmptyDataSet中正确使用method_setImplementation进行Swizzling的Code:
[self swizzleIfPossible:@selector(reloadData)];

- (void)swizzleIfPossible:(SEL)selector
{
    // Check if the target responds to selector
    // 如果没有实现selector,return
    if (![self respondsToSelector:selector]) {
        return;
    }
    
    // Create the lookup table
    //创建存储原始IMP的字典,供后续查找调用
    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.
    //确保 method_setImplementation 在一种类中只调用一次,即_impLookupTable存有要被Swizzling的selector,说明已经被Swizzling了,这时return
    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;
            }
        }
    }
    
    Class baseClass = dzn_baseClassToSwizzleForTarget(self);
    NSString *key = dzn_implementationKey(baseClass, selector);
    NSValue *impValue = [[_impLookupTable objectForKey:key] valueForKey:DZNSwizzleInfoPointerKey];
    
    // If the implementation for this class already exist, skip!!
    // 与上面一样,已经被Swizzling则return
    if (impValue || !key || !baseClass) {
        return;
    }
    
    // Swizzle by injecting additional implementation
    // 开始Swizzle,method-被替换的方法实现  (IMP)dzn_original_implementation)-自定义的方法实现
    Method method = class_getInstanceMethod(baseClass, selector);
    IMP dzn_newImplementation = method_setImplementation(method, (IMP)dzn_original_implementation);
    
    // Store the new implementation in the lookup table
    //存储被替换的原始方法信息:
    //baseClass-类 NSStringFromSelector(selector)-selector字符串, [NSValue valueWithPointer:dzn_newImplementation]-指针值,
    NSDictionary *swizzledInfo = @{DZNSwizzleInfoOwnerKey: baseClass,
                                   DZNSwizzleInfoSelectorKey: NSStringFromSelector(selector),
                                   DZNSwizzleInfoPointerKey: [NSValue valueWithPointer:dzn_newImplementation]};
    
    [_impLookupTable setObject:swizzledInfo forKey:key];
}

扩展

根据DZNEmptyDataSet的源码,自己写了一个用于在UIViewController显示空白提示的控件库 - UIViewControllerLoadResultHint

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

推荐阅读更多精彩内容