美文网首页
iOS Category源码分析

iOS Category源码分析

作者: 码省理工0 | 来源:发表于2019-03-27 23:01 被阅读0次

    首先来思考几个问题

    • Category本质是什么?
    • Category 给类增加方法和属性,那为什么不允许增加成员变量?
    • Category中有load方法吗?load方法是什么时候调用的?load 方法能继承吗?
    • load、initialize的区别,以及它们在category重写的时候的调用的次序。
    @interface Person : NSObject
    - (void)run;
    @end
    
    #import "Person.h"
    
    @implementation Person
    - (void)run {
        NSLog(@"run");
    }
    
    @interface Person (Test)<NSCopying>
    @property (nonatomic, copy) NSString *hobby;
    - (void)eat;
    - (void)work;
    @end
    
    #import "Person+Test.h"
    
    
    @implementation Person (Test)
    - (void)eat {
        NSLog(@"eat");
    }
    - (void)work {
        NSLog(@"work");
    }
    - (nonnull id)copyWithZone:(nullable NSZone *)zone {
       Person *p = [[Person alloc] init];
        return p;
    }
    @end
    

    我们创建了一个Person和它的分类Person+Test

    预备知识struct category_t结构体

    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;//属性
        // Fields below this point are not always present on disk.
        struct property_list_t *_classProperties;
        method_list_t *methodsForMeta(bool isMeta) {
            if (isMeta) return classMethods;
            else return instanceMethods;
        }
        property_list_t *propertiesForMeta(bool isMeta, struct header_info *hi);
        };
    
    

    从源码基本可以看出我们平时使用categroy的方式,对象方法,类方法,协议,和属性都可以找到对应的存储方式。并且我们发现分类结构体中是不存在成员变量的,因此分类中是不允许添加成员变量的。分类中添加的属性并不会帮助我们自动生成成员变量,只会生成get set方法的声明,需要我们自己去实现。

    编译时的分类

    clang -rewrite-objc -fobjc-arc -stdlib=libc++ -mmacosx-version-min=10.7 -fobjc-runtime=macosx-10.7 -Wno-deprecated-declarations Person+Test.m取出关键代码
    method_list_t 方法列表有新加的eat,work方法

    static struct /*_method_list_t*/ {
        unsigned int entsize;  // sizeof(struct _objc_method)
        unsigned int method_count;
        struct _objc_method method_list[2];
    } _OBJC_$_CATEGORY_INSTANCE_METHODS_Person_$_Test __attribute__ ((used, section ("__DATA,__objc_const"))) = {
        sizeof(_objc_method),
        2,
        {{(struct objc_selector *)"eat", "v16@0:8", (void *)_I_Person_Test_eat},
        {(struct objc_selector *)"work", "v16@0:8", (void *)_I_Person_Test_work}}
    };
    

    _protocol_list_t协议列表有新增的NSCopying

    static struct /*_protocol_list_t*/ {
        long protocol_count;  // Note, this is 32/64 bit
        struct _protocol_t *super_protocols[1];
    } _OBJC_CATEGORY_PROTOCOLS_$_Person_$_Test __attribute__ ((used, section ("__DATA,__objc_const"))) = {
        1,
        &_OBJC_PROTOCOL_NSCopying
    };
    

    _prop_list_t属性列表hobby

    static struct /*_prop_list_t*/ {
        unsigned int entsize;  // sizeof(struct _prop_t)
        unsigned int count_of_properties;
        struct _prop_t prop_list[1];
    } _OBJC_$_PROP_LIST_Person_$_Test __attribute__ ((used, section ("__DATA,__objc_const"))) = {
        sizeof(_prop_t),
        1,
        {{"hobby","T@\"NSString\",C,N"}}
    };
    

    _category_t初始化将method_list_t,_protocol_list_t,_prop_list_t放到_category_t对应位置。

    static struct _category_t _OBJC_$_CATEGORY_Person_$_Test __attribute__ ((used, section ("__DATA,__objc_const"))) = 
    {
        "Person",
        0, // &OBJC_CLASS_$_Person,
        (const struct _method_list_t *)&_OBJC_$_CATEGORY_INSTANCE_METHODS_Person_$_Test,
        0,
        (const struct _protocol_list_t *)&_OBJC_CATEGORY_PROTOCOLS_$_Person_$_Test,
        (const struct _prop_list_t *)&_OBJC_$_PROP_LIST_Person_$_Test,
    };
    

    最后,这个类的category们生成了一个数组,存在了__DATA段下的__objc_catlistsection里

    static struct _category_t *L_OBJC_LABEL_CATEGORY_$ [1] __attribute__((used, section ("__DATA, __objc_catlist,regular,no_dead_strip")))= {
        &_OBJC_$_CATEGORY_Person_$_Test,
    };
    

    上边就是编译期间做的准备工作。

    在运行期

    _objc_init
    └──map_2_images
        └──map_images_nolock
            └──_read_images
    

    在objc-os.mm文件中找到

    void _objc_init(void)
    {
        static bool initialized = false;
        if (initialized) return;
        initialized = true;
        
        // fixme defer initialization until an objc-using image is found?
        environ_init();
        tls_init();
        static_init();
        lock_init();
        exception_init();
    
        _dyld_objc_notify_register(&map_images, load_images, unmap_image);
    }
    

    category被附加到类上面是在map_images的时候发生的,在new-ABI的标准下,_objc_init里面的调用的map_images最终会调用objc-runtime-new.mm里面的_read_images方法,而在_read_images方法的结尾,有以下的代码片段:

     // 发现和处理所有Category
        for (EACH_HEADER) {
            // 外部循环遍历找到当前类,查找类对应的Category数组
            category_t **catlist = 
                _getObjc2CategoryList(hi, &count);
            bool hasClassProperties = hi->info()->hasCategoryClassProperties();
    
            // 内部循环遍历当前类的所有Category
            for (i = 0; i < count; i++) {
                category_t *cat = catlist[i];
                Class cls = remapClass(cat->cls);
                
                if (!cls) {
                    catlist[i] = nil;
                    if (PrintConnecting) {
                        _objc_inform("CLASS: IGNORING category \?\?\?(%s) %p with "
                                     "missing weak-linked target class", 
                                     cat->name, cat);
                    }
                    continue;
                }
     
                // 首先,通过其所属的类注册Category。如果这个类已经被实现,则重新构造类的方法列表。
                bool classExists = NO;
                if (cat->instanceMethods ||  cat->protocols  
                    ||  cat->instanceProperties) 
                {
                    // 将Category添加到对应Class的value中,value是Class对应的所有category数组
                    addUnattachedCategoryForClass(cat, cls, hi);
                    // 将Category的method、protocol、property添加到Class
                    if (cls->isRealized()) {
                        remethodizeClass(cls);
                        classExists = YES;
                    }
                    if (PrintConnecting) {
                        _objc_inform("CLASS: found category -%s(%s) %s", 
                                     cls->nameForLogging(), cat->name, 
                                     classExists ? "on existing class" : "");
                    }
                }
    
                // 这块和上面逻辑一样,区别在于这块是对Meta Class做操作,而上面则是对Class做操作
                // 根据下面的逻辑,从代码的角度来说,是可以对原类添加Category的
                if (cat->classMethods  ||  cat->protocols  
                    ||  (hasClassProperties && cat->_classProperties)) 
                {
                    addUnattachedCategoryForClass(cat, cls->ISA(), hi);
                    if (cls->ISA()->isRealized()) {
                        remethodizeClass(cls->ISA());
                    }
                    if (PrintConnecting) {
                        _objc_inform("CLASS: found category +%s(%s)", 
                                     cls->nameForLogging(), cat->name);
                    }
                }
            }
        }
    

    在上述的代码片段里,addUnattachedCategoryForClass只是把类和category做一个关联映射,而remethodizeClass才是真正去处理添加事宜的功臣。

    // 将Category的信息添加到Class,包含method、property、protocol
    static void remethodizeClass(Class cls)
    {
        category_list *cats;
        bool isMeta;
        runtimeLock.assertWriting();
        isMeta = cls->isMetaClass();
        // 从Category哈希表中查找category_t对象,并将已找到的对象从哈希表中删除
        if ((cats = unattachedCategoriesForClass(cls, false/*not realizing*/))) {
            if (PrintConnecting) {
                _objc_inform("CLASS: attaching categories to class '%s' %s", 
                             cls->nameForLogging(), isMeta ? "(meta)" : "");
            }
            
            attachCategories(cls, cats, true /*flush caches*/);        
            free(cats);
        }
    }
    
    

    通过上述代码我们发现attachCategories函数接收了类对象cls和分类数组cats,如我们一开始写的代码所示,一个类可以有多个分类。之前我们说到分类信息存储在category_t结构体中,那么多个分类则保存在category_list中。

    我们来到attachCategories函数内部。

    attachCategories(Class cls, category_list *cats, bool flush_caches)
    {
        if (!cats) return;
        if (PrintReplacedMethods) printReplacements(cls, cats);
    
        bool isMeta = cls->isMetaClass();
    
        // 按照Category个数,分配对应的内存空间
        // fixme rearrange to remove these intermediate allocations
        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));
    
        // Count backwards through cats to get newest categories first
        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];// 分类,locstamped_category_t 类型
    // 取出分类中的方法列表;如果是元类,取得的是类方法列表;否则取得的是实例方法列表
            method_list_t *mlist = entry.cat->methodsForMeta(isMeta);
            if (mlist) {
                mlists[mcount++] = mlist;// 将方法列表放入 mlists 方法列表数组中
                fromBundle |= entry.hi->isBundle();// 分类的头部信息中存储了是否是 bundle,将其记住
            }
     // 取出分类中的属性列表,如果是元类,取得是nil
            property_list_t *proplist = 
                entry.cat->propertiesForMeta(isMeta, entry.hi);
            if (proplist) {
                proplists[propcount++] = proplist;// 将属性列表放入 proplists 属性列表数组中
            }
    
            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);
    }
    
    

    结合注释上述源码中可以看出,首先根据方法列表,属性列表,协议列表,malloc分配内存,根据多少个分类以及每一块方法需要多少内存来分配相应的内存地址。之后从分类数组里面往三个数组里面存放分类数组里面存放的分类方法,属性以及协议放入对应mlist、proplists、protolosts数组中,这三个数组放着所有分类的方法,属性和协议。

    之后通过类对象的data()方法,拿到类对象的class_rw_t结构体rw,在class结构中我们介绍过,class_rw_t中存放着类对象的方法,属性和协议等数据,rw结构体通过类对象的data方法获取,所以rw里面存放这类对象里面的数据。

    之后分别通过rw调用方法列表、属性列表、协议列表的attachList函数,将所有的分类的方法、属性、协议列表数组传进去,我们大致可以猜想到在attachList方法内部将分类和本类相应的对象方法,属性,和协议进行了合并。

     void attachLists(List* const * addedLists, uint32_t addedCount) {
            if (addedCount == 0) return;
    
            if (hasArray()) {
                // many lists -> many lists
                uint32_t oldCount = array()->count;//原来的列表数组
                uint32_t newCount = oldCount + addedCount;
                //扩展原来的列表数组,重新分配内存
                setArray((array_t *)realloc(array(), array_t::byteSize(newCount)));
                array()->count = newCount;
                // memmove :内存移动。
                /*  __dst : 移动内存的目的地
                 *   __src : 被移动的内存首地址
                 *   __len : 被移动的内存长度
                 *   将__src的内存移动__len块内存到__dst中
                 */
                memmove(array()->lists + addedCount, array()->lists, 
                        oldCount * sizeof(array()->lists[0]));
                // memcpy :内存拷贝。
                /*  __dst : 拷贝内存的拷贝目的地
                 *   __src : 被拷贝的内存首地址
                 *   __n : 被移动的内存长度
                 *   将__src的内存移动__n块内存到__dst中
                 */
                memcpy(array()->lists, addedLists, 
                       addedCount * sizeof(array()->lists[0]));
            }
            else if (!list  &&  addedCount == 1) {
                // 0 lists -> 1 list
                list = addedLists[0];
            } 
            else {
                // 1 list -> many lists
                List* oldList = list;
                uint32_t oldCount = oldList ? 1 : 0;
                uint32_t newCount = oldCount + addedCount;
                setArray((array_t *)malloc(array_t::byteSize(newCount)));
                array()->count = newCount;
                if (oldList) array()->lists[addedCount] = oldList;
                memcpy(array()->lists, addedLists, 
                       addedCount * sizeof(array()->lists[0]));
            }
        }
    
    image

    首先扩展内存=array()->count + addedCount;
    然后memmove方法之后,内存变化为


    image

    经过memmove方法之后,我们发现,虽然本类的方法,属性,协议列表会分别后移,但是本类的对应数组的指针依然指向原始位置。


    image

    指针并没有改变,至始至终指向开头的位置。并且经过memmove和memcpy方法之后,分类的方法,属性,协议列表被放在了类对象中原本存储的方法,属性,协议列表前面。这样可以保证分类的方法,属性,协议同名方法优先级高于类初始化方法。

    总结

    在编译时期,会将分类中实现的方法生成一个结构体 method_list_t 、将声明的属性生成一个结构体 property_list_t ,然后通过这些结构体生成一个结构体 category_t 。
    然后将结构体 category_t 保存下来
    在运行时期,Runtime 会拿到编译时期我们保存下来的结构体 category_t
    然后将结构体 category_t 中的实例方法列表、协议列表、属性列表添加到主类中
    将结构体 category_t 中的类方法列表、协议列表添加到主类的 metaClass 中

    load 和 initialize

    load方法会在程序启动就会调用,当装载类信息的时候就会调用。
    调用顺序看一下源代码。

    void call_load_methods(void)
    {
        static bool loading = NO;
        bool more_categories;
    
        loadMethodLock.assertLocked();
    
        // Re-entrant calls do nothing; the outermost call will finish the job.
        if (loading) return;
        loading = YES;
    
        void *pool = objc_autoreleasePoolPush();
    
        do {
            // 1.先调用类的load方法
            while (loadable_classes_used > 0) {
                call_class_loads();
            }
    
            // 2. 调用分类load方法
            more_categories = call_category_loads();
    
            // 3. Run more +loads if there are classes OR more untried categories
        } while (loadable_classes_used > 0  ||  more_categories);
    
        objc_autoreleasePoolPop(pool);
    
        loading = NO;
    }
    

    通过源码我们发现是优先调用类的load方法,之后调用分类的load方法。

    我们通过代码验证一下:
    我们添加Son继承Presen类,并添加Son+Test分类,分别重写只+load方法,其他什么都不做通过打印发现


    Snip20190320_1.png

    确实是优先调用类的load方法之后调用分类的load方法,不过调用类的load方法之前会保证其父类已经调用过load方法

    之后我们为Preson、Son 、Son+Test 添加initialize方法。
    我们知道当类第一次接收到消息时,就会调用initialize,相当于第一次使用类的时候就会调用initialize方法。调用子类的initialize之前,会先保证调用父类的initialize方法。如果之前已经调用过initialize,就不会再调用initialize方法了。当分类重写initialize方法时会先调用分类的方法。但是load方法并不会被覆盖,首先我们来看一下initialize的源码。

    void callInitialize(Class cls)
    {
        ((void(*)(Class, SEL))objc_msgSend)(cls, SEL_initialize);
        asm("");
    }
    

    上图中我们发现,initialize是通过消息发送机制调用的,消息发送机制通过isa指针找到对应的方法与实现,因此先找到分类方法中的实现,会优先调用分类方法中的实现。

       static void call_class_loads(void)
    {
        int i;
        // Detach current loadable list.
        struct loadable_class *classes = loadable_classes;
        int used = loadable_classes_used;
        loadable_classes = nil;
        loadable_classes_allocated = 0;
        loadable_classes_used = 0;
        
        // Call all +loads for the detached list.
        for (i = 0; i < used; i++) {
            Class cls = classes[i].cls;
            load_method_t load_method = (load_method_t)classes[i].method;
            if (!cls) continue; 
            if (PrintLoading) {
                _objc_inform("LOAD: +[%s load]\n", cls->nameForLogging());
            }
            (*load_method)(cls, SEL_load);
        }
        // Destroy the detached list.
        if (classes) free(classes);
        }
    

    可以看出来load是根据函数地址直接调用

    总结

    问:Category中有load方法吗?load方法是什么时候调用的?load 方法能继承吗?
    答:Category中有load方法,load方法在程序启动装载类信息的时候就会调用。load方法可以继承。调用子类的load方法之前,会先调用父类的load方法
    问:load、initialize的区别,以及它们在category重写的时候的调用的次序。
    答:区别在于调用方式和调用时刻
    调用方式:load是根据函数地址直接调用,initialize是通过objc_msgSend调用
    调用时刻:load是runtime加载类、分类的时候调用(只会调用1次),initialize是类第一次接收到消息的时候调用,每一个类只会initialize一次(父类的initialize方法可能会被调用多次)
    调用顺序:先调用类的load方法,先编译那个类,就先调用load。在调用load之前会先调用父类的load方法。分类中load方法不会覆盖本类的load方法,先编译的分类优先调用load方法。initialize先初始化父类,之后再初始化子类。如果子类没有实现+initialize,会调用父类的+initialize(所以父类的+initialize可能会被调用多次),如果分类实现了+initialize,就覆盖类本身的+initialize调用。

    相关文章

      网友评论

          本文标题:iOS Category源码分析

          本文链接:https://www.haomeiwen.com/subject/hwvyyqtx.html