Programador ajudante e aprendiz da comunidade open source.

VRaptor e Hibernate Com Repository, Generics e Herança

Uma dificuldade frequente para os desenvolvedores, iniciantes ou não, em seus primeiros projetos é como organizar a estrutura de suas aplicações. Com tantos padrões e idéias diferentes fica fácil se perder em meio às palavras abstract, interface, generics, herança, sobrescrita, sobrecarga e afins. Pensando em dar um norte para quem esta começando uma aplicação, vamos criar um projeto utilizando alguns padrões junto a esse monte de palavras que a princípio nos assutam.

Objetivo:

Usando VRaptor e o Hibernate, criar um projeto voltado a interface que tire proveito das classes genéricas e da herança.

Herança

Como o nome mesmo já diz, a herança serve para herdar alguma coisa de alguém. Sendo assim, é muito utilizada para fazer o reaproveitamento de código, que será o nosso caso neste post. É claro que sua utilização é muito ampla como, por exemplo, tirar proveito do polimorfismo. Mas o foco deste artigo não é explicar estes conceito que já estão bem abatidos por ai. Como estamos utilizando o Hibernate poderíamos criar uma classe que mantenha o atribute id que cada model da aplicação obrigatoriamente deve possuir. Desta forma será criada uma classe abstrata para manter esse atributo que poderá ser herdado por outras classes. Este atributo também já estará anotado com as configurações da JPA e o seu get() e set(), aumentando com isso o reaproveitamento do código:

@MappedSuperclass
public class AbstractEntity {

 @Id
 @GeneratedValue
 private Long id;

 // get e set

}

Esta classe servirá de base para todos os modelos do sistema. Logo, devemos fazer com que os models herdem essa classe. Assim, o atributo id e seus respectivos get() e set() não precisarão ser repetidos em todos os modelos criados, pois agora iremos recebê-los da entidade AbstractEntity através da herança. Nesta classe poderá ser adicionado qualquer código que necessite ser comum às entidades como, por exmeplo, o hashCode() e equals(). Veja um exemplo a seguir como a entidade Usuario receberia estes valores por herança:

public class Usuario extends AbstractEntity {

}

É preciso observar que a entidade abstrata só servirá para herança, por isso, no lugar do @Entity, esta classe É anotada com @MappedSuperclass. Essa anotação diz para o Hibernate que a classe não será uma entidade que terá uma representação no banco em forma de tabela, sendo apenas uma superclasse.

Generics

A classe genérica é aquela que não recebe ou manipula um tipo exato, ou seja, ela tem a capacidade de trabalhar com vários tipos de classes diferentes. O nosso sistema possuirá a classe GenericBusiness, que manterá o CRUD base. Esta classe não irá manipular um model específico, mas sim o que indicarmos, por isso ela é genérica. Assim, todas as outras classes de negócios que dependam de alguma ação do CRUD deverá herdá-la para obter estes métodos prontos. No código a seguir temos um trecho dessa classe genérica que em sua declaração recebe o tipo do modelo a ser manipulado:

public abstract class GenericBusiness<T extends AbstractEntity> {

 protected EntityManager manager;
 protected Class<T> clazz;

 ...

}

Recebemos um argumento genérico T para indicar e manter o tipo da classe manipulada no momento. Veja que só são aceitas classes que estendem AbstractEntity, ou seja, deve ser uma entidade que obrigatoriamente tenha o atributo id, deixando nossa estrutura um pouco menos sussetível a erros.

A classe GenericBusiness precisará do EntityManager e de um atributo do tipo Class, que servirá para manter o tipo da classe recebida através do argumento genérico T. Esta classe a ser manipulada será capturada no construtor da classe genérica, como mostrado a seguir:

protected GenericBusiness(EntityManager manager) {
 this.manager = manager;
 this.clazz = (Class<T>)
  ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0];
}

Através da classe atual, GenericBusiness, o tipo genérico é recuperado e convertido para o tipo parametrizado. Com isso o método getActualTypeArguments() recupera a lista dos argumentos e devolve apenas o primeiro por meio de seu índice [0], que é exatamente o tipo genérico. Por fim, este tipo genérico é convertido em um Class para que possamos saber qual classe a nossa classe genérica irá manipular. Quanto ao manager, continua com a sua injeção normalmente, porém não precisaremos injetá-lo em cada uma das camada de negócios que forem existir no sistema, pois ele também será herdado.

Como o tipo da classe é dinâmico, será utilizado o argumento genérico T para representar o modelo e o atributo clazz para representar a classe desse modelo, pois tanto o tipo quanto a classe serão capturados em tempo de execução. Dessa forma, criaríamos o método remove() da seguinte forma:

public void remove(T entity) {
 manager.remove(manager.getReference(clazz, entity.getId()));
}

E onde deveria ser passado a classe da entidade, será passado o atributo clazz. Em uma HQL que tenha o nome do modelo a ser manipulado, escrito estaticamente, agora terá este nome capturado a partir do atributo clazz, como visto a seguir:

manager.createQuery("from " + clazz.getName());

Deste modo não importa qual modelo será tratado, pois a classe genérica é inteligente o suficiente para montar os métodos CRUD para cada um deles. Com isso, evitamos a criação destes métodos em cada camada de negócio de um determinado modelo, bastando que estas camadas estendam a classe genérica para receber esses métodos prontos.

Repository

Hoje em dia há vários padrões disponíveis para melhorar a saúde do projeto. Um deles é o Repository, no qual trabalhamos em cima de interfaces e não mais diretamente com a implementação da lógica. Quando o sistema está voltado à interface, as injeções das camadas de negócios são substituídas por suas respectivas interfaces.

Digamos que temos a camada de negócios UsuarioBusiness, logo deveríamos uma interface para os métodos contidos nessa classe. No Eclipse há uma opção de refatoração que gera uma interface baseada em uma classe com métodos concretos de forma automática. Utilizando esta refatoração, a primeira interface a ser extraída será a do CRUD genérico que acabamos de criar. Este processo pode ser realizado através dos seguintes passos:

  • Abra a classe GenericBusiness;
  • Clique com o botão direito em qualquer lugar do código;
  • Selecione a opção Refactor > Extract Interface;
  • Dê o nome de GenericRepository;
  • Clique em Select All para selecionar todos os métodos;
  • Desmarque a opção Generate method comments e clique em Ok.

Com isso o Eclipse irá rastrear todos os métodos dessa classe e criar uma interface contendo a assinatura de cada um deles, como demonstrado a seguir.

public interface GenericRepository<T extends AbstractEntity> {

 public abstract Collection<T> all() throws Exception;
 public abstract T find(Long id) throws Exception;
 public abstract void remove(T entity) throws Exception;
 public abstract T save(T entity) throws Exception;

}

Esta interface poderia ser criada manualmente, mas é mais seguro e rápido deixar o Eclipse fazer este trabalho. Note que as assinaturas são geradas com os modificadores public abstract. No entanto, como toda interface já é pública e abstrata por padrão, eles podem ser removidos. O Eclipse também já declara, na GenericBusiness, a implementação que ela deverá fazer. Repare no código a seguir que na declaração da implementação também é passado o tipo genérico T da classe, já que este tipo também deve ser declarado na interface criada:

public abstract class GenericBusiness<T extends AbstractEntity> implements GenericRepository<T>

Agora esta camada de negócio genérica está assinando um contrato, ou seja, ela tem que implementar os métodos de sua interface. Contudo, vale a pena destacar que a aplicação não dependerá somente dos métodos CRUD. Lembre-se também que existem métodos específicos de cada entidade. Deste modo, além desta interface criada, é necessária a criação das interfaces de cada camada de negócio, como é o caso de UsuarioBusiness, que terá a seguinte interface:

public interface UsuarioRepository {

}

Assim, quando houver algum método além do CRUD para a entidade Usuario, a assinatura deste método deverá ser incluída na interface UsuarioRepository. O código a seguir mostra como ficará a camada de negócio UsuarioBusiness:

@Component
public class UsuarioBusiness implements UsuarioRepository {

}

A partir deste ponto, em nosso controller, será injetado o repositório em vez da camada de negócio. Com isso é preciso ter atenção, pois o repositório do usuário não tem nenhum método para ser implementado, porém precisamos no mínimo dos métodos CRUD. Então, para conseguirmos os métodos CRUD devemos fazer com que o repositório da camada de negócio estenda o repositório GenericRepository, conforme o código:

public interface UsuarioRepository extends GenericRepository<Usuario> {

}

Veja que na declaração do repositório genérico é passado o tipo da classe a ser manipulada. Neste caso, a classe Usuario. Dessa forma, todos os tipos genéricos T serão substituídos por esse tipo.
Como o repositório de usuário agora possui as assinaturas dos métodos CRUD por estender o repositório genérico, a camada de negócio UsuarioBusiness ficará responsável por implementar estes métodos. Como já deixamos nossa arquitetura bem definida, possuímos uma classe com estas implementações, a GenericBusiness. Portanto, ao invés de implementarmos estes métodos na camada de negócios do usuário, basta que esta camada estenda a camada genérica:

@Component
public class UsuarioBusiness extends GenericBusiness<Usuario> implements UsuarioRepository {

 protected UsuarioBusiness(EntityManager manager) {
  super(manager);
 }

}

Note que agora estamos usando o construtor da camada de negócio do usuário para passar o EntityManager para a classe pai, que neste caso é a classe GenericBusiness. Esta classe genérica agora é responsável por fazer a injeção deste objeto e disponibilizá-lo para qualquer outra classe que herdá-la. Com o repositório criado, certifique-se de injetar as interfaces no lugar das camadas de negócios e o sistema já estará voltado à interface. Desta forma tornamos possível a integração de alguns frameworks que trabalham em cima de interface ou da troca de implementação sem quebrar a compatibilidade do sistema. E com isso teremos uma camada preparada para exposição dos métodos para acesso externo à aplicação, onde o cliente só se preocupará com o que o método faz e não mais com o modo que ele faz. Veja no código a seguir a injeção do nosso repositório no controller do usuário:

private UsuarioRepository repository;

public UsuarioController(UsuarioRepository repository) {
 this.repository = repository;
}

Por fim o nosso GenericBusiness ficaria assim:

public abstract class GenericBusiness<T extends AbstractEntity> implements GenericRepository<T> {

  protected final EntityManager manager;
  private final Class<T> clazz;

  protected GenericBusiness(EntityManager manager) {
  this.manager = manager;

  @SuppressWarnings("unchecked")
  Class<T> clazz = (Class<T>)
  ((ParameterizedType) getClass().getGenericSuperclass()).getActualTypeArguments()[0];

  this.clazz = clazz;
  }

  public Collection<T> all() {
  Query query = manager.createQuery("from " + clazz.getName());

  @SuppressWarnings("unchecked")
  Collection<T> list = query.getResultList();

  return list;
  }

  public T find(Long id) {
  return manager.find(clazz, id);
  }

  public void remove(T entity) {
  manager.remove(manager.getReference(clazz, entity.getId()));
  }

  public T save(T entity) throws CommonException {
  return manager.merge(entity);
  }

}

Agora conseguimos abstrair boa parte do nosso código deixando de lado as preocupações triviais de um sistema. Há também outras formas de tornar o seu código mais reaproveitável nas views utilizando o Sitemesh para trabalhar com templates e o prelude injetar códigos nas páginas.

Essas implementações estão disponíveis no VRaptor Starting Project no sentido de otimizar o seu tempo nas tarefas mais comuns de início de projeto.

Link do projeto:

http://github.com/wbotelhos/vraptor-starting-project

  1. Márcio 7 Fev 2013 23:56

    Me corrija se estiver errado, mas quando você cria uma classe AbstractEntity com um @Id você destrói a validação de chaves compostas. Exemplo, imagina:

    public class A extends AbstractEntity{

    @Id
    String b;

    @Id
    String c;

    }

    Mesmo b e c sendo iguais a chave será composta por id, b e c. Sendo assim, a chave composta que deveria ser só b e c foi pro espaço. Tô certo ?

  2. Gilluan 9 Nov 2012 08:37

    Olá Washington, estou começando no Vraptor e sempre acompanho seu blog para aprender mais sobre a tecnologia. Muito obrigado por dividir seu conhecimento.

  3. Rogerio 2 Out 2012 10:33

    Baixei o projeto vraptor-starting-project e quando faço um upload para a galeria o usuario_id da tabela UsuarioImage fica sempre NULL. Mesmo setando manualmente o usuario_id só consegui ver a imagem mudando @Get@ Path("/usuario/{entity.id}/gallery/{fileName}/image") para @Get("/usuario/{entity.id}/gallery/image/{fileName}")

  4. Hugo Chagas 17 Mai 2012 10:58

    Botelhos, achei interessante o seu exemplo porém surgiu uma dúvida. Me corrija se eu estiver errado, mas a sua camada de negócio está acoplada a sua camada de persistência, já que os métodos de CRUD estão dentro do GenericBusiness. Não seria melhor manter essas duas camadas separadas?

    1. Washington Botelho autor 18 Mai 2012 07:39

      Oi Hugo,

      Quando estamos trabalhando com JDBC temos uma cadama a mais, a DAO.
      Porém usando Hibernate, o DAO é o próprio Hibernate, então não faz muito sentido separar uma outra classe só para chamar um manager.merge(obj), por exemplo. Neste caso a nossa camada de negócios chama o DAO (Hibernate).

      1. Hugo Chagas 21 Mai 2012 17:26

        Excelente Botelhos. Obrigado pelo esclarecimento. O blog tá cada dia melhor. Parabéns!

  5. Luiz José 27 Mar 2012 12:20

    Amigo, excelente post.

    Vc poderia esclarecer como exatamente seria a injeção do entity manager pelo vraptor?

    Obrigado!!

    1. Washington Botelho autor 30 Mar 2012 08:37

      Oi Luiz,

      Quem faz tudo via Inversão de Controle é o próprio VRaptor.
      Basta registrar o componente da JPA no seu web.xml e ela já estará gerenciada pelo container:

      <context-param>
        <param-name>br.com.caelum.vraptor.packages</param-name>
        <param-value>br.com.caelum.vraptor.util.jpa</param-value>
      </context-param>
      

      Em seguida você só precisa declarar e adicioná-la no construtor da sua classe:

      private final EntityManager manager;
      
      protected GenericBusiness(EntityManager manager) {
          this.manager = manager;
      }
      
  6. SuporteDev 21 Mar 2012 20:10

    Muito bom, mais uma vez mandando muito bem! em um outro exemplo que vi no lugar da AbrstractEntity tinha um esquema com genérics (PK) para deixar o tipo da chave primária dinâmico, tb na interface Generics tinha mais alguns métodos comum a todas as entidades. tipo public Integer size();

    1. Washington Botelho autor 23 Mar 2012 12:14

      Oi SuporteDev,

      Deve ser o famoso generics dizendo que a chave pode ser qualquer coisa que implemente Serializable.
      Isso funciona sim, porém só não gosto porque sempre temos que passar o tipo, logo prefiro já definir meu tipo direto, já que não irei alterá-lo.

      Na classe genérica pode ser adicionado qualquer coisa, porém quanto mais coisa não reaproveitada em todas as classes se tornará inútil para quem herda, e devemos tomar cuidado com isso, sendo uma das maiores críticas da herança.

Em resposta:
(cancelar)
Formate seu código utilizando Markdown.