Classes Adaptadoras


Os dados sempre deverão estar encapsulados em Objetos que conversam entre si enviando mensagens uns aos outros. No entanto essas mensagens podem conter dados no formato que só o Objeto emissor conhece.

Como o Objeto receptor irá saber ler esses dados que, outrora, estavam encapsulados no Objeto emissor?

Unsplash image

Introdução

Cada Objeto detém o conhecimento sobre seus próprios dados encapsulados. Ninguém mais.

Para um sistema funcionar esses Objetos devem conversar entre si, enviando mensagens uns aos outros.

Sabemos o que fazer quando queremos saber informações sobre um determinado Objeto. Basta utilizar seu Método About.

Você, programador, sabe o que fazer com esses dados pois você detém o conhecimento sobre todas as Classes e Objetos. No entanto são os Objetos que devem conversar entre eles mesmos. Você está fora dessa conversa. Você não pode ajudá-los. Esse é o problema.

Então deve haver uma maneira do Objeto emissor conversar com o Objeto receptor, utilizando um mesmo dialeto, sem que você faça conversões explícitas para que essa conversa aconteça.

Dados entre Formulários

Sempre que utilizamos formulários — ou qualquer tipo de view — é porque queremos exibir alguma informação para que o usuário tome alguma decisão ou execute alguma tarefa.

Esses formulários podem obter seus dados quando são criados ou posteriormente, devido a alguma ação do usuário.

Vamos nos concentrar nesses dados inicias.

Imagine um sistema Financeiro. Há dois formulários:

  1. Faturas a Pagar
  2. Opções de Pagamento

No formulário de Faturas a Pagar o usuário irá selecionar as faturas, clicar em algum botão para pagar e, nesse momento, um outro formulário com as Opções de Pagamento será exibido.

O que o formulário de Faturas a Pagar deveria enviar para o formulário de Opções de Pagamento no seu construtor?

Bem, isso depende.

Antes precisamos definir, nesse pequeno exemplo, o que é uma Fatura a Pagar, assim como o que são Opções de Pagamento.

Vamos nos concentrar nos dados:

  1. Uma Fatura encapsula um número sequencial, um valor a pagar original, um valor a pagar atual (com multa e juros), uma data, uma descrição, itens… vamos parar aqui.

  2. Uma Opção de Pagamento encapsula opções (dinheiro, cartão de crédito, etc), valor para cada opção, valor total a pagar e… tudo bem, já está bom.

Oções de Implementação

Agora que temos algumas definições, podemos pensar no modelo que iremos seguir para determinar como será feita a implementação.

Vamos ver as opções.

1- Banco de dados e registros

Não pense em dados provenientes de um banco de dados, queries ou DataSet. Os dados já estão no formulário, numa grid listando todas as faturas.

Você já tem tudo que precisa nos widgets do formulário. Não há necessidade de fazer uma nova requisição de dados.

E agora, ficou mais fácil?

Ainda não.

Se toda Entidade deve ser representada por um Objeto, você já sabe que não são apenas 2 Objetos (formulários) que irão fazer parte dessa conversa. Haverá outros Objetos.

Mas lembre-se que ainda estamos falando de dados.

2- Objetos anêmicos e listas

Não pense em criar Classes Anêmicas como TInvoice com todos os campos acima, utilizando Getters e Setters e uma lista TInvoices para passar ao formulário de Opções de Pagamento.

Pensou nisso mesmo?

Essa é uma opção de implementação que irá acoplar ambos os formulários a essa lista de Faturas. E isso irá restringir o formulário de Opções de Pagamento.

Então vamos adicionar um complicador:

  • O formulário de Opções de Pagamento será utilizado para pagar qualquer coisa dentro do sistema, ou seja, não apenas Faturas.

Nesse caso uma refatoração seria necessária.

Ainda acha que criar uma lista de Faturas seria a melhor opção?

3- Herança e esperança

Ora, vamos criar uma lista genérica ou Interface, utilizar herança para TInvoices e refatorar o formulário para receber essa lista.

É claro que não.

Já sabemos que herança não foi feita para compartilhar código e que ela pode piorar (e muito) a arquitetura do projeto.

Essa seria uma das piores opções. Esqueça-a.

4- Manualmente

Então você, o programador, manipula os dados do formulário de Faturas, criando um XML que você sabe que o formulário de Opções de Pagamento espera receber — porque você pode ver o código-fonte de todas as Classes — e então repassa esse XML para o formulário de Opções de Pagamento.

É, talvez irá funcionar… mas por quanto tempo?

Sabendo que o formulário de Opções de Pagamento pode ser utilizado por outros módulos, se houver alguma alteração nos dados que ele espera receber, será muito difícil procurar em todos esses lugares para fazer alterações. Cada equipe que trabalha em módulos distintos — mas que utiliza esse mesmo formulário — pode ter criado suas próprias versões do XML para enviar ao formulário. O código foi duplicado. Terrível.

5- Classes Adaptadoras

Minha sugestão é utilizarmos Classes Adaptadoras.

Elas poderão ser muitas. Vai depender de quantos módulos/classes irão utilizar o formulário de Opções de Pagamentos.

Classes Adaptadoras são conectores. Elas adaptam as interfaces, adaptam os contratos que cada Objeto tem para com o sistema.

Elas tornam possível uma Classe-A trabalhar em conjunto com a uma Classe-B, mesmo que ambas não se conheçam.

Os programadores só precisam saber que essas Classes Adaptadoras existem e onde estão guardadas, quando eles precisarem delas.

Adaptando

No formulário de Faturas a Pagar teremos, no mínimo, mais duas Classes que irão fazer parte da conversa. São elas:

  1. A Classe TGridSelectedRows
  2. A Classe TInvoiceMedia

A Classe TGridSelectedRows é responsável por adaptar as linhas selecionadas da grid para o formato XML — ou qualquer outro formato que lhe agrade — e seu resultado é utilizado ou validado pela TInvoiceMedia.

TInvoiceMedia.New(
  TGridSelectedRows.New(
    InvoiceGrid, 'invoices', 'invoice'
  )
  .Stream
)

A chamada a TGridSelectedRows::Stream irá retorna uma instância de IDataStream (veja aqui a implementação). Os outros argumentos são utilizados para criar o XML dessa forma:

<invoices>
  <invoice>
    <number...
    <value...
  </invoice>
  <invoice>
    <number...
    <value...
  </invoice>
</invoices>

A implementação de TGridSelectedRows não é relevante para o entendimento do problema.

Nesse exemplo TInvoiceMedia implementa IDataStream. Mas essa classe também terá a inteligência para validar o XML (stream) que foi lhe passado no construtor.

Então temos o XML válido com todas as faturas encapsulado em TInvoiceMedia. Precisamos agora de uma Classe Adaptadora para transformar Faturas no formato que Opções de Pagamento entenda.

E aqui vai uma dica importante: A Classes que adaptam um conceito devem estar “próximas” umas das outras para que seja fácil para o programador achá-las e utilizá-las.

Vamos dar nomes as outras Classes:

  • Formulário Opções de Pagamento: TPaymentOptionsForm
  • Tipo do argumento no construtor do Formulário: IPaymentOptionsMedia
  • Classe Adaptadora de Faturas para Opções: TPaymentOptionsForInvoices

O código do evento no botão para exibir as Opções de Pagamento, ou seja, a chamada do formulário, seria parecido com o código abaixo:

with
  TPaymentOptionsForm.Create(
    TPaymentOptionsForInvoices.New(
      TInvoiceMedia.New(
        TGridSelectedRows.New(
          InvoiceGrid, 'invoices', 'invoice'
        )
        .Stream
      )
    )
  )
do
  try
    ShowModal;
  finally
    Free;
  end;

A Classe TPaymentOptionsForInvoices irá receber o XML de Faturas a Pagar e irá adaptar num XML de Opções de Pagamento (somar todos os valores das faturas, verificar alguma insconcistência, etc).

O formulário de Opções de Pagamento só conhece implementações de IPaymentOptionsMedia, que é a Interface implementada por TPaymentOptionsForInvoices.

Para todos os outros casos de pagamentos, basta criar outra Classe Adaptadora especialista com o mesmo prefixo TPaymentOptionsFor... para facilitar o code-completion quando o programador estiver procurando um conector.

Quando houver alguma alteração no XML que o formulário Opções de Pagamento recebe, basta alterar as Classes Adaptadoras. Você saberá exatamente onde procurar. E, tão importante quanto, é ter em mente que essas Classes poderão compartilhar código entre elas bastando criar mais Classes especialistas — talvez privada na unidade.

Conclusão

Classes Adaptadoras e Interfaces é como plugamos as peças dentro de um software Orientado a Objetos.

Em alguns casos pode ser bem difícil identificar essas Classes ou a melhor forma de implementá-las. Mas, não desista, pois vale muito a pena. Seu código irá ficar mais desacoplado, sem duplicação e muito mais reutilizável.

Dessa forma um Objeto receptor saberá ler os dados de Objetos emissores mesmo sem conhecê-los intimamente.

Até logo.

Posts Relacionados

  • Redefinindo Classes

  • Git-work Project

  • Imutabilidade do Estado

  • Diretivas de Compilação

  • Declarando Unidades

  • James 2017-07

  • Objetos Validadores

  • Atributos Não Existem

  • Mutabilidade Encapsulada

  • Atributos Primários e Secundários