起因
我们项目中很多公用的类都封装在framework中,以便iPhone、iPad共同调用。某些逻辑不一样的东西我们会在主工程用category实现,然而category默认是不能定义属性的。我们来看看怎么在category中添加属性
AssociatedObject
iOS有些基础的朋友应该会知道,runtime里有objc_setAssociatedObject和objc_getAssociatedObject两个方法,可以将属性挂到Object上:
@interface Model (Property)
@property (nonatomic, strong)NSString *name;
@end
@implementation Model (Property)
static void *kName = &kName;
- (void)setName:(NSString *)name{ objc_setAssociatedObject(self, kName, name, OBJC_ASSOCIATION_COPY_NONATOMIC);}
- (NSString *)name{ return objc_getAssociatedObject(self, kName);}
@end
重写property的setter和getter方法,在setter的时候调用objc_setAssociatedObject将属性挂到self上,在getter的时候,从self身上将属性取出来。
这样的实现已经是可以用了,事实上大多数为category添加属性的代码都是这样写的。不过我还是太懒,每添加一个属性,就要写这么大一堆代码。想想要是加上十个八个属性,顿时整个人都觉得不好了...
class_addMethod
既然能用runtime动态将属性挂在class上,我们也可以用runtime动态将setter和getter方法插入到class中。runtime提供了class_addMethod方法动态插入method
class_addMethod需要4个参数。class可以通过[self class]获取,SEL可以通过property的name拼接出对应的SEL,types由于参数的类型固定,所以也是可以直接确定。但是IMP怎么办?
imp_implementationWithBlock
说到IMP,我们先来了解一下IMP是个什么东西
IMP是一个函数指针,指向相应的函数实现,函数一般会有2个默认参数:id类型的self和SEL类型的_cmd。平时我们之所以能在OC函数中调用self,也是因为函数中有隐藏起来了的self参数
翻阅runtime的文档,我们找到了通过block转换成IMP的API:
封装
一切都准备就绪了,那我们就来封装一个动态添加属性的方法吧,为了简化流程,我们暂时先只考虑id类型的属性。
+ (void)addObjectProperty:(NSString *)name
{
//1. 通过class的指针和property的name,创建一个唯一的key NSString *key = [NSString stringWithFormat:@"%p_%@",self,name];
//2. 用block实现setter方法
id setblock = ^(id self,id value){ objc_setAssociatedObject(self, (__bridge void *)key, value, OBJC_ASSOCIATION_RETAIN_NONATOMIC); };
//3. 将block的实现转化为IMP
IMP imp = imp_implementationWithBlock(setblock);
//4. 用name拼接出setter方法
NSString *selString = [self setMethodNameWithProperty:name];
//5. 将setter方法加入到class中
BOOL result = class_addMethod([self class], NSSelectorFromString(selString), imp, "v@:@");
//6. getter
id getBlock = ^id(id self){ return objc_getAssociatedObject(self, (__bridge void*)key); };
IMP getImp = imp_implementationWithBlock(getBlock);
result = class_addMethod([self class], NSSelectorFromString(name), getImp, "@@:");}
通过class的指针和property的name,创建一个唯一的key。用来在AssociatedObject的时候存取属性。
在block中实现setter方法
通过block创建IMP
通过name将setter的方法名拼接出来,-setMethodNameWithProperty是自己写的方法,这里没有贴出来
将setter方法加入到class中。其中@"v@:@":v表示空,setter的返回值为空。@表示id类型,第一个参数,也就是self为id类型。:表示SEL类型,第二个参数为method的selector。@表示id类型,第三个参数也就是setter方法真正要传入的参数为id类型。
后面是相应的getter方法,与setter方法类似
使用
这时候,再也不用担心有很多property,写一堆重复的代码。我们只需要调一个函数就可以将在category插入属性
@interface Model (Property)
@property (nonatomic, strong)NSString *name;
@property (nonatomic, strong)NSURL *URL;
@property (nonatomic, strong)NSDate *date;
@end
@implementation Model (Property)
+ (void)load{ [self addObjectProperty:@"name"];
[self addObjectProperty:@"URL"];
[self addObjectProperty:@"date"];}
@end
+load方法在程序运行之前会调用,不用担心在用的时候,property还未插入进去。所有的category的+load方法系统都会自动调用。也不用担心+load方法在category中被覆盖。
开始考虑过在+initialize中使用,不过由于+initialize一个class只会调用一次,多个category的时候会有覆盖。所以+load中使用是最好的选择
你以为这样就ok了么?过几天有用户反馈说App启动的时候有点卡啊,因为+load方法是在app启动的时候调用的,里面执行的代码越多,App启动越慢,(说得有点夸张,实际这点代码影响不了什么)。我们知道除了+load之外,还有一个+initialize方法,+initialize会在第一次使用这个类的时候调用,我们完全可以在+initialize中添加属性。然而+initialize有个最大的问题就是,他跟普通方法一样,当有多个category实现的时候,会发生覆盖,系统只会调用一个Category中的+initialize,那该怎么办呢?
消除Category同名方法覆盖
sunnyxx大神在objc category的秘密里介绍过,category的同名方法覆盖并不是真的其他同名方法就消失了,而是因为系统调用方法的时候根据方法名在method_list中查找方法,找到第一个名字匹配的方法之后就不继续往下找了。所以每次调用的都是method_list中最前面的同名方法。实际其他同名方法还在method_list中so...我们可以根据selector查找到所有的同名method,然后调用:
static inline void __invoke_all_method(id self, SEL selecotr)
{
//1. 根据self,获取
class Class class = object_getClass(self);
//2. 获取方法列表
uint count;
Method *methodList = class_copyMethodList(class, &count);
//3. 遍历方法列表
for (int i = 0; i < count; i++)
{ Method method = methodList[i];
//4. 根据SEL查找方法
if (!sel_isEqual(selecotr, method_getName(method)))
{ continue; }
//5. 获取方法的实现
IMP implement = method_getImplementation(method);
//6. 直接调用方法的实现
((void(*)(id,SEL))implement)(self, selecotr); }}
+ (void)invokeAllClassMethodWithSelector:(SEL)selector
{
__invoke_all_method(self, selector);
}
根据刚刚介绍的原理,我们封装了一个通过selector调用所有同名method的方法。
根据self,获取class,如果self是实例方法的self,这里获取的是普通的class,如果self是类方法的self,这里获取的是metaClass。实例方法存放在普通class中,类方法存放在metaClass中。了解更多请看iOS开发RunTime之函数调用
通过class_copyMethodList获取class的方法列表。如果class传的是metaClass,获取的是类方法的方法列表,如果class是普通class,获取的是实例方法的方法列表。
遍历methodList
根据SEL查找method
获取IMP
直接调用IMP
在系统的+initialize中,我们用invokeAllClassMethodWithSelector调用自定义的+categoryInitialize。这时候,在category的+categoryInitialize中添加属性,就不怕Category覆盖了
@implementation Model
+ (void)initialize{
[self invokeAllClassMethodWithSelector:@selector(categoryInitialize)];}
@end
@implementation Model (Property1)
+ (void)categoryInitialize{ [self addBasicProperty:@"point" encodingType:@encode(CGPoint)];
[self addBasicProperty:@"myRect" encodingType:@encode(CGRect)];}
@end
@implementation Model (Property2)
+ (void)categoryInitialize{ [self addBasicProperty:@"f" encodingType:@encode(float)];
[self addBasicProperty:@"a" encodingType:@encode(int)];}
@end
Extension
文章主要为了说明思路,很多代码没贴出来。也没考虑接口设计和不是id类型的问题。如果想在项目中使用这个方法。大家可以去我的github上下载完整的代码。LcCategoryProperty
网友评论