Enums com extensions no Dart

Explore como extensions do Dart podem adicionar comportamento a enums e tornar o código baseado em enums mais fácil de ler e manter.

Enums com Extensions no Dart

Como escrever código mais limpo usando métodos de extensão no Dart

Exemplo de código Dart usando um método de extensão
Exemplo de código Dart usando um método de extensão

O Dart lançou recentemente o suporte a métodos de extensão, o que significa que agora você pode usar este recurso incrível. Este artigo descreve um exemplo de como eu uso métodos de extensão no meu código Flutter.

Sempre usei enums no meu código Flutter, mas integrar enums e métodos de extensão tornou o desenvolvimento em Flutter mais fácil e o código mais limpo de ler.

Digamos que você crie uma enumeração e que o seu texto dependa do enum. Antes, eu usaria uma instrução switch dentro do Widget por meio de IIFE (post do blog). Uma expressão de função invocada imediatamente permite invocar um método anônimo, que é um padrão útil do Dart. Mas usar esse padrão pode levar a código espaguete, como mostrado no exemplo abaixo. Além disso, se você precisar adicionar o mesmo texto em outro lugar, teria que copiar o trecho de código inteiro em vez de apenas fazer uma chamada de função.

dart
Text((){
​
  switch (selectedColor) {
​
    case SelectedColor.PrimaryColor:
​
      return 'This is the Primary Color';
​
    case SelectedColor.SecondaryColor:
​
      return 'This is the Secondary Color';
​
    default:
​
      return 'SelectedScheme Title is null';
​
  }
​
}()),
​
Text((){
​
  switch (selectedColor) {
​
    case SelectedColor.PrimaryColor:
​
      return 'This is the Primary Color';
​
    case SelectedColor.SecondaryColor:
​
      return 'This is the Secondary Color';
​
    default:
​
      return 'SelectedScheme Title is null';
​
  }
​
}()),

Além disso, e se você precisar mudar a cor do texto com base no enum? Você precisaria usar outro IIFE para obter o PrimaryColor ou SecondaryColor.

Em vez disso, você pode estender seu enum e criar um método dentro dessa extensão, assim você não precisa usar um IIFE. Assim, quando você invocar seu método no código, ele fica mais limpo, mas ainda produz o mesmo resultado. Esta é uma técnica importante que desenvolvedores Java conhecem e é uma capacidade esperada em enums.

dart
enum SelectedColor {
​
  primaryColor,
​
  secondaryColor,
​
}
​
extension SelectedColorExtension on SelectedColor {
​
  String get name => describeEnum(this);
​
  String get displayTitle {
​
    switch (this) {
​
      case SelectedColor.PrimaryColor:
​
        return 'This is the Primary Color';
​
      case SelectedColor.SecondaryColor:
​
        return 'This is the Secondary Color';
​
      default:
​
        return 'SelectedScheme Title is null';
​
    }
​
  }
​
}

A função describeEnum(), definida na biblioteca de fundação do Flutter, remove o nome da classe do enum de enumEntry.toString(). Forneço o código abaixo caso você queira usá-lo fora do desenvolvimento Flutter, em outros projetos Dart:

dart
String describeEnum(Object enumEntry) {
​
  final String description = enumEntry.toString();
​
  final int indexOfDot = description.indexOf('.');
​
  assert(indexOfDot != -1 && indexOfDot < description.length - 1);
​
  return description.substring(indexOfDot + 1);
​
}

Para brincar com o exemplo mencionado acima, experimente este Pen.

No exemplo completo, que você pode ver no CodePen acima, o enum é estendido com quatro métodos: displayTitle(), displayColorChangeText(), color() e getRandomSelectedColor(). Ao chamar o método displayTitle() no código Flutter, você pode ver que o código fica modularizado, mais limpo em comparação com o IIFE. Além disso, se você decidir adicionar outra variável ao enum, é mais fácil atualizar, já que todo o código está dentro da extensão. Isso se vê quando o método color() foi chamado para mudar a cor do texto. Se eu quisesse fazer isso com o IIFE, o código ficaria complicado rapidamente. Também é mais fácil adicionar métodos no futuro usando extensões; você pode ver isso quando o método color() foi invocado no CodePen.

A Flutter Gallery usa enums com extensões ao lidar com demos de categorias. A Gallery usa enums para categorizar o código das demos e usa métodos de extensão quando quer converter a enumeração em texto para o aplicativo.

Considerações finais

Métodos de extensão são uma ferramenta poderosa fornecida pelo Dart. Ao usar enums e métodos de extensão juntos, você pode ter um código mais limpo e escalável.

Saiba mais sobre padrões úteis do Dart em 3 padrões legais do Dart para a programação do dia a dia no Flutter.

Sobre o autor: Jose se formou recentemente na universidade e agora trabalha no Material, um design system que ajuda equipes a criar experiências digitais de alta qualidade. A equipe do Jose mantém a biblioteca material do Flutter.

Para saber mais sobre o Jose, visite as páginas dele no GitHub, LinkedIn, YouTube e Instagram.

Mais do Flutter