少し前から、Macのアプリも動作環境が引き上がり、Swiftを使って開発するようになりました。

Macのアプリでは歴史的な経緯がある処理や既存のコードを活かすべきケースが多くあり、Swiftだけでは完結できません。Objective-CのコードやC/C++のコードを共存させています。

そんな、複数の言語が共存している中でコードを書いていると、Swiftから使いやすくするために、共存させるObjective-Cのコードをブラッシュアップさせて、Swiftから使われる準備をしたり、他のプロジェクトに組み込まれたときのための、予防措置を入れておくべきだなと強い感じます。

ARC対応であることを宣言する

まずは、他のプロジェクトに組み込まれたときのための予防措置です。

macOS 10.6よりも前の時代からメンテナンスし続けているコードの場合、多くは ARC = Automatic Reference Counting に非対応でしょう。そんなことはないぞというところは、コストをかけて、すぐにキャッチアップしてきたか、中小規模のプログラムではないでしょうか？大規模なプログラムの場合、途中で ARC を導入するのは困難です。

私の場合は大規模なプログラムであるために ARC を導入していません。ただ、その中からほんの一部のコードを Swift で書いているプログラムに移植するという機会が生まれました。移植先のプロジェクトはARC対応プロジェクトです。移植するソースファイルだけARCの対象外にすることは設定できますが、将来を考えれば悪手でしょう。ブラッシュアップする良い機会を得たと考えて、ARC対応に修正してから組み込みました。

しかし、このコードが再びどこか別のプロジェクトに移植される可能性は高いと考えられるコードです。再び移植される先はARC非対応プロジェクトかもしれません。そのときに備えて、次のようなコードを書いておきます。

#if !__has_feature(objc_arc)
#error This source file must be compiled with ARC.
#endif

このコードにより、ARC非対応プロジェクトでビルドしようとするとビルドエラーになります。エラーになった先のプロジェクトで、このソースファイルはARCを有効化してビルドされることでしょう。

コメントなどに書いておいても恐らく見ません。気が付かれません。エラーになって初めて気が付くでしょう。

SwiftのOptionalに備える

SwiftにはOptionalという特徴があります。プロパティや引数、関数戻り値がnilになることがあるかどうかをコードで書きます。

Objective-CにはOptionalはありません。Objective-Cはnilになったインスタンスに何かを行っても、無視されるという特徴がある言語です。ある意味ではインスタンスは全てnilになることを前提にしているとも言えるでしょう。

これがSwiftと相性が悪いです。Swift側からObjective-Cのメソッドを呼ぶときに、邪魔になる要素です。

そこで、Objective-Cが進歩しました。nilになる可能性があるか、どうかをObjective-C側で書けるようになりました。Swiftから使うときは、これによって、OptionalなタイプとOptionalではないタイプとにマッピングされるようになりました。

nilになる可能性がない場合は「nonnull」、nilになる可能性があるときは「nullable」を指定します。

次のように、メソッドの戻り値や引数、プロパティなどで指定します。もちろん、これを書くときは適当に書くのではなく、中身の実装も、その指定通りの動作になるようにしましょう。「nonnull」を指定しておきながら「nil」が返ってきたら、Swift側で困ります。というより、たちが悪いです。

@interface MyObject : NSObject

// nilにならないプロパティ
@property (nonnull, nonatomic, strong) NSString *firstName;
@property (nonnull, nonatomic, strong) NSString *lastName;
// nilになるかもしれないプロパティ
@property (nullable, nonatomic, strong) NSString *middleName;

// メソッドの戻り値や引数にも指定する
- (nullable MyObject *)nextObject;
- (nonnull String *)fullNameWithPrefix:(nullable NSString *)prefix suffix:(nullable NSString *)suffix;

@end

コレクションの要素のタイプを書く

NSArrayやNSDictionaryなどで、格納されている要素のタイプを書くようにしましょう。書かないとSwiftではAnyになってしまうので、扱いづらいです。

要素のタイプは次のようなコードで宣言できます。もちろん、Objective-Cなので、宣言していても他のものを入れられます。しかし、トラブルの元なのでやめましょう。

// NSString*の配列
NSArray<NSString *> *stringArray;

// キーがNSNumber*, 値がNSString*のディクショナリ
NSDictionary<NSNumber *, NSString *> *mappingTable;