Pular para o conteúdo principal

Geração de classes persistentes com a engenharia reversa no SpringRoo

Fechando uma série com 3 posts que descrevem algumas características do Spring Roo  para a camada de persistência, neste último post vou demonstrar como criar entidades persistentes a partir de uma base de dados relacional, utilizando engenharia reversa via o add-on DBRE (Database Reverse Engineering) do Spring Roo.

O diferencial do Roo, em relação a outras ferramentas de engenharia reversa, é a possibilidade de re-utilizar essa funcionalidade durante todo o ciclo de desenvolvimento, não se limitando apenas na fase inicial de codificação.

Modelo de dados
Vou usar o mesmo projeto demonstração dos outros dois posts, um CRUD de produtos, no MySQL com as seguintes tabelas:

Projeto Roo
Para experimentar a engenharia reversa do Spring Roo é interessante começar um projeto novo. A seguir, as instruções necessárias para montar o projeto:
roo> project --topLevelPackage br.com.yaw.produtos
roo> persistence setup --provider HIBERNATE --database MYSQL --databaseName roodb 
  --hostName localhost --userName roo --password roo
Importante: os parâmetros databaseName, hostName, userName e password mudam conforme a instalação realizada no banco.

Metadata no Banco de dados
O DBRE do Roo precisa de uma conexão com o banco de dados para consultar a estrutura das tabelas (metadados). Isso é feito através da interface DatabaseMetadata implementada pelo driver JDBC subjacente. Essas informações são mantidas pelo Roo em formato XML, e a partir deles o Roo gera o código das entidades persistentes.

Para utilizar o DBRE pela primeira vez, são necessários alguns comandos para configurar o add-on. Para quem já testou o DBRE esses passos podem ser ignorados. Primeiro é necessário instalar o driver JDBC do MySQL, por isso consultamos o seu id na lista de add-ons:
roo> addon list
roo> addon install id --searchResultId 39
Sobre o último comando, esse efetivamente instala o driver e 39 é id do #jdbcdriver do MySQL.

Pronto, agora para consultar a estrutura das tabelas no banco de dados e listar as informações no Shell basta executar a seguinte instrução:
roo> database introspect --schema roodb
<database name="no-schema-required">
  <table name="categoria">
    <column name="id" primaryKey="true" required="true" size="10" 
      type="4,INT"/>
    <column name="nome" primaryKey="false" required="true" size="50" 
      type="12,VARCHAR"/>
    <foreign-key foreignTable="produto" name="fk_categoria" onDelete="none" 
      onUpdate="none">
      <option key="exported" value="true"/>
      <reference foreign="categoria" local="id"/>
    </foreign-key>
    <unique name="PRIMARY">
        <unique-column name="id"/>
    </unique>
  </table>
  <table name="produto">
    <column name="id" primaryKey="true" required="true" size="10" 
      type="4,INT"/>
    <column name="descricao" primaryKey="false" required="true" size="60" 
      type="12,VARCHAR"/>
    <column name="preco" primaryKey="false" required="true" size="22" 
      type="8,DOUBLE"/>
    <column name="categoria" primaryKey="false" required="true" size="10" 
      type="4,INT"/>
    <foreign-key foreignTable="categoria" name="fk_categoria" onDelete="none" 
      onUpdate="none">
      <option key="exported" value="false"/>
      <reference foreign="id" local="categoria"/>
    </foreign-key>
    <unique name="PRIMARY">
      <unique-column name="id"/>
    </unique>
    <index name="fk_categoria">
      <index-column name="categoria"/>
    </index>
  </table>
</database>
Outras opções para executar esse comando:
  • schema no-schema-required: uma opção ao invés do nome do schema.
  • enableViews: habilita a engenharia reversa para visões do banco de dados (View).
  • file: guarda a pesquisa de metadados em arquivo XML.

Geração de Entidades
A geração do código das entidades ocorre através do comando database reverse engineer. A opção package é opcional e indica em qual pacote as classes devem ser geradas. Veja:
roo> database reverse engineer --schema roodb --package ~.model

Created SRC_MAIN_JAVA/br/com/yaw/produtos/model
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Categoria.java
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Produto.java
Updated SRC_MAIN_RESOURCES/META-INF/persistence.xml
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Produto_Roo_ToString.aj
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Produto_Roo_DbManaged.aj
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Categoria_Roo_DbManaged.aj
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Produto_Roo_Configurable.aj
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Categoria_Roo_Entity.aj
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Produto_Roo_Entity.aj
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Categoria_Roo_ToString.aj
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Categoria_Roo_Configurable.aj
Created ROOT/.roo-dbre

Depois de executar esse comando o Roo cria o arquivo .roo-dbre com a estrutura do banco e, as classes Categoria e Produto. Para cada classe o Roo também cria três aspectos, que foram apresentados no primeiro post: _Roo_Configurable, _Roo_Entity e _Roo_ToString.

Porém, com o DBRE o Roo marca a entidade com a anotação @RooDbManaged e cria um quarto tipo de aspecto: _Roo_DbManaged. Nesse aspecto o Roo coloca o código de mapeamento JPA gerado pela engenharia reversa. Veja o exemplo do aspecto Produto_Roo_DbManaged:
//...
privileged aspect Produto_Roo_DbManaged {
    
  @ManyToOne
  @JoinColumn(name = "categoria", referencedColumnName = "id", nullable = false)
  private Categoria Produto.categoria;
    
  @Column(name = "descricao", columnDefinition = "VARCHAR", length = 60)
  @NotNull
  private String Produto.descricao;
    
  @Column(name = "preco", columnDefinition = "DOUBLE")
  @NotNull
  private Double Produto.preco;
  
  public Categoria Produto.getCategoria() {
    return this.categoria;
  }
    
  public void Produto.setCategoria(Categoria categoria) {
    this.categoria = categoria;
  }
    
  public String Produto.getDescricao() {
    return this.descricao;
  }
    
  public void Produto.setDescricao(String descricao) {
      this.descricao = descricao;
  }
    
  public Double Produto.getPreco() {
      return this.preco;
  }
    
  public void Produto.setPreco(Double preco) {
      this.preco = preco;
  }
}

As classes Produto e Categoria ficam praticamente sem código, só com as anotações do Roo. A intenção do Roo é inferir o mínimo possível no código Java sem tirar a autonomia do programador, que pode a qualquer momento sobrescrever na própria entidade um atributo ou remover a marcação @RooDbManaged.

Outras opções também podem ser utilizadas com o comando database reverse engineer:
  • testAutomatically: cria o código de teste de integração para as entidades.
  • enableViews: habilita a engenharia reversa para Visões (View).
  • includeTables: filtra as tabelas que serão processadas, por exemplo as tabelas com o prefixo prod: --includeTables "prod*"
  • excludeTables: opção para restringir tabelas, por exemplo tabelas com prefixo sys: --excludeTables "sys*"

Com mais dois comandos e aplicação já pode ser testada:
roo> controller all --package ~.web
roo> perform package
Caso a tabela sofra alguma modificação, uma nova coluna por exemplo, é possível em qualquer momento executar novamente o comando database reverse engineer que o resto do trabalho é feito pelo Roo.


Relacionamentos
O DBRE compreende o relacionamento entre entidades através das chaves estrangeiras (foreign key) existentes no banco de  dados. No exemplo utilizado aqui, o Roo resolve com associção many-valued bidirecional sendo o Produto relacionado (ManyToOne) a uma Categoria. Já a Categoria com um conjunto de Produtos (OneToMany).

A geração do código seria diferente se, por exemplo, o campo categoria da tabela produto fosse a chave primária. Dessa forma o Roo montaria o relacionamento OneToOne da Categoria com o Produto, nesse caso unidirecional na classe Categoria.

O Roo também suporta a definição de chave primária com duas ou mais colunas, maiores detalhes estam disponíveis na documentação.


Padrão de nomes
O Roo define um algoritmo simples para definir o nome das classes e atributos a partir das tabelas e colunas. Para a tabela os caracteres "_", "-" ou "\" são separadores de nome, veja exemplos:
  • Tabela produto > Classe Produto
  • Tabela produto_categoria > ProdutoCategoria
  • Tabela PRODUTO-ITEM > ProdutoItem

O comportamento é parecido para as colunas:
  • Coluna preco > Atributo preco
  • Coluna codigo_produto > Atributo codigoProduto
É isso!

Outras referências:
[]s
Eder Magalhães
www.yaw.com.br
twitter.com/youandwe
twitter.com/edermag

Comentários

Adriano disse…
Parabéns pelo Post. Você sabe como criar novas anotações para o ROO? Se é possível criarmos um código java e criarmos uma anotação referente a este código, para que seja gerenciado pelo Roo. Tem indicação de material?
Abraço
Alan D Avila disse…
Muito bom o post, é exatamente o que eu estou precisando. Parabéns pela iniciativa e pelo blog.

Postagens mais visitadas deste blog

Melhorando Performance de JPA com Spring Web Flow

No TDC2009 realizado pela Globalcode em São Paulo foi apresentado um Lightning Talk sobre um problema específico de performance em aplicações Web com JPA e uma possível solução usando o Spring Web Flow . Num período de 15 minutos, os slides a seguir foram apresentados e seguidos de alguns vídeos de demonstração de uma aplicação Web em execução. Melhorando performance do JPA com Spring Web Flow View more presentations from Dr. Spock . Nesta apresentação foi dito que temos encontrado problemas de performance em aplicações Web que utilizam as tecnologias JSF + JPA + Ajax quando precisamos gerenciar um contexto de persistência (EntityManager). Estes problemas se manifestam quando aplicamos uma resposta errada para a pergunta: Como gerenciar o contexto de persistência numa aplicação Web? Se as aplicações não usam Ajax e limitam-se ao modelo orientado a requisições, a solução mais comum é o uso do design pattern chamado "Open Session In View Filter". Através deste design

10 reasons why we love JSF

1. One-slide technology: it's so simple that I can explain basic JSF with one slide. 2. Easy to extend: components, listeners, render kit, Events, Controller, etc. 3. Real-world adoption: JBoss, Exadel, Oracle, IBM, ... 4. Architecture model: you can choose between more than 100 different architecture. 5. Open-mind community: using JSF you are going to meet very interesting people. 6. We are using JSF the last 5 years and we found very good market for JSF in Brazil 7. Progress: look to JSf 1.1 to JSF 1.2, JSF 1.2 to JSF 2.0. People are working really hard! 8. Many professionals now available 9. It's a standard. It's JCP. Before complain, report and help! 10. Ed Burns, spec leader, is an old Globalcode community friend! EXTRA: My wife is specialist in JSF. She's my F1 for JSF :) Nice job JSF community! -Vinicius Senger

O que é Lógica de programação?

Este é o segundo de uma série de posts voltados aos leitores do blog que estão dando início à carreira de desenvolvimento de software. O assunto de hoje é a lógica de programação. Para ler antes: Entendendo como funciona a programação de computadores: linguagens de programação, lógica, banco de dados A lógica de programação é um pré-requisito para quem quer se tornar um desenvolvedor de software, independente da linguagem de programação que se pretende utilizar. Mas o que é de fato a Lógica de Programação e como saber se eu tenho esse pré-requisito? A lógica de programação nada mais é do que a organização coerente das instruções do programa para que seu objetivo seja alcançado. Para criar essa organização, instruções simples do programa, como mudar o valor de uma variável ou desenhar uma imagem na tela do computador, são interconectadas a estruturas lógicas que guiam o fluxo da execução do programa. Isso é muito próximo ao que usamos em nosso cotidiano para realizar atividad

Dica rápida: Apagando registros duplicados no MySQL

Ola pessoal, Sei que vocês estão acostumados a ver posts meus sobre tecnologia móvel ou algo relacionado, mas hoje vou falar sobre um pequeno "truque" que usei esse final de semana com o MySQL. Eu estava desenvolvendo o lado servidor de uma nova aplicação mobile (ahh, então "tem a ver" com mobile hehe), e quando fui fazer alguns testes percebi que tinha quase 7 mil registros duplicados (!!!) na minha base de dados! Bom, o meu primeiro reflexo como programador foi pensar em fazer um "programinha" Java para buscar e deletar todos esses registros duplicados. Mas ai, resolvi tirar as teias de aranha dos neurônios e usar os vários anos de experiência que passei com SQL e criar uma query que fizesse esse trabalho todo de uma vez!! E a query ficou assim: delete from TABLE_NAME USING  TABLE_NAME, TABLE_NAME  AS  auxtable WHERE   ( NOT  TABLE_NAME.id  =  auxtable.id ) AND   ( TABLE_NAME.name  =  auxtable.name ) Explicação direta: TABLE_NAME

JavaMail: Enviando mensagem HTML com anexos

Introdução Depois do post "JavaMail: Enviando e-mail com Java" , que apresentava como enviar um e-mail com Java, resolvi complementar a assunto apresentando como enviar uma mensagem formatada, em HTML , e também como realizar o envio de anexos. Bibliotecas Além da biblioteca JavaMail, veja mais no post anterior , é necessário incluir o JavaBeans Activation Framework (JAF), apenas se a versão utilizada for anterior ao JSE 6.0 , que já tem o JAF incluso. O JAF está disponível em http://www.oracle.com/technetwork/java/javase/downloads/index-135046.html , e neste download encontramos, alguns exemplos na pasta demo , documentação, incluindo javadocs, na pasta docs e a biblioteca activation.jar , que deve ser acrescentada no classpath da aplicação para versões anteriores ao JSE 6.0. Exemplo Primeiramente devemos realizar a configuração da javax.mail.Session e da javax.mail.internet.MimeMessage , estes passos podem ser vistos no post anterior . Agora vamos montar um

TDC ONLINE: SUA PLATAFORMA DE PALESTRAS GRAVADAS DO TDC DISPONÍVEL

Além do conteúdo ao vivo transmitido online nas edições do TDC, agora você pode ter acesso à centenas de palestras gravadas, através da nossa nova plataforma de vídeos - o TDC Online, que reúne todas as Trilhas premium, Stadium e Salas dos Patrocinadores das edições anteriores de 2022, TDC Innovation e TDC Connections.  Para acessar, basta clicar na edição em que você participou ( TDC Innovation ou TDC Connections ); Fazer o mesmo login (com e-mail e senha) cadastrados na hora de adquirir ou resgatar o seu ingresso no TDC; E clicar na Trilha de sua opção, e de acordo com a modalidade do seu ingresso. Logo em seguida, você será direcionado para a seguinte página com a lista de todas as palestras por Trilha: Pronto! Agora você tem acesso à centenas de palestras gravadas da sua área de interesse, para assistir como e quando quiser! Caso tenha esquecido a senha, clique na opção "Esqueci a senha" , insira o e-mail que você realizou para o cadastro no evento, e aparecerá a op