OC底层原理15 - 关联对象源码探索

在OC底层原理14 - 类的加载之分类一文中提及，通过使用关联对象的方法实现分类中属性的getter/setter方法。本节将从底层源码的角度来探索关联对象。

关联对象的使用

  • objc_setAssociatedObject：给指定对象关联某个值
  • objc_getAssociatedObject：根据标识符，从对象中获取关联的值。

接下来逐一进行探索

objc_setAssociatedObject 源码探索

  • 查看objc_setAssociatedObject实现
/*
该方法共4个参数：
object：要关联的对象
key：标识符，方便于下次查找
value：关联的值
policy：关联的策略，如nonatomic、atomic、assign等
*/
void objc_setAssociatedObject(id object, const void *key, id value, objc_AssociationPolicy policy) {
    _object_set_associative_reference(object, key, value, policy);
}
  • 进入_object_set_associative_reference源码
void _object_set_associative_reference(id object, const void *key, id value, uintptr_t policy) {
    //忽略非重点代码
    //...

    //将object包装成DisguisedPtr<objc_object>类型
    DisguisedPtr<objc_object> disguised{(objc_object *)object};
    //将policy - value包装成ObjcAssociation类型
    ObjcAssociation association{policy, value};

    // retain the new value (if any) outside the lock.
    association.acquireValue();

    bool isFirstAssociation = false;
    {
        //初始化manager变量
        AssociationsManager manager;
        //获取AssociationsHashMap，注意：AssociationsHashMap有且只有一个
        AssociationsHashMap &associations(manager.get());

        if (value) {//若有值，则进行关联对象
            //此处是重点
            auto refs_result = associations.try_emplace(disguised, ObjectAssociationMap{});
            if (refs_result.second) {
                /* it's the first association we make */
                isFirstAssociation = true;
            }

            /* establish or replace the association */
            auto &refs = refs_result.first->second;
            auto result = refs.try_emplace(key, std::move(association));
            if (!result.second) {
                association.swap(result.first->second);
            }
        } else {//没有值，则对已经关联的对象进行移除
            auto refs_it = associations.find(disguised);
            if (refs_it != associations.end()) {
                auto &refs = refs_it->second;
                auto it = refs.find(key);
                if (it != refs.end()) {
                    association.swap(it->second);
                    refs.erase(it);
                    if (refs.size() == 0) {
                        associations.erase(refs_it);
                    }
                }
            }
        }
    }
    if (isFirstAssociation)
        object->setHasAssociatedObjects();
    association.releaseHeldValue();
}

从以上源码中可以得知，当有value时，需要将值与对象进行关联。这里重点分析。

  • 【1】获取一个AssociationsHashMap。
typedef DenseMap<const void *, ObjcAssociation> ObjectAssociationMap;
typedef DenseMap<DisguisedPtr<objc_object>, ObjectAssociationMap> AssociationsHashMap;
  • 【2】通过try_emplace方法，查找AssociationsHashMap中是否存在object的关联对象表。
std::pair<iterator, bool> try_emplace(const KeyT &Key, Ts &&... Args) {
    BucketT *TheBucket;
    //查找是否存在Key的bucket
    if (LookupBucketFor(Key, TheBucket))
      //存在Key的bucket，将bucket与false等包装成pair并返回
      return std::make_pair(
               makeIterator(TheBucket, getBucketsEnd(), true),
               false); // Already in map.

    // Otherwise, insert the new element.
    //不存在Key的bucket，则new一个新的bucket，并将这个新的bucket和true包装成pair进行返回
    TheBucket = InsertIntoBucket(TheBucket, Key, std::forward<Ts>(Args)...);
    return std::make_pair(
             makeIterator(TheBucket, getBucketsEnd(), true),
             true);
}

此处通过lldb来查看一下，try_emplace函数过程中TheBucket的变化情况。

//LookupBucketFor函数前TheBucket的值，此时是垃圾数据
(lldb) p/x TheBucket
(objc::detail::DenseMapPair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > > *) $0 = 0x00007ffeefbff1e0

//第一步：调用LookupBucketFor(Key, TheBucket)；

//LookupBucketFor函数后TheBucket的值
(lldb) p/x TheBucket
(objc::detail::DenseMapPair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > > *) $1 = 0x0000000000000000

//以上表明当前不存在AssociationsHashMap
//第二步：经过InsertIntoBucketImpl后，开辟AssociationsHashMap中Buckets空间，并计算Key索引，找到Buckets与Key索引对应且未被占用的Bucket
(lldb) p/x TheBucket
(objc::detail::DenseMapPair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > > *) $3 = 0x000000010082b210
(lldb) p *$3
(objc::detail::DenseMapPair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > >) $4 = {
  std::__1::pair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > > = {
    first = (value = 1)
    second = {
      Buckets = 0x1e317413ba120c7e
      NumEntries = 422045868
      NumTombstones = 2223205251
      NumBuckets = 0
    }
  }
}

//第三步，将DisguisedPtr<objc_object>赋值给Bucket的第一个参数
(lldb) p/x TheBucket
(objc::detail::DenseMapPair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > > *) $5 = 0x000000010082b210
(lldb) p/x *$5
(objc::detail::DenseMapPair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > >) $6 = {
  std::__1::pair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > > = {
    first = (value = 0xfffffffeff9892d0)
    second = {
      Buckets = 0x1e317413ba120c7e
      NumEntries = 0x1927e8ac
      NumTombstones = 0x84836b83
      NumBuckets = 0x00000000
    }
  }
}

//第四步，将ObjectAssociationMap赋值给Bucket的第二个参数，此时ObjectAssociationMap中还没与标识符及value关联
(lldb) p/x TheBucket
(objc::detail::DenseMapPair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > > *) $8 = 0x000000010082b210
(lldb) p/x *$8
(objc::detail::DenseMapPair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > >) $9 = {
  std::__1::pair<DisguisedPtr<objc_object>, objc::DenseMap<const void *, objc::ObjcAssociation, objc::DenseMapValueInfo<objc::ObjcAssociation>, objc::DenseMapInfo<const void *>, objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> > > = {
    first = (value = 0xfffffffeff9892d0)
    second = {
      Buckets = 0x0000000000000000
      NumEntries = 0
      NumTombstones = 0
      NumBuckets = 0
    }
  }
}
  • LookupBucketFor函数源码
bool LookupBucketFor(const LookupKeyT &Val, const BucketT *&FoundBucket) const {
    //获取AssociationsHashMap表中Buckets的地址
    const BucketT *BucketsPtr = getBuckets();
    //获取当前AssociationsHashMap表中Bucket的个数
    const unsigned NumBuckets = getNumBuckets();

    //此处表示当前AssociationsHashMap没有Bucket
    if (NumBuckets == 0) {
      FoundBucket = nullptr;
      return false;
    }

    // FoundTombstone - Keep track of whether we find a tombstone while probing.
    const BucketT *FoundTombstone = nullptr;
    const KeyT EmptyKey = getEmptyKey();
    const KeyT TombstoneKey = getTombstoneKey();
    assert(!KeyInfoT::isEqual(Val, EmptyKey) &&
           !KeyInfoT::isEqual(Val, TombstoneKey) &&
           "Empty/Tombstone value shouldn't be inserted into map!");
    //计算Buckets中，Val对应的索引
    unsigned BucketNo = getHashValue(Val) & (NumBuckets-1);
    unsigned ProbeAmt = 1;
    //根据索引、偏移遍历Buckets，只有两种情况退出，一种是找到Val对应的Buckets，另一种是未找到Buckets
    while (true) {
      //根据索引和首地址，进行偏移找到当前ThisBucket
      const BucketT *ThisBucket = BucketsPtr + BucketNo;
      //比较ThisBucket的Val与传参Val是否一致，若一致则表示找到bucket
      if (LLVM_LIKELY(KeyInfoT::isEqual(Val, ThisBucket->getFirst()))) {
        FoundBucket = ThisBucket;
        return true;
      }

      // If we found an empty bucket, the key doesn't exist in the set.
      // Insert it and return the default value.
      //当前ThisBucket是否是一个EmptyKey，若是的话，表示Buckets已经查找完了，但是未找到Val对应的Bucket
      if (LLVM_LIKELY(KeyInfoT::isEqual(ThisBucket->getFirst(), EmptyKey))) {
        // If we've already seen a tombstone while probing, fill it in instead
        // of the empty bucket we eventually probed to.
        FoundBucket = FoundTombstone ? FoundTombstone : ThisBucket;
        return false;
      }

      if (KeyInfoT::isEqual(ThisBucket->getFirst(), TombstoneKey) &&
          !FoundTombstone)
        FoundTombstone = ThisBucket;  // Remember the first tombstone found.
      if (ValueInfoT::isPurgeable(ThisBucket->getSecond())  &&  !FoundTombstone)
        FoundTombstone = ThisBucket;

      if (ProbeAmt > NumBuckets) {
        FatalCorruptHashTables(BucketsPtr, NumBuckets);
      }
      //修改偏移、索引
      BucketNo += ProbeAmt++;
      BucketNo &= (NumBuckets-1);
    }
  }

【总结】
【第一步】判断AssociationsHashMap表中是否有Buckets。若有则进入第二步。若无则将FoundBucket置为空并返回false。
【第二步】根据Val计算一个hash索引，遍历Buckets查到是否存在与Val对应的Bucket。若存在则将FoundBucket置为查找到的Bucket并返回true。否则将FoundBucket置为空并返回false。

  • InsertIntoBucket源码
BucketT *InsertIntoBucket(BucketT *TheBucket, KeyArg &&Key,
                            ValueArgs &&... Values) {
    //新建一个Bucket，插入至AssociationsHashMap表的Buckets中
    TheBucket = InsertIntoBucketImpl(Key, Key, TheBucket);
    //将新建Bucket的第一个参数与Key进行关联
    TheBucket->getFirst() = std::forward<KeyArg>(Key);
    //将新建Bucket的第二个参数与Values进行关联，此时的Value为ObjectAssociationMap
    ::new (&TheBucket->getSecond()) ValueT(std::forward<ValueArgs>(Values)...);
    return TheBucket;
  }
  • InsertIntoBucketImpl源码
BucketT *InsertIntoBucketImpl(const KeyT &Key, const LookupKeyT &Lookup, BucketT *TheBucket) {
    unsigned NewNumEntries = getNumEntries() + 1;
    unsigned NumBuckets = getNumBuckets();
    if (LLVM_UNLIKELY(NewNumEntries * 4 >= NumBuckets * 3)) {
      //通过allocateBuckets分配空间
      this->grow(NumBuckets * 2);
      LookupBucketFor(Lookup, TheBucket);
      NumBuckets = getNumBuckets();
    } else if (LLVM_UNLIKELY(NumBuckets-(NewNumEntries+getNumTombstones()) <= NumBuckets/8)) {
      //扩容
      this->grow(NumBuckets);
      LookupBucketFor(Lookup, TheBucket);
    }
    ASSERT(TheBucket);

    if (KeyInfoT::isEqual(TheBucket->getFirst(), getEmptyKey())) {
      // Replacing an empty bucket.
      incrementNumEntries();
    } else if (KeyInfoT::isEqual(TheBucket->getFirst(), getTombstoneKey())) {
      // Replacing a tombstone.
      incrementNumEntries();
      decrementNumTombstones();
    } else {
      // we should be purging a zero. No accounting changes.
      ASSERT(ValueInfoT::isPurgeable(TheBucket->getSecond()));
      TheBucket->getSecond().~ValueT();
    }

    return TheBucket;
  }

【总结】
【第一步】判断AssociationsHashMap表中是否有Buckets，若没有，则通过allocateBuckets，分配4个Bucket的大小的空间，并将Bucket的第一个参数置为EmptyKey。
【第二步】将Key通过hash计算得到一个索引值BucketNo，在Buckets中找到BucketNo对应的且未占用的Bucket。并将其赋值给TheBucket并返回。

  • 【3】使用try_emplace函数，继续从DisguisedPtr<objc_object>对应的Bucket中获取ObjcAssociation，查找原理同上。
//此时查找的是DisguisedPtr<objc_object>值对应的Map
(lldb) p/x TheBucket
(objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> *) $15 = 0x0000000000000000

//调用InsertIntoBucketImpl后，开辟ObjcAssociation空间，并返回索引相应的Bucket
(lldb) p/x TheBucket
(objc::detail::DenseMapPair<const void *, objc::ObjcAssociation> *) $16 = 0x000000010082abc8
(lldb) p/x *$16
(objc::detail::DenseMapPair<const void *, objc::ObjcAssociation>) $17 = {
  std::__1::pair<const void *, objc::ObjcAssociation> = {
    first = 0xffffffffffffffff
    second = {
      _policy = 0x0000000000000000
      _value = 0x0006000000000000
    }
  }
}
//将第一个参数设置为Key
(lldb) p/x *$16
(objc::detail::DenseMapPair<const void *, objc::ObjcAssociation>) $18 = {
  std::__1::pair<const void *, objc::ObjcAssociation> = {
    first = 0x0000000100003ca4  //"cate_name"
    second = {
      _policy = 0x0000000000000000
      _value = 0x0006000000000000
    }
  }
}
//将第二个参数设置为Value
(lldb) p/x *$16
(objc::detail::DenseMapPair<const void *, objc::ObjcAssociation>) $19 = {
  std::__1::pair<const void *, objc::ObjcAssociation> = {
    first = 0x0000000100003ca4  //对应于Key："cate_name"
    second = {
      _policy = 0x0000000000000003  //对应于policy：3
      _value = 0x0000000100004040 "123"  //对应于value：@"123"
    }
  }
}

此时，已经完成object与value的关联。

当objc_setAssociatedObject函数传入的value为空时，则表示移除关联。
【1】在AssociationsHashMap中找到以对象为Key的ObjectAssociationMap。
【2】在ObjectAssociationMap中找到以关联标识符为Key的ObjcAssociation并将其移除。
【3】将以对象为Key的ObjectAssociationMap移除。

objc_setAssociatedObject 源码总结

  1. 关联对象是由AssociationsManager管理的AssociationsHashMap，AssociationsHashMap只存在一份。AssociationsHashMap的第一个参数为包装的对象，第二个参数为ObjectAssociationMap。
  2. ObjectAssociationMap主要是存储关联对象的值、标识符、策略等信息。
  3. 调用objc_setAssociatedObject的过程：
    • 在AssociationsHashMap中，查找Key为object的Map。若未找到，则新建一个以object为Key的Map。
    • 在object的Map查找以关联标识符为Key的ObjcAssociation。若未找到，则新建一个以关联标识符为Key的ObjcAssociation，并将关联对象的值和策略等信息设置至ObjcAssociation中。
关联对象的Map结构.png

objc_getAssociatedObject 源码探索

id objc_getAssociatedObject(id object, const void *key) {
    return _object_get_associative_reference(object, key);
}
  • 进入_object_get_associative_reference源码
id
_object_get_associative_reference(id object, const void *key)
{
    ObjcAssociation association{};

    {
        AssociationsManager manager;
        //获取AssociationsHashMap
        AssociationsHashMap &associations(manager.get());
        //遍历查找AssociationsHashMap，找到以object为Key的ObjectAssociationMap
        AssociationsHashMap::iterator i = associations.find((objc_object *)object);
        if (i != associations.end()) {
            //从得到的ObjectAssociationMap中获取ObjcAssociation
            ObjectAssociationMap &refs = i->second;
           //遍历ObjcAssociation，找到以关联标识符为Key的ObjcAssociation
            ObjectAssociationMap::iterator j = refs.find(key);
            if (j != refs.end()) {
                association = j->second;
                association.retainReturnedValue();
            }
        }
    }
    return association.autoreleaseReturnedValue();
}

objc_getAssociatedObject 源码总结

从源码中看，获取关联对象的值较为简单
【1】在AssociationsHashMap中找到以对象为Key的ObjectAssociationMap。
【2】在ObjectAssociationMap中找到以关联标识符为Key的ObjcAssociation。
【3】从ObjcAssociation中找到value。

关联对象注意

关联对象不需要我们手动移除，会在对象析构即dealloc时释放。

dealloc的源码查找路径为：dealloc -> _objc_rootDealloc -> rootDealloc -> object_dispose（释放对象）-> objc_destructInstance -> _object_remove_assocations

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,324评论 5赞 476
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,303评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,192评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,555评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,569评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,566评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,927评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,583评论 0赞 257
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,827评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2赞 320
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,365评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,941评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2赞 342

推荐阅读更多精彩内容