Refatoração e Code Smells - Guru-SP

Apresentação feita no 55º encontro do Guru-SP.

Transcript

1. Refatoração e Code Smells
2. Olar! André Benjamim Desenvolvedor Ruby @ Rebase @andregomesb 2
6. Ciclo do código • Resolver um problema • Código Limpo ◦ Flexibilidade ◦ Escalabilidade ◦ Manutenibilidade • SOLID • Refatoração, Code Smells e Design Patterns • Arquitetura 6
7. Do design ao código limpo 7 1 Design Definir a solução do problema. Código Escrever a solução como código. Refatoração Melhorar o design através do código. Código limpo Resultado é código legível e flexível. 2 3 4
8. Refatoração O que é, quando e como usar? 1
9. “ Refactoring is a disciplined technique for restructuring an existing body of code, altering its internal structure without changing its external behavior. 9 – Martin Fowler
10. Por que refatorar? 10
11. Por que refatorar? Dentre os benefícios de refatorar, podemos listar: Melhora o design da aplicação Facilita o entendimento do código Ajuda a encontrar bugs Desenvolvimento mais rápido 11
12. Quando refatorar? 12
13. Quando refatorar? Situações mais comuns para refatorar: Regra de três Quando adicionar uma feature Quando corrigir um bug Durante o code review 13
14. Quando refatorar? Alguns sinais que indicam a hora de refatorar: Muitos bugs Olhar constantemente o código Novos membros têm dificuldade de entender Testes são difíceis de escrever Introduzir novas features é custoso Produção quebra mais do que deveria 14
15. Como se preparar? 15
16. Como se preparar? Antes de codar, avalie esses pontos: Defina o que você irá refatorar Verifique a cobertura de testes Verifique quais cenários estão cobertos Entenda a funcionalidade e como ela afeta o sistema (front, back, suporte e cliente) Não altere os testes enquanto refatora! 16
17. Reek, Flay e Flog Essas ferramentas ajudam com code smells, duplicação de código e métricas ABC, respectivamente. Use ferramentas Rubycritic É a combinação das três ferramentas com gráficos, classificação de cada arquivo e code smells em formato HTML. 17
18. Code Smells O que é e como se livrar? 2
19. O que é Code Smell? 19
20. Tipos de code smells Bloaters Métodos e classes que cresceram tanto que são difíceis de lidar. São smells que não são aparentes de início, mas tornam-se uma bola de neve. Couplers Esse smells representa o código que tornam as classes acopladas excessivamente. Além do acoplamento, também há o excesso de delegação. Change Preventers Alterações no código precisam ser feitas em múltiplos lugares, tornando o desenvolvimento custoso. 20 Dispensables São códigos desnecessários que tornam o código mais legível, limpo e fácil de entender quando removidos. Object-Orientation Abusers Aplicações incompletas ou erradas de orientação a objetos.
21. Bloaters Long Method Long Parameter List Large Class Data Clumps Primitive Obsession 21
22. Bloaters Long Method Long Parameter List Large Class Data Clumps Primitive Obsession 22
23. Long Method Esse code smell apresenta os seguintes sintomas: • Você não sabe o que o método faz, ao menos não sem ler algumas vezes • Código muito identado (loops e ifs) • Muitos comentários explicando o que um trecho de código faz 23
24. Soluções • Extract Method para quebrar o método grande em métodos menores • Replace Temp with Query para remover variáveis temporárias • Replace Method with Method Object para variáveis muito acopladas • Decompose Conditional para condicionais 24
25. Extract method Quebrar métodos grandes em métodos menores 25
28. Replace Temp with Query Extrair variáveis temporárias para métodos 28
32. Replace Method with Method Object Extrair método para uma classe 32
40. Decompose Conditional Extrair condicionais para métodos 40
46. Bloaters Long Method Long Parameter List Large Class Data Clumps Primitive Obsession 46
47. Long Parameter List Esse code smell apresenta o seguinte sintoma: • Muitos parâmetros (4 ou mais) 47
48. Soluções • Replace Parameter with Method para valores que podem ser obtidos no objeto • Preserve Whole Object para valores que são obtidos de outro objeto • Introduce Parameter Object para itens sem um objeto 48
49. Replace Parameter with Method Extrair valores dos métodos do próprio objeto 49
54. Preserve Whole Object Extrair valores diretamente de um objeto 54
62. Introduce Parameter Object Criar um objeto que represente os parâmetros 62
69. Bloaters Long Method Long Parameter List Large Class Data Clumps Primitive Obsession 69
70. Large Class Esse code smell apresenta os seguintes sintomas: • Muitas variáveis de instância • Muitos métodos públicos e/ou privados • Mais de uma responsabilidade 70
71. Soluções • Extract Class para classes com mais de uma responsabilidade • Replace Type Code with Polymorphism para classes que verificam o tipo de objeto • Replace Type Code with Strategy para classes que tenham algoritmos diferentes com base no tipo 71
72. Extract Class Extrair métodos e campos para criar uma nova classe 72
78. Replace Type Code with Polymorphism Extrair comportamento para subclasses 78
82. Replace Type Code with Strategy Separar comportamentos que mudam no tempo de execução 82
88. Bloaters Long Method Long Parameter List Large Class Data Clumps Primitive Obsession 88
89. Data Clump Esse code smell apresenta os seguintes sintomas: • Conjunto de parâmetros que estão sempre juntos • Aparecem em múltiplas classes • Fazem parte da assinatura de múltiplos métodos 89
90. Soluções • Extract Class para converter em um objeto • Introduce Parameter Object ou Preserve Whole Object para ajustar a assinatura de métodos 90
91. Bloaters Long Method Long Parameter List Large Class Data Clumps Primitive Obsession 91
92. Primitive Obsession Esse code smell apresenta os seguintes sintomas: • Manipulação de Strings • Métodos que usam intervalo de valores, ou obtém o maior/menor valor • Validação ou pequenas lógicas para manipular valores 92
93. Soluções • Replace Data Value with Object para encapsular o comportamento em um objeto • Introduce Parameter Object ou Preserve Whole Object se os campos são usados como parâmetros 93
94. Replace Data Value with Object Extract Class com outro nome 94
100. Change Preventers Shotgun Surgery Divergent Change 100
101. Change Preventers Shotgun Surgery Divergent Change 101
102. Shotgun Surgery Esse code smell apresenta o seguinte sintoma: • Qualquer alteração precisa ser feita em múltiplos lugares 102
103. Soluções • Move Field ou Move Method para extrair a mudança para apenas uma classe 103
104. Move Field Mover um campo de uma classe para outra 104
112. Move Method Mover um método de uma classe para outra 112
113. Change Preventers Shotgun Surgery Divergent Change 113
114. Divergent Change Esse code smell apresenta os seguintes sintomas: • Quando uma classe é alterada por diversos motivos • A classe possui mais de uma responsabilidade 114
115. Solução • Extract Class para remover responsabilidades 115
116. Couplers Feature Envy Inappropriate Intimacy 116
117. Couplers Feature Envy Inappropriate Intimacy 117
118. Feature Envy Esse code smell apresenta os seguintes sintomas: • Métodos que utilizam mais os dados de um objeto do que da própria classe • Métodos que só utilizam os parâmetros passados e nada mais 118
120. Soluções • Move Field ou Move Method para colocar no lugar mais apropriado • Extract Method para remover somente o trecho que possui o smell e depois Move Method 120
121. Couplers Feature Envy Inappropriate Intimacy 121
122. Inappropriate Intimacy Esse code smell apresenta o seguinte sintoma: • Classes que conhecem métodos e campos internos de outra classe 122
125. Soluções • Extract Class para remover responsabilidades • Move Field ou Move Method para mover as partes que são utilizadas 125
126. Object-Oriented Abusers Temporary Field Refused Bequest 126
127. Object-Oriented Abusers Temporary Field Refused Bequest 127
128. Temporary Field Esse code smell apresenta o seguinte sintoma: • Variável que só é atribuído valor em certos cenários 128
129. Soluções • Introduce Null Object no lugar de condicionais para verificar se o campo possui valor • Replace Method with Method Object ou Extract Class para extrair o campo e operações que dependem dele 129
130. Introduce Null Object Substituir valores nil por um objeto 130
136. Object-Oriented Abusers Temporary Field Refused Bequest 136
137. Refused Bequest Esse code smell apresenta os seguintes sintomas: • Subclasses utilizam apenas alguns métodos • Subclasses recusam-se a implementar a interface que herdaram 137
138. Solução • Replace Inheritance with Delegation 138
139. Replace Inheritance with Delegation Delegar ao invés de Herdar 139
144. Dispensables Comments Duplicate Code Lazy Class Data Class Dead Code Speculative Generality 144
145. Quero saber mais • Refactoring.Guru • Source Making • refactoring.com 145
146. Quero saber mais • Refactoring: Improving the Design of Existing Code • Refactoring: Ruby Edition • Ruby Science • Practical Object-Oriented Design in Ruby • 99 Bottles of OOP 146
147. Quero saber mais • Refactoring from Good to Great - Ben Orenstein • Get a Whiff of This - Sandi Metz • Workflows of Refactoring - Martin Fowler • Refactoring Live: Primitive Obsession - James Dabbs (RailsConf 2019 ) • Succession - Katrina Owen (RailsConf 2016) 147
148. Quero saber mais • Therapeutic Refactoring - Katrina Owen (Cascadia Ruby Conf 2012) • Polly want a message - Sandi Metz • All The Little Things - Sandi Metz • Software Design in the 21st Century - Martin Fowler • Refatoração: um pouco além do código - Edmilton Neves (Guru-SP) 148
149. Aceito feedbacks 149
150. 150 Obrigado!
151. 151 @andregomesb bit.ly/code-smells-guru-55