Codifique melhor

Codiﬁque melhorMarcos Sousa / André Fonseca@marcos_sousa / @aoqfonseca

Quem somos?

Aﬁnal, o nosso objetivo é

valorize seu cliente

conheça o negócio

o importante é osoftware em operação

com feedbacks curtos

É fácil encontrar alguma coisa aí?

tenha como objetivo

organizar e mater organizado

Um software é livro

Classes são capítulos

seu código deve ser

Seu texto (aka classes) dever ser conciso

As idéias/parágrafos (métodos) interconectadas

As informações (nomes de variáveis/metodos/classes) claras e objetivas

Um exemplo

public boolean finalizar(AditivoContato aditivo) { if ((aditivo.getValor() > aditivo.getContrato().getValor() * 0.30 && aditivo.getAprovacaoGerente() == true) && aditivo.getValor() < getSaldoConta(aditivo.getConta())) { aditivo.getContrato().setStatus(‘A’); aditivo.getContrato().setValor(aditivo.getValor() ...); aditivo.setStatus(‘F’); dao.save(aditivo); return true; } else { return false; }} Quantas operações estão fazendo este método?

public boolean finalizar(AditivoContato aditivo) { if ((aditivo.getValor() > aditivo.getContrato().getValor() * 0.30 && aditivo.getAprovacaoGerente() == ‘S’) && aditivo.getValor() < getSaldoConta(aditivo.getConta())) { aditivo.getContrato().setStatus(‘A’); aditivo.getContrato().setValor(aditivo.getValor() ...); aditivo.setStatus(‘F’); dao.save(aditivo); return true; } else { return false; }}

public boolean finalizar(AditivoContato aditivo) { if ((aditivo.getValor() > aditivo.getContrato().getValor() * 0.30 && aditivo.getAprovacaoGerente() == ‘S’) && aditivo.getValor() < getSaldoConta(aditivo.getConta())) { aditivo.getContrato().setStatus(‘A’); aditivo.getContrato().setValor(aditivo.getValor() ...); aditivo.setStatus(‘F’); dao.save(aditivo); return true; } else { return false; }} 1 - Checa se ultrapassa 30% e se está aprovado

public boolean finalizar(AditivoContato aditivo) { if ((aditivo.getValor() > aditivo.getContrato().getValor() * 0.30 && aditivo.getAprovacaoGerente() == ‘S’) && aditivo.getValor() < getSaldoConta(aditivo.getConta())) { aditivo.getContrato().setStatus(‘A’); aditivo.getContrato().setValor(aditivo.getValor() ...); aditivo.setStatus(‘F’); dao.save(aditivo); return true; } else { return false; }} 1 - Checa se ultrapassa 30% e se está aprovado 2 - Veriﬁca se há saldo para o aditivo

public boolean finalizar(AditivoContato aditivo) { if ((aditivo.getValor() > aditivo.getContrato().getValor() * 0.30 && aditivo.getAprovacaoGerente() == ‘S’) && aditivo.getValor() < getSaldoConta(aditivo.getConta())) { aditivo.getContrato().setStatus(‘A’); aditivo.getContrato().setValor(aditivo.getValor() ...); aditivo.setStatus(‘F’); dao.save(aditivo); return true; } else { return false; }} 1 - Checa se ultrapassa 30% e se está aprovado 2 - Veriﬁca se há saldo para o aditivo 3 - atualiza status e calcula novo valor do contrato

public boolean finalizar(AditivoContato aditivo) { if ((aditivo.getValor() > aditivo.getContrato().getValor() * 0.30 && aditivo.getAprovacaoGerente() == ‘S’) && aditivo.getValor() < getSaldoConta(aditivo.getConta())) { aditivo.getContrato().setStatus(‘A’); aditivo.getContrato().setValor(aditivo.getValor() ...); aditivo.setStatus(‘F’); dao.save(aditivo); return true; } else { return false; }} 1 - Checa se ultrapassa 30% e se está aprovado 2 - Veriﬁca se há saldo para o aditivo 3 - atualiza status e calcula novo valor do contrato 4 - Deﬁne novo status

public boolean finalizar(AditivoContato aditivo) { if ((aditivo.getValor() > aditivo.getContrato().getValor() * 0.30 && aditivo.getAprovacaoGerente() == ‘S’) && aditivo.getValor() < getSaldoConta(aditivo.getConta())) { aditivo.getContrato().setStatus(‘A’); aditivo.getContrato().setValor(aditivo.getValor() ...); aditivo.setStatus(‘F’); dao.save(aditivo); return true; } else { return false; }} 1 - Checa se ultrapassa 30% e se está aprovado 2 - Veriﬁca se há saldo para o aditivo 3 - atualiza status e calcula novo valor do contrato 4 - Deﬁne novo status 5 - Responde a resquisição

passo-a-passo

public boolean finalizar(AditivoContato aditivo) { if (aditivo.isValorPermitidoOuAprovado() && aditivo.getValor() < getSaldoConta(aditivo.getConta())) { aditivo.getContrato().setStatus(‘A’); aditivo.getContrato().setValor(aditivo.getValor() ...); aditivo.setStatus(‘F’); repository.save(aditivo); return true; } else { return false; }}...public static float MAXIMO_PERMITIDO = 0.30public static float SIM = ‘S’public boolean isValorPermitidoOuAprovado() { return (aditivo.getValor() > aditivo.getContrato().getValor() * MAXIMO_PERMITIDO) && aditivo.getAprovacaoGerente() == SIM;}

public boolean finalizar(AditivoContato aditivo) { if (aditivo.isValorPermitidoOuAprovado() && aditivo.getValor() < getSaldoConta(aditivo.getConta())) { aditivo.getContrato().setStatus(‘A’); aditivo.getContrato().setValor(aditivo.getValor() ...); aditivo.setStatus(‘F’); repository.save(aditivo); return true; } else { return false; } USE CONSTANTES AUTO-EXPLICATIVAS}...public static float MAXIMO_PERMITIDO = 0.30public static float SIM = ‘S’public boolean isValorPermitidoOuAprovado() { return (aditivo.getValor() > aditivo.getContrato().getValor() * MAXIMO_PERMITIDO) && aditivo.getAprovacaoGerente() == SIM;}

public boolean isValorPermitidoOuAprovado() { return isValorPermitidoSemAprovacao() || hasAprovacaoGerente();}private boolean isValorPermitidoSemAprovacao() { return valor > contrato.getValor() * TRINTA_POR_CENTO;}private boolean hasAprovacaoGerente() { return aprovacaoGerente == SIM;}

public boolean isValorPermitidoOuAprovado() { return isValorPermitidoSemAprovacao() || hasAprovacaoGerente();}private boolean isValorPermitidoSemAprovacao() { return valor > contrato.getValor() * TRINTA_POR_CENTO;}private boolean hasAprovacaoGerente() { return aprovacaoGerente == SIM;} A ORDEM AJUDA NA LEITURA

... e o resultado é

public boolean finalizar(AditivoContato aditivo) { return aditivo.podeFinalizar() && hasSaldoAditivo(aditivo) &&repository.salvo(aditivo.finalizado()));} Realizando apenas uma operção :)

public boolean finalizar(AditivoContato aditivo) { return aditivo.podeFinalizar() && hasSaldoAditivo(aditivo) &&repository.salvo(aditivo.finalizado()));} Realizando apenas uma operção :) Uma mudança de requisitos pode impactar apenas um método no sistema

Métodos pequenos =Sigle Responsability Principle

... mas nem sempre sobra tempo

E por onde começar?

e vença uma batalha por vez

e jamais desistir

Tenha sempre em mente

...eis o dilemaPreciso de testes pararefatorar. Mas para ter testes preciso refatorar!

Alto acoplamentoVisível apenas quando tentamos testar partes isoladas

Quando fazer um refactoring?

Quando fazer um refactoring?✓ Inclusão de novas funcionalidades

Quando fazer um refactoring?✓ Inclusão de novas funcionalidades✓ Correção de bugs

Quando fazer um refactoring?✓ Inclusão de novas funcionalidades✓ Correção de bugs✓ Revisão do código

algorítimo do refactoring

identiﬁcar pontos de mudanças

identiﬁcar cenários de testes

eliminar dependências

escrever testes

fazer as mundanças

mas lembre-se!O bom é inimigo do ótimo Voltaire

para atingir o objetivo✓ Fazer mudanças✓ Não quebrar funcionalidade✓ Melhorar o design do código

Regra 1: contato com código Siga o modelo já existente Nomenclaturas, bibliotecas, estrutura

Regra 1: contato com código Respeite os desenvolvedores Que estão ou que passaram pelo projeto

Regra 2: em quem não conﬁar? Em sistemas de deploy Analise as etapas, dependências e reﬁne-o removendo passos personalizados

Regra 2: em quem não conﬁar? Em especiﬁcações Documentos facilmente estão desatualizados

Regra 2: em quem não conﬁar? Apenas no código e testes Eles estão fazendo atendendo ao propósito?

Regra 3: feedbacks rápidosFaça deploy, execute e teste-o! Mais de uma vez Quanto tempo você gasta?

Regra 3: feedbacks rápidos Crie falhas! Veja o quão tolerante é o seu sistema

Regra 3: feedbacks rápidosCrie um ambiente de testes Não ﬁque no escuro e porque não integração contínua?

Regra 3: feedbacks rápidosProve que suas mudanças funcionaram Tudo continua funcionando Nova funcionalidade está ok

Regra 3: feedbacks rápidos Prove que suas mudanças funcionaram Tudo continua funcionando Nova funcionalidade está okComo?

Regra 3: feedbacks rápidos Prove que suas mudanças funcionaram Tudo continua funcionando Nova funcionalidade está ok Como?Testes Unitários + Testes de Integração

Regra 4: manter a ordemEvite inserir comentários Deixe o código falar pro si próprio

Faça código auto- explicativo// funcionários de contratação mensal que tenha certificações e quetenham mais de 5 anos de carreira ganham 5%if (tipoContratacao() == “mensal” || certificacoes > 0 &&getTotalEmAnosContratado() > 5) { bonus = 0.05;}

Faça código auto- explicativo// funcionários de contratação mensal que tenha certificações e quetenham mais de 5 anos de carreira ganham 5%if (tipoContratacao() == “mensal” || certificacoes > 0 &&getTotalEmAnosContratado() > 5) { bonus = 0.05;}Que tal isso?if (possuiCriteriosParaBonus())

Regra 4: manter a ordemNão deixe códigos comentados Se é velho ou desnecessário porque está ali?

Regra 4: manter a ordemSempre que puder, remova excessos de acoplamento O ideal é ter um ponto de mudança

o código de que acabou de criar já é legado

escreva código fácil de ser modiﬁcado

faça pair programming sempre que puder

Aprenda com o códigolegado como codiﬁcar melhor

André Fonseca Marcos Sousaaofonseca@gmail.com falecomigo@marcossousa.com@aoqfonseca @marcos_sousa

Codifique melhor

by Marcos Sousa on Aug 16, 2011

Accessibility

Categories

Tags

Upload Details

Usage Rights

Statistics

Codifique melhor — Presentation Transcript