Codifique melhor

Codiﬁque melhor
Marcos Sousa
@marcos_sousa

o importante é o
software em operação

É fácil encontrar alguma coisa aí?

analogia: software
com livro

os capítulos (aka classes)
devem ser concisos

parágrafos (métodos)
interconectadas

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

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;
}
}

dao.save(aditivo);
return true;
} else {
return false;
}
}

Quantas operações são realizadas
neste método?

dao.save(aditivo);
return true;
} else {
return false;
}
1 - Checa se ultrapassa 30% e se está aprovado
}

dao.save(aditivo);
return true;
} else {
return false;
}
}

2 - Veriﬁca se há saldo para o aditivo

dao.save(aditivo);
return true;
} else {
return false;
}
}

3 - atualiza status e calcula novo valor do
contrato

dao.save(aditivo);
return true;
} else {
return false;
}
}

contrato
4 - Deﬁne novo status

dao.save(aditivo);
return true;
} else {
return false;
}
}

contrato
4 - Deﬁne novo status
5 - Responde a resquisição

if (aditivo.isValorPermitidoOuAprovado()
repository.save(aditivo);
return true;
} else {
return false;
}
}
...
public static float MAXIMO_PERMITIDO_SEM_APROVACAO = 0.30
public static float FLAG_APROVACAO_GERENTE = ‘S’
public boolean isValorPermitidoOuAprovado() {
return (aditivo.getValor() >
aditivo.getContrato().getValor() * MAXIMO_PERMITIDO_SEM_APROVACAO)
&& aditivo.getAprovacaoGerente() == FLAG_APROVACAO_GERENTE;
}

if (aditivo.isValorPermitidoOuAprovado()
repository.save(aditivo);
return true;
} else {
return false;
}
USE CONSTANTES AUTO-EXPLICATIVAS
}
...
public static float MAXIMO_PERMITIDO_SEM_APROVACAO = 0.30
public static float FLAG_APROVACAO_GERENTE = ‘S’
return (aditivo.getValor() >
aditivo.getContrato().getValor() * MAXIMO_PERMITIDO_SEM_APROVACAO)
&& aditivo.getAprovacaoGerente() == FLAG_APROVACAO_GERENTE;
}

return isValorPermitidoSemAprovacao() ||
hasAprovacaoGerente();
}
private boolean isValorPermitidoSemAprovacao() {
return valor > contrato.getValor() *
MAXIMO_PERMITIDO_SEM_APROVACAO;
}
private boolean hasAprovacaoGerente() {
return aprovacaoGerente == FLAG_APROVACAO_GERENTE;
}

return isValorPermitidoSemAprovacao() ||
hasAprovacaoGerente();
}
private boolean isValorPermitidoSemAprovacao() {
return valor > contrato.getValor() *
MAXIMO_PERMITIDO_SEM_APROVACAO;
}
private boolean hasAprovacaoGerente() {
return aprovacaoGerente == FLAG_APROVACAO_GERENTE;
}

A ORDEM AJUDA NA LEITURA

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

}

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

...eis o dilema

preciso de testes para
refatorar. Mas para ter
testes preciso refatorar!

sintoma de alto
acoplamento

visível quando tentamos
testar partes isoladas

Quando fazer um
refactoring?

Quando fazer um
refactoring?

✓Inclusão de novas funcionalidades

Quando fazer um
refactoring?

✓Correção de bugs

Quando fazer um
refactoring?

✓Correção de bugs
✓Revisão do código

identiﬁcar pontos de
mudanças

identiﬁcar cenários de
testes

mas lembre-se!

o bom é inimigo do ótimo
Voltaire

...para atingir o objetivo

✓Faça mudanças necessárias
✓Não quebre funcionalidade
✓E melhore o design do código

regra 1: contato com código

siga o modelo já existente
nomenclaturas, bibliotecas, estrutura

regra 2: contato com código

respeite os desenvolvedores
que estão ou que passaram pelo projeto

regra 3: em quem não conﬁar?

em sistemas de deploy
analise as etapas, dependências e reﬁne-o removendo passos
personalizados


apenas nas especiﬁcações
documentos facilmente estão desatualizados


apenas no código e testes
eles estão atendendo ao propósito?

regra 6: feedbacks rápidos

faça deploy, execute e teste-o!
Mais de uma vez
quanto tempo você gasta?


crie falhas!
veja o quão tolerante é o seu sistema


crie um ambiente de testes
não ﬁque no escuro e porque não integração contínua?


prove que suas mudanças
funcionaram
Tudo continua funcionando
Nova funcionalidade está ok


funcionaram
Como?


funcionaram
Como?
Testes Unitários + Testes de Integração

regra 10: manter a ordem

evite inserir comentários
deixe o código falar pro si

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

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

Que tal isso?
if (possuiCriteriosParaBonus())


remova códigos comentados
se é velho ou desnecessário porque está aqui?


sempre 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ódigo
legado como codiﬁcar
melhor

Marcos Sousa
falecomigo@marcossousa.com
@marcos_sousa

Codifique melhor

Recommandé

Recommandé

Contenu connexe

En vedette

En vedette (8)

Similaire à Codifique melhor

Similaire à Codifique melhor (20)

Codifique melhor

Notes de l'éditeur