Em busca de qualidade em aplicações Java, a apresentação tem como objetivo combater code smells com técnicas de clean code, SOLID, entre outros. Apresentação TDC São Paulo 2017, trilha de Java

1. COMBATENDO CODE SMELLS EM
APLICAÇÕES JAVA
Trilha Java
Emmanuel Neri

2. EMMANUEL NERI
‣ Mestre em Desenvolvimento de Tecnologia
‣ Desenvolvedor desde 2010
‣ Atualmente desenvolvedor back-end na Navita
)(

3. PROBLEMA
O que são code smells?

4. COMO RESOLVER?
Como evitar códigos ruins no dia a dia?

5. CULTURAL
Reuso
Abstração
Código limpo
Encapsulamento

6. PRATICAR

7. POR ONDE COMEÇAR?

8. LEGIBILIDADE
‣ Nome claros
‣ Nome que revelem seu propósito
‣ Nomes pronunciáveis
‣ Nomes passíveis de busca

9. LEITURA DO CÓDIGO
BigDecimal valor = BigDecimal.ZERO;
for(Conta x : lista) {
for(ItemConta y : x.getItens()) {
if(y.getValor() != null) {
valor = valor.add(y.getValor());
}
}
BigDecimal media = valor.divide(BigDecimal.valueOf(lista.size()));

10. LEITURA DO CÓDIGO
BigDecimal valor = BigDecimal.ZERO;
for(Conta x : lista) {
for(ItemConta y : x.getItens()) {
if(y.getValor() != null) {
valor = valor.add(y.getValor());
}
}
BigDecimal media = valor.divide(BigDecimal.valueOf(lista.size()));

11. LEITURA DO CÓDIGO
BigDecimal valorTotal = BigDecimal.ZERO;
for(Conta conta : contas) {
for(ItemConta itemConta : conta.getItens()) {
if(itemConta.getValor() != null) {
valorTotal = valorTotal.add(itemConta.getValor());
}
}
}
BigDecimal quantidadeDeContas = BigDecimal.valueOf(contas.size());
BigDecimal media = valorTotal.divide(quantidadeDeContas);

12. S O L I D
SINGLE
RESPONSIBILITY
PRINCIPLE
OPEN / CLOSE
PRINCIPLE
LISKOVS
SUBSTITUTION
PRINCIPLE
INTERFACE
SEGREGATION
PRINCIPLE
DEPENDENCY
INVERSION
PRINCIPLE
SRP OCP LSP ISP DIP
O
"A class should have only one reason to change."
ACRÔNIMO

13. EXTRAINDO EM MÉTODOS
public SumarioConta sumarizarConta(List<Conta> contas) {
final BigDecimal valorTotal = calcularValorTotal(contas);
final BigDecimal quantidadeDeContas = getQuantidadeDeContas(contas);
final BigDecimal media = CalculoUtil.media(valorTotal, quantidadeDeContas);
return new SumarioConta(valorTotal, media);
}
private BigDecimal calcularValorTotal(List<Conta> contas) {
return contas.stream()
.map(Conta::getValorTotal)
.reduce(BigDecimal.ZERO, BigDecimal::add);
}
private BigDecimal getQuantidadeDeContas(List<Conta> contas) {
return BigDecimal.valueOf(contas.size());
}

14. TAMANHO DE CÓDIGO
‣ Classes

15. DUPLICAÇÃO DE CÓDIGO
public class ContaService {
public BigDecimal calcularDesconto(Conta conta) {
....
}
}
public class ItemContaService {
public BigDecimal calcularDesconto(Conta conta) {
....
}
}
public class Conta {
public BigDecimal calcularDesconto() {
....
}
}

16. DUPLICAÇÃO DE CÓDIGO
private static final int ESCALA_FINANCEIRA = 2;
private static final int ESCALA_CONTABIL = 6;
public BigDecimal calcularMediaFinanceira(BigDecimal total,
BigDecimal quantidade) {
return total.divide(quantidade, ESCALA_FINANCEIRA, HALF_EVEN);
}
public BigDecimal calcularMediaContabil(BigDecimal total,
BigDecimal quantidade) {
return total.divide(quantidade, ESCALA_CONTABIL, HALF_EVEN);
}

17. DUPLICAÇÃO DE CÓDIGO
private static final int ESCALA_FINANCEIRA = 2;
private static final int ESCALA_CONTABIL = 6;
public BigDecimal calcularMediaFinanceira(BigDecimal total,
BigDecimal quantidade) {
return total.divide(quantidade, ESCALA_FINANCEIRA, HALF_EVEN);
}
public BigDecimal calcularMediaContabil(BigDecimal total,
BigDecimal quantidade) {
return total.divide(quantidade, ESCALA_CONTABIL, HALF_EVEN);
}

18. DUPLICAÇÃO DE CÓDIGO
private static final int ESCALA_FINANCEIRA = 2;
private static final int ESCALA_CONTABIL = 6;
public BigDecimal calcularMediaFinanceira(BigDecimal total,
BigDecimal quantidade) {
return divide(total, quantidade, ESCALA_FINANCEIRA);
}
public BigDecimal calcularMediaContabil(BigDecimal total,
BigDecimal quantidade) {
return divide(total, quantidade, ESCALA_CONTABIL);
}
private BigDecimal divide(BigDecimal total, BigDecimal quantidade,
int escala) {
return total.divide(quantidade, escala, RoundingMode.HALF_EVEN);
}

19. EXCESSO DE COMPLEXIDADE
public BigDecimal calcular(Conta conta) {
if() {
if() {
}
} else if() {
} else {
if() {
} else {
}
}
}
‣ KISS ("keep it small and simple”)

20. public class Fatura {
private TipoFatura tipoFatura;
private Integer quantidade;
private Integer duracao;
private Integer bytes;
private BigDecimal valorUnitario;
public BigDecimal getValorTotal() {
if(tipoFatura == TipoFatura.VOZ) {
return valorUnitario.multiply(BigDecimal.valueOf(duracao));
} else if(tipoFatura == TipoFatura.DADOS) {
return valorUnitario.multiply(BigDecimal.valueOf(bytes));
} else {
return valorUnitario.multiply(BigDecimal.valueOf(quantidade));
}
}
}

21. public class Fatura {
private TipoFatura tipoFatura;
private Integer quantidade;
private Integer duracao;
private Integer bytes;
private BigDecimal valorUnitario;
public BigDecimal getValorTotal() {
if(tipoFatura == TipoFatura.VOZ) {
return valorUnitario.multiply(BigDecimal.valueOf(duracao));
} else if(tipoFatura == TipoFatura.DADOS) {
return valorUnitario.multiply(BigDecimal.valueOf(bytes));
} else {
return valorUnitario.multiply(BigDecimal.valueOf(quantidade));
}
}
}

22. public enum TipoFatura {
VOZ {
@Override
public BigDecimal calcularValorTotal(Fatura fatura) {
return multiply(fatura.getValorUnitario(), fatura.getDuracao());
}
},
DADOS {
@Override
public BigDecimal calcularValorTotal(Fatura fatura) {
return multiply(fatura.getValorUnitario(), fatura.getBytes());
}
}
public abstract BigDecimal calcularValorTotal(Fatura fatura);
}
public BigDecimal getValorTotal() {
return tipoFatura.calcularValorTotal(this);
}

23. PRINCIPIO DE ABERTO / FECHADO
"Software entities (classes, modules, functions, etc.) should be
open for extension, but closed for modification"
O - OPEN / CLOSE PRINCIPLE
public BigDecimal getValorTotal() {
if(tipoFatura == TipoFatura.VOZ) {
return valorUnitario.multiply(BigDecimal.valueOf(duracao));
} else if(tipoFatura == TipoFatura.DADOS) {
return valorUnitario.multiply(BigDecimal.valueOf(bytes));
} else {
return valorUnitario.multiply(BigDecimal.valueOf(quantidade));
}
}

24. INVEJOSO
public class ContaService {
public void resumir(Conta conta) {
final BigDecimal valorTotal = conta.getItens().stream()
.map(item -> item.getValorUnitario()
.multiply(item.getMinutos()))
.reduce(BigDecimal.ZERO, BigDecimal::add);
final BigDecimal quantidadeDeMinutos = conta.getItens().stream()
.map(ItemConta::getMinutos)
.reduce(BigDecimal.ZERO, BigDecimal::add);
final int quantidadeDeItensNaConta = conta.getItens().size();
...
}
}

25. INVEJOSO
public class ContaService {
public void resumir(Conta conta) {
final BigDecimal valorTotal = conta.getItens().stream()
.map(item -> item.getValorUnitario()
.multiply(item.getMinutos()))
.reduce(BigDecimal.ZERO, BigDecimal::add);
final BigDecimal quantidadeDeMinutos = conta.getItens().stream()
.map(ItemConta::getMinutos)
.reduce(BigDecimal.ZERO, BigDecimal::add);
final int quantidadeDeItensNaConta = conta.getItens().size();
...
}
}

26. FEATURE ENVY
public class ContaService {
public void resumir(Conta conta) {
final BigDecimal valorTotal = conta.calcularValorTotal();
final BigDecimal quantidadeDeMinutos =
conta.calcularQuantidadeDeMinutos();
final BigDecimal quantidadeDeItensNaConta =
conta.getQuantidadeDeItensNaConta();
...
}
}

27. NÍVEL DE MÉTODO
‣ Muitos parâmetros
public List<Conta> buscar(LocalDate dataInicio, LocalDate dataFim,
String cliente, String identificador,
String descricao) {
}
public List<Conta> buscar(ContaFiltroTO contaFiltro) {
}

28. NÍVEL DE MÉTODO
‣ Parâmetros de saída
public void pagarConta(Conta conta) {
conta.setStatus(StatusConta.PAGA);
}
conta.pagar();

29. NÍVEL DE MÉTODO
‣ Parâmetros lógicos
public void pagar(boolean isAtrasada, boolean isNotificarPagamento) {
if(isAtrasada) {
conta.pagaAtrasada();
} else {
conta.pagar();
}
if(isNotificarPagamento) {
notificarPagamento();
}
}
public void pagarAtrasada() { }
public void pagarNoPrazo() { }
public void notificarPagamento() { }

30. OUTROS
‣ Excessivo retorno de dados
‣ Lazy class
‣ Intimidade inapropriada
‣ Uso de Switch
‣ Refused bequest (Liskov Substitution Principle)
‣ Atributos de classe temporários
‣ Data clumps
‣ Dead code
‣ ….

31. FERRAMENTAS
‣ SonarQube
‣ FindBugs
‣ IDEs

32. DASHBOARD SONAR
https://github.com/emmanuelneri/productivity-with-spring/blob/master/pom.xml#L80

33. USANDO SONAR

34. RECOMENDAÇÃO

35. OBRIGADO
emmanuelnerisouza@gmail.com
https://github.com/emmanuelneri
@emmanuelnerii
www.emmanuelneri.com.br
“VOCÊ SEMPRE DEVE DEIXAR O LUGAR
MAIS LIMPO DO QUE ENCONTROU”