Runtime 系列 3-- 给 category 添加属性

时间 2019-11-24

标签 runtime 系列 category 添加属性繁體版

原文原文链接

Associated Objects的做用

Associated Objects的做用通常有以下三种：html

为系统类添加私有变量以帮助实现细节；

为系统类添加公有属性；

为 KVO 建立一个关联的观察者。

咱们用的最多的是第二种状况。程序员

那么给系统类添加公共属性是如何作到的呢？咱们能够经过category来实现，下面具体讲讲实现过程。网络

###category添加属性的实现原理咱们知道，在 Objective-C 中能够经过 Category 给一个系统类添加属性，可是却不能添加实例变量，这彷佛成为了 Objective-C 的一个明显短板。看下面category的结构就知道app

Objective-C

struct category_t {
    // 类名
    const char *name;
    // 类
    classref_t cls;
    // 实例方法
    struct method_list_t *instanceMethods;
    // 类方法
    struct method_list_t *classMethods;
    // 协议
    struct protocol_list_t *protocols;
    // 属性
    struct property_list_t *instanceProperties;
};复制代码

从以上的分类结构，能够看出，分类中是不能添加成员变量的，也就是Ivar类型。因此，若是想在分类中存储某些数据时，关联对象就是在这种状况下的经常使用选择。异步

须要注意的是，关联对象并非成员变量，关联对象是由一个全局哈希表存储的键值对中的值。ide

全局哈希表

class AssociationsManager {
    static spinlock_t _lock;
    static AssociationsHashMap *_map;               // associative references:  object pointer -> PtrPtrHashMap.
public:
    AssociationsManager()   { spinlock_lock(&_lock); }
    ~AssociationsManager()  { spinlock_unlock(&_lock); }

    AssociationsHashMap &associations() {
        if (_map == NULL)
            _map = new AssociationsHashMap();
        return *_map;
    }
};复制代码

其中的AssociationsHashMap就是那个全局哈希表，而注释中也说明的很清楚了：哈希表中存储的键值对是（源对象指针 : 另外一个哈希表）。而这个value，即ObjectAssociationMap对应的哈希表以下：函数

// hash_map和unordered_map是模版类
// 查看源码后能够看出AssociationsHashMap的key是disguised_ptr_t类型，value是ObjectAssociationMap *类型
// ObjectAssociationMap的key是void *类型，value是ObjcAssociation类型

#if TARGET_OS_WIN32
    typedef hash_map ObjectAssociationMap;
    typedef hash_map AssociationsHashMap;
#else
    typedef ObjcAllocator > ObjectAssociationMapAllocator;
    class ObjectAssociationMap : public std::map {
    public:
        void *operator new(size_t n) { return ::_malloc_internal(n); }
        void operator delete(void *ptr) { ::_free_internal(ptr); }
    };
    typedef ObjcAllocator > AssociationsHashMapAllocator;

    class AssociationsHashMap : public unordered_map {
    public:
        void *operator new(size_t n) { return ::_malloc_internal(n); }
        void operator delete(void *ptr) { ::_free_internal(ptr); }
    };
#endif复制代码

AssociationsManager里面是由一个静态AssociationsHashMap来存储全部的关联对象的。这至关于把全部对象的关联对象都存在一个全局map里面。而map的的key是这个对象的指针地址（任意两个不一样对象的指针地址必定是不一样的），而这个map的value又是另一个AssociationsHashMap，里面保存了关联对象的key-value对。ui

####实现代码范例给系统类UIViewController添加一个name属性atom

#import 
  
  
  

 
  
  @interface UIViewController (Utilities) @property(nonatomic,strong)NSString *name; @end ====================================== #import "UIViewController+Utilities.h" #import 
 
  
    @implementation UIViewController (Utilities) -(void)setName:(NSString *)name { objc_setAssociatedObject(self, @selector(name), name, OBJC_ASSOCIATION_COPY); } -(NSString *)name { return objc_getAssociatedObject(self, @selector(name)); } @end 
   

 复制代码

Associated Objects的使用

key 值

关于前两个函数中的 key 值是咱们须要重点关注的一个点，这个 key 值必须保证是一个对象级别（为何是对象级别？看完下面的章节你就会明白了）的惟一常量。通常来讲，有如下三种推荐的 key 值：

声明 static char kAssociatedObjectKey; ，使用 &kAssociatedObjectKey 做为 key 值;

声明 static void *kAssociatedObjectKey = &kAssociatedObjectKey; ，使用 kAssociatedObjectKey 做为 key 值；

用 selector ，使用 getter 方法的名称做为 key 值。

最推荐第3种方式，由于你不须要去定义一个变量名。

关联策略

在给一个对象添加关联对象时有五种关联策略可供选择：

大多数场景咱们选择OBJC_ASSOCIATION_RETAIN_NONATOMIC。

场景一、给button关联一个block

通常咱们初始化一个UIbutton，而后给他加上点击事件，这个时候点击事件的代码须要去另一个方法实现，致使代码太分散。咱们能够给button关联一个block，把点击事件的代码都移到block里面执行。

实现代码

@interface UIButton ()

@property (nonatomic, copy) void (^callbackBlock)(UIButton * button);

@end

@implementation UIButton (Callback)

- (void (^)(UIButton *))callbackBlock {
    return objc_getAssociatedObject(self, @selector(callbackBlock));
}

- (void)setCallbackBlock:(void (^)(UIButton *))callbackBlock {
    objc_setAssociatedObject(self, @selector(callbackBlock), callbackBlock, OBJC_ASSOCIATION_COPY_NONATOMIC);
}

- (instancetype)initWithFrame:(CGRect)frame{

    if (self = [super initWithFrame:frame]) {
        [self addTarget:self action:@selector(didClickAction:) forControlEvents:UIControlEventTouchUpInside];
    }
    return self;
}

- (void)didClickAction:(UIButton *)button {
    self.callbackBlock(button);
}

@end复制代码

调用

UIButton *btn = [[UIButton alloc]initWithFrame:CGRectMake(100,100 , 100, 100)];
    [btn setTitle:@"dsd" forState:UIControlStateNormal];
    btn.backgroundColor = [UIColor redColor];
    [self.view addSubview:btn];
    btn.callbackBlock = ^(UIButton *btn){
        NSLog(@"%@",btn.titleLabel.text);
    };复制代码

场景二、给UIAlertView关联一个block

同上面的场景同样，UIAlertView的代理方法里面代码和初始化方法是分开的，咱们也能够用block把他们集中到一块儿实现。

实现代码

#import 
  
  
  

 
  
  static void *alertViewBlockKey = &alertViewBlockKey; - (void)function { UIAlertView *alertView = [[UIAlertView alloc] initWithTitle:@"Question" message:@"What do you want to do?" delegate:self cancelButtonTitle:@"Cancel" otherButtonTitles:@"Continue", nil]; void (^block)(NSInteger) = ^(NSInteger buttonIndex) { if (buttonIndex == 0) { //你的代码; } else { //你的代码; } }; objc_setAssociatedObject(alertView, alertViewBlockKey, block, OBJC_ASSOCIATION_COPY); [alertView show]; } // UIAlertViewDelegate protocol method - (void)alertView:(UIAlertView *)alertView clickedButtonAtIndex:(NSInteger)buttonIndex { void (^block)(NSInteger) = objc_getAssociatedObject(alertView, alertViewBlockKey); block(buttonIndex); } 

 复制代码

场景三、AFNetworking给UIImageView添加私有属性

当扩展一个内建类的行为时，保持附加属性的状态可能很是必要。注意如下说的是一种很是教科书式的关联对象的用例：AFNetworking在 UIImageView 的category上用了关联对象来保持一个operation对象，用于从网络上某URL异步地获取一张图片。

@interface UIImageView (_AFNetworking)
@property (readwrite, nonatomic, strong, setter = af_setImageRequestOperation:) AFHTTPRequestOperation *af_imageRequestOperation;
@end

@implementation UIImageView (_AFNetworking)

- (AFHTTPRequestOperation *)af_imageRequestOperation {
    return (AFHTTPRequestOperation *)objc_getAssociatedObject(self, @selector(af_imageRequestOperation));
}

- (void)af_setImageRequestOperation:(AFHTTPRequestOperation *)imageRequestOperation {
    objc_setAssociatedObject(self, @selector(af_imageRequestOperation), imageRequestOperation, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}

@end复制代码

@implementation UIImageView (AFNetworking)

- (void)setImageWithURLRequest:(NSURLRequest *)urlRequest
              placeholderImage:(UIImage *)placeholderImage
                       success:(void (^)(NSURLRequest *request, NSHTTPURLResponse * __nullable response, UIImage *image))success
                       failure:(void (^)(NSURLRequest *request, NSHTTPURLResponse * __nullable response, NSError *error))failure
{
    [self cancelImageRequestOperation];

    UIImage *cachedImage = [[[self class] sharedImageCache] cachedImageForRequest:urlRequest];
    if (cachedImage) {
        if (success) {
            success(urlRequest, nil, cachedImage);
        } else {
            self.image = cachedImage;
        }

        self.af_imageRequestOperation = nil;
    } else {
        if (placeholderImage) {
            self.image = placeholderImage;
        }

        __weak __typeof(self)weakSelf = self;
        self.af_imageRequestOperation = [[AFHTTPRequestOperation alloc] initWithRequest:urlRequest];
        self.af_imageRequestOperation.responseSerializer = self.imageResponseSerializer;
        [self.af_imageRequestOperation setCompletionBlockWithSuccess:^(AFHTTPRequestOperation *operation, id responseObject) {
            __strong __typeof(weakSelf)strongSelf = weakSelf;
            if ([[urlRequest URL] isEqual:[strongSelf.af_imageRequestOperation.request URL]]) {
                if (success) {
                    success(urlRequest, operation.response, responseObject);
                } else if (responseObject) {
                    strongSelf.image = responseObject;
                }

                if (operation == strongSelf.af_imageRequestOperation){
                        strongSelf.af_imageRequestOperation = nil;
                }
            }

            [[[strongSelf class] sharedImageCache] cacheImage:responseObject forRequest:urlRequest];
        } failure:^(AFHTTPRequestOperation *operation, NSError *error) {
            __strong __typeof(weakSelf)strongSelf = weakSelf;
            if ([[urlRequest URL] isEqual:[strongSelf.af_imageRequestOperation.request URL]]) {
                if (failure) {
                    failure(urlRequest, operation.response, error);
                }

                if (operation == strongSelf.af_imageRequestOperation){
                        strongSelf.af_imageRequestOperation = nil;
                }
            }
        }];

        [[[self class] af_sharedImageRequestOperationQueue] addOperation:self.af_imageRequestOperation];
    }
}复制代码

不恰当的使用场景

一、当值不须要的时候创建一个关联对象。

一个常见的例子就是在view上建立一个方便的方法去保存来自model的属性、值或者其余混合的数据。若是那个数据在以后根本用不到，那么这种方法虽然是没什么问题的，但用关联到对象的作法并不可取。

二、当一个值能够被其余值推算出时创建一个关联对象。

例如：在调用cellForRowAtIndexPath: 时存储一个指向view的 UITableViewCell 中accessory view的引用，用于在 tableView:accessoryButtonTappedForRowWithIndexPath: 中使用。

三、用关联对象替代X，这里的X能够表明下列含义：

当继承比扩展原有的类更方便时用子类化。
为事件的响应者添加响应动做。
当响应动做不方便使用时使用的手势动做捕捉。
行为能够在其余对象中被代理实现时要用代理(delegate)。
用NSNotification 和 NSNotificationCenter进行松耦合化的跨系统的事件通知。

PS:

比起其余解决问题的方法，关联对象应该被视为最后的选择（事实上category也不该该做为首选方法）。

总结：

关于category的实现细节，你们能够参考这篇文章：

tech.meituan.com/DiveIntoCat…

更多文章欢迎你们关注个人我的blog：

blog.ximu.site

Runtime 系列 3-- 给 category 添加属性

Associated Objects的做用

全局哈希表

Associated Objects的使用

相关函数

key 值

关联策略

场景一、给button关联一个block

实现代码

调用

场景二、给UIAlertView关联一个block

实现代码

场景三、AFNetworking给UIImageView添加私有属性

不恰当的使用场景

一、 当值不须要的时候创建一个关联对象。

二、当一个值能够被其余值推算出时创建一个关联对象。

三、 用关联对象替代X，这里的X能够表明下列含义：

总结：

一、当值不须要的时候创建一个关联对象。

三、用关联对象替代X，这里的X能够表明下列含义：