Associative Storage: カテゴリに疑似インスタンス変数を追加
Tags: Cocoa, DesignPatterns, Objective-C
イントロダクション
Objective-Cのカテゴリはサブクラスを作ることなくメソッドの拡張(またはメソッドごとの分類)が行える点で強力だ。しかしメソッドの定義はできてもインスタンス変数の追加ができない。そこでCocoaのKey Value Coding (KVC)の機能を用いてカテゴリに擬似的にインスタンス変数を生成させる。これにより元クラスを手直しすることなくインスタンス変数を追加することができる。なおこの手法は、よりフレキシブルという理由でNSMapTableを用いるのが一般的なようだが、ここではNSMutableDictionaryを代用した。理由は使い慣れているからだ。NSMapTableを用いた方法はBuck and Yacktman - Cocoa Design Patternsが詳しい。
具体例
簡単な例としてボタンを押すとアラートを表示するアプリケーションを考える。ボタンプッシュ後の動作はAppControllerクラスで以下のように定義されているとする。
//AppController.m @implementation AppController -(IBAction)buttonPressed:(id)sender{ NSRunAlertPanel(@"Alert", @"This is an alert.", @"OK", nil, nil); } @end
ここで「一度アラート表示された場合は再度アラートを表示させない」仕様に変更するとしよう。AppControllerにBOOL値を格納するインスタンス変数を追加して制御するのが手っ取り早いが、ここではAppControllerのカテゴリ(ShowAtOnce)を新規に定義して制御することにする。カテゴリ作成の大まかな手順は以下のようになる。
- 疑似インスタンス変数格納用にNSMutableDictionary変数をカテゴリに定義
- 疑似インスタンス変数としたいオブジェクトを上記NSMutableDictionary変数に格納。その際のキーストリングはAppControllerインスタンスに固有のものを用いる
- 格納したオブジェクトのAccesors (Setters/Getters)をカテゴリに定義
- インスタンスの解放時にNSMutableDictionaryからオブジェクトを消去するメソッドをカテゴリに定義
以下順にみていこう。
1. 疑似インスタンス変数格納用変数の定義
疑似インスタンス変数にしても情報を格納する場所は必要になる。そこで疑似インスタンス変数を格納する場所としてNSMutableDictionaryオブジェクトをカテゴリ(ShowAtOnce)に定義する。さらにこのオブジェクトのAccesorsをクラスメソッドとして定義する。つまりこの格納用のNSMutableDictionaryオブジェクトはAppControllerインスタンスすべてで使い回されることになる。
//AppController-ShowAtOnce.m @implementation AppController (ShowAtOnce) static NSMutableDictionary *_simulatedIVars = nil; +(NSMutableDictionary *)_simulatedIVars{ if (_simulatedIVars == nil){ _simulatedIVars = [[NSMutableDictionary alloc] init]; } return _simulatedIVars; } @end
2. インスタンス固有のキーストリング
上記例のアプリケーションの仕様を実現するためには、一度アラートが表示されたかどうかを調べるBOOL値を(NSMutableDictionary *)_simulatedIVarsに格納できればよさそうだ。しかし今は疑似インスタンス変数を作りたいのでAppControllerインスタンスごとに異なる値を格納できるようにする必要がある。そこでまず「AppControllerインスタンスに固有なNSStringオブジェクト」を生成するメソッドを定義する。このメソッドは-[AppController self]のストリング表現を返す。
//AppController-ShowAtOnce.m -(NSString *)_instanceID{ return [NSString stringWithFormat:@"%@", self]; }
さらに「疑似インスタンス変数名に相当するNSStringオブジェクト」を用意する。これはクラス全体で使い回しができるようにすればよい。ここではAlertHasEverBeenShownKeyStringという名前で定義しておこう。
//AppController-ShowAtOnce.m static NSString * const AlertHasEverBeenShownKeyString = @"alertHasEverBeenShown";
あとは「AppControllerインスタンスに固有なNSStringオブジェクト」と「疑似インスタンス変数名に相当するNSStringオブジェクト」を適当に繋げて「あるAppControllerインスタンスの疑似インスタンス変数に固有なNSStringオブジェクト」を作成するメソッドを定義する。このメソッドの返り値が(NSMutableDictionary *)_simulatedIVarsへの格納用キーストリングとして利用されるわけだ。
//AppController-ShowAtOnce.m -(NSString *)_objectKeyForKeyString:(NSString *)aKeyString{ return [NSString stringWithFormat:@"%@:%@", [self _instanceID], aKeyString]; }
現在までのAppController (ShowAtOnce)の中身をまとめると以下のようになっているはずだ。
//AppController-ShowAtOnce.m static NSString * const AlertHasEverBeenShownKeyString = @"alertHasEverBeenShown"; @implementation AppController (ShowAtOnce) static NSMutableDictionary *_simulatedIVars = nil; +(NSMutableDictionary *)_simulatedIVars{ if (_simulatedIVars == nil){ _simulatedIVars = [[NSMutableDictionary alloc] init]; } return _simulatedIVars; } #pragma mark - #pragma mark Utilities -(NSString *)_instanceID{ return [NSString stringWithFormat:@"%@", self]; } -(NSString *)_objectKeyForKeyString:(NSString *)aKeyString{ return [NSString stringWithFormat:@"%@:%@", [self _instanceID], aKeyString]; } @end
3. 疑似インスタンス変数のAccesors
上記メソッド群を利用してカテゴリ(ShowAtOnce)に定義する。Settersは-[AppController _setAlertHasEverBeenShown:]、Gettersは-[AppController _alertHasEverBeenShown]としよう。ここはstraightforwardだと思う。
//AppController-ShowAtOnce.m -(BOOL)_alertHasEverBeenShown{ NSString *aKey = [self _objectKeyForKeyString:AlertHasEverBeenShownKeyString]; id object = [[[self class] _simulatedIVars] objectForKey:aKey]; if (object == nil){ return NO; } return [object boolValue]; } -(void)_setAlertHasEverBeenShown:(BOOL)yn{ NSString *aKey = [self _objectKeyForKeyString:AlertHasEverBeenShownKeyString]; [[[self class] _simulatedIVars] setObject:[NSNumber numberWithBool:yn] forKey:aKey]; }
あとはAppController内でこのメソッドを使ってやればよい。具体的には以下のようになるだろう。
//AppController.m #import "AppController-ShowAtOnce.h" @implementation AppController -(IBAction)buttonPressed:(id)sender{ if (![self _alertHasEverBeenShown]){ NSRunAlertPanel(@"Alert", @"This is an alert.", @"OK", nil, nil); [self _setAlertHasEverBeenShown:YES]; } } @end
4. 疑似インスタンス変数を解放
AppControllerインスタンスごとに(NSMutableDictionary *)_simulatedIVarsに登録されるのだからAppControllerインスタンスが不要になったら疑似インスタンス変数も解放する必要がある。そのために以下のようなメソッドをAppController(ShowAtOnce)に定義しておく。このメソッドは呼ばれれば不要になった疑似インスタンス変数を解放する。
//AppController-ShowAtOnce.m -(void)_removeSimulatedIVars{ NSString *aKey = [self _objectKeyForKeyString:AlertHasEverBeenShownKeyString]; id object = [[[self class] _simulatedIVars] objectForKey:aKey]; if (object){ [[[self class] _simulatedIVars] removeObjectForKey:aKey]; } }
さてこれまでAppControllerそのものを一切変更しないように実装すると言ってきたが実は嘘で、AppControllerそのものを手直しする必要がでてくる。というのも疑似インスタンス変数の解放を呼ぶメソッドをカテゴリに書くことは危険だからだ。例えば-[AppController dealloc]をカテゴリ(ShowAtOnce)に再定義することは可能だが、もし他に疑似インスタンス変数を持つ別カテゴリが同様の-[AppController dealloc]を実装した場合どちらの-[AppController dealloc]が呼び出されるかわからなくなるからだ(結果どちらかのカテゴリの疑似インスタンス変数は解放メソッドを呼ばれないがために生き残ってしまう)。したがって疑似インスタンス変数の解放メソッドを呼び出すのはAppControllerとするのがよいだろう。
//AppController.m -(void)dealloc{ [self _removeSimulatedIVars]; [super dealloc]; }
全ソースコード
最終的なコードは以下のようになっている。
//AppController.h #import <Cocoa/Cocoa.h> @interface AppController : NSObject { } -(IBAction)buttonPressed:(id)sender; @end
//AppController.m #import "AppController.h" #import "AppController-ShowAtOnce.h" @implementation AppController -(IBAction)buttonPressed:(id)sender{ if (![self _alertHasEverBeenShown]){ NSRunAlertPanel(@"Alert", @"This is an alert.", @"OK", nil, nil); [self _setAlertHasEverBeenShown:YES]; } } -(void)dealloc{ [self _removeSimulatedIVars]; [super dealloc]; } @end
//AppController-ShowAtOnce.h #import <Cocoa/Cocoa.h> #import "AppController.h" @interface AppController (ShowAtOnce) +(NSMutableDictionary *)_simulatedIVars; -(void)_removeSimulatedIVars; -(BOOL)_alertHasEverBeenShown; -(void)_setAlertHasEverBeenShown:(BOOL)yn; -(NSString *)_instanceID; -(NSString *)_objectKeyForKeyString:(NSString *)aKeyString; @end
//AppController-ShowAtOnce.m #import "AppController-ShowAtOnce.h" //Private static NSString * const AlertHasEverBeenShownKeyString = @"alertHasEverBeenShown"; @implementation AppController (ShowAtOnce) static NSMutableDictionary *_simulatedIVars = nil; +(NSMutableDictionary *)_simulatedIVars{ if (_simulatedIVars == nil){ _simulatedIVars = [[NSMutableDictionary alloc] init]; } return _simulatedIVars; } -(void)_removeSimulatedIVars{ NSLog(@"%s", __FUNCTION__); NSString *aKey = [self _objectKeyForKeyString:AlertHasEverBeenShownKeyString]; id object = [[[self class] _simulatedIVars] objectForKey:aKey]; if (object){ [[[self class] _simulatedIVars] removeObjectForKey:aKey]; } } #pragma mark - #pragma mark Setters Getters -(BOOL)_alertHasEverBeenShown{ NSString *aKey = [self _objectKeyForKeyString:AlertHasEverBeenShownKeyString]; id object = [[[self class] _simulatedIVars] objectForKey:aKey]; if (object == nil){ return NO; } return [object boolValue]; } -(void)_setAlertHasEverBeenShown:(BOOL)yn{ NSString *aKey = [self _objectKeyForKeyString:AlertHasEverBeenShownKeyString]; [[[self class] _simulatedIVars] setObject:[NSNumber numberWithBool:yn] forKey:aKey]; } #pragma mark - #pragma mark Utilities -(NSString *)_instanceID{ return [NSString stringWithFormat:@"%@", self]; } -(NSString *)_objectKeyForKeyString:(NSString *)aKeyString{ return [NSString stringWithFormat:@"%@:%@", [self _instanceID], aKeyString]; } @end
-[NSObject performSelector:withObject]に複数の引数を渡す
Tags: Cocoa, DesignPatterns, NSInvocation, NSProxy, Objective-C
イントロダクション
あるメソッドを遅延して実行したい場合、-[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パターンに相当するもので、これを利用することで上記問題を解決することができる。具体的には以下のような手順を踏むことになるだろう。
- -[NSObject performSelector:withObject:afterDelay:]で本来実行したい複数引数を持つメソッドをNSInvocationオブジェクトとしてひとつにまとめてしまう(メソッドのオブジェクト化)
- 作成したNSInvocationオブジェクトを実行するための新たなメソッド(引数はNSInvocationオブジェクトひとつのみ)を定義、それを-[NSObject performSelector:withObject:afterDelay:]で実行する。単一引数なので問題なし
- 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オブジェクトをどのように扱うのか指示を待つ。
- -[NSProxy methodSignatureForSelector:]を呼び出しNSMthodSignatureオブジェクトを作成する。ただしNSMethodSignatureオブジェクトを作成するための必要な情報(ターゲット etc.)はメソッド内に適切に与えてやる必要がある
- NSMethodSignatureオブジェクトを元にNSInvocationオブジェクトを作成する
- -[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
[ActionScript] モンハンでAbstract Factory
Tags: ActionScript, DesignPatterns
剣士装備・ガンナー装備
モンスターハンターの武器は大きくわけて二種類に分類できる。それは大剣やハンマーといった近接武器(剣士専用)と弓やボウガンなどの遠距離武器(ガンナー専用)である。面白いのは防具にも剣士専用のものとガンナー専用のものがあるところで、武器と防具の関係に以下のような制約が付けられているのが他のRPG(例えばドラクエ)と大きく異なる点であろう。
- 剣士専用武器を装備している時は剣士専用防具しか装備できない。
- ガンナー専用武器を装備している時はガンナー専用防具しか装備できない。
剣士・ガンナー武器の違いは予想できるとして、剣士・ガンナー防具の違いは何だろう。答えは防御力だ。ガンナー専用防具の防御力は剣士専用防具のそれに比べて著しく低い。これは妥当な設定だ。崖の上でスコープを構えて銃撃するハンターよりも、モンスターの足下すれすれで剣を振り回しているハンターの方がモンスターからダメージを受ける可能性が高いからであろう。ダメージを受ける頻度が異なる者同士をより平等に扱うためには防御力による差別化をはかったという風に考えれば、上記のような剣士・ガンナー防具の制約はとてもリーズナブルだ。
裸のハンター
さて剣士・ガンナー防具の制約、面白い仕組みなのだが、少しだけストレスになることがある。着替えをする時だ。モンハンをやったことがある人なら経験があると思うが、今例えば剣士専用装備(近接武器+近接武器用防具)をしているとしよう。この状態で武器をガンナー専用であるボウガンに替えたとするとどうなるか。答えは防具が全部外れて裸になる、である。なぜならボウガンを装備した時点でガンナー武器を装備していることになり、上記の剣士・ガンナー防具の制約から剣士防具が装備できなくなるからである。ボウガンだけを装備した裸のハンターはガンナー専用防具をイチから装備し直さないといけないのだ。そしてこの問題は剣士・ガンナー間の装備変更にはいつもつきまとうことになる。
便利な機能
そこでゲーム内に用意されているのが着替えを一括で行うマクロ機能だ。自分のお気に入りの武器と防具の組み合わせをあらかじめ登録しておくことで、次回からボタン一つで全身の装備コーディネートができてしまう。もちろん登録時の装備は自分が今現在装備しているものから選ばれているため、剣士・ガンナー防具の制約も必ず満たすことになる。登録スロットも20もあり(MHP2Gの場合)、好きなときに好きなスロットの装備にボタン一つで変身できるようになる。
本題
前置きが長くなったが、このモンハンの装備一括変更のマクロ機能、デザインパターンで言うところの何に相当するのか、ということで少し考えた。いくつか候補があったものの結局これに落ち着いた。Abstract Factoryパターンである。全く同じ操作でユーザーを煩わせることなく機能する、というところに重点を置いた結果である。Abstract Factoryパターンの解説は以下リンク先へどうぞ。簡単なActionScriptコード付き。
Design Patterns for ActionScript
Tags: ActionScript, DesignPatterns
Eric Gamma et al. - Desingn Patternsを全部Action Scriptで解説しようと思ったらなかなかハードで途中で力尽きてしまった。一応全体三部のうちのStructural Patterns(以下参照)については完成はしていたので公開することに。ただし注意。そもそもの動機が自分のための勉強だったため、単なる書物の和訳にならないように自分で本質だと感じた部分をメインに書いている。したがって内容に少しでも疑問を持った場合は原著をあたってください。
- Adapter
- Bridge
- Composite
- Decorator
- Facade
- Flyweight
- Proxy
» Design Patterns for ActionScript
MVCオルタナティブ
Tags: DesignPatterns
今日William Sanders - ActionScript 3.0 Design Patternsを読み直してて気づいた。ずっとViewは見た目オンリーで仕事は何もせずにControllerにまかせっきりだと思ってたけど、自分の衣装は自分で着るらしい。
一般的なMVC
いわゆる本に載ってるやつで意外にViewが働く。triadと呼ぶにふさわしく仕事がバランスよく分担されている。
- ユーザーがViewとインタラクション
- ViewがControllerにユーザーインタラクションを通達
- Controllerがインタラクション内容にそってModelを更新
- Modelが自身の変更をViewに通達
- Viewが更新されたModelを使ってView自身を更新
MVCオルタナティブ
僕がMVCだとおもってたやつでViewはほとんど仕事をしない。自分としてはModelとViewに全く関連性がないのはなかなか良さそうに思うんだけどどうなんだろう。Controllerが仕事しすぎ?
- ユーザーがViewとインタラクション
- ViewがControllerにユーザーインタラクションを通達
- Controllerがインタラクション内容にそってModelを更新
- Modelが自身の変更をControllerに通達
- Controllerが更新されたModelを使ってViewを更新

