TDC2018SP | Trilha UX - Agucando o olfato, como identificar code smells?

1. AGUÇANDO O OLFATO.
COMO IDENTIFICAR ODORES DE CÓDIGO?
CODE SMELLS

2. AGENDA
AGENDA
▸ Introdução
▸ Categorias de odores de código
▸ Inchadores.
▸ Abusadores de Orientação a objetos.
▸ Preventores de alteração.
▸ Dispensaveis.
▸ Acopladores.
▸ Referências e sugestões de leitura
Photo by Richárd Ecsedi on Unsplash

3. ODORES DE CÓDIGO
ODORES DE CÓDIGO
▸ Inchadores
▸ Métodos grandes
▸ Obsessão Primitiva
▸ Aglomerados de dados
▸ Abusadores de Orientação a
objetos
▸ Switch Statements
▸ Recusado Legado
▸ Preventores de alteração
▸ Cirurgia de espingarda
▸ Dispensaveis
▸ Comentários
▸ Classe de dados
▸ Acopladores
▸ Cadeias de Mensagens
▸ Homem do meio

4. CODE SMELL É UMA INDICAÇÃO NA
SUPERFÍCIE QUE GERALMENTE
CORRESPONDE A UM PROBLEMA MAIS
PROFUNDO NO SISTEMA.
Martin Fowler
DEFINIÇÃO

5. INCHADORES
BLOATERS

6. INCHADORES
INCHADORES
▸ São códigos, métodos e
classes que aumentaram para
proporções gigantescas com
as quais são difíceis de
trabalhar.
▸ Normalmente, esses cheiros
não surgem do nada, eles se
acumulam com o tempo à
medida que o programa
evolui.

7. MÉTODOS GRANDES
LONG METHODS

8. MÉTODOS GRANDES
SINAIS E SINTOMAS
▸ Um método contém muitas linhas de código. Geralmente,
qualquer método com mais de dez linhas deve fazer com
que você comece a fazer perguntas.

15. OBSESSÃO POR PRIMITIVOS
PRIMITIVE OBSESSION

16. OBSESSÃO POR PRIMITIVOS
SINAIS E SINTOMAS
▸ Uso de primitivos em vez de pequenos objetos para
tarefas simples (como moeda, intervalos, cadeias especiais
para números de telefone, etc.)
▸ Uso de constantes para codificação de informações (como
uma constante USER_ADMIN_ROLE = 1 para se referir a
usuários com direitos de administrador.)

18. AGLOMERADOS DE DADOS
DATA CLUMPS

19. AGLOMERADOS DE DADOS
SINAIS E SINTOMAS
▸ Às vezes, partes diferentes do código contêm grupos
idênticos de variáveis. Esses grupos devem ser
transformados em suas próprias classes.

21. ABUSADORES DE
ORIENTAÇÃO A OBJETOS
OBJECT-ORIENTATION
ABUSERS

22. ABUSADORES DE ORIENTAÇÃO A OBJETOS
ABUSADORES DE ORIENTAÇÃO A OBJETOS
▸ Todos esses odores são
aplicações incompletas ou
incorretas de princípios de
programação orientados a
objetos.

23. LEGADO RECUSADO
REFUSED BEQUEST

24. LEGADO RECUSADO
SINAIS E SINTOMAS
▸ Se uma subclasse usar apenas alguns dos métodos e
propriedades herdados de seus pais, a hierarquia estará
desalinhada. Os métodos desnecessários podem
simplesmente não ser usados ou redefinidos e emitir
exceções.

27. OPERADORES SWITCH
SWITCH STATEMENTS

28. OPERADORES SWITCH
SINAIS E SINTOMAS
▸ Você tem um operador de switch complexo ou sequência
de instruções if.
QUANDO IGNORAR
▸ Quando um operador de switch executa ações simples, não há
motivo para fazer alterações no código.
▸ Muitas vezes, os operadores de comutação são usados pelos
padrões de projeto de fábrica (Factory Method e Abstract
Factory) para selecionar uma classe criada.

29. PREVENTORES
DE ALTERAÇÃO
CHANGE
PREVENTERS
https://www.infopedia.pt/dicionarios/lingua-portuguesa/preventores

30. PREVENTORES DE ALTERAÇÃO
PREVENTORES DE ALTERAÇÃO
▸ Esses odores significam que,
se você precisar alterar algo
em um lugar em seu código,
também precisará fazer
muitas alterações em outros
lugares. O desenvolvimento
de programas torna-se
muito mais complicado e
caro como resultado.

31. CIRURGIA DE ESCOPETA
SHOTGUN SURGERY

32. CIRURGIA DE ESCOPETA
SINAIS E SINTOMAS
▸ Fazer quaisquer modificações requer que você faça muitas
pequenas alterações em muitas classes diferentes.

33. DISPENSÁVEIS
DISPENSABLES

34. DISPENSÁVEIS
DISPENSABLES
▸ Um dispensável é algo sem
sentido e desnecessário,
cuja ausência tornaria o
código mais limpo, mais
eficiente e mais fácil de
entender.

35. COMENTÁRIOS
COMMENTS

36. COMENTÁRIOS
SINAIS E SINTOMAS
▸ Um método é preenchido com comentários explicativos.
QUANDO IGNORAR
▸ Comentários às vezes podem ser úteis:
▸ Ao explicar porque algo está sendo implementado de
uma maneira particular.
▸ Ao explicar algoritmos complexos (quando todos os
outros métodos para simplificar o algoritmo foram
tentados e são curtos).

37. UMA FALÁCIA COMUM É ASSUMIR QUE OS
AUTORES DE CÓDIGO INCOMPREENSÍVEL
PODERÃO DE ALGUMA FORMA SE EXPRESSAR
DE FORMA LÚCIDA E CLARA NOS
COMENTÁRIOS.
Kevlin Henney
COMENTÁRIOS

38. CLASSE DE DADOS
DATA CLASS

39. CLASSE DE DADOS
SINAIS E SINTOMAS
▸ Uma classe de dados refere-se a uma classe que contém
apenas campos e métodos brutos para acessá-los (getters
e setters). Estes são simplesmente contêineres para dados
usados por outras classes. Essas classes não contêm
nenhuma funcionalidade adicional e não podem operar
de forma independente nos dados que possuem.

40. ACOPLADORES
COUPLERS

41. ACOPLADORES
COUPLERS
▸ Todos os odores deste
grupo contribuem para o
acoplamento excessivo
entre as classes ou mostram
o que acontece se o
acoplamento for substituído
pela delegação excessiva.

42. CADEIAS DE MENSAGEM
MESSAGE CHAINS

43. CADEIAS DE MENSAGEM
SINAIS E SINTOMAS
▸ No código, você vê uma série de chamadas parecidas com
$ a-> b () -> c () -> d ()
QUANDO IGNORAR
▸ O ocultamento de delegações agressivo pode causar
código em que é difícil ver onde a funcionalidade está
realmente ocorrendo.

44. INTERMEDIÁRIO
MIDDLE MAN

45. INTERMEDIÁRIO
SINAIS E SINTOMAS
▸ Se uma classe executa apenas uma ação, delegando
trabalho para outra classe, por que ela existe?
QUANDO IGNORAR
▸ Não exclua o intermediário que foi criado por um motivo:
▸ Um intermediário pode ter sido adicionado para evitar
dependências interclasses.
▸ Alguns padrões de design criam o intermediário de
propósito (como Proxy e Decorator).

47. REFERÊNCIAS
REFERÊNCIAS
▸ https://www.youtube.com/watch?v=ZsHMHukIlJY
▸ https://martinfowler.com/bliki/CodeSmell.html
▸ https://refactoring.guru/refactoring/smells
▸ https://sourcemaking.com/refactoring/smells
▸ https://blog.codinghorror.com/code-smells/
▸ https://en.wikipedia.org/wiki/Code_smell
▸ https://scrutinizer-ci.com/docs/refactoring/

48. SUGESTÕES DE LEITURA
SUGESTÕES DE LEITURA
▸ Clean Code: A Handbook of Agile Software Craftsmanship
▸ Refactoring: Improving the Design of Existing Code
▸ Working Effectively with Legacy Code

49. OBRIGADO!
Photo by Alexander Maasch on Unsplash