iOS 底层解析weak的实现原理（包含weak对象的初始化，引用，释放的分析）

原文

不多有人知道weak表实际上是一个hash（哈希）表，Key是所指对象的地址，Value是weak指针的地址数组。更多人的人只是知道weak是弱引用，所引用对象的计数器不会加一，并在引用对象被释放的时候自动被设置为nil。一般用于解决循环引用问题。但如今单知道这些已经不足以应对面试了，好多公司会问weak的原理。weak的原理是什么呢？下面就分析一下weak的工做原理（只是本身对这个问题好奇，学习过程当中的笔记，但愿对读者也有所帮助）。

weak 实现原理的归纳

Runtime维护了一个weak表，用于存储指向某个对象的全部weak指针。weak表实际上是一个hash（哈希）表，Key是所指对象的地址，Value是weak指针的地址（这个地址的值是所指对象的地址）数组。

weak 的实现原理能够归纳一下三步：

一、初始化时：runtime会调用objc_initWeak函数，初始化一个新的weak指针指向对象的地址。

二、添加引用时：objc_initWeak函数会调用 objc_storeWeak() 函数， objc_storeWeak() 的做用是更新指针指向，建立对应的弱引用表。

三、释放时，调用clearDeallocating函数。clearDeallocating函数首先根据对象地址获取全部weak指针地址的数组，而后遍历这个数组把其中的数据设为nil，最后把这个entry从weak表中删除，最后清理对象的记录。

下面将开始详细介绍每一步：

一、初始化时：runtime会调用objc_initWeak函数，objc_initWeak函数会初始化一个新的weak指针指向对象的地址。

示例代码：

1 2 3 4

{      NSObject *obj = [[NSObject alloc] init];      id __weak obj1 = obj; }

当咱们初始化一个weak变量时，runtime会调用 NSObject.mm 中的objc_initWeak函数。这个函数在Clang中的声明以下：

1	id objc_initWeak(id *object, id value);

而对于 objc_initWeak() 方法的实现

1 2 3 4 5 6 7 8 9 10 11 12

id objc_initWeak(id *location, id newObj) { // 查看对象实例是否有效 // 无效对象直接致使指针释放      if  (!newObj) {          *location = nil;          return  nil;      }      // 这里传递了三个 bool 数值      // 使用 template 进行常量参数传递是为了优化性能      return  storeWeakfalse /*old*/ ,  true /*new*/ ,  true /*crash*/ >      (location, (objc_object*)newObj); }

能够看出，这个函数仅仅是一个深层函数的调用入口，而通常的入口函数中，都会作一些简单的判断（例如 objc_msgSend 中的缓存判断），这里判断了其指针指向的类对象是否有效，无效直接释放，再也不往深层调用函数。不然，object将被注册为一个指向value的__weak对象。而这事应该是objc_storeWeak函数干的。

注意：objc_initWeak函数有一个前提条件：就是object必须是一个没有被注册为__weak对象的有效指针。而value则能够是null，或者指向一个有效的对象。

二、添加引用时：objc_initWeak函数会调用 objc_storeWeak() 函数， objc_storeWeak() 的做用是更新指针指向，建立对应的弱引用表。

objc_storeWeak的函数声明以下：

1	id objc_storeWeak(id *location, id value);

objc_storeWeak() 的具体实现以下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87

// HaveOld:     true - 变量有值 //             false - 须要被及时清理，当前值可能为 nil // HaveNew:     true - 须要被分配的新值，当前值可能为 nil //             false - 不须要分配新值 // CrashIfDeallocating: true - 说明 newObj 已经释放或者 newObj 不支持弱引用，该过程须要暂停 //             false - 用 nil 替代存储 template bool HaveOld, bool HaveNew, bool CrashIfDeallocating> static id storeWeak(id *location, objc_object *newObj) {      // 该过程用来更新弱引用指针的指向      // 初始化 previouslyInitializedClass 指针      Class previouslyInitializedClass = nil;      id oldObj;      // 声明两个 SideTable      // ① 新旧散列建立      SideTable *oldTable;      SideTable *newTable;      // 得到新值和旧值的锁存位置（用地址做为惟一标示）      // 经过地址来创建索引标志，防止桶重复      // 下面指向的操做会改变旧值 retry:      if  (HaveOld) {          // 更改指针，得到以 oldObj 为索引所存储的值地址          oldObj = *location;          oldTable = &SideTables()[oldObj];      }  else  {          oldTable = nil;      }      if  (HaveNew) {          // 更改新值指针，得到以 newObj 为索引所存储的值地址          newTable = &SideTables()[newObj];      }  else  {          newTable = nil;      }      // 加锁操做，防止多线程中竞争冲突      SideTable::lockTwoHaveOld, HaveNew>(oldTable, newTable);      // 避免线程冲突重处理      // location 应该与 oldObj 保持一致，若是不一样，说明当前的 location 已经处理过 oldObj 但是又被其余线程所修改      if  (HaveOld  &&  *location != oldObj) {          SideTable::unlockTwoHaveOld, HaveNew>(oldTable, newTable);          goto retry;      }      // 防止弱引用间死锁      // 而且经过 +initialize 初始化构造器保证全部弱引用的 isa 非空指向      if  (HaveNew  &&  newObj) {          // 得到新对象的 isa 指针          Class cls = newObj->getIsa();          // 判断 isa 非空且已经初始化          if  (cls != previouslyInitializedClass  &&              !((objc_class *)cls)->isInitialized()) {              // 解锁              SideTable::unlockTwoHaveOld, HaveNew>(oldTable, newTable);              // 对其 isa 指针进行初始化              _class_initialize(_class_getNonMetaClass(cls, (id)newObj));              // 若是该类已经完成执行 +initialize 方法是最理想状况              // 若是该类 +initialize 在线程中              // 例如 +initialize 正在调用 storeWeak 方法              // 须要手动对其增长保护策略，并设置 previouslyInitializedClass 指针进行标记              previouslyInitializedClass = cls;              // 从新尝试              goto retry;          }      }      // ② 清除旧值      if  (HaveOld) {          weak_unregister_no_lock(&oldTable->weak_table, oldObj, location);      }      // ③ 分配新值      if  (HaveNew) {          newObj = (objc_object *)weak_register_no_lock(&newTable->weak_table,                                                        (id)newObj, location,                                                        CrashIfDeallocating);          // 若是弱引用被释放 weak_register_no_lock 方法返回 nil          // 在引用计数表中设置若引用标记位          if  (newObj  &&  !newObj->isTaggedPointer()) {              // 弱引用位初始化操做              // 引用计数那张散列表的weak引用对象的引用计数中标识为weak引用              newObj->setWeaklyReferenced_nolock();          }          // 以前不要设置 location 对象，这里须要更改指针指向          *location = (id)newObj;      }      else  {          // 没有新值，则无需更改      }      SideTable::unlockTwoHaveOld, HaveNew>(oldTable, newTable);      return  (id)newObj; }

撇开源码中各类锁操做，来看看这段代码都作了些什么。

1)、SideTable

SideTable 这个结构体，我给他起名引用计数和弱引用依赖表，由于它主要用于管理对象的引用计数和 weak 表。在 NSObject.mm 中声明其数据结构：

1 2 3 4 5 6 7 8

struct SideTable { // 保证原子操做的自旋锁      spinlock_t slock;      // 引用计数的 hash 表      RefcountMap refcnts;      // weak 引用全局 hash 表      weak_table_t weak_table; }

对于 slock 和 refcnts 两个成员不用多说，第一个是为了防止竞争选择的自旋锁，第二个是协助对象的 isa 指针的 extra_rc 共同引用计数的变量（对于对象结果，在从此的文中提到）。这里主要看 weak 全局 hash 表的结构与做用。

2)、weak表

weak表是一个弱引用表，实现为一个weak_table_t结构体，存储了某个对象相关的的全部的弱引用信息。其定义以下(具体定义在objc-weak.h中)：

1 2 3 4 5 6 7 8 9 10

struct weak_table_t {      // 保存了全部指向指定对象的 weak 指针      weak_entry_t *weak_entries;      // 存储空间      size_t    num_entries;      // 参与判断引用计数辅助量      uintptr_t mask;      // hash key 最大偏移值      uintptr_t max_hash_displacement; };

这是一个全局弱引用hash表。使用不定类型对象的地址做为 key ，用 weak_entry_t 类型结构体对象做为 value 。其中的 weak_entries 成员，从字面意思上看，即为弱引用表入口。其实现也是这样的。

其中weak_entry_t是存储在弱引用表中的一个内部结构体，它负责维护和存储指向一个对象的全部弱引用hash表。其定义以下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

typedef objc_object ** weak_referrer_t; struct weak_entry_t {      DisguisedPtrobjc_object> referent;      union {          struct {              weak_referrer_t *referrers;              uintptr_t        out_of_line : 1;              uintptr_t        num_refs : PTR_MINUS_1;              uintptr_t        mask;              uintptr_t        max_hash_displacement;          };          struct {              // out_of_line=0 is LSB of one of these (don't care which)              weak_referrer_t  inline_referrers[WEAK_INLINE_COUNT];          };      } }

在 weak_entry_t 的结构中，DisguisedPtr referent 是对泛型对象的指针作了一个封装，经过这个泛型类来解决内存泄漏的问题。从注释中写 out_of_line 成员为最低有效位，当其为0的时候， weak_referrer_t 成员将扩展为多行静态 hash table。其实其中的 weak_referrer_t 是二维 objc_object 的别名，经过一个二维指针地址偏移，用下标做为 hash 的 key，作成了一个弱引用散列。

那么在有效位未生效的时候，out_of_line 、 num_refs、 mask 、 max_hash_displacement 有什么做用？如下是笔者自身的猜想：

out_of_line：最低有效位，也是标志位。当标志位 0 时，增长引用表指针纬度。

num_refs：引用数值。这里记录弱引用表中引用有效数字，由于弱引用表使用的是静态 hash 结构，因此须要使用变量来记录数目。

mask：计数辅助量。

max_hash_displacement：hash 元素上限阀值。

其实 out_of_line 的值一般状况下是等于零的，因此弱引用表老是一个 objc_objective 指针二维数组。一维 objc_objective 指针可构成一张弱引用散列表，经过第三纬度实现了多张散列表，而且表数量为 WEAK_INLINE_COUNT 。

总结一下 StripedMap[] ： StripedMap 是一个模板类，在这个类中有一个 array 成员，用来存储 PaddedT 对象，而且其中对于 [] 符的重载定义中，会返回这个 PaddedT 的 value 成员，这个 value 就是咱们传入的 T 泛型成员，也就是 SideTable 对象。在 array 的下标中，这里使用了 indexForPointer 方法经过位运算计算下标，实现了静态的 Hash Table。而在 weak_table 中，其成员 weak_entry 会将传入对象的地址加以封装起来，而且其中也有访问全局弱引用表的入口。

旧对象解除注册操做 weak_unregister_no_lock

该方法主要做用是将旧对象在 weak_table 中接触 weak 指针的对应绑定。根据函数名，称之为解除注册操做。从源码中，能够知道其功能就是从 weak_table 中接触 weak 指针的绑定。而其中的遍历查询，就是针对于 weak_entry 中的多张弱引用散列表。

新对象添加注册操做 weak_register_no_lock

这一步与上一步相反，经过 weak_register_no_lock 函数把心的对象进行注册操做，完成与对应的弱引用表进行绑定操做。

初始化弱引用对象流程一览

弱引用的初始化，从上文的分析中能够看出，主要的操做部分就在弱引用表的取键、查询散列、建立弱引用表等操做，能够总结出以下的流程图：

这个图中省略了不少状况的判断，可是当声明一个 weak 会调用上图中的这些方法。固然， storeWeak 方法不只仅用在 weak 的声明中，在 class 内部的操做中也会经常经过该方法来对 weak 对象进行操做。

三、释放时，调用clearDeallocating函数。clearDeallocating函数首先根据对象地址获取全部weak指针地址的数组，而后遍历这个数组把其中的数据设为nil，最后把这个entry从weak表中删除，最后清理对象的记录。

当weak引用指向的对象被释放时，又是如何去处理weak指针的呢？当释放对象时，其基本流程以下：

一、调用objc_release

二、由于对象的引用计数为0，因此执行dealloc

三、在dealloc中，调用了_objc_rootDealloc函数

四、在_objc_rootDealloc中，调用了object_dispose函数

五、调用objc_destructInstance

六、最后调用objc_clear_deallocating

重点看对象被释放时调用的objc_clear_deallocating函数。该函数实现以下：

1 2 3 4 5 6 7

void  objc_clear_deallocating(id obj)  {      assert(obj);      assert(!UseGC);      if  (obj->isTaggedPointer())  return ;     obj->clearDeallocating(); }

也就是调用了clearDeallocating，继续追踪能够发现，它最终是使用了迭代器来取weak表的value，而后调用weak_clear_no_lock,而后查找对应的value，将该weak指针置空，weak_clear_no_lock函数的实现以下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

/**   * Called by dealloc; nils out all weak pointers that point to the   * provided object so that they can no longer be used.   *   * @param weak_table   * @param referent The object being deallocated.   */ void weak_clear_no_lock(weak_table_t *weak_table, id referent_id) {      objc_object *referent = (objc_object *)referent_id;      weak_entry_t *entry = weak_entry_for_referent(weak_table, referent);      if  (entry == nil) {          /// XXX shouldn't happen, but does with mismatched CF/objc          //printf("XXX no entry for clear deallocating %p\n", referent);          return ;      }      // zero out references      weak_referrer_t *referrers;      size_t count;        if  (entry->out_of_line) {          referrers = entry->referrers;          count = TABLE_SIZE(entry);      }      else  {          referrers = entry->inline_referrers;          count = WEAK_INLINE_COUNT;      }        for  (size_t i = 0; i < count; ++i) {          objc_object **referrer = referrers[i];          if  (referrer) {              if  (*referrer == referent) {                  *referrer = nil;              }              else  if  (*referrer) {                  _objc_inform( "__weak variable at %p holds %p instead of %p. "                               "This is probably incorrect use of "                               "objc_storeWeak() and objc_loadWeak(). "                               "Break on objc_weak_error to debug.\n" ,                               referrer, (void*)*referrer, (void*)referent);                  objc_weak_error();              }          }      }      weak_entry_remove(weak_table, entry); }

objc_clear_deallocating该函数的动做以下：

一、从weak表中获取废弃对象的地址为键值的记录

二、将包含在记录中的全部附有 weak修饰符变量的地址，赋值为nil

三、将weak表中该记录删除

四、从引用计数表中删除废弃对象的地址为键值的记录

看了objc-weak.mm的源码就明白了：其实Weak表是一个hash（哈希）表，而后里面的key是指向对象的地址，Value是Weak指针的地址的数组。

补充：.m和.mm的区别

.m：源代码文件，这个典型的源代码文件扩展名，能够包含OC和C代码。

.mm：源代码文件，带有这种扩展名的源代码文件，除了能够包含OC和C代码以外，还能够包含C++代码。仅在你的OC代码中确实须要使用C++类或者特性的时候才用这种扩展名。

参考资料：

• weak 弱引用的实现方式

• weak的生命周期：具体实现方法