IOS之教你用Xtrace读懂Mantle源码

Mantle是什么?

Mantle makes it easy to write a simple model layer for your Cocoa or Cocoa Touch application. --Mantle是构建Cocoa或者Cocoa Touch应用程序的Model层的框架。

Mantle地址:GitHub - Mantle/Mantle: Model framework for Cocoa and Cocoa Touch

Xtrace是什么?

Xtrace是ios中强大的调试的库,能详细打印出一个某个方法被调用的堆栈,方便调试时定位问题。

Xtrace地址:GitHub - johnno1962/Xtrace: Trace Objective-C method calls by class or instance

OK~提供了以上信息之后,正式开始我们的主题。不同于其他大神模式,一上来就分析源码+总结,今天我们借助与Xtrace工具来一步步教你读懂Mantle源码。

开始

在我们的Mantle案例中需要添加Xtrace的支持,将Xtrace.h和Xtrace.mm两个文件添加到我们的项目中,并在AppDelegate.m中添加Xtrace的引用和配置相关项。

Xtrace相关配置项

大家了解过Mantle使用的人大致应该了解MTLModel类、MTLJSONAdapter类以及MTLJSONSerializing协议是整个Mantle的核心,所以我们在上面的XTrace配置项中针对MTLModel的子类GHIssueMantle(实现MTLJSONSerializing协议)和MTLJSONAdapter类进行堆栈跟踪。以下是我们解析过程中经常使用的代码:

入口代码

我们来看一下XTrace跟踪到的堆栈情况:

XTrace调用堆栈

大家可以看到从入口代码到Mantle内部的执行过程就非常的清晰了,整个过程从JSON串转换到Model所涉及到的方法的执行过程是按顺序进行的,所以接下来我们主要针对这些这些方法进行一个解读。

方法一:modelOfClass:fromJSONDictionary:error:

modelOfClass:fromJSONDictionary:error:

这个方法通过initWithModelClass方法初始化MTLJSONAdapter实例,之后调用modelFromJSONDictionary: error:将JSON字典转化成Model;

方法二:initWithModelClass:

initWithModelClass:

这个方法会主要用来初始化变量,并返回MTLJSONAdapter实例。先是调用了JSONKeyPathsByPropertyKey来指定对象的属性如何映射到不同的key path,并将结果保存。再是调用propertyKeys方法获取model中所有属性(除了存储类型为MTLPropertyStorageNone)。接着遍历_JSONKeyPathsByPropertyKey变量,先判断是不是包含在propertyKeys集合中,如果未包含直接return掉;如果包含则获取对应属性keyPath,这里keyPath有两种形式,一种字符串的形式、一种数组的形式,所以这里做了一下判断。然后调用了valueTransformersForModelClass方法来获取model中每个属性对应的值转换器的字典。最后初始化了JSONAdaptersByModelClass变量并返回实例。

方法三:JSONKeyPathsByPropertyKey

JSONKeyPathsByPropertyKey

这是子类Model遵守MTLJSONSerializing协议必须实现的方法,主要指定对象的属性如何映射到不同的key path。

方法四:propertyKeys

propertyKeys

这个方法主要获取获取model中所有属性(除了存储类型为MTLPropertyStorageNone)。这里通过关联对象形式来获取缓存,如果缓存为Nil,则调用enumeratePropertiesUsingBlock一次遍历所有属性,通过调用storageBehaviorForPropertyWithKey获取每个属性的存储行为,并将存储行为不是MTLPropertyStorageNone的结果加入到集合中,最后结果关联到当前对象并返回。

方法五:enumeratePropertiesUsingBlock

enumeratePropertiesUsingBlock

这个方法主要来循环获取model及其父类(非MTLModel)的所有属性,并执行block。这里运用到了runtime函数class_copyPropertyList来获取属性列表。

方法六:storageBehaviorForPropertyWithKey

storageBehaviorForPropertyWithKey

这个方法主要用来获取指定属性的存储行为。先是通过runtime获取属性,并通过mtl_copyPropertyAttributes获取属性内部结构。之后的判断逻辑相对比较复杂,同时也说明作者考虑比较周到。从这个逻辑判断我们可以知道,Mantle实际将存储类型分类为两种(可存储和不可存储),而不可存储的属性是没有变量空间ivar,readonly属性往往会是这种情况。这里内部出现嵌套调用的情况,主要是考虑到了一个被覆盖的readonly属性其父类可能存在变量空间。

方法七:valueTransformersForModelClass

valueTransformersForModelClass

这个方法用来获取model中属性对应的值转换器集合。先去判断了是否实现"属性名称"+"JSONTransformer"方法,如果实现进行动态调用并返回。如果未实现则判断是否实现JSONTransformerForKey这个方法,如果实现则进行调用并返回。如果未实现,则对属性结构进行判断,返回合适的值转换器。这里因为我们实现了URLJSONTransformer这个方法,所以代用完URLJSONTransformer就直接返回了。

注意:第373行的函数调用方式可以在一个循环内频繁地调用一个特定的方法时,通过这种方式可以提高程序的性能,免去了runtime方法查找的性能损失。

方法八:modelOfClass:fromJSONDictionary:error:

[MTLJSONAdapter modelOfClass:fromJSONDictionary:error:

这个方法是将JSON转换为Model最主要的方法,前面做的都是一些初始化工作。先是判断当前类是否实现了classForParsingJSONDictionary方法,这个方法在存在类族的情况下判断具体哪个类来执行转换工作。接着遍历model的所有属性,通过kvc获取每个属性的值,并判断相应属性是否存在值转换器,若果存在,则对值进行相应转换。最后将所有的值存储在字典中,并调用modelWithDictionary: error通过kvc的方式验证并设置值。

方法九:modelWithDictionary: error

modelWithDictionary: error

这个方法只是调用了initWithDictionary: error:自定义实现,而我在这个方法只是简单的调用了MTLModel的initWithDictionary: error:实现。

方法十:initWithDictionary: error:

initWithDictionary: error:

这个方法通过kvc的方式初始化model实例。先是遍历了字典,获取值并验证是否为NSNull.null类型,接着通过KVC的方式为model实例验证并设置值。注意:XTrace跟踪不到静态函数。所以这里申明的MTLValidateAndSetValue函数并未跟踪到。

附上案例地址:GitHub - qsw1214/MantleDemo: A MantleDemo for learing

如果理解有错误的地方,欢迎大家可以指出来,一起探讨。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,723评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,003评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,512评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,825评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,874评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,841评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,812评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,582评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,033评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,309评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,450评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,158评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,789评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,409评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,609评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,440评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,357评论 2 352

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,089评论 4 62
  • iOS网络架构讨论梳理整理中。。。 其实如果没有APIManager这一层是没法使用delegate的,毕竟多个单...
    yhtang阅读 5,184评论 1 23
  • 文/南屿 而温言以为对方取笑自己,涨红了脸,他也不知道为什么在这个人面前,自己会变得这么无措,这不像他。 “我成...
    南屿l阅读 530评论 0 0
  • 在构图方面有进步,画的像个样子了。加油!
    cc904ea6870c阅读 174评论 0 0
  • 每一个学生都憧憬过考试之后的假期。最后一门考试就像一个时间节点一样,往前数都是痛苦的复习,熬夜,无休止的咖啡,犯困...
    karenzzz阅读 325评论 0 1