Sunday, December 02, 2012

深入浅出Cocoa之消息(二)-详解动态方法决议(Dynamic Method Resolution)


深入浅出Cocoa之消息(二)-详解动态方法决议(Dynamic Method Resolution)   

前言:这是我 blog 上面系列文章之一,以前在这个板块发过其中的 深入浅出Cocoa之消息,但在那篇文章并未覆盖消息的动态方法决议,最近重新研究了下运行时系统,改写了 深入浅出 Cocoa 之消息一文,并诞生了本文。为了不让以前写的那片不够完整的文章误导大家,所以将《详解动态方法决议》贴在这里,这样就完整了。

欢迎大家访问系列文章:深入浅出Cocoa系列,这个系列对 objc 运行时系统有较多研究,希望大家喜欢。


 深入浅出Cocoa之消息(二)-详解动态方法决议(Dynamic Method Resolution)
罗朝辉 (http://www.cnblogs.com/kesalin/)
本文遵循“署名-非商业用途-保持一致”创作公用协议




序言

如果我们在 Objective C 中向一个对象发送它无法处理的消息,会出现什么情况呢?根据前文《深入浅出Cocoa之消息》的介绍,我们知道发送消息是通过 objc_send(id, SEL, ...) 来实现的,它会首先在对象的类对象的 cache,method list 以及父类对象的 cache, method list 中依次查找 SEL 对应的 IMP;如果没有找到且实现了动态方法决议机制就会进行决议,如果没有实现动态方法决议机制或决议失败且实现了消息转发机制就会进入消息转发流程,否则程序 crash。也就是说如果同时提供了动态方法决议和消息转发,那么动态方法决议先于消息转发,只有当动态方法决议依然无法正确决议 selector 的实现,才会尝试进行消息转发。在前文中,我并没有详细讲解动态方法决议,因此本文将详细介绍之。
本文代码下载:  DeeoIntoMethod.zip (45 K) 下载次数:0 


一,向一个对象发送该对象无法处理的消息


如下代码:


复制代码
  1. @interface Foo : NSObject
  2. -(void)Bar;
  3. @end
  4. @implementation Foo
  5. -(void)Bar
  6. {
  7.     NSLog(@" >> Bar() in Foo");
  8. }
  9. @end
  10. /////////////////////////////////////////////////
  11. #import "Foo.h"
  12. int main (int argc, const char * argv[])
  13. {
  14.     @autoreleasepool {
  15.         Foo * foo = [[Foo alloc] init];
  16.         [foo Bar];
  17.         [foo MissMethod];
  18.         [foo release];
  19.     }
  20.     return 0;
  21. }

在编译时,XCode 会提示警告:
[pre]Instance method '-MissMethod' not found (return type defaults to 'id')[/pre]

如果,我们忽视该警告运行之,一定会 crash:
>> Bar() in Foo
-[Foo MissMethod]: unrecognized selector sent to instance 0x10010c840
*** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[Foo MissMethod]: unrecognized selector sent to instance 0x10010c840'
*** Call stack at first throw:
......
terminate called after throwing an instance of 'NSException'

下划线部分就是造成 crash 的原因:对象无法处理 MissMethod 对应的 selector,也就是没有相应的实现。


二,动态方法决议

Objective C 提供了一种名为动态方法决议的手段,使得我们可以在运行时动态地为一个 selector 提供实现。我们只要实现 +resolveInstanceMethod: 和/或 +resolveClassMethod: 方法,并在其中为指定的 selector  提供实现即可(通过调用运行时函数 class_addMethod 来添加)。这两个方法都是 NSObject 中的类方法,其原型为:

+(BOOL)resolveClassMethod:(SEL)name;
+ (BOOL)resolveInstanceMethod:(SEL)name;

参数 name 是需要被动态决议的 selector;返回值文档中说是表示动态决议成功与否。但在上面的例子中(不涉及消息转发的情况下),如果在该函数内为指定的 selector  提供实现,无论返回 YES 还是 NO,编译运行都是正确的;但如果在该函数内并不真正为 selector 提供实现,无论返回 YES 还是 NO,运行都会 crash,道理很简单,selector 并没有对应的实现,而又没有实现消息转发。resolveInstanceMethod 是为对象方法进行决议,而 resolveClassMethod 是为类方法进行决议。
下面我们用动态方法决议手段来修改上面的代码:
复制代码
  1. //  Foo.m
  2. //  DeepIntoMethod
  3. //
  4. //  Created by 飘飘白云 on 12-11-13.
  5. //  Copyright (c) 2012年 kesalin@gmail.com All rights reserved.
  6. //
  7. #import "Foo.h"
  8. #include <objc/runtime.h>
  9. void dynamicMethodIMP(id self, SEL _cmd) {
  10.     NSLog(@" >> dynamicMethodIMP");
  11. }
  12. @implementation Foo
  13. -(void)Bar
  14. {
  15.     NSLog(@" >> Bar() in Foo");
  16. }
  17. + (BOOL)resolveInstanceMethod:(SEL)name
  18. {   
  19.     NSLog(@" >> Instance resolving %@", NSStringFromSelector(name));
  20.     if (name == @selector(MissMethod)) {
  21.         class_addMethod([self class], name, (IMP)dynamicMethodIMP, "v@:");
  22.         return YES;
  23.     }
  24.     return [super resolveInstanceMethod:name];
  25. }
  26. + (BOOL)resolveClassMethod:(SEL)name
  27. {
  28.     NSLog(@" >> Class resolving %@", NSStringFromSelector(name));
  29.     return [super resolveClassMethod:name];
  30. }
  31. @end

在前文《深入浅出Cocoa之消息》中已经介绍过 Objective C 中的方法其实就是至少带有两个参数(self 和 _cmd)的普通 C 函数,因此在上面的代码中提供这样一个 C 函数 dynamicMethodIMP,让它来充当对象方法 MissMethod 这个 selector 的动态实现。因为 MissMethod 是被对象所调用,所以它被认为是一个对象方法,因而应该在 resolveInstanceMethod 方法中为其提供实现。通过调用

class_addMethod([self class], name, (IMP)dynamicMethodIMP, "v@:");
就能在运行期动态地为 name 这个 selector 添加实现:dynamicMethodIMP。class_addMethod 是运行时函数,所以需要导入头文件:objc/runtime.h。
再次编译运行前面的测试代码,输出如下:
[pre] >> Bar() in Foo.[/pre]
[pre] >> Instance resolving MissMethod[/pre]
[pre]  >> dynamicMethodIMP called.[/pre]
[pre] >> Instance resolving _doZombieMe[/pre]

dynamicMethodIMP 被调用了,crash 没有了!万事大吉!

注意:这里两次调用了 resolveInstanceMethod,而且两次决议的 selector 在不同的系统下是不同的,上面演示的是 10.7 系统下第一个决议 MissMethod,第二个决议 _doZombieMe;在 10.6 系统下两次都是决议 MissMethod。

下面我把 resolveInstanceMethod 方法中为 selector 添加实现的那一行屏蔽了,消息转发就应该会进行:

//class_addMethod([self class], name, (IMP)dynamicMethodIMP, "v@:");
再次编译运行,此时输出:
[pre] >> Bar() in Foo.[/pre]
[pre] >> Instance resolving MissMethod[/pre]
[pre] +[Foo resolveInstanceMethod:MissMethod] returned YES, but no new implementation of -[Foo MissMethod] was found[/pre]
[pre]  >> Instance resolving _doZombieMe[/pre]
[pre] objc[1223]: +[Foo resolveInstanceMethod:MissMethod] returned YES, but no new implementation of -[Foo MissMethod] was found[/pre]
[pre] -[Foo MissMethod]: unrecognized selector sent to instance 0x10010c880[/pre]
[pre]  *** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[Foo MissMethod]: unrecognized selector sent to instance 0x10010c880'[/pre]
[pre] *** Call stack at first throw:[/pre]
[pre] ......[/pre]

在这里,resolveInstanceMethod 使诈了,它声称成功(返回 YES )决议了 selector,但是并没有真正提供实现,被编译器发觉而提示相应的错误信息。那它的返回值到底有什么作用呢,在它没有提供真正的实现,并且提供了消息转发机制的情况下,YES 表示不进行后续的消息转发,返回  NO 则表示要进行后续的消息转发。


三,源码剖析

让我们来看看运行时系统是如何进行动态方法决议的,下面的代码来自苹果官方公开的源码 objc-class.mm,我在其中添加了中文注释:

1,首先是判断是不是要进行类方法决议,如果不是或决议失败,则进行实例方法决议(请参考:《深入浅出Cocoa之类与对象》):

复制代码
  1. /***********************************************************************
  2. * _class_resolveMethod
  3. * Call +resolveClassMethod or +resolveInstanceMethod and return 
  4. * the method added or NULL. 
  5. * Assumes the method doesn't exist already.
  6. **********************************************************************/
  7. __private_extern__ Method _class_resolveMethod(Class cls, SEL sel)
  8. {
  9.     Method meth = NULL;
  10.     if (_class_isMetaClass(cls)) {
  11.         meth = _class_resolveClassMethod(cls, sel);
  12.     }
  13.     if (!meth) {
  14.         meth = _class_resolveInstanceMethod(cls, sel);
  15.     }
  16.     if (PrintResolving  &&  meth) {
  17.         _objc_inform("RESOLVE: method %c[%s %s] dynamically resolved to %p", 
  18.                      class_isMetaClass(cls) ? '+' : '-', 
  19.                      class_getName(cls), sel_getName(sel), 
  20.                      method_getImplementation(meth));
  21.     }
  22.     return meth;
  23. }


2,类方法决议与实例方法决议大体相似,在这里就只看实例方法决议部分了:

复制代码
  1. /***********************************************************************
  2. * _class_resolveMethod
  3. * Call +resolveClassMethod or +resolveInstanceMethod and return 
  4. * the method added or NULL. 
  5. * Assumes the method doesn't exist already.
  6. **********************************************************************/
  7. __private_extern__ Method _class_resolveMethod(Class cls, SEL sel)
  8. {
  9.     Method meth = NULL;
  10.     if (_class_isMetaClass(cls)) {
  11.         meth = _class_resolveClassMethod(cls, sel);
  12.     }
  13.     if (!meth) {
  14.         meth = _class_resolveInstanceMethod(cls, sel);
  15.     }
  16.     if (PrintResolving  &&  meth) {
  17.         _objc_inform("RESOLVE: method %c[%s %s] dynamically resolved to %p", 
  18.                      class_isMetaClass(cls) ? '+' : '-', 
  19.                      class_getName(cls), sel_getName(sel), 
  20.                      method_getImplementation(meth));
  21.     }
  22.     return meth;
  23. }

这段代码很容易理解:
1,首先判断是否实现了 resolveInstanceMethod,如果没有实现,返回 NULL,进入下一步处理;
2,如果实现了,调用 resolveInstanceMethod,获取返回值;
3,如果返回值为 YES,表示 resolveInstanceMethod 声称它已经提供了 selector 的实现,因此再次查找 method list,如果依然找到对应的 IMP,则返回该实现,否则提示警告信息,返回 NULL,进入下一步处理;
4,如果返回值为 NO,返回 NULL,进入下一步处理;

四,加入消息转发

在前文《深入浅出Cocoa之消息》一文中,我演示了一个消息转发的示例,下面我把动态方法决议部分去除,把消息转发部分添加进来:

复制代码
  1. // Proxy
  2. @interface Proxy : NSObject
  3. -(void)MissMethod;
  4. @end
  5. @implementation Proxy
  6. -(void)MissMethod
  7. {
  8.     NSLog(@" >> MissMethod() called in Proxy.");
  9. }
  10. @end
  11. // Foo
  12. @interface Foo : NSObject
  13. -(void)Bar;
  14. @end
  15. @implementation Foo
  16. - (void)forwardInvocation:(NSInvocation *)anInvocation
  17. {
  18.     SEL name = [anInvocation selector];
  19.     NSLog(@" >> forwardInvocation for selector %@", NSStringFromSelector(name));
  20.     Proxy * proxy = [[[Proxy alloc] init] autorelease];
  21.     if ([proxy respondsToSelector:name]) {
  22.         [anInvocation invokeWithTarget:proxy];
  23.     }
  24.     else {
  25.         [super forwardInvocation:anInvocation];
  26.     }
  27. }
  28. - (NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector {
  29.     return [Proxy instanceMethodSignatureForSelector:aSelector];
  30. }
  31. -(void)Bar
  32. {
  33.     NSLog(@" >> Bar() in Foo.");
  34. }
  35. @end

运行测试代码,输出如下:
[pre]  >> Bar() in Foo.[/pre]
[pre]  >> forwardInvocation for selector MissMethod[/pre]
[pre]  >> MissMethod() called in Proxy.[/pre]

如果我把动态方法决议部分代码也加入进来输出又是怎样呢?下面只列出了 Foo 的实现代码,其他代码不变动。

复制代码
  1. @implementation Foo
  2. +(BOOL)resolveInstanceMethod:(SEL)name
  3. {
  4.     NSLog(@" >> Instance resolving %@", NSStringFromSelector(name));
  5.     if (name == @selector(MissMethod)) {
  6.         class_addMethod([self class], name, (IMP)dynamicMethodIMP, "v@:");
  7. return YES;
  8.     }
  9.     return [super resolveInstanceMethod:name];
  10. }
  11. +(BOOL)resolveClassMethod:(SEL)name
  12. {
  13.     NSLog(@" >> Class resolving %@", NSStringFromSelector(name));
  14.     return [super resolveClassMethod:name];
  15. }
  16. - (void)forwardInvocation:(NSInvocation *)anInvocation
  17. {
  18.     SEL name = [anInvocation selector];
  19.     NSLog(@" >> forwardInvocation for selector %@", NSStringFromSelector(name));
  20.     Proxy * proxy = [[[Proxy alloc] init] autorelease];
  21.     if ([proxy respondsToSelector:name]) {
  22.         [anInvocation invokeWithTarget:proxy];
  23.     }
  24.     else {
  25.         [super forwardInvocation:anInvocation];
  26.     }
  27. }
  28. - (NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector {
  29.     return [Proxy instanceMethodSignatureForSelector:aSelector];
  30. }
  31. -(void)Bar
  32. {
  33.     NSLog(@" >> Bar() in Foo.");
  34. }
  35. @end

此时,输出为:
[pre]  >> Bar() in Foo.[/pre]
[pre]  >> Instance resolving MissMethod[/pre]
[pre]  >> dynamicMethodIMP called.[/pre]
[pre]  >> Instance resolving _doZombieMe[/pre]

注意到了没,消息转发没有进行!在前文中说过,消息转发只有在对象无法正常处理消息时才会调用,而在这里我在动态方法决议中为 selector 提供了实现,使得对象可以处理该消息,所以消息转发不会继续了。官方文档中说:

If you implement resolveInstanceMethod: but want particular selectors to actually be forwarded via the forwarding mechanism, you return NO for those selectors.

文档里的说法其实并不准确,只有在 resolveInstanceMethod 的实现中没有真正为 selector 提供实现,并返回 NO 的情况下才会进入消息转发流程;否则绝不会进入消息转发流程,程序要么调用正确的动态方法,要么 crash。这也与前面的源码不太一致,我猜测在比上面源码的更高层次的地方,再次查找了 method list,如果提供了实现就能够找到该实现。

下面我把 resolveInstanceMethod 方法中为 selector 添加实现的那一行屏蔽了,消息转发就应该会进行:

//class_addMethod([self class], name, (IMP)dynamicMethodIMP, "v@:");
再次编译运行,此时输出正如前面所推断的那样:
[pre]  >> Bar() in Foo.[/pre]
[pre]  >> Instance resolving MissMethod[/pre]
[pre]  objc[1618]: +[Foo resolveInstanceMethod:MissMethod] returned YES, but no new implementation of -[Foo MissMethod] was found[/pre]
[pre]  >> forwardInvocation for selector MissMethod[/pre]
[pre]  >> MissMethod() called in Proxy.[/pre]
[pre]  >> Instance resolving _doZombieMe
[/pre]


进行了消息转发!而且编译器很善意地提示(见前面源码剖析):哎呀,你不能欺骗我嘛,你说添加了实现(返回YES),其实还是没有呀!然后编译器就无奈地去看能不能消息转发了。当然如果把返回值修改为 NO 就不会有该警告出现,其他的输出不变。


五,总结

从上面的示例演示可以看出,动态方法决议是先于消息转发的。
如果向一个 Objective C 对象对象发送它无法处理的消息(selector),那么编译器会按照如下次序进行处理:
1,首先看是否为该 selector 提供了动态方法决议机制,如果提供了则转到 2;如果没有提供则转到 3;
2,如果动态方法决议真正为该 selector 提供了实现,那么就调用该实现,完成消息发送流程,消息转发就不会进行了;如果没有提供,则转到 3;
3,其次看是否为该 selector 提供了消息转发机制,如果提供了消息了则进行消息转发,此时,无论消息转发是怎样实现的,程序均不会 crash。(因为消息调用的控制权完全交给消息转发机制处理,即使消息转发并没有做任何事情,运行也不会有错误,编译器更不会有错误提示。);如果没提供消息转发机制,则转到 4;
4,运行报错:无法识别的 selector,程序 crash;


六,引用

官方运行时源代码:http://www.opensource.apple.com/source/objc4/objc4-532/runtime/
Objective-C Runtime Programming Guide
深入浅出Cocoa之消息
深入浅出Cocoa之类与对象

No comments: