— boreal-kiss.com

Archive
Tag "NSProxy"

例えば、NSProxyのサブクラスにメッセージのフォワーディングをさせたい時1などにどうしてもこの警告が表示されてしまう。存在しないメソッドを呼んでいるので警告が出るのは当たり前だが放置しておくにはうっとおしい。この警告、実は簡単に消すことができる。

Solution

“…may not respond to…”が表示されるクラスのカテゴリを新規に作成し(インターフェイスのみ)、その中に”…may not respond to…”が表示されるメソッドを定義してやる。インターフェイスは”…may not respond to…”が表示されるファイルの一番上にでも書いておけばよいだろう。

Example

以下の例ではMyObjectクラスの-[MyClass doSomething]をメインスレッドで実行する際にNSProxyのフォワーディングを利用している。-[MyObject doSomethingOnMainThread]に注目してもらいたい。-[NSObject performSelectorOnMainThread:withObject:waitUntilDone:]をNSProxyのサブクラス(MyProxy)に送っているがMyProxy ()カテゴリのおかげで”…may not respond to…”の警告が表示されない。

//
//  MyObject.m
//
 
#import "MyProxy.h"
 
//This is important!!
@interface MyProxy ()
-(void)doSomething;
@end
 
@implementation MyObject 
 
-(void)doSomethingOnMainThread{
	MyProxy *myProxy = [[[MyProxy alloc] initWithTarget:self] autorelease];
 
	//No warnings!!
	[myProxy doSomething];
}
 
-(void)doSomething{
	//Does something.
}
 
@end
//
//  MyProxy.h
//
 
#import <Foundation/Foundation.h>
 
@interface MyProxy : NSProxy {
	id _target;
}
 
-(id)initWithTarget:(id)aTarget;
 
@end
//
//  MyProxy.m
//
 
#import "MyProxy.h"
 
@implementation MyProxy
 
-(id)initWithTarget:(id)aTarget{
	_target = aTarget;
	return self;
}
 
//Override
-(NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector{
	return [_target methodSignatureForSelector:aSelector];
}
 
//Override
-(void)forwardInvocation:(NSInvocation *)anInvocation{
	[anInvocation performSelectorOnMainThread:@selector(invokeWithTarget:)
		withObject:_target waitUntilDone:NO];
}
 
-(void)dealloc{
	_target = nil;
	[super dealloc];
}
 
@end

Reference

Footnotes

  1. メッセージフォワーディングの具体例は-[NSObject performSelector:withObject]に複数の引数を渡す – boreal-kiss.com []
Read More

イントロダクション

-[NSObject performSelector:withObject]に複数の引数を渡す – boreal-kiss.comで少しだけ言及していたHigher Order Messaging (HOM)の例をいくつか挙げておく。なおCocoaにおけるHOMはMetaobjectによるMPWFoundationの機能の一部として利用することができる(ようである)。

ケース1

ボタンを押す(-[AppController buttonPressed:])とアラートを表示する(-[AppController openAlert])アプリケーションを考えよう。アプリケーションのコントローラー部分は以下のように記述されているとする。

@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	[self openAlert];
}
 
-(void)openAlert{
	NSRunAlertPanel(@"Alert", @"This is an alert", @"OK", nil, nil);
}
 
@end

1秒後にアラート表示をさせたい場合は-[NSObject performSelector:withObject:afterDelay:]を用いると以下のように書き換えることができる。

-(IBAction)buttonPressed:(id)sender{
	[self performSelector:@selector(openAlert) withObject:nil afterDelay:1.0];
}

この書き方でももちろんかまわないが、HOMを用いるとメッセージ内容がより直感的に表現される。新しくNSProxyのサブクラス(DelayedTrampoline)を導入してHOM的な書き方をした場合は以下のようになる。

#import "DelayedTrampoline.h"
 
@implementation AppController
 
//New
-(IBAction)buttonPressed:(id)sender{
	[[self afterDelay:1.0] openAlert];
}
 
-(void)openAlert{
	NSRunAlertPanel(@"Alert", @"This is an alert", @"OK", nil, nil);
}
 
//New
-(DelayedTrampoline *)afterDelay:(NSTimeInterval)delay{
	return [DelayedTrampoline delayedTrampolineWithTarget:self 
			afterDelay:delay];
}
 
@end
@interface DelayedTrampoline : NSProxy {
	id _target;
	NSTimeInterval _delay;
}
 
-(id)initWithTarget:(id)aTarget afterDelay:(NSTimeInterval)delay;
+(id)delayedTrampolineWithTarget:(id)aTarget afterDelay:(NSTimeInterval)delay;
@end
@implementation DelayedTrampoline
 
-(id)initWithTarget:(id)aTarget afterDelay:(NSTimeInterval)delay{
	_target = aTarget;
	_delay = delay;
	return self;
}
 
+(id)delayedTrampolineWithTarget:(id)aTarget afterDelay:(NSTimeInterval)delay{
	return [[[[self class] alloc] initWithTarget:aTarget 
				afterDelay:delay] autorelease];
}
 
//Override
-(NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector{
	return [_target methodSignatureForSelector:aSelector];
}
 
//Override
-(void)forwardInvocation:(NSInvocation *)anInvocation{
	[anInvocation performSelector:@selector(invokeWithTarget:) 
		withObject:_target afterDelay:_delay];
}
 
-(void)dealloc{
	_target = nil;
	[super dealloc];
}
 
@end

以下に比較したい箇所だけを抜き出す。HOMの場合メッセージ(afterDelay:)の引数がメッセージ(openAlert)であるかのように書くことができることがわかる。これがHOMの”Higher Order”たる所以である。[NSObject performSelector:withObject:afterDelay:]を用いた従来の書き方よりもより直感的に理解できる表現だ。もちろん引数に書かれたメッセージは実際に引数を持つことができるため柔軟性も高い(例: -[NSObject performSelector:withObject]に複数の引数を渡す – boreal-kiss.com)。

//Normal
-(IBAction)buttonPressed:(id)sender{
	[self performSelector:@selector(openAlert) withObject:nil afterDelay:1.0];
}
 
//HOM
-(IBAction)buttonPressed:(id)sender{
	[[self afterDelay:1.0] openAlert];
}

ケース2

HOMは同じ内容を繰り返し記述しなければならない場合などにも便利だ。例えばdelegateメソッドを実行する際にターゲットであるdelegateが実際にメソッドを実装しているか確認する次のようなコードを大量に書いて(あるいはコピペして)骨が折れた経験はないだろうか。

if ([_delegate respondsToSelector:@selector(doSomething)]){
	[_delegate doSomething];
}

この場合あらかじめdelegateオブジェクトを扱うクラス(例えばAppController)にHOMを実装しておけば問題は回避可能だ。

@interface AppController : NSObject {
	id _delegate;
}
@end
#import "IfRespondsToTrampoline.h"
 
@implementation AppController
 
-(IfRespondsToTrampoline *)delegateIfRespondsTo{
	if (_delegate){
		return [IfRespondsToTrampoline 
			ifRespondsToTrampolineWithTarget:_delegate];
	}
	return nil;
}
 
@end
@interface IfRespondsToTrampoline : NSProxy {
	id _target;
}
 
-(id)initWithTarget:(id)aTarget;
+(id)ifRespondsToTrampolineWithTarget:(id)aTarget;
@end
@implementation IfRespondsToTrampoline
 
-(id)initWithTarget:(id)aTarget{
	_target = aTarget;
	return self;
}
 
+(id)ifRespondsToTrampolineWithTarget:(id)aTarget{
	return [[[[self class] alloc] initWithTarget:aTarget] autorelease];
}
 
//Override
-(NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector{
	return [_target methodSignatureForSelector:aSelector];
}
 
//Override
-(void)forwardInvocation:(NSInvocation *)anInvocation{
	[anInvocation invokeWithTarget:_target];
}
 
-(void)dealloc{
	_target = nil;
	[super dealloc];
}
 
@end

以下に比較したい箇所だけ抜粋する。AppControllerに上記のようなHOMが実装されていれば、delegateオブジェクトがメソッドを実装していれば実行、なければ何もしない(実際には内部でNSProxyによるNSInvalidArgumentExceptionが挙がる)というコードが一行で書けてしまう。

//In AppController.m
 
//Normal
if ([_delegate respondsToSelector:@selector(doSomething)]){
	[_delegate doSomething];
}
 
//HOM
[[self delegateIfRespondsTo] doSomething];
Read More

イントロダクション

あるメソッドを遅延して実行したい場合、-[NSObject performSelector:withObject:afterDelay]を用いることが多々ある。しかし対象のメソッドが複数の引数を持つものであった場合、この方法は直接的には用いることができなくなってしまう。そこでNSInvocationクラスとNSProxyクラスを用いて複数引数を持つメソッドでも適用できるように工夫する。なおこの方法はHigher Order Messaging(メッセージを引数に持つメッセージという意味合い)と呼ばれる。

*******************************************************************
HOMについてまとめた記事はこちら。
Higher Order Messaging (HOM) – boreal-kiss.com
*******************************************************************

問題の一例

例えば以下のようなコントローラークラスを考える。このコントローラーではUI中のボタン(Show Alert)が押されるとアラートが表示される仕組みになっている。

@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	[self openAlertWithTitle:@"Alert" message:@"This is an alert." 
		defaultButtonTitle:@"OK"];
}
 
-(void)openAlertWithTitle:(NSString *)aTitle 
				message:(NSString *)aMessage 
				defaultButtonTitle:(NSString *)aDefaultButtonTitle{
	NSRunAlertPanel(aTitle, aMessage, aDefaultButtonTitle, nil, nil);
}
 
@end

このままだと、ボタンが押された途端にアラートが表示され、ボタンの描画状態がプッシュ中のままになることがわかる。気持ちわるい。

そこで-[NSObject performSelector:withObject:afterDelay:]を用いてアラートを遅延表示させるのが得策だろう。しかし-[NSObject performSelector:withObject:afterDelay:]では-[AppController showAlertWithTitle:message:defaultButtonTitle:]を正しく実行できない。引数が複数あるためだ。それではどうすればよいだろうか。解決策のひとつとして複数の引数をひとつにまとめてしまう方法が考えられる。

NSInvocation

NSInvocationはメソッドをオブジェクト化したクラスである。デザインパターンで言うところのCommandパターンに相当するもので、これを利用することで上記問題を解決することができる。具体的には以下のような手順を踏むことになるだろう。

  1. -[NSObject performSelector:withObject:afterDelay:]で本来実行したい複数引数を持つメソッドをNSInvocationオブジェクトとしてひとつにまとめてしまう(メソッドのオブジェクト化)
  2. 作成したNSInvocationオブジェクトを実行するための新たなメソッド(引数はNSInvocationオブジェクトひとつのみ)を定義、それを-[NSObject performSelector:withObject:afterDelay:]で実行する。単一引数なので問題なし
  3. NSInvocationオブジェクトの中身(本来実行したいメソッド)を実行する

以下では新しく-[AppController openDelayedAlertWithTitle:message:defaultButtonTitle:]としてアラートの遅延表示を実現している。

@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	[self openDelayedAlertWithTitle:@"Alert" message:@"This is an alert."
		defaultButtonTitle:@"OK"];
}
 
-(void)openAlertWithTitle:(NSString *)aTitle
	message:(NSString *)aMessage
	defaultButtonTitle:(NSString *)aDefaultButtonTitle{
	NSRunAlertPanel(aTitle, aMessage, aDefaultButtonTitle, nil, nil);
}
 
//New
-(void)openDelayedAlertWithTitle:(NSString *)aTitle
	message:(NSString *)aMessage
	defaultButtonTitle:(NSString *)aDefaultButtonTitle{
 
	NSMethodSignature *aSignature = [[self class] 
		instanceMethodSignatureForSelector:
		@selector(openAlertWithTitle:message:defaultButtonTitle:)];
	NSInvocation *anInvocation = [NSInvocation 
		invocationWithMethodSignature:aSignature];
	[anInvocation setTarget:self];
	[anInvocation setArgument:&aTitle atIndex:2];
	[anInvocation setArgument:&aMessage atIndex:3];
	[anInvocation setArgument:&aDefaultButtonTitle atIndex:4];
	[anInvocation setSelector:
		@selector(openAlertWithTitle:message:defaultButtonTitle:)];
	[self performSelector:@selector(performInvocation:)
		withObject:anInvocation afterDelay:0.0];
}
 
//New
-(void)performInvocation:(NSInvocation *)anInvocation{
	[anInvocation invokeWithTarget:self];
}
 
 
@end

実行結果。アラート表示が遅延されボタンがプッシュ状態でなくなっているのがわかる。気持ちいい。

上記例からメソッドをオブジェクト化するというNSInvocationクラスの有用性が実感できた。反面、NSInvocationオブジェクトは作成するまでの手順が面倒なこともわかったと思う(例えば引数が10個あるメソッドをNSInvocationオブジェクト化するためには10回も-[NSInvocation setArgument:atIndex:]を書かないといけない)。実は適当なメッセージを送るとメッセージ内容をNSInvocationオブジェクトにしてくれる便利クラスが存在する。NSProxyだ。

NSProxy

NSProxyはデザインパターンで言うところのProxyパターンを実現するものである。NSProxyは自分が理解できないメッセージをとりあえずNSInvocationオブジェクトにしてしまうという機能を持っているのでこれを利用する。NSProxyはメッセージを受け取ると以下のような手順でNSInvocationオブジェクトを作成し、NSInvocationオブジェクトをどのように扱うのか指示を待つ。

  1. -[NSProxy methodSignatureForSelector:]を呼び出しNSMthodSignatureオブジェクトを作成する。ただしNSMethodSignatureオブジェクトを作成するための必要な情報(ターゲット etc.)はメソッド内に適切に与えてやる必要がある
  2. NSMethodSignatureオブジェクトを元にNSInvocationオブジェクトを作成する
  3. -[NSProxy forwardInvocation:]を呼び出しメソッド内容の指示に従う

自動作成されたNSInvocationオブジェクトは-[NSProxy forwardInvocation:]の引数に渡されるので、あとはこのNSInvocationオブジェクトの扱い方を内部に記述してやればよい。以下ではNSProxyのサブクラスとしてTrampolineクラスを用いてNSInvocationオブジェクトを作成させている。AppControllerの中身の変更にも注目してもらいたい。

#import "Trampoline.h"
 
@implementation AppController
 
-(IBAction)buttonPressed:(id)sender{
	[self openDelayedAlertWithTitle:@"Alert" message:@"This is an alert."
		defaultButtonTitle:@"OK"];
}
 
-(void)openAlertWithTitle:(NSString *)aTitle
	message:(NSString *)aMessage
	defaultButtonTitle:(NSString *)aDefaultButtonTitle{
	NSRunAlertPanel(aTitle, aMessage, aDefaultButtonTitle, nil, nil);
}
 
//New
-(void)openDelayedAlertWithTitle:(NSString *)aTitle
	message:(NSString *)aMessage
	defaultButtonTitle:(NSString *)aDefaultButtonTitle{
	[[self trampoline] openAlertWithTitle:aTitle
		message:aMessage defaultButtonTitle:aDefaultButtonTitle];
}
 
-(void)performInvocation:(NSInvocation *)anInvocation{
	[anInvocation invokeWithTarget:self];
}
 
//New
-(Trampoline *)trampoline{
	return [Trampoline trampolineWithTarget:self
		selector:@selector(performInvocation:)];
}
 
 
 
@end
@interface Trampoline : NSProxy {
	id _target;
	SEL _selector;
}
 
-(id)initWithtarget:(id)aTarget selector:(SEL)aSelector;
+(id)trampolineWithTarget:(id)aTarget selector:(SEL)aSelector;
 
@end
@implementation Trampoline
 
-(id)initWithtarget:(id)aTarget selector:(SEL)aSelector{
	_target = aTarget;
	_selector = aSelector;
	return self;
}
 
+(id)trampolineWithTarget:(id)aTarget selector:(SEL)aSelector{
	return [[[[self class] alloc] initWithtarget:aTarget selector:aSelector] 
		autorelease];
}
 
//Override
-(NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector{
	return [_target methodSignatureForSelector:aSelector];
}
 
//Override
-(void)forwardInvocation:(NSInvocation *)anInvocation{
	[_target performSelector:_selector withObject:anInvocation afterDelay:0.0];
}
 
-(void)dealloc{
	_target = nil;
	[super dealloc];
}
 
@end

References

Read More