Sichere Schatztruhe

Opake Typen

Einführung

Opake Typen sind eine Kapselungstechnik in Elm. Manche nennen das auch Informationsverbergung oder das Verbergen von Implementierungsdetails. Sie werden außerdem häufig eingesetzt, um Validierung zu erzwingen, und zwar mit dem Muster Parse, dont validate. Zum Beispiel könntest du einen opaken Typ EmailAddress haben, der nur gültige E-Mail-Adressen enthalten kann (im Gegensatz zu einem String, der alles enthalten kann).

Einen opaken Typ erstellen

Benutzerdefinierte Typen haben eine oder mehrere Varianten, und der Compiler erzeugt automatisch eine Funktion, um jede Variante zu erstellen, und zwar anhand des Namens der Variante. Das ist die einzige Möglichkeit, benutzerdefinierte Typen zu erstellen. Der Compiler erlaubt außerdem Destrukturierung für diese Varianten.

type Maybe a
    = Nothing --> Variant implies a 'Nothing' function, with type 'Maybe a', and destructuring of 'Nothing'
    | Just a  --> Variant implies a 'Just' function, with type 'a -> Maybe a', and destructuring of 'Just _'

Standardmäßig ist all das intern für die Datei bzw. das Modul, und mit dem Schlüsselwort exposing wählen wir aus, was exportiert wird. Um einen opaken Typ zu erstellen, entscheidest du dich einfach dafür, die Varianten nicht zu exportieren.

Wenn du das tust, musst du fast immer eine andere Möglichkeit bereitstellen, die Varianten zu erstellen und auszulesen, indem du eigene Funktionen exponierst. Diese eigenen Funktionen erlauben es dir, beim Erstellen und Auslesen der Varianten eine gewisse Logik anzuwenden. Das verbirgt die internen Implementierungsdetails des Moduls und bedeutet, dass du die Implementierungsdetails beliebig ändern kannst, solange die exponierten Funktionen gleich bleiben.

Parse, don't validate

Der wohl häufigste Einsatz von opaken Typen ist das Erzwingen von Validierung mit dem Muster Parse, dont validate. Bei diesem Muster exponierst du eine Funktion, die eine Eingabe mit weniger Struktur bzw. Typsicherheit entgegennimmt, als du möchtest, zum Beispiel einen String, und diese dann in einen stärker strukturierten Typ wie EmailAddress parst. Dabei gibst du entweder den Typ zurück oder einen Fehler (meist Maybe oder Result).

Im folgenden Code zum Beispiel können externe Module einen EmailAddress-Typ nur mit der Funktion parseEmailAddress erstellen. Wenn du also mit dem Typ EmailAddress arbeitest, kannst du sicher sein, dass er gültig ist.

module EmailAddress exposing ( EmailAddress, parseEmailAddress, getEmailAddress )

-- The `EmailAddress` custom type has one variant, also called `EmailAddress`
-- When a custom type has one variant, it is idiomatic to use the same name for both.
type EmailAddress = 
  EmailAddress String

-- create an EmailAddress variant
parseEmailAddress: String -> Maybe EmailAddress
parseEmailAddress candidateEmailAddress =   
  if isValidEmailAddress candidateEmailAddress then
    Just (EmailAddress candidateEmailAddress)
  else
    Nothing

-- get an EmailAddress variant
getEmailAddress: EmailAddress -> String
getEmailAddress ( EmailAddress  emailAdress ) =
  emailAdress

isValidEmailAddress: String -> bool
-- ...