Cocoaの日々

作った。というか古いコードをCocoaPodsで使えるようにまとめた。

使い方は最初に通知を設定

[NSNotificationCenter.defaultCenter addObserver:self
                                       selector:@selector(_updatedLocation:)
                                           name:LKLocationManagerDidUpdateLocationNotification
                                         object:nil];

[NSNotificationCenter.defaultCenter addObserver:self
                                       selector:@selector(_finishedLocation:)
                                           name:LKLocationManagerDidFinishLocationNotification
                                         object:nil];

ハンドラを書いて

- (void)_updatedLocation:(NSNotification*)notification
{
  LKLocationManager* manager = notification.object;
  CLLocation* location = manager.location;
    :
}

- (void)_finishedLocation:(NSNotification*)notification
{
  LKLocationManager* manager = notification.object;
  CLLocation* location = manager.location;
    :
}

位置取得をスタート

[LKLocationManager.sharedManager startUpdate];

十分な精度になるか一定時間が過ぎたら自動的に止まる（詳細はコードを見て!）。

更新→ LKLocationManagerDidUpdateLocationNotification
更新→ LKLocationManagerDidUpdateLocationNotification
　：
精度条件を満たした or タイムアウト
→ LKLocationManagerDidUpdateLocationNotification（最後のコール）
→ LKLocationManagerDidFinishLocationNotification

途中の状態は statusプロパティで取得できる。

typedef NS_ENUM(NSInteger, LKLocationManagerStatus) {
    LKLocationManagerStatusIdle = 0,
    LKLocationManagerStatusLocationUpdating,
    LKLocationManagerStatusLocationUpdated,
    LKLocationManagerStatusLocationCanceled,
    LKLocationManagerStatusLocationFailed
};

stopUpdateを使えば自分で止める事もできるが、最近の機種は精度の高い位置情報を取得するのに時間がかからなくなっているのであまり使う場面は無いと思われる（場所にもよるが）。


別クラスで位置情報から地名を取得する（Reverse Geocoding）クラスも同梱している。

[LKReverseGeocoder reverseGeocodeLocation:manager.location
                        completionHandler:^(NSArray *placemarks,
                                          NSString *addressString,
                                          NSDictionary *addressDictionary,
                                          NSError *error) {
                            self.place.text = addressString;
                              :
                        }];

addressString は AddressBookUI フレームワークを使ってローカライズされた住所を返す。
こんな感じ

東京都千代田区丸の内1丁目9番地1

addressDictionary はこう

{
    City = "San Francisco";
    Country = "United States";
    CountryCode = US;
    FormattedAddressLines =     (
        "Apple Store, San Francisco",
        "1800 Ellis St",
        "San Francisco, CA  94115-4004",
        "United States"
    );
    Name = "Apple Store, San Francisco";
    PostCodeExtension = 4004;
    State = CA;
    Street = "1800 Ellis St";
    SubAdministrativeArea = "San Francisco";
    SubLocality = "Union Square";
    SubThoroughfare = 1800;
    Thoroughfare = "Ellis St";
    ZIP = 94115;
}

FormattedAddressLines からも住所をが得られる（ただこちらは国まで入っている）。

ライブラリにするほどでも無いと思いつつ毎回キャッシュのディレクトリの取得はどうやったっけ、とかディレクトリやらファイル名の処理で毎回同じコードを書いている。Cocoapodsも使い始めたこともあり薄いラッパーを書いた。

使い方は簡単で保存先のディレクトリに応じて LKDocumentArchiver もしくは LKCachesArchiver を選んでクラスメソッドを呼び出すだけ。

アーカイブ

#import "LKDocumentArchier.h"

[LKDocumentDirectoryArchiver archiveRootObject:userList
                                        forKey:@"UserList"];

処理はいたって簡単で下記相当の処理が実行されるだけ。

// filename is equal to (Application Directory)/Documents/UserList.archive
[NSKeyedArchiver archiveRootObject:userList toFile:filename];

ファイル名は渡された key文字列に拡張子 ".archive" を付けたものになる（固定）。

アンアーカイブ

id userList = [LKDocumentDirectoryArchiver unarchiverObjectForKey:@"UserList"];

初回呼び出し時用に初期値も返せる。

id userList = [LKDocumentDirectoryArchiver unarchiveRootObject:userList
                                          forKey:@"UserList"
                                   defaultObject:^id{
                                       return @[].mutableCopy;
                                   }];

あるいは代わりに処理を走らせるなど。

id userList = [LKDocumentDirectoryArchiver unarchiveObject:userList
                                      forKey:@"UserList"
                                     failure:^{
                                        // do something
                                     }];

こちらも中身は NSKyedUnarchiverのメソッドを呼び出しているだけ。

id userList = [NSKeyedUnarchiver unarchiverObjectWithFile:filename];

なお共に @try/@catchで例外対応していて、例外発生時にはNSLogに書き出す。ただし処理は中断しない。

その他
アーカイブファイル削除

[LKDOcumentDirectoryArchiver removeArchiverForKey:@"UserList"];

アーカイブファイルの存在チェック

[LKDocumentDirectoryArchiver archiverExistsForKey:@"UserList"];

キャッシュディレクトリを使いたい場合は LKCachesDirectoryArchiverを使う。

[LKCachesDirecotryArchiver archiveRootObject:userList toFile:filename];

- - - -
コードが短すぎてわざわざライブラリにすべきか微妙ではあるが。。

以前 アプリのできるまで KickReminder で紹介したアプリをバージョンアップした。デザインも一新して iOS7完全対応。2/1に間に合った ^^;


ちなみに以前のデザインはこう。


（当社比）３倍ほど垢抜けた。画面遷移も標準に合わせた（以前はスライド式に重なるビューを使ってた）。

- - - -
自分自身でも意外によく使うアプリの一つになったのだが、デザインが古臭くて気になってた。ユーザからの要望をきっかけに iOS7準拠のデザインに完全にビューを作りなおした。
モデルは書き直しが無かったので、こういうケースでは MVC が非常に役に立った。ビューコントローラはコピペしつつ書き直し。ただグループ名や日付のリストのコントローラは元々非ViewControllerなクラスとして作ってたのでここもモデル同様そのまま再利用できた。UITableViewDataSourceとか UITableViewDelegateの実装にあたるところ。新規開発でも試行錯誤の過程でレイアウトを変えることは頻繁にあるので最近はこのスタイルを取るようにしている。

早速修正

プロパティ定義だけでアーカイブできるライブラリ LKCodingObject公開

class_copyPropertyList で取得できるプロパティには親クラスのリストが含まれないことに実際のプロジェクトで使っていたら気がついた。この為、親クラスで定義されているプロパティがアーカイブ/アンアーカイブの対象にならない。

そこで再帰的に親クラスを取得してプロパティ名を取得するように手を入れた。

- (void)_propertyNamesForClass:(Class)cls propertyNames:(NSMutableArray*)propertyNames
{
    Class superClass = class_getSuperclass(cls);
    if (superClass != [NSObject class]) {
        [self _propertyNamesForClass:superClass propertyNames:propertyNames];
    }

    unsigned int count, i;
    objc_property_t *objc_properties = class_copyPropertyList(cls, &count);
    
    for(i = 0; i < count; i++) {
        objc_property_t objc_property = objc_properties[i];
        NSString* name = [NSString stringWithUTF8String:property_getName(objc_property)];
        [propertyNames addObject:name];
    }
    free(objc_properties);
    
}

サブクラスのテストケースも加えておいた。
なお誤ってタグを 1.1にしてしまった（1.0は欠番）。

プロパティネタの第２弾。


使い方は簡単で LKCodingObject を派生しておいて、普通にプロパティを定義するだけ。

#import "LKCodingObject.h"

@interface UserInfo : LKCodingObject
@property (strong, nonatomic) NSString* name;
@property (strong, nonatomic) NSString* email;
@end

アーカイブ

UserInfo* userInfo = UserInfo.new;
userInfo.name = @"Hoge";
userInfo.email = @"hoge@xcatsan.com";
[NSKeyedArchiver archiveRootObject:userInfo toFile:@"user_info.dat"];

アンアーカイブ

UeserInfo* userInfo = [NSKeyedUnarchiver unarchiveObjectWithFile:@"user_info.dat"];

通常だと NSCodingプロトコルのメソッド initWithCoder: encodeWithCoder: を実装する必要があるが、このライブラリを使うとサブクラス化するだけでメソッドを書かずにアーカイブ・アンアーカイブできる。


ライブラリのコードは簡単で initWithCoder: encodeWithCoder: を実装しているだけ。

- (id)initWithCoder:(NSCoder*)decoder
{
    self = [super init];
    if (self) {
        for (NSString* name in self._propertyNames) {
            id value = [decoder decodeObjectForKey:name];
            [self setValue:value forKey:name];
        }
    }
    return self;
}

- (void)encodeWithCoder:(NSCoder *)coder
{
    for (NSString* name in self._propertyNames) {
        id value = [self valueForKey:name];
        if ([value conformsToProtocol:@protocol(NSCoding)]) {
            [coder encodeObject:value forKey:name];
        }
    }
}

プロパティ名をランタイム関数から取得してきて KVCでセット・ゲットしてる。intやfloatのプロパティも適当にラップしてくれてうまく動く。

プロパティ名取得

- (NSArray*)_propertyNames
{
    NSMutableArray* propertyNames = @[].mutableCopy;
    
    unsigned int count, i;
    objc_property_t *objc_properties = class_copyPropertyList(self.class, &count);
    
    for(i = 0; i < count; i++) {
        objc_property_t objc_property = objc_properties[i];
        propertyNames[i] = [NSString stringWithUTF8String:property_getName(objc_property)];
    }
    free(objc_properties);
    return propertyNames;
}

注意点としては、NCodingに準拠していないクラスのプロパティは無視すること。エラーにならないので注意。
ここは例外を飛ばすとかしたほうがいいのかもしれない。


- - - -
CocoaPods 便利だわ。諦めてた自作コードの再利用が進む進む。特に小さなコードはコピペしてしまうのが常だったが CocoaPodsだと管理が苦にならない。ただ CocoaPods対応が若干面倒なのでこの辺りの自動化がもう少しできると良さそう。

前回のフォローと記録を兼ねて。

この型判定がくせものでランタイム時に提供される情報（NSMethoSignatureなど）では引数/戻り値のクラスを知る方法を見つけることができなかった（オブジェクト=idであることしかわからなかった）。setterの場合は引数の型でそれが判断できるが getterの場合　Property List から取り出した NSData から判断するしかない。

と書いたが何のことはない、ランタイム関数を使えばプロパティのクラス名（文字列）が取得できるのでそれを使えばいい。
こんな感じ

- (NSString*)classNameForKey:(NSString*)key
{
    NSString* className = nil;
    
    objc_property_t property = class_getProperty(self.target.class, key.UTF8String);
    const char* value = property_copyAttributeValue(property, "T");
    if (value && value[0] == '@') {
        NSString* valueString = [NSString stringWithUTF8String:&value[1]];
        className = [valueString stringByReplacingOccurrencesOfString:@"\"" withString:@""];
    }
    return className;
}

property_copyAttributeValue のキーは property_copyAttributeList()で取得した objc_property_attribute_t.key を見るとわかる。例えば NSString の場合はこんな感じ。

T: @"NSString"
&:
N:
V: _stringValue

属性 T の場合の値が型を表していてオブジェクト型の場合はタイプが @ でその後に "クラス名" が続く。プリミティブ型の場合、クラス名はつかない。
以下はintegerの場合

T: i
N: 
V: _integerValue

上記メソッドを使う方法で LKUserDefaultsを修正した。これをもってVer1.0.0としてみた。

前回（Cocoaの日々: NSUserDefaults の値をプロパティアクセスできるようにする）のコードをライブラリ化して公開した。


使い方は、まずサブクラスを作りプロパティを書く。

#import "LKUserDefaults.h"

@interface UserDefaults : LKUserDefaults
@property (strong, nonatomic) NSString* name;
@property (strong, nonatomic) NSString* email;
@end

後はプロパティへアクセスするだけで自動的に NSUserDefaultsへの読み書きが行われる。

UserDefaults* defaults = [UserDefaults sharedInstance];
defaults.name = @"Hoge";        // キー "name" で NSUserDefaults へ書き込み
    :
NSString* name = defaults.name; // キー "name" の値を NSUserDefaults から読み出し

初期値を設定しておくこともできる。

- (void)registerDefaults
{
    self.name = @"unkown";
    self.name = @"unkown@xcatsan.com";
}

上記を定義しておくと、未設定の値を読みだした時にこの値が使われる。

定義可能なプロパティの型は NSUserDefaults と同じ。

@property (assign, nonatomic) BOOL boolValue;
@property (assign, nonatomic) NSInteger integerValue;
@property (assign, nonatomic) float floatValue;
@property (assign, nonatomic) double doubleValue;

@property (strong, nonatomic) NSString* stringValue;
@property (strong, nonatomic) NSArray* arrayValue;
@property (strong, nonatomic) NSArray* stringArrayValue;
@property (strong, nonatomic) NSDictionary* dictionaryValue;
@property (strong, nonatomic) NSData* dataValue;
@property (strong, nonatomic) NSURL* urlValue;
@property (strong, nonatomic) NSDate* dateValue;

オブジェクト型のプロパティの定義では ARC属性を strongにしておく。これは上記 registerDefaults の値を保持しておくため。

- - - -
実装のポイントは前回解説のように NSProxy をかましてプロパティへのアクセスをフックしているところにある。

前回記事：Cocoaの日々: NSUserDefaults の値をプロパティアクセスできるようにする

ライブラリでは汎用性のある部分を抽出して LKKeyValuStore と LKPropertyHook というクラスを作り、それを LKUserDefaults と LKUserDefaultsProxy が継承するようにしている。この為、若干読みづらいコードになっているかもしれない。今回は用意していないが NSUbiquitosKeyValueStore 用のクラスを用意すればiCloudの値も同じように使うことができる（たぶん）。


ハマったところとしては NSURL の格納部分。NSURL自体は NSuserDefaults のファイル形式である Property List には入れられない型だが NSUserDefaults では専用のメソッド（setURL:forKey:, URLforKey:）を用意していて、内部的に NSDataに変換して Property List へ入れている。この為、プロパティアクセスをフックしている今回の場合はプロパティの型情報を見てNSURLの時だけ適宜 NSDataへ変換してやる必要がある。この型判定がくせものでランタイム時に提供される情報（NSMethoSignatureなど）では引数/戻り値のクラスを知る方法を見つけることができなかった（オブジェクト=idであることしかわからなかった）。setterの場合は引数の型でそれが判断できるが getterの場合　Property List から取り出した NSData から判断するしかない。この為今回は NSUserDefaults から取得したオブジェクトが NSData の場合は無理やり URLforKey: を使って変換を掛けて、変換に成功したら NSURL として返し、失敗したら例外をキャッチして NSData のまま返すようにしている。ちょっとむりくりだけど。

なお形態としてはシングルトンになるが、複数クラスを定義したり、それらを継承関係にしたりすることができるようにしてある。ただしアクセス対象の NSuserDefaults は一つだけ（standardUserDefaults）。


課題・エンハンス案など
・現在はプロパティの先頭が小文字で始まることを前提にしている
・プロパティ名を途中で変更した場合、旧名の値が残り続ける（もしくは引き継げない）
・クラス定義毎に NSuserDefaults を作ることができるようにする
・擬似的な名前空間を作れるようにする（例えば VolumeSetting.name のようなキーで登録できるようにする）

何かあれば pull request をどうぞ。