クラス/構造体のプロパティ#

Mirror を利用する方法#

【Swift 5.x】クラス/構造体のプロパティ名を取得するが大変参考になりました。

• インスタンスが必要

import Foundation

class UserResultList: Codable {
    var path: String = "/results"
    let userId: String
    let startTime: Date
    let endTime: Date

    init(userId: String, startTime: Date, endTime: Date) {
        self.userId = userId
        self.startTime = startTime
        self.endTime = endTime
    }

    // Mirror.Childrenを辞書に変換
    var properties: [String: String] {
        Mirror(reflecting: self).children
            .filter({ $0.label != .none })
            .reduce(into: [:]) {
                $0[$1.label!] = $1.value as? String
            }
            .compactMapValues({ $0 })
    }
}

注意点としてはインスタンスがないとMirrorは利用できないという点です。つまりstatic varやclass varは利用できません。

プロパティを表示するビュー#

ただ定義しただけではどのように動いているかわからないので、中身を表示するように以下のようなプロパティビューワーを作成します。

struct PropertyView: View {
    @State var request: RequestType
    @State var toggle: Bool = false
    @State var stepper: Int = 0

    var body: some View {
        ForEach(request.properties, id:\.key) { key, value in
            HStack {
                Text(key)
                Spacer()
                Text(value as? String ?? "-")
                    .foregroundColor(.secondary)
            }
        }
    }
}

::: warning 型の問題

クラスのプロパティは単にString型だけではなくInt型やDate型やBool型など様々なものが考えられる。

それら全てに本来は対応しなければいけないのだが、今回はとりあえずString型のみ考え、String型にキャストできないプロパティについては-で表示することとした。

:::

これを利用すればContentViewを次のように定義できます。

struct ContentView: View {
    @State var requests: [RequestType] = [
        UserResultList(userId: "tkgling", startTime: Date(), endTime: Date()),
        UserResult(userId: "tkgling", resultId: 0)
    ]

    var body: some View {
        Form {
            ForEach(requests, id:\.path) { request in
                Section(header: Text(String(describing: type(of: request)))) {
                    PropertyView(request: request)
                }
            }
        }
    }
}

::: warning プロトコルの配列を ForEach する

プロトコルの配列はそのままでは ForEach でループさせることができない。何故なら、プロトコルの配列は順序というものが定義できず、一意性が保証されないためだ。基本的にはIdentifiableに適合させる必要があるのだが、Identifiableに適合するとtypeAliasが必要になり今度はプロトコルを適合したインスタンスを配列にできなくなる。

よってIdentifiableに適合させずに ForEach を利用する方法を考えなければいけない。このときに利用できるのがidでこれを使ってユニークなプロパティを指定して一意性を強制的に保証する。今回の場合だとpathは必ず全てのRequestType適合のクラスで異なるはずなのでこれを指定した。

:::

値を変更できるようにする#

とはいえ、このままでは単にインスタンスに設定されている値を表示しているだけなのでその値を変更できるようにしましょう。

SwiftUI は構造体なので単に変数を指定しても値を更新することができません。よって値を SwiftUI フレームワークで管轄できるようにStateの Property Wrapper を設定する必要があります。

ところがここで気になるのはPrpertyViewが受け取ったリクエストによってどんなパラメータを設定するかが異なるという点です。つまり、予め「String 型のプロパティが 5 つあるから、5 つの変数を用意しておこう」といったことができません。

更に困ったことにRequestTypeはuserIdとpathしか定義していないためrequest.startTimeのようにアクセスすることができません。

そこで@DynamicMemberLookupという機能を使ってみます。

使い方#

やることは簡単で、まずは適用したいクラス、構造体、プロトコルに対して@dynamicMemberLookupをつけます。

@dynamicMemberLookup
protocol UserType {
    var id: Int { get set }
    var userName: String { get set }
    var rank: UserRank { get set }
}

extension UserType {
    subscript<T>(dynamicMember keyPath: KeyPath<UserRank, T>) -> T {
        rank[keyPath: keyPath]
    }
}

そしてExtensionでsubscriptを定義します。これがないとコンパイルエラーが発生します。

subsciptはいろいろな定義ができるのですが、

subscript<T>(dynamicMember keyPath: KeyPath<XXXXXXXX, T>) -> T {
    YYYYYYYY[keyPath: keyPath] // XXXXXXXX型のプロパティYYYYYYYYを指定
}

の書き方が良いかと思います。

注意点としてはYYYYYYYYは存在するプロパティでないとだめだということです。

var users: [UserType] = [UserInfo(), PlayerInfo()]
for user in users {
    print(user.rankId) // user.rank.rankIdにアクセスしているのと同等
}

注意点#

@dynamicMemberLookup
protocol UserType {
    var id: Int { get set }
    var userName: String { get set }
    var rank: UserRank { get set }
    var colorType: Color { get set }
}

extension UserType {
    subscript<T>(dynamicMember keyPath: KeyPath<UserRank, T>) -> T {
        rank[keyPath: keyPath]
    }
    subscript<T>(dynamicMember keyPath: KeyPath<Color, T>) -> T {
        colorType[keyPath: keyPath]
    }
}

このように複数のsubscriptを定義することもできます。

このとき注意しないといけないのはUserRankとColorのプロパティ名が被ってしまうとDynamicMemberLookupが使えなくなることです。

class UserRank {
    var rankId: Int = Int.random(in: 0 ... 100)
    var rankName: String = "Intern"
    var description: String = "UserRank Class" // 追加　

    init() {}
    init(rankId: Int, rankName: String) {
        self.rankId = rankId
        self.rankName = rankName
    }
}

例えば、UserRankクラスに新たなプロパティdescriptionを追加します。実はこのプロパティはColorクラスにも存在するので、

var users: [UserType] = [UserInfo(), PlayerInfo()]
for user in users {
    print(user.rankId)
    print(user.description) // Ambiguous use of 'subscript(dynamicMember)'
}

というエラーが発生し「どちらの subscript を使えばよいかわからない」という内容が表示されます。

プロパティ名は被らないようにするか、被ったときにはちょっとめんどくさいですがuser.rank.descriptionのようにどちらかを明示するようにしましょう。

計算プロパティ#

@dynamicMemberLookup
protocol UserType {
    var id: Int { get set }
    var rank: UserRank { get set }
}

extension UserType {
    var colorType: Color {
        Color.yellow
    }

    subscript<T>(dynamicMember keyPath: KeyPath<Color, T>) -> T {
        colorType[keyPath: keyPath]
    }
}

このように計算プロパティであっても正しく動作します。

配列で利用する#

配列はオブジェクトではないため直接利用できないのですが、いろいろと奇妙な振る舞いが楽しめます。

@dynamicMemberLookup
protocol UserType {
    var id: Int { get set }
    var userName: String { get set }
    var colorType: [Color] { get set }
}

extension UserType {
    subscript<T>(dynamicMember keyPath: WritableKeyPath<[Color], T>) -> T {
        return colorType[keyPath: keyPath]
    }
}

このような感じで定義して、適当に値を代入してみると、

var users: [UserType] = [UserInfo(), PlayerInfo()]
for user in users {
    print(user.colorType) // -> [red, blue, gray]
    print(user[0]) // -> red
}

なんとuser[0]にアクセスするとuser.colorType[0]と同じ扱いになるので.redが表示されました！