如何实现 iOS 中的 Associated Object

467 查看

关注仓库,及时获得更新:iOS-Source-Code-Analyze

Follow: Draveness · Github

这一篇文章是对 FBRetainCycleDetector 中实现的关联对象机制的分析;因为追踪的需要, FBRetainCycleDetector 重新实现了关联对象,本文主要就是对其实现关联对象的方法进行分析。

文章中涉及的类主要就是 FBAssociationManager

FBAssociationManager is a tracker of object associations. For given object it can return all objects that are being retained by this object with objc_setAssociatedObject & retain policy.

FBRetainCycleDetector 在对关联对象进行追踪时,修改了底层处理关联对象的两个 C 函数,objc_setAssociatedObjectobjc_removeAssociatedObjects,在这里不会分析它是如何修改底层 C 语言函数实现的,如果想要了解相关的内容,可以阅读下面的文章。

关于如何动态修改 C 语言函数实现可以看动态修改 C 语言函数的实现这篇文章,使用的第三方框架是 fishhook

FBAssociationManager

FBAssociationManager 的类方法 + hook 调用时,fishhook 会修改 objc_setAssociatedObjectobjc_removeAssociatedObjects 方法:

将它们的实现替换为 FB::AssociationManager:: fb_objc_setAssociatedObject 以及 FB::AssociationManager::fb_objc_removeAssociatedObjects 这两个 Cpp 静态方法。

上面的两个方法实现都位于 FB::AssociationManager 的命名空间中:

命名空间中有两个用于存储关联对象的数据结构:

  • AssociationMap 用于存储从对象到 ObjectAssociationSet * 指针的映射
  • ObjectAssociationSet 用于存储某对象所有关联对象的集合

其中还有几个比较重要的成员变量:

  • _associationMap 就是 AssociationMap 的实例,是一个用于存储所有关联对象的数据结构
  • _associationMutex 用于在修改关联对象时加锁,防止出现线程竞争等问题,导致不可预知的情况发生
  • hookMutex 以及 hookTaken 都是在类方法 + hook 调用时使用的,用于保证 hook 只会执行一次并保证线程安全

用于追踪关联对象的静态方法 fb_objc_setAssociatedObject 只会追踪强引用:

std::lock_guard l(*_associationMutex)fb_objc_setAssociatedObject 过程加锁,防止死锁问题,不过 _associationMutex 会在作用域之外被释放。

通过输入的 policy 我们可以判断哪些是强引用对象,然后调用 _threadUnsafeSetStrongAssociation 追踪它们,如果不是强引用对象,通过 _threadUnsafeResetAssociationAtKeykey 对应的 value 删除,保证追踪的正确性:

_threadUnsafeSetStrongAssociation 会以 object 作为键,查找或者创建一个 ObjectAssociationSet * 集合,将新的 key 插入到集合中,当然,如果 value == nil 或者上面 fb_objc_setAssociatedObject 方法中传入的 policy 是非 retain 的就会调用 _threadUnsafeResetAssociationAtKey 重置 ObjectAssociationSet 中的关联对象:

同样在查找到对应的 ObjectAssociationSet 之后会擦除 key 对应的值,_threadUnsafeRemoveAssociations 的实现与这个方法也差不多,相较于 reset 方法移除某一个对象的所有关联对象,该方法仅仅移除了某一个 key 对应的值。

调用 _threadUnsafeRemoveAssociations 的方法 fb_objc_removeAssociatedObjects 的实现也很简单,利用了上面的方法,并在执行结束后,使用原 obj_removeAssociatedObjects 方法对应的函数指针 fb_orig_objc_removeAssociatedObjects 移除关联对象:

FBObjectiveCGraphElement 获取关联对象

因为在获取某一个对象持有的所有强引用时,不可避免地需要获取其强引用的关联对象;因此我们也就需要使用 FBAssociationManager 提供的 + associationsForObject: 接口获取所有强引用关联对象: