Associated Values w Swift: co to jest, składnia i przykłady

Czym są Associated Values?

Associated Values — to dodatkowe informacje, które case enum może przechowywać razem z sobą. W przeciwieństwie do raw values, które są ustalone na poziomie deklaracji, associated values są określane podczas tworzenia instancji enum.

Wyobraź sobie modelowanie metody płatności: case creditCard może przechowywać ostatnie 4 cyfry i datę ważności, a case applePay — nic. Dzięki associated values jest to realizowane naturalnie, bez podklas czy opcjonalnych pól.

Według dokumentacji Apple, associated values przekształcają enum z prostego zestawu stałych w algebraiczny typ danych (sum type), charakterystyczny dla języków funkcyjnych. Znacząco zwiększa to wyrazistość kodu.

Składnia associated values

Associated values są deklarowane w nawiasach okrągłych po case, z podaniem nazw i typów parametrów, jak w funkcjach.

enum MediaFile {
    case image(width: Int, height: Int, format: String)
    case video(duration: Double, codec: String)
    case audio(bitrate: Int)
    case unknown
}

Podczas tworzenia instancji associated values są przekazywane jako argumenty:

let photo = MediaFile.image(width: 1920, height: 1080, format: "jpeg")
let clip = MediaFile.video(duration: 120.5, codec: "h264")

Swift nie nakłada ograniczeń na liczbę ani typy associated values. Możesz używać dżeneryków, funkcji-zamykań i innych enum wewnątrz associated values. Umożliwia to budowanie złożonych zagnieżdżonych struktur.

Nazwy parametrów associated values są używane jako etykiety argumentów podczas tworzenia instancji — poprawia to czytelność kodu. Podczas wydobycia przez switch nazwy służą jako dokumentacja, wyjaśniając znaczenie każdej wartości. Takie podejście sprawia, że kod jest samodokumentujący się i zmniejsza prawdopodobieństwo błędów podczas dopasowywania danych. Jest to szczególnie cenne w zespołowym tworzeniu dużych aplikacji iOS.

Switch z associated values

Switch — główny sposób wydobywania associated values. Wartości są wiązane do stałych lub zmiennych przez let lub var.

func describe(_ file: MediaFile) -> String {
    switch file {
    case .image(let w, let h, let fmt):
        return "Image \(w)x\(h) .\(fmt)"
    case .video(let duration, let codec):
        return "Video \(duration)s, \(codec)"
    case .audio(let bitrate):
        return "Audio \(bitrate)kbps"
    case .unknown:
        return "Unknown format"
    }
}

Swift obsługuje częściowe dopasowanie — można określać konkretne wartości associated values:

switch file {
case .image(let w, let h, "png"):
    print("Obraz PNG \(w)x\(h)")
case .image(1920, 1080, _):
    print("Obraz Full HD")
default:
    break
}

Użycie wildcard (_) pozwala ignorować niepotrzebne associated values, a stałe w case'ach — sprawdzać zgodność z konkretnymi wartościami.

Associated Values vs Raw Values

Wielu początkujących programistów myli associated values z raw values. To różne mechanizmy z różnymi scenariuszami zastosowania.

Według Swift Evolution, associated values zostały wprowadzone w Swift 2.0 jako część przeprojektowania enum. Zapewniają algebraiczne podejście do typów, gdzie każdy case to osobny konstruktor z własną sygnaturą.

Praktyczne przykłady associated values

Associated values są aktywnie wykorzystywane w rzeczywistych projektach iOS. Rozważmy trzy typowe scenariusze.

Modelowanie odpowiedzi API

enum APIResponse<T: Codable> {
    case success(data: T, cached: Bool)
    case failure(error: Error, retryAvailable: Bool)
    case loading(progress: Double)
}

Maszyna stanów UI

enum ViewState<T> {
    case idle
    case loading(message: String)
    case loaded(data: T)
    case error(message: String, retryAction: () -> Void)
}

Dzięki associated values enum zamienia się w potężne narzędzie dla automatów skończonych: każdy case to stan, associated values — parametry tego stanu. Kompilator gwarantuje, że wszystkie przejścia są obsłużone.

Wydobycie przez if case i guard case

Do sprawdzenia jednego case'a bez switch użyj if case lub guard case. Jest to bardziej zwięzłe, gdy trzeba obsłużyć tylko jeden wariant.

let error = NetworkError.timeout(seconds: 30)

if case .timeout(let seconds) = error {
    print("Żądanie przekroczyło limit czasu po \(seconds)s")
}

guard case .httpError(let code, _) = error else {
    return
}
print("Błąd HTTP z kodem \(code)")