DesignPatternSamples

Branch	Build
Develop
Main

Aplicação de exemplo de aplicação de Design Patterns na prática em um projeto WebAPI .NET Core 3.1 utilizada na palestra "Aplicando design patterns na prática com C#" (Link Apresentação)

Testes de Cobertura

Passo a passo sobre como executar os testes unitários (e calcular o code coverage) localmente antes de realizar o commit.

Obs.: O VS2019 possui esta funcionalidade nativamente, porém ela só está habilitada para a versão Enterprise segundo a documentação da própria Microsoft.

Pré-Requisitos

Para gerar o relatório é necessário instalar o dotnet-reportgenerator-globaltool

dotnet tool install --global dotnet-reportgenerator-globaltool --version 4.6.1

Execução

Executar o .bat para realizar a execução dos testes automatizados com a extração do relatório de cobertura na sequência.

$ test-coverage.bat

Padrões na Prática

Strategy

Problema:

Nosso objetivo é Utilizar o método Distinct do System.Linq, este por sua vez espera como entrada uma IEqualityComparer. Isso por si só já representa uma implementação de Strategy, entretanto nós não queremos criar uma única implementação engessada que nos permita comparar um determinado objeto de uma única forma.

Solução:

1. Criar uma classe que implemente a interface IEqualityComparer;
2. Esta classe deve receber o 'como' os objetos deverão ser comparados através de um parâmetro, que neste caso é uma função anônima;

Desta forma a classe que criamos sabe comparar objetos, porém ela não sabe os critérios que serão utilizados, os critérios serão injetados através de uma função anônima.

Implementação
Consumo

Podemos tornar o consumo ainda mais interessante criando uma Sugar Syntax através de métodos de extensão.

Implementação
Consumo

Desta forma através do padrão Strategy estamos aderentes ao princípio Aberto-Fechado e Inversão de Controle.

Factory

Problema:

Nós queremos criar um serviço de consulta de débitos do veículo que seja capaz de acessar o sistema do DETRAN e obter estas informações, porém o DETRAN possui uma aplicação completamente diferente de acordo com o estado.

Nós não queremos modificar o nosso serviço sempre que um novo estado for implementado.

Solução:

1. Criar uma interface que determine uma assinatura única para o serviço;
2. Realizar uma implementação para cada um dos estados;
3. Criar uma classe Factory, onde sua responsabilidade será determinar qual classe concreta deverá ser instanciada;

Implementação
Consumo
Teste

Desta forma através do padrão Factory estamos aderentes ao princípio Aberto-Fechado.

Neste exemplo o nosso Factory ainda está diretamente relacionado ao princípio Substituição de Liskov.

Singleton

Problema:

Visto que o nosso Factory tem como responsabilidade apenas identificar a classe concreta que teve ser inicializada a partir de um Setup pré-estabelecido no Startup da aplicação, não faz sentido que ele seja instanciado a cada solicitação.

Solução:

Como estamos fazendo uso da Injeção de Dependência nativa do .Net Core processo se torna mais simples:

1. Modificar o registro no Startup para que o serviço seja registrado como Singleton.

Implementação

Com isso nós temos uma única instância sendo inicializada e configurada no Startup da aplicação.

Template Method

Problema:

Visto que em algum momento iremos implementar 27 serviços diferentes para acessar os DETRAN que temos espalhados pelo Brasil.

Entendemos que, mesmo que, os sites sejam diferentes, os passos necessários para extrair a informação costumam ser semelhantes:

• Consultar Site
• Consolidar Resultado

Como a nossa interface IDetranVerificadorDebitosRepository possui apenas o método ConsultarDebitos, nosso código corre risco de não ficar padronizado e ainda perdermos o princípio da Responsabilidade Única.

Solução:

1. Criar uma classe abstrata com métodos mais específicos para realizar o trabalho desejado;
2. A classe abstrata 'deve' implementar o método exposto pela Interface;
3. Ao invés das classes implementarem a Interface, elas herdarão o comportamento da classe abstrata, implementando apenas os métodos mais específicos.

Com isso torna-se mais fácil:

• Dividir o trabalho;
• Testar o código.

Implementação
Consumo

O neste exemplo o nosso Template Method ainda seguindo o princípio Segregação da Interface, onde os métodos específicos foram adicionados na nossa classe abstrata DetranVerificadorDebitosRepositoryCrawlerBase, desta forma conseguimos atingir também o princípio de Substituição de Liskov.

Decorator

Problema:

Com o serviço DetranVerificadorDebitosServices identificamos que precisamos adicionar funcionalidades técnicas a ele (como por exemplo Log e Cache), porém essas funcionalidades não devem gerar acoplamento no nosso código.

Então como fazer isso sem quebrar os princípios Responsabilidade Única e Aberto-Fechado?

Solução:

Neste cenário estamos usando uma abordagem que nos permite transferir a complexidade de registrar um Decorator no ServiceCollection para um método de extensão.

Desta forma precisamos:

1. Criar uma nova classe concreta que deverá implementar a Interface que será 'decorada';
2. Implementar nesta nova classe a funcionalidade que gostaríamos de acrescentar ao método em questão;
3. Adicionar Decorator no Injetor de Dependências fazendo referência à interface que será decorada.

Obs.: É possível incluir mais de um Decorator, porém é preciso ter ciência de que a ordem em que eles são associados faz diferença no resultado final.

Método de Extensão
Implementação
Registro

O Decorator funciona como uma 'Boneca Russa' dessa forma podemos 'empilhar' diversos Decorators em uma mesma Interface.

Temos o exemplo de um segundo Decorator adicionando o recurso de Cache ao nosso Service.

Implementação
Registro

Desta forma nós agregamos duas funcionalidades ao nosso serviço sem modificar o comportamento do serviço, ou modificar quem chama o serviço, desta forma estamos aderentes aos princípios Responsabilidade Única, Aberto-Fechado e Inversão de Controle.

Obs.: Seguir o princípio Segregação de Interfaces pode tornar o seu Decorator mais simples de ser implementado, visto que você terá menos métodos para submeter ao padrão.