类结构分析

开发中经常创建一个 TestClass.h 和 TestClass.m 文件，而这个 TestClass 就是我们所谓的类，那类的结构到底是怎样的呢？

新建一个类 TestClass：

@interface TestClass : NSObject {
    NSString *flyIvar;
}

@property (nonatomic, strong) NSString *flyProperty;

@end

@implementation TestClass

@end

在 main.m 的 main 函数中写入下方代码：

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        // insert code here...
        TestClass *object = [[TestClass alloc] init];

        Class pClass = object_getClass(object);
        
        NSLog(@"%p - %p",object,pClass);
    }
    return 0;
}

1、OC 代码编译成 C++ 执行代码

然后通过命令行工具将 main.m 转换成 C++ 编译的文件 main.cpp，命令如下：
clang -rewrite-objc main.m -o main.cpp

打开 main.cpp 到最底部，就能看到 main 函数中的东西在 C++ 编译成了如下代码：

int main(int argc, const char * argv[]) {
    /* @autoreleasepool */ { __AtAutoreleasePool __autoreleasepool; 

        TestClass *object = ((TestClass *(*)(id, SEL))(void *)objc_msgSend)((id)((TestClass *(*)(id, SEL))(void *)objc_msgSend)((id)objc_getClass("TestClass"), sel_registerName("alloc")), sel_registerName("init"));

        Class pClass = object_getClass(object);

        NSLog((NSString *)&__NSConstantStringImpl__var_folders_cj_20kzp4xj3x32g8_b79x0tg4h0000gn_T_main_508fc7_mi_0,object,pClass);
    }
    return 0;
}

2、Class 在底层源码中定义

查找到 Class 的定义为：typedef struct objc_class *Class;，查看一下 objc_class 的结构体定义：

struct objc_class : objc_object {
    // Class ISA;
    Class superclass;
    cache_t cache;             // formerly cache pointer and vtable
    class_data_bits_t bits;    // class_rw_t * plus custom rr/alloc flags

    class_rw_t *data() { 
        return bits.data();
    }

    //...
}

struct objc_object {
    Class _Nonnull isa  OBJC_ISA_AVAILABILITY;
};

上方代码就能看到 objc_class 继承于 objc_object，从这里看到 OC 万物之祖为结构体类型，也就是编译器在编译的时候会把我们的类编译成结构体类型，并且在结构体中第一个为 isa ，第二个为当前类的父类，第三个为 cache_t cache，第四个为class_data_bits_t bits。

那么问题来了，上方 TestClass 中的属性 @property (nonatomic, strong) NSString *flyProperty; 和成员变量 NSString *flyIvar; 在哪儿存放着呢？

3、类中属性变量和成员变量的查找

struct class_ro_t {
    //类保存的所有东西，比如：属性，方法 协议等
    uint32_t flags;
    uint32_t instanceStart;
    uint32_t instanceSize;
#ifdef __LP64__
    uint32_t reserved;
#endif

    const uint8_t * ivarLayout;
    
    const char * name;
    method_list_t * baseMethodList;
    protocol_list_t * baseProtocols;
    const ivar_list_t * ivars;

    const uint8_t * weakIvarLayout;
    property_list_t *baseProperties;

    //...
}

经过一番查找在 bits.data(); 返回的 class_rw_t 里的 class_ro_t *ro 中发现了我们需要的属性列表 property_list_t *baseProperties; ，那怎么取到 class_data_bits_t bits 呢？

1、类内存结构的分析

接下来看一下 TestClass 的内存结构：

类的内存结构

从上方的内存结构中，能看到第二个匹配上了 superclass ，但是第三和第四个却不知道是什么。

对这个内存结构进行分析一下：

指向当前类的指针首地址为 0x100001200，我们知道第一个 0x001d8001000011d9 是 isa 占用 8 字节，所以我们用 0x100001200 + 8 打印一下， 输出了 ，而 superclass 是 Class 类型的，它也占用 8 字节。

接下来就到 0x100001210 了，尝试将 0x100001210 强转成 (cache_t *) 类型输出一下，然后调用 cache_t 结构体里面的 mask() 方法打印一下，发现输出了 (mask_t) 类型的 $6，就确定了 0x100001210 指针地址指向的为 cache_t cache 。

image.png

2、cache_t 结构体占用内存大小的计算

确定了 cache_t cache 的指针首地址，还需要知道 cache_t cache 大小才能知道 class_data_bits_t bits 的首地址，此时就需要对 cache 的大小进行计算了。

struct cache_t {
    struct bucket_t *_buckets;
    mask_t _mask;
    mask_t _occupied;

   //...
}

cache 是一个 cache_t 的 struct 结构体类型，结构体类型的大小计算需要计算结构体里所有成员的大小。计算如下：

_buckets 为 struct bucket_t * 的结构体指针类型占用 8 字节，_mask 和 _occupied 都是 uint32_t 类型，uint32_t占用 4 字节，方法不占内存空间，则 cache 占用内存为 16 字节。

3、class_data_bits_t 的分析

计算了 cache 的占用内存，那么 class_data_bits_t bits 的首地址就为 0x100001210 + 16 = 0x100001220。

接下来就要获取 class_data_bits_t 中存储的东西了， 强转 0x100001220 类型为 (class_data_bits_t *) ，获取 bits -> data() 返回的 class_rw_t * 并打印显示如下结果。

image.png

获取 class_rw_t 中的 class_ro_t *ro并打印，baseProperties 中存储的就是 属性变量，ivars 中存储的是 成员变量。

image.png

1、属性变量和成员变量的获取

分别打印 baseProperties 和 ivars ：

• baseProperties 是一个数组，数组中存储了一个元素，就是 @property (nonatomic, strong) NSString *flyProperty;
• ivars 同样是一个数组，但是这个数组中存储了两个元素，第一个为 NSString *flyIvar; ，第二个为 NSString *_flyProperty;，因为属性会自动生成一个带下划线的成员变量

baseProperties

ivars

这样就找到属性变量和成员变量存储的地方。那么方法列表呢？

2、方法列表的获取

同理以获取 baseProperties 的方式获取 baseMethodList，第一个是 flyProperty 的 getter 方法，第二个是 flyProperty 的 setter 方法，第三个是编译成 C++ 代码系统添加的。

image.png

上方的打印是只有一个属性变量，没有任何方法添加，现在添加一个类方法和一个实例方法再次打印看看。

//TestClass.h
@interface TestClass : NSObject {
    NSString *flyIvar;
}

@property (nonatomic, strong) NSString *flyProperty;

- (void)testClassInstanceMethod;
+ (void)testClassClassMethod;

@end

//TestClass.m
@implementation TestClass

- (void)testClassInstanceMethod {
    NSLog(@"testClassInstanceMethod");
}

+ (void)testClassClassMethod {
    NSLog(@"testClassClassMethod");
}

添加方法后的baseMethodList

在这里发现少了一个方法 + (void)testClassClassMethod; ，那这个方法存储在哪儿了？

我们知道类里面存储的是实例对象的方法，元类里面存储的是类对象的方法，既然了解了这个就使用 isa 从元类里面查找吧。

image.png

在推导的过程可以看到对象的实例方法在类对象存储，相对于元类，类方法又属于元类的实例方法。

4、关于 NSObject 的内容补充

@interface NSObject  {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wobjc-interface-ivars"
    Class isa  OBJC_ISA_AVAILABILITY;
#pragma clang diagnostic pop
}

NSObject (Class) 和 objc_class 的关系：NSObject (Class) 是 objc_class 类型呢，在编译的时候会编译成 objc_class。

NSObject 和 objc_object 的关系：NSObject 是对 objc_object 结构体的仿写，只是一个是我们 OC 对象的，一个是编译器编译过后底层真正运行的。

5、关于 isa 的内容补充

这里有一个小细节 ，为什么 struct objc_object 中 isa 的是 Class 类型的呢？我们学习的过程明明知道 isa 是一个 isa_t 类型的联合体，那这里的 isa 怎么不是 isa_t 类型的？

这是因为在早期的 iOS 调用 isa 就是为了返回 Class 的，当我们调用了 object_getClass() 时，OC 底层源码调用的是 obj->getIsa();，接着进入 getIsa() ，又 return ISA() ，在 ISA() 中就能看到早期代码使用 (Class)isa.bits; 返回，现在使用 (Class)(isa.bits & ISA_MASK); 返回，也就是说明了在返回时将二进制强转成了一个 Class 类型的结构体，这也是 isa 是 Class 类型的原因。

Class object_getClass(id obj)
{
    if (obj) return obj->getIsa();
    else return Nil;
}

inline Class 
objc_object::ISA() 
{
    assert(!isTaggedPointer()); 
#if SUPPORT_INDEXED_ISA
    if (isa.nonpointer) {
        uintptr_t slot = isa.indexcls;
        return classForIndex((unsigned)slot);
    }
    return (Class)isa.bits;
#else
    //这里是返回类对象需要用 isa 的指针 & ISA_MASK
    return (Class)(isa.bits & ISA_MASK);
#endif
}