Baú de Tesouro Seguro

Tipos opacos

Introdução

Tipos opacos são uma técnica de encapsulamento em Elm. Algumas pessoas também chamam isso de ocultação de informações, ou ocultação de detalhes de implementação. Eles também são comumente usados para garantir a validação, usando o padrão Parse, dont validate. Por exemplo, você pode ter um tipo opaco EmailAddress, que só pode conter endereços de email válidos (ao contrário de uma String, que pode conter qualquer coisa).

Criando um tipo opaco

Tipos personalizados têm uma ou mais variantes, e o compilador gera automaticamente uma função para criar cada variante, usando o nome da variante. Essas são a única forma de criar tipos personalizados. O compilador também permite desestruturação para essas variantes.

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 _'

Por padrão, tudo isso é interno ao arquivo / módulo, e usamos a palavra-chave exposing para escolher o que exportar. Para criar um tipo opaco, você simplesmente escolhe não exportar as variantes.

Quando você faz isso, quase sempre precisa fornecer outra forma de criar e obter as variantes, expondo funções personalizadas. Essas funções personalizadas permitem que você aplique alguma lógica ao criar e obter as variantes. Isso oculta os detalhes de implementação internos do módulo e significa que você pode alterar os detalhes de implementação o quanto quiser, desde que as funções expostas permaneçam as mesmas.

Parse, dont validate

Provavelmente o uso mais comum de Tipos opacos é garantir a validação, usando o padrão Parse, dont validate. Nesse padrão, você expõe uma função que recebe uma entrada com menos estrutura / segurança de tipos do que você deseja, como uma String, e então a parseia para um tipo mais estruturado, como EmailAddress, retornando o tipo ou retornando um erro (geralmente Maybe ou Result).

Por exemplo, no código abaixo, só é possível para módulos externos criar um tipo EmailAddress usando a função parseEmailAddress, então quando você está trabalhando com o tipo EmailAddress, você tem certeza de que ele é válido.

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
-- ...