Embedded FrameworkをSwiftで作るときはpublicとかinternalとかprivateをしっかり書こう

Posted at 2015-03-13

Embedded FrameworkをSwiftで作成

自分のアプリのWatchKit対応をしながら、そろそろコードをしっかりと共通化させようとしていたらエラーが発生してハマってしまったのでメモ。

エラー発生

プロジェクトの構成はこのようになっています。Extensionは作成せず、Embedded FrameworkであるFrameKitと本体のアプリターゲット、SwiftFrameがあるだけです。

FrameKitにはFrameObjectというクラスを追加しているだけです。

で、これを使おうとしたら "Use of unresolved identifier FrameObject" というエラーがされてコンパイルが通りませんでした。

アクセス制御

原因はアクセス制御でした。

Swiftは モジュール と ソースフファイル をアクセス制御の単位としています。

	アクセスレベル	用途
public	どこからでもアクセス可能	どこからでもアクセス可能なのでframeworkのAPIを定義する場合はこれを使う
internal	デフォルトのアクセスレベル	自身のモジュールと同じモジュールのソースファイル内であればアクセス可能。何も指定しない場合はこれが指定される。
private	最も厳しいアクセスレベル	モジュール内の同じソースファイルでなければアクセスできない。外部に隠蔽しておきたいものはこれを指定。

Swiftはプロジェクト内のターゲットをモジュールとみなすようです。上記のFrameObjectはアクセスレベルを何も指定していなかったのでinternalが指定されている状態、つまりモジュール内でしか読み込めないようになっていました。

これをSwiftFrameターゲットで使用するためにはFrameObjectをモジュール外からも読み込めるようにしなくてはいけません。Objective-Cで書いているときは「公開するのだけヘッダファイルに後で書き足せばいいや」くらいの感じでやっているので気をつけないといけないですね。

ということで、publicを指定すればエラーは起きなくなりました。

最初はクラス名にpublicをつければ問題ないかと思っていたのですが、プロパティはもちろんメソッド名にもアクセスレベルの記述をしなければいけません。

プロパティそれぞれに異なるアクセスレベルを設定してみましょう。先ほど、Embedded Frameworkに作成したFrameObjectクラスをこんな感じに設定します。

Framekit/FrameObject.swift

public class FrameObject: NSObject {

    public   var publicName:   String
    internal var internalName: String
    private  var privateName:  String

    public init(publicName:String, internalName:String, privateName:String) {
        self.publicName   = publicName
        self.internalName = internalName
        self.privateName  = privateName
    }
}

publicなプロパティにはアクセスできますが、internal、privateにはアクセスできません。

今度はFrameObjectを 同一モジュール内に作成 してみましょう。

SwiftFrame/FrameObject.swift

public class FrameObject: NSObject {

    public   var publicName:   String
    internal var internalName: String
    private  var privateName:  String

    public init(publicName:String, internalName:String, privateName:String) {
        self.publicName   = publicName
        self.internalName = internalName
        self.privateName  = privateName
    }
}