DZNEmptyDataSet关键源码解读__附Method详情

DZNEmptyDataSet是一个能够为UITableView、UICollectionView自动添加空页面提示的第三方库,使用起来方便快捷。

最近看了实现原理,整理如下:
DZNEmptyDataSet 用类似 MethodSwizzle 的方法,重新实现了UITableView、UICollectionViewreloadData 方法。在新的方法实现中通过UITableView、UICollectionViewDataSource代理方法获取要展示数据的条数item,如果item = 0, 则展示空页面。

  1. 如何改写reloadData 方法的实现?
 - (void)swizzleIfPossible:(SEL)selector {

    if (![self respondsToSelector:selector]) {
        return;
    }

    // 新建检索字典
    if (!_impLookupTable) {
        _impLookupTable = [[NSMutableDictionary alloc] initWithCapacity:3];
        // 3 represent the supported base classes 
        // 字典key: className + selectorName
        // 字典value: dict { DZNSwizzleInfoOwnerKey:     class
                             // DZNSwizzleInfoPointerKey:   impValue
                             // DZNSwizzleInfoSelectorKey:  selector
    }

    // 查找是否已经改写过selector
    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;
            }
        }
    }

    // 获取self的类
    Class baseClass = dzn_baseClassToSwizzleForTarget(self);
    // 字符串拼接 className + selectorName
    NSString *key = dzn_implementationKey(baseClass, selector); 

    NSValue *impValue = [[_impLookupTable objectForKey:key] valueForKey:DZNSwizzleInfoPointerKey];

    // 如果实现已存在,跳过
    if (impValue || !key || !baseClass) {
        return;
    }

    // Swizzle
    Method method = class_getInstanceMethod(baseClass, selector);

    // 将dzn_original_implementation新的实现赋值给method, 其操作返回值为method的原有实现,将存储到检索字典中
    IMP dzn_newImplementation = method_setImplementation(method, (IMP)dzn_original_implementation);

    // 存储到检索字典中
    NSDictionary *swizzledInfo = @{DZNSwizzleInfoOwnerKey: baseClass,
                                   DZNSwizzleInfoSelectorKey: NSStringFromSelector(selector),
                                   DZNSwizzleInfoPointerKey: [NSValue valueWithPointer:dzn_newImplementation]};

    [_impLookupTable setObject:swizzledInfo forKey:key];
}

  1. 这之后,调用reloadData方法将会调用dzn_original_implementation的实现
void dzn_original_implementation(id self, SEL _cmd) {
    // 在检索表中查找原有方法实现
    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];

    // 执行是否显示空页面的操作
    [self dzn_reloadEmptyDataSet];

    // 执行原有方法实现
    if (impPointer) {
        ((void(*)(id,SEL))impPointer)(self,_cmd);
    }
}

  1. 其中[self dzn_reloadEmptyDataSet];通过UITableView、UICollectionViewDataSource代理方法获取要展示数据的条数item,如果item = 0, 则展示空页面,如果item > 0将移除空页面。
    展示和移除空页面的UI操作不做详细分析。

附 method详情

定义

先来看一下method相关的定义

  typedef struct objc_method *Method;

  struct objc_method {
      SEL method_name;
      char *method_types;
      IMP method_imp;
  } 

  struct objc_method_list {
      struct objc_method_list *obsolete                        OBJC2_UNAVAILABLE;

      int method_count                                         OBJC2_UNAVAILABLE;
  #ifdef __LP64__
      int space                                                OBJC2_UNAVAILABLE;
  #endif
      /* variable length structure */
      struct objc_method method_list[1]                        OBJC2_UNAVAILABLE;
  } 

  struct objc_method_description {
      SEL name;               /**< The name of the method */
      char *types;            /**< The types of the method arguments */

  };

  struct objc_method_description_list {
      int count;
      struct objc_method_description list[1];
  };

里边有三个类型别名,在这儿先解释一下

  • SEL selector 的简写,俗称方法选择器,实质存储的是方法的名称
  • IMP implement 的简写,俗称方法实现,看源码得知它就是一个函数指针
  • Method 对上述两者的一个包装结构.
函数

method相关的函数也不是太多,下边简单罗列说明一下

  //判断类中是否包含某个方法的实现
  BOOL class_respondsToSelector(Class cls, SEL sel)
  //获取类中的方法列表
  Method *class_copyMethodList(Class cls, unsigned int *outCount) 
  //为类添加新的方法,如果方法该方法已存在则返回NO
  BOOL class_addMethod(Class cls, SEL name, IMP imp, const char *types)
  //替换类中已有方法的实现,如果该方法不存在添加该方法
  IMP class_replaceMethod(Class cls, SEL name, IMP imp, const char *types) 
  //获取类中的某个实例方法(减号方法)
  Method class_getInstanceMethod(Class cls, SEL name)
  //获取类中的某个类方法(加号方法)
  Method class_getClassMethod(Class cls, SEL name)
  //获取类中的方法实现
  IMP class_getMethodImplementation(Class cls, SEL name)
  //获取类中的方法的实现,该方法的返回值类型为struct
  IMP class_getMethodImplementation_stret(Class cls, SEL name) 

  //获取Method中的SEL
  SEL method_getName(Method m) 
  //获取Method中的IMP
  IMP method_getImplementation(Method m)
  //获取方法的Type字符串(包含参数类型和返回值类型)
  const char *method_getTypeEncoding(Method m) 
  //获取参数个数
  unsigned int method_getNumberOfArguments(Method m)
  //获取返回值类型字符串
  char *method_copyReturnType(Method m)
  //获取方法中第n个参数的Type
  char *method_copyArgumentType(Method m, unsigned int index)
  //获取Method的描述
  struct objc_method_description *method_getDescription(Method m)
  //设置Method的IMP
  IMP method_setImplementation(Method m, IMP imp) 
  //替换Method
  void method_exchangeImplementations(Method m1, Method m2)

  //获取SEL的名称
  const char *sel_getName(SEL sel)
  //注册一个SEL
  SEL sel_registerName(const char *str)
  //判断两个SEL对象是否相同
  BOOL sel_isEqual(SEL lhs, SEL rhs) 

  //通过块创建函数指针,block的形式为^ReturnType(id self,参数,...)
  IMP imp_implementationWithBlock(id block)
  //获取IMP中的block
  id imp_getBlock(IMP anImp)
  //移出IMP中的block
  BOOL imp_removeBlock(IMP anImp)

  //调用target对象的sel方法
  id objc_msgSend(id target, SEL sel, 参数列表...)

Showtime

下边就来玩玩runtime API中的method相关操作

  //创建继承自NSObject类的People类
  Class People = objc_allocateClassPair([NSObject class], "People", 0);
  //将People类注册到runtime中
  objc_registerClassPair(People);
  //注册test: 方法选择器
  SEL sel = sel_registerName("test:");
  //函数实现
  IMP imp = imp_implementationWithBlock(^(id this,id args,...){
      NSLog(@"方法的调用者为 %@",this);
      NSLog(@"参数为 %@",args);
      return @"返回值测试";
  });

  //向People类中添加 test:方法;函数签名为@@:@,
  //    第一个@表示返回值类型为id,
  //    第二个@表示的是函数的调用者类型,
  //    第三个:表示 SEL
  //    第四个@表示需要一个id类型的参数
  class_addMethod(People, sel, imp, "@@:@");
  //替换People从NSObject类中继承而来的description方法
  class_replaceMethod(People,@selector(description), imp_implementationWithBlock(^NSString*(id this,...){
      return @"我是Person类的对象";}),
      "@@:");

  //完成 [[People alloc]init];
  id p1 = objc_msgSend(objc_msgSend(People, @selector(alloc)),@selector(init));
  //调用p1的sel选择器的方法,并传递@"???"作为参数
  id result = objc_msgSend(p1, sel,@"???");
  //输出sel方法的返回值
  NSLog(@"sel 方法的返回值为 : %@",result);

  //获取People类中实现的方法列表
  NSLog(@"输出People类中实现的方法列表");
  unsigned int methodCount;
  Method * methods = class_copyMethodList(People, &methodCount);
  for (int i = 0; itypes);
  }
  free(methods);

你可能感兴趣的:(DZNEmptyDataSet关键源码解读__附Method详情)