Padrão Template Method

Parte da seção Programação Orientada a Objetos do Journey de Dart da Coddy — lição 97 de 110.

O padrão Template Method define o esqueleto de um algoritmo em uma classe base, permitindo que subclasses sobrescrevam etapas específicas sem alterar a estrutura geral. A classe base controla o fluxo de trabalho, enquanto as subclasses personalizam etapas individuais.

Este padrão usa herança: uma classe abstrata define um método template que chama uma sequência de passos, alguns dos quais são abstratos (devem ser implementados por subclasses) e alguns possuem implementações padrão:

abstract class DataProcessor {
  // Método Template - define a estrutura do algoritmo
  void process() {
    readData();
    processData();
    saveData();
  }

  void readData();      // Abstrato - as subclasses devem implementar
  void processData();   // Abstrato - as subclasses devem implementar

  void saveData() {     // Implementação padrão
    print('Data saved to database');
  }
}

class CsvProcessor extends DataProcessor {
  @override
  void readData() => print('Reading CSV file');

  @override
  void processData() => print('Parsing CSV rows');
}

class JsonProcessor extends DataProcessor {
  @override
  void readData() => print('Reading JSON file');

  @override
  void processData() => print('Parsing JSON objects');

  @override
  void saveData() => print('Saved to cloud storage');
}

void main() {
  var csv = CsvProcessor();
  csv.process();
  // Lendo arquivo CSV
  // Analisando linhas do CSV
  // Dados salvos no banco de dados

  var json = JsonProcessor();
  json.process();
  // Lendo arquivo JSON
  // Analisando objetos JSON
  // Salvo no armazenamento em nuvem
}

O método process() é o template — ele define a ordem das operações. As subclasses implementam readData() e processData() de forma diferente e podem, opcionalmente, sobrescrever saveData(). O principal benefício é que a estrutura do algoritmo permanece consistente em todas as implementações, permitindo flexibilidade em etapas individuais.

Desafio

Fácil

Vamos construir um sistema de geração de relatórios usando o padrão Template Method! Você criará uma estrutura onde diferentes tipos de relatórios seguem a mesma estrutura geral, mas cada tipo de relatório personaliza etapas específicas, como a coleta de dados e a formatação da saída.

Você organizará seu código em dois arquivos:

report_generator.dart: Este arquivo contém sua classe base abstrata e as implementações concretas dos relatórios. Crie uma classe abstrata ReportGenerator com um método template chamado generate() que define o fluxo de trabalho de geração de relatório nesta ordem: fetchData(), analyzeData(), formatReport() e deliver(). Os métodos fetchData() e formatReport() devem ser abstratos (cada tipo de relatório os trata de forma diferente), enquanto analyzeData() deve imprimir Analyzing data... e deliver() deve imprimir Report delivered via email. como implementações padrão. Em seguida, crie duas classes de relatório concretas:
- SalesReport - seu fetchData() imprime Fetching sales data from database... e seu formatReport() imprime Formatting as bar charts and tables.
- InventoryReport - seu fetchData() imprime Fetching inventory levels from warehouse..., seu formatReport() imprime Formatting as inventory list., e ele sobrescreve deliver() para imprimir Report sent to warehouse manager.
main.dart: Importe seu arquivo do gerador de relatórios e demonstre como o padrão Template Method mantém a estrutura do algoritmo consistente enquanto permite a personalização. Crie um SalesReport e chame seu método generate(). Em seguida, imprima uma linha vazia para separação. Crie um InventoryReport e chame seu método generate() também.

Observe como ambos os relatórios seguem o mesmo processo de quatro etapas, mas cada um personaliza as etapas que importam para seu propósito específico. O InventoryReport até sobrescreve o método de entrega padrão para enviar relatórios a um destinatário diferente!

Saída esperada:

Fetching sales data from database...
Analyzing data...
Formatting as bar charts and tables.
Report delivered via email.

Fetching inventory levels from warehouse...
Analyzing data...
Formatting as inventory list.
Report sent to warehouse manager.

Folha de consulta

O padrão Template Method define o esqueleto de um algoritmo em uma classe base, permitindo que as subclasses sobrescrevam etapas específicas sem alterar a estrutura geral.

Uma classe abstrata define um método template que chama uma sequência de etapas. Algumas etapas são abstratas (devem ser implementadas pelas subclasses) e outras possuem implementações padrão:

abstract class DataProcessor {
  // Método template - define a estrutura do algoritmo
  void process() {
    readData();
    processData();
    saveData();
  }

  void readData();      // Abstrato - as subclasses devem implementar
  void processData();   // Abstrato - as subclasses devem implementar

  void saveData() {     // Implementação padrão
    print('Data saved to database');
  }
}

class CsvProcessor extends DataProcessor {
  @override
  void readData() => print('Reading CSV file');

  @override
  void processData() => print('Parsing CSV rows');
}

class JsonProcessor extends DataProcessor {
  @override
  void readData() => print('Reading JSON file');

  @override
  void processData() => print('Parsing JSON objects');

  @override
  void saveData() => print('Saved to cloud storage');
}

O método template controla a ordem do fluxo de trabalho. As subclasses personalizam etapas individuais implementando métodos abstratos e, opcionalmente, sobrescrevendo implementações padrão. A estrutura do algoritmo permanece consistente em todas as implementações.

Experimente você mesmo

import 'report_generator.dart';

void main() {
  // TODO: Crie um SalesReport e chame seu método generate()

  // TODO: Imprima uma linha vazia para separação

  // TODO: Crie um InventoryReport e chame seu método generate()
}