探秘Runtime - 深入剖析Category

部落格配圖

Category

有了之前Runtime的基礎，一些內部實現就很好理解了。在OC中可以透過Category新增屬性、方法、協議，在Runtime中Class和Category都是透過結構體實現的。

和Category語法很相似的還有Extension，二者的區別在於，Extension在編譯期就直接和原類編譯在一起，而Category是在執行時動態新增到原類中的。

基於之前的原始碼分析，我們來分析一下Category的實現原理。

在_read_images函式中會執行一個迴圈巢狀，外部迴圈遍歷所有類，並取出當前類對應Category陣列。內部迴圈會遍歷取出的Category陣列，將每個category_t物件取出，最終執行addUnattachedCategoryForClass函式新增到Category雜湊表中。

// 將category_t新增到list中，並透過NXMapInsert函式，更新所屬類的Category列表static void addUnattachedCategoryForClass(category_t *cat, Class cls, 
                                          header_info *catHeader){    // 獲取到未新增的Category雜湊表
    NXMapTable *cats = unattachedCategories();
    category_list *list;    // 獲取到buckets中的value，並向value對應的陣列中新增category_t
    list = (category_list *)NXMapGet(cats, cls);    if (!list) {        list = (category_list *)            calloc(sizeof(*list) + sizeof(list->list[0]), 1);
    } else {        list = (category_list *)            realloc(list, sizeof(*list) + sizeof(list->list[0]) * (list->count + 1));
    }    // 替換之前的list欄位
    list->list[list->count++] = (locstamped_category_t){cat, catHeader};
    NXMapInsert(cats, cls, list);
}

Category維護了一個名為category_map的雜湊表，雜湊表儲存所有category_t物件。

// 獲取未新增到Class中的category雜湊表static NXMapTable *unattachedCategories(void){    // 未新增到Class中的category雜湊表
    static NXMapTable *category_map = nil;    if (category_map) return category_map;    // fixme initial map size
    category_map = NXCreateMapTable(NXPtrValueMapPrototype, 16);    return category_map;
}

上面只是完成了向Category雜湊表中新增的操作，這時候雜湊表中儲存了所有category_t物件。然後需要呼叫remethodizeClass函式，向對應的Class中新增Category的資訊。

在remethodizeClass函式中會查詢傳入的Class引數對應的Category陣列，然後將陣列傳給attachCategories函式，執行具體的新增操作。

// 將Category的資訊新增到Class，包含method、property、protocolstatic void remethodizeClass(Class cls){
    category_list *cats;    bool isMeta;
    isMeta = cls->isMetaClass();    // 從Category雜湊表中查詢category_t物件，並將已找到的物件從雜湊表中刪除
    if ((cats = unattachedCategoriesForClass(cls, false/*not realizing*/))) {
        attachCategories(cls, cats, true /*flush caches*/);        
        free(cats);
    }
}

在attachCategories函式中，查詢到Category的方法列表、屬性列表、協議列表，然後透過對應的attachLists函式，新增到Class對應的class_rw_t結構體中。

// 獲取到Category的Protocol list、Property list、Method list，然後透過attachLists函式新增到所屬的類中static void attachCategories(Class cls, category_list *cats, bool flush_caches){    if (!cats) return;    if (PrintReplacedMethods) printReplacements(cls, cats);    bool isMeta = cls->isMetaClass();    // 按照Category個數，分配對應的記憶體空間
    method_list_t **mlists = (method_list_t **)        malloc(cats->count * sizeof(*mlists));    property_list_t **proplists = (property_list_t **)        malloc(cats->count * sizeof(*proplists));    protocol_list_t **protolists = (protocol_list_t **)        malloc(cats->count * sizeof(*protolists));    int mcount = 0;    int propcount = 0;    int protocount = 0;    int i = cats->count;    bool fromBundle = NO;    
    // 迴圈查詢出Protocol list、Property list、Method list
    while (i--) {        auto& entry = cats->list[i];        method_list_t *mlist = entry.cat->methodsForMeta(isMeta);        if (mlist) {
            mlists[mcount++] = mlist;
            fromBundle |= entry.hi->isBundle();
        }        property_list_t *proplist = 
            entry.cat->propertiesForMeta(isMeta, entry.hi);        if (proplist) {
            proplists[propcount++] = proplist;
        }        protocol_list_t *protolist = entry.cat->protocols;        if (protolist) {
            protolists[protocount++] = protolist;
        }
    }    auto rw = cls->data();    // 執行新增操作
    prepareMethodLists(cls, mlists, mcount, NO, fromBundle);
    rw->methods.attachLists(mlists, mcount);    free(mlists);    if (flush_caches  &&  mcount > 0) flushCaches(cls);

    rw->properties.attachLists(proplists, propcount);    free(proplists);

    rw->protocols.attachLists(protolists, protocount);    free(protolists);
}

這個過程就是將Category中的資訊，新增到對應的Class中，一個類的Category可能不只有一個，在這個過程中會將所有Category的資訊都合併到Class中。

方法覆蓋

在有多個Category和原類的方法重複定義的時候，原類和所有Category的方法都會存在，並不會被後面的覆蓋。假設有一個方法叫做method，Category和原類的方法都會被新增到方法列表中，只是存在的順序不同。

排列順序

在進行方法呼叫的時候，會優先遍歷Category的方法，並且後面被新增到專案裡的Category，會被優先呼叫。上面的例子呼叫順序就是Category3 -> Category2 -> Category1 -> TestObject。如果從方法列表中找到方法後，就不會繼續向後查詢，這就是類方法被Category”覆蓋”的原因。

問題

在有多個Category和原類方法重名的情況下，怎樣在一個Category的方法被呼叫後，呼叫所有Category和原類的方法？

可以在一個Category方法被呼叫後，遍歷方法列表並呼叫其他同名方法。但是需要注意一點是，遍歷過程中不能再呼叫自己的方法，否則會導致遞迴呼叫。為了避免這個問題，可以在呼叫前判斷被調動的方法IMP是否當前方法的IMP。

那怎樣在任何一個Category的方法被呼叫後，只呼叫原類方法呢？

根據上面對方法呼叫的分析，Runtime在呼叫方法時會優先所有Category呼叫，所以可以倒敘遍歷方法列表，只遍歷第一個方法即可，這個方法就是原類的方法。

Category Associate

在專案中經常會用到Category，有時候會遇到給Category新增屬性的需求，這時候就需要用到associated的Runtime API了。例如下面的例子中，需要在屬性的set、get方法中動態新增實現。

// 宣告檔案@interface TestObject (Category)@property (nonatomic, strong) NSObject *object;@end// 實現檔案#import <objc/runtime.h>#import <objc/message.h>static void *const kAssociatedObjectKey = (void *)&kAssociatedObjectKey;@implementation TestObject (Category)- (NSObject *)object {    return objc_getAssociatedObject(self, kAssociatedObjectKey);
}

- (void)setObject:(NSObject *)object {
    objc_setAssociatedObject(self, kAssociatedObjectKey, object, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}@end

在Category中新增屬性後，預設是沒有實現方法的，如果呼叫屬性則會崩潰，而且還會提示下面兩個警告資訊。

Property 'object' requires method 'object' to be defined - use @dynamic or provide a method implementation in this category

Property 'object' requires method 'setObject:' to be defined - use @dynamic or provide a method implementation in this category

下面讓我們看一下associated的原始碼，看Runtime是怎麼透過Runtime動態新增set、get的。下面是objc_getAssociatedObject函式的實現程式碼，objc_setAssociatedObject實現也是類似，這裡節省地方就不貼出來了。

id _object_get_associative_reference(id object, void *key) {
    id value = nil;
    uintptr_t policy = OBJC_ASSOCIATION_ASSIGN;
    {
        AssociationsManager manager;
        AssociationsHashMap &associations(manager.associations());
        disguised_ptr_t disguised_object = DISGUISE(object);
        AssociationsHashMap::iterator i = associations.find(disguised_object);        if (i != associations.end()) {
            ObjectAssociationMap *refs = i->second;
            ObjectAssociationMap::iterator j = refs->find(key);            if (j != refs->end()) {
                ObjcAssociation &entry = j->second;
                value = entry.value();
                policy = entry.policy();                if (policy & OBJC_ASSOCIATION_GETTER_RETAIN) {
                    objc_retain(value);
                }
            }
        }
    }    if (value && (policy & OBJC_ASSOCIATION_GETTER_AUTORELEASE)) {
        objc_autorelease(value);
    }    return value;
}

從原始碼可以看出，所有透過associated新增的屬性，都被存在一個單獨的雜湊表AssociationsHashMap中。objc_setAssociatedObject和objc_getAssociatedObject函式本質上都是在操作這個雜湊表，透過對雜湊表進行對映來存取物件。

在associated的API中會設定一些記憶體管理的關鍵字，例如OBJC_ASSOCIATION_ASSIGN，這是用來指定物件的記憶體管理的，這些關鍵字在Runtime原始碼中也有對應的處理。

簡書由於排版的問題，閱讀體驗並不好，佈局、圖片顯示、程式碼等很多問題。所以建議到我Github上，下載Runtime PDF合集。把所有Runtime文章總計九篇，都寫在這個PDF中，而且左側有目錄，方便閱讀。

Runtime PDF

下載地址：
麻煩各位大佬點個贊，謝謝！?