Seja um Desenvolvedor, não um liquidificador

Voltemos ao mundo dos DTOs

Já na primeira página desse post foi dito que não é bom misturar os conceitos ao utilizar um framework. Vamos rever um exemplo mostrado na primeira página:

@Entity
@XmlRootElement
@JsonAutoDetect
@DiscriminatorColumn(name = "animal_type")
@JsonTypeInfo(
        use = JsonTypeInfo.Id.NAME,
        include = JsonTypeInfo.As.PROPERTY,
        property = "type")
@JsonSubTypes({
        @JsonSubTypes.Type(value = Dog.class, name = "dog"),
        @JsonSubTypes.Type(value = Cat.class, name = "cat"),
        @JsonSubTypes.Type(value = Bird.class, name = "bird")
})
public class Animal {

    @Id
    private int id;

    @JsonSerialize(using = JsonDateSerializer.class)
    private Date birthday;

    @JsonView(ToothView.class)
    @OneToMany(mappedBy = "animal")
    private List<Tooth> teethList;

    // other stuff
}

Como é possível ver no código acima temos código de JPA e JSON misturados na mesma classe. O problema dessa abordagem é que toda alteração de JPA na classe pode alterar o JSON retornado para o cliente; toda alteração no JSON pode alterar o modo de como os dados da entidade será salvo no banco de dados.

Note que quando eu falo de VIEW eu não estou falando de um retorno HTML, mas sim de toda saída de dados do sistema. Quando falo sobre saída de dados eu quero dizer: HTML, WebServices REST (JSON, XML), SOAP, arquivos, etc.

É necessário que o código de VIEW esteja desacoplado do código de MODELO. Uma maneira fácil e simples de conseguir isso é através do padrão DTO.

DTO significa Data Transfer Object que serve, como o nome já diz, apenas para levar dados. Uma class DTO não deve ter regras de negócio ou qualquer código que faça alguma ação, ele serve apenas para transportar informação

Veja como ficaria em um exemplo abaixo a utilização de um DTO:

public DogDTO getDogById(int id){
    final Dog dog = dogRepository.findById(id);

    final DogDTO dogDTO = new DogDTO();
    dogDTO.setId(dog.getId());
    dogDTO.setName(dog.getName());

    return dogDTO;
}

Veja que estamos protegendo nossa entidade da VIEW e que toda as anotações de JSON podem e devem ficar na classe DogDTO. Criar um atributo na entidade (Dog) que não precise ser enviado para a VIEW não afetará em nada a classe que de VIEW (DogDTO).

Existe um problema na abordagem acima… Imagine que a classe DogTO tenha 25 atributos… Seria necessário ter 25 get/set para passar os dados da entidade para o DTO. Não desanime com isso, existe um modo de facilitar esse processo.

Como facilitar a cópia de uma Entity para um DTO

Existem frameworks que facilitam na hora de passar a informação de uma Entity para um DTO. Vou citar dois frameworks que têm uma classe BeanUtils: Apache e Spring.

Veja o código abaixo:

BeanUtils.copyProperties(source, target);

Utilizando essas bibliotecas podemos copiar os dados de uma classe para a outra sem muito esforço. Cada biblioteca tem sua abordagem e seus requisitos, vale a pena investir tempo estudando um pouco de cada e decidir qual a melhor para o seu projeto.

Solução proposta

Não retorne entidade de JPA para sua VIEW. Não acople seu modelo de negócio à cadama de visualização dos dados.

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