Seja um Desenvolvedor, não um liquidificador

Teoria da Janela Quebrada

Imagine que um cientista deixe um carro parado em um bairro durante uma semana . O carro passa desapercebido como se fosse um carro normal de algum morador. O cientista então quebra uma janela do carro e volta uma semana depois encontrando o carro vandalizado.

http://www.manhattan-institute.org/pdf/_atlantic_monthly-broken_windows.pdf

Imagine que um prédio seja desocupado, mas sua fachada ainda está bonita. Assim que as primeiras janelas quebradas aparecerem o prédio começará a ser vandalizado.

http://en.wikipedia.org/wiki/Broken_windows_theory#Article_and_crime_prevention

Infelizmente o efeito da Janela Quebrada é muito encontrada em nossos códigos. É muito fácil encontrar um código feio e deixá-lo mais feio ainda. Qual o problema em adicionar um if em um método de 300 linhas?

Existem algumas ações/atitudes que podem gerar uma janela quebrada em seu projeto.

Mantenha seu build sempre funcionando

Quando o build do projeto não funciona o primeiro pensamento que vem a mente do desenvolvedor é que o projeto não está organizado.

Evite deixar configurações manuais serem feitas, detalhes que atrapalhem um build, por exemplo: ser necessário ter um arquivo em determinada pasta ou alguma variável de ambiente.

Uma solução para esse tipo de problema é sempre ter algo default, ou seja, um valor que pode ser sempre aplicado. Caso um valor default não seja possível o idéal é que exista uma mensagem de erro clara, deixando claro qual o problema. Evite colocar uma linha de log escondida no meio do projeto, se possível, evidencie como abaixo:

log log log log log log log

ERRO DO BUILD AQUI, ESPAÇADO

log log log log log log log

Ao deixar claro qual foi o problema que aconteceu, o desenvolvedor vai começar a solucionar os problemas de um modo direcionado ao invés de ter que procurar o erro sem saber onde. Um build quebrado é algo nocivo para o projeto, o desenvolvedor que entrar no projeto perderá a confiança na arquitetura e robustez do projeto.

Nunca deixe testes quebrados

Nunca é uma palavra muito forte, mas quando relacionamos com os testes ela se encaixa perfeitamente. O problema de sempre termos testes quebrados é que, caso quebre mais um, ninguém dará importância.

Quando testes falham é comum um desenvolvedor sempre executar o build do projeto fazendo o “skip” dos testes. Caso outro teste quebre ele não será notado e um novo/velho bug será introduzido na próxima versão.

Obs.: caso seu gerente te obrigue a fazer commit com teste quebrado, oficialize por email um texto que diz que por ordem expressa você está fazendo isso. Lembre-se: sempre se proteja

Não comente/ignore seus testes

Se você estiver comentando um teste (//@Test) ou ignorando (@Ignore) uma bandeira deve ser levantada. Por que isso está acontecendo?

Um teste comentado/ignorado tem grande chance de virar um teste esquecido, e um teste esquecido é um bug que voltará a acontecer em breve.

Solução proposta

Tenha zelo pelo seu código. Não deixe o código de qualquer jeito ou então começarão aparecer janelas quebradas por todo o projeto.

35 thoughts on “Seja um Desenvolvedor, não um liquidificador

  1. Ótimo assunto a ser abordado em uma época em que annotations invadem nossos códigos e cada vez mais é notável a falta de conceitos básicos

    • Rafael, bom dia.

      Realmente eu fico triste por ver o básico sendo trocado por facilidades, que depois viram o buraco do projeto.

      Obrigado pelo apoio. (:

  2. Hébert, você nunca retorna uma entidade JPA para a view, mesmo se for para um HTML? Sempre cria um DTO se for fazer isso?

    Fiquei surpreso com a afirmação, não estava ciente de que isso era considerado uma boa prática. Costumo criar DTOs apenas se as informações da view não refletem exatamente os campos da entidade, necessitando exibir outros campos.

    Outra coisa, e se eu estiver utilizando JDBC? Ainda assim você criaria um DTO para exibir na view?

    • Rafael, boa noite.

      Nos últimos 4 projetos que criei eu não retornei mais a Entity para a VIEW, e honestamente só vi ganho nessa abordagem. O problema de começar retornando uma Entity direto para View é justamente que quando houver a necessidade da diferença em que a view precisa de coisa a mais, será necessário um refactoring que poderia ser evitado.
      E eu acredito que a prática de DTO deve ser aplicada independente se você está com JDBC, JPA, etc.

      Obrigado pela visita. (:

      • E como você nomeia estes DTOs?
        Por exemplo, digamos que você tenha uma página ListaProdutos.jsp, e outra CadastraProduto.jsp, sendo que existem diferenças entre os campos exibidos em cada uma.

        Neste caso você criaria uma CadastraProdutoDTO e uma ListaProdutosDTO, ou criaria apenas uma ProdutoDTO com todos os campos das duas páginas?

        • Rafael, boa noite.

          Eu diria isso varia. No caso de um cadastro de produto, realmente eu utilizaria um ProdutoDTO. Agora, imagine que na tela de listar produto, seja necessário diversos outros atributos. Aí eu criaria um ListarProdutosHome e nele colocaria o ProdutoDTO e os outros atributos.

          Para entrada de dados que eu costumo criar objetos mais específicos. Imagine que tenha um serviço só para alterar o preço do produto. Eu penso que seria melhor ter um AlteraPreçoProdutoDTO com um campo apenas (+ID), do que a pessoa ver um ProdutoDTO e não saber oq deve ou não ter lá dentro.

          Espero ter sido claro.

          Obrigado pela visita.

  3. Ótimo post, para mim que sou um “recruta” em programação java o post despertou uma vontade de buscar mais sobre as boas práticas de desenvolvimento e principalmente sobre o que não deve ser feito!

    Abraços

    • Matheus, boa noite.

      Fico feliz em saber que consegui te estimular na qualidade de código.

      Obrigado pelo comentário e pelo apoio.

  4. otimo post hebert como sempre

    mas eu gostaria de fazer uma pergunta esse post voce escreveu baseado em sua experiencia como desenvolvedor ou se voce leu algum livro ou algo assim que serviu de inspiração para criar ele ? e se foi so de experiencia qual livro ou conteudo voce indicaria pra ter uma base maior alem do post ?

    • Manoel, boa noite.

      Eu diria que foi baseado em um pouco de cada.

      Quanto aos livros eu já li + de 40 livros técnicos, então não tenho um específico que aborde tudo. =/

      Eu diria que o livro de padrão de projeto e de OO da séria Use a Cabeça já são um ótimo início.

      Obrigado pelo apoio e pelo comentário.

  5. Excelente artigo Hebert. A facilidade fornecida pelo mundo das annotations e a pressa por “criar” algo as vezes deixa o desenvolvedor preguiçoso por entender como as coisas funcionam por debaixo dos panos e a forma correta de se estruturar uma aplicação. Conhecer o conceito é parte fundamental da evolução do desenvolvedor e, o resultado vemos em sistemas que chegam a ir para produção mas logo começam a falhar por coisas como essas.

  6. Herbert, uma pergunta,no caso do componente p:autocomplete do primefaces, para retornar a lista com os valares para o componente autocompletar, faço acesso ao um metodo da minha classe DAO, isso é correto ou estou misturando camadas:

    /* Métodos dos Componentes AutoComplete */
    public List orgOrigemComplete(String parametro) {
    return new TOrgDAO().consultarComplete(parametro, “I”,
    loginBean.getLogin());
    }

    Coloco no meu Managed Bean ….

    • Cedric, boa noite.

      Note que seu MB está acoplado ao DAO diretamente. Tem um parâmetro “I” que não é claro no que significa e o MB também chamada o loginBean.

      Honestamente eu faria lago como
      return pessoaService.consultar(parametro, login());

      Desse modo, qualquer alteração no modo de pesquisa, não afetaria o MB.

      Bem, essa é minha opinião e existem vários outros modos de se fazer isso.

      Espero ter ajudado.

  7. Excelente post Hebert, porém eu gostaria de discutir um pouco sobre a camada de Service:
    Ao implementação de pequenos CRUDs na aplicação os objetos Service acabam existindo como meros Dispatchers, isso acaba entrando em outro problema, pois criamos um objeto anêmico.

    • Leonardo, boa tarde.

      Me desculpe a demora, estive muito ocupado nesse último mês.

      Eu concordo com você. O problema é justamente quando for começar a ter alguma lógica. A pessoa que for criar a lógica, ela vai saber criar a nova camada? Se sim, por mim poderia até pular essa camada. Em minha experiência é que se os desenvolvedores não vêem, eles não usam/criam do padrão. Por isso que eu acabo sempre criando essa camada ‘seca’. =/

      Obrigado por tudo e desculpe a demora.

Leave a Comment