Clean Code: Boas práticas e design de código

Transcript

1. Clean Code Boas práticas e Design de código
2. Gefy Marcos Front-end Developer @gefymarcos gefy.com.br Laguna - SC
3. https://code4tuba.com.br
4. @gefymarcos
5. @gefymarcos O que é clean code? @gefymarcos
6. "Aplicar técnicas simples que visam facilitar a escrita e leitura de um código, tornando-o de fácil compreensão e revelando a sua real intenção.” Clean Code: A Handbook of Agile Software Craftsmanship; Robert C. Martin @gefymarcos
7. "Aplicar técnicas simples que visam facilitar a escrita e leitura de um código, tornando-o de fácil compreensão e revelando a sua real intenção.” Clean Code: A Handbook of Agile Software Craftsmanship; Robert C. Martin @gefymarcos
8. "Aprender a criar códigos limpos é uma tarefa árdua e requer mais do que o simples conhecimento dos princípios e padrões. Você deve suar a camisa;" Clean Code: A Handbook of Agile Software Craftsmanship; Robert C. Martin @gefymarcos
9. Clean Code: A Handbook of Agile Software Craftsmanship; Robert C. Martin @gefymarcos
10. 10:1 Clean Code: A Handbook of Agile Software Craftsmanship; Robert C. Martin @gefymarcos
11. “Qualquer um consegue escrever código que um computador entende. Bons programadores escrevem códigos que humanos entendem.” Martin Fowler @gefymarcos
13. Usuário, Programador, Venda… Classes: substantivos @gefymarcos
14. Adicionar, Remover, Calcular… Métodos: Verbos @gefymarcos
15. Evite colocar comentários desnecessários @gefymarcos
16. //Valida se o cliente possui benefícios if ((cliente.idade > 45 && cliente.salario < enumValorSalarios.salarioMinimo) @gefymarcos
17. if (this.isPossuiBeneficios(cliente)) ... ... possuiBeneficios(cliente: Cliente) { return cliente.idade > 45 && cliente.salario < enumValorSalarios.salarioMinimo) } @gefymarcos
18. Tenha no máximo 1 nível de indentação @gefymarcos
19. // BAD class Diario { gerarMedia(aluno) { // 1 if (aluno) { // 2 if (this.calculaFrequencia(aluno)) { // 3 if (this.calculaMedia(aluno) >= 7) { return 'Aprovado'; } else { return 'Reprovado'; } } else { throw new Exception('Sem frequência suficiente'); } } else { throw new Exception('Aluno não encontrado.'); } } } @gefymarcos
20. // GOOD class Diario { gerarMedia(aluno) { if (aluno) { calcularSituacao(aluno); } else { throw new Exception('Aluno não encontrado.'); } } calcularMedia(notas) { if (this.media(notas) >= 7) { return 'Aprovado'; } else { return 'Reprovado'; } } calcularSituacao(aluno) { if (this.calcularFrequencia(aluno)) { this.calcularMedia(aluno.notas); } else { throw new Exception('Sem frequência suficiente'); } } } @gefymarcos
21. Não utilize “Else” @gefymarcos
22. function() { if (sucesso) { return executarSuccess(); } else { return tratarErro(); } } @gefymarcos
23. // BAD function() { if (sucesso) { return executarSucesso(); } else { return tratarErro(); } } // GOOD function() { if (!sucesso) { return tratarErro(); } return executarSucesso(); } Abordagem otimista @gefymarcos
24. Abordagem pessimista // GOOD function() { if (sucesso) { return executarSucesso(); } return tratarErro(); } // BAD function() { if (sucesso) { return executarSucesso(); } else { return tratarErro(); } } @gefymarcos
25. Encapsular tipos primitivos e strings @gefymarcos
26. //BAD class Aluno { id: number; notas: number[]; } @gefymarcos
27. //BAD class Aluno { id: number; notas: number[]; } aluno.notas.push(20); @gefymarcos
28. // GOOD class Aluno { id: number; notas: Nota[]; } class Nota { private _valor: number; set valor(valor: number) { if (this.isNotaValida(valor)) { this._valor = valor; } } get valor() { return this._valor; } isNotaValida(valor: number) { return (valor >= 0 && valor <= 10); } } @gefymarcos
29. Mantenha as entidades e métodos pequenos @gefymarcos
30. Extract Method class Board { private int[][] data = ... public String toString() { StringBuffer buffer = new StringBuffer(); for(int i = 0; i<10; i++) { for(int j = 0; j<10; j++) { buffer.append(data[i][j]); buffer.append(“\n"); } } } } @gefymarcos
31. Extract Method class Board { private int[][] data = ... public String toString() { StringBuffer buffer = new StringBuffer(); for(int i = 0; i<10; i++) { for(int j = 0; j<10; j++) { buffer.append(data[i][j]); buffer.append(“\n"); } } } } @gefymarcos
32. Extract Method private collectRow(StringBuffer buffer, int row) { for(int j = 0; j<10; j++){ buffer.append(data[row][j]); } buffer.append("\n"); } @gefymarcos
33. Métodos menores geram testes mais fáceis @gefymarcos
34. Princípio de responsabilidade única @gefymarcos
35. // BAD class Diario { gerarMedia(aluno) { // 1 if (aluno) { // 2 if (this.calculaFrequencia(aluno)) { // 3 if (this.calculaMedia(aluno) >= 7) { aluno.situacao = 'Aprovado'; } else { aluno.situacao = 'Reprovado'; } if (this.aluno.situacao === 'Aprovado' && this.isFaturasPagas() && this.isConcluiuHorasExtraCurriculares()) { this.emitirCertificado(aluno); } … } else { throw new Exception('Sem frequência suficiente'); } } else { throw new Exception('Aluno não encontrado.'); } } } @gefymarcos
36. // GOOD class Diario { fecharDiario(aluno) { if (aluno) { aluno.situacao = this.calcularSituacao(aluno); if (!aluno.isPossuiPendencias()) { this.emitirCertificado(aluno); } } } isPossuiPendencias() { return this.isFaturasPagas() && this.isConcluiuHorasExtraCurriculares(); } isPossuiMedia(aluno: Aluno) { return this.calculaMedia(aluno) >= 7; } isPossuiFrequencia(aluno: Aluno) { return this.calculaFrequencia >= 70; } calcularSituacao(aluno: Aluno) { if (this.isPossuiMedia(aluno) && this.isPossuiFrequencia(aluno)) { return APROVADO; } return REPROVADO; } } @gefymarcos
37. Teoria das janelas quebradas @gefymarcos
38. “Se uma janela de um edifício for quebrada e logo não receber reparo, a tendência é que passem a arremessar pedras nas outras janelas e posteriormente passem a ocupar o edifício e destruí-lo.” Fixing Broken Windows: Restoring Order and Reducing Crime in Our Communities; George L. Kelling e Catherine Coles; @gefymarcos
39. Regra dos escoteiros @gefymarcos
40. “Ao sair da área onde você estava acampado, deixe-a mais limpa do que quando a encontrou.” @gefymarcos
41. Agile como vilão @gefymarcos
42. código que funciona > que código bom @gefymarcos
43. código que funciona != código RUIM @gefymarcos
44. Você está construindo um produto pra durar quanto tempo? @gefymarcos
45. Conclusão @gefymarcos Clean code são técnicas simples; Programador lê muito mais do que escreve; Arrume suas janelas; Limpe seu acampamento; Agile não quer dizer código ruim;
46. Conclusão @gefymarcos Clean code são técnicas simples; Programador lê muito mais do que escreve; Arrume suas janelas; Limpe seu acampamento; Agile não quer dizer código ruim;
47. Conclusão @gefymarcos Clean code são técnicas simples; Programador lê muito mais do que escreve; Arrume suas janelas; Limpe seu acampamento; Agile não quer dizer código ruim;
48. Conclusão @gefymarcos Clean code são técnicas simples; Programador lê muito mais do que escreve; Arrume suas janelas; Limpe seu acampamento; Agile não quer dizer código ruim;
49. Conclusão @gefymarcos Clean code são técnicas simples; Programador lê muito mais do que escreve; Arrume suas janelas; Limpe seu acampamento; Agile não quer dizer código ruim;
50. Você está construindo hoje o legado de manhã @gefymarcos
51. @gefymarcos gefy.com.br Obrigado!