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

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

2º Bate Papo do SP-GTUG - Divulgação

Pessoal, Para aqueles que já estiveram presentes nas atividades do SP-GTUG (encontros ou bate papos na Globalcode), e para os que ainda não puderam estar presentes, teremos um novo bate papo acerca de mais duas tecnologias do Google: AdSense e Python no GAE. Este será o nosso segundo bate papo do SP-GTUG, nos mesmos moldes dos minicursos da Globalcode . Local e data O bate papo acontecerá no dia 27/03/10, das 10:00 às 13:00 na Globalcode. Para fazer sua inscrição e participar acesse a home da Globalcode e vá até a parte de "Minicursos Gratuitos da Semana ". Conteúdo das apresentações Abaixo seguem as descrições passadas pelos palestrantes: Título: "Algoritmos em Python" Resumo: Python é uma linguagem considerada frugal, simples, sem ser simplória! Entenda como construir algoritmos ninjas com essa linguagem, adotada pela Google e pelo MIT. Veremos muito, muito código, desde algoritmos clássicos até tutoriais do

JSF 2 - Composite Components, você não precisa mais ser um ninja

Estamos em uma nova era da computação, os dados não estão mais localizados em um banco dentro de sua empresa, vivemos a explosão de redes sociais, informações são geradas a todo instante, e se torna essencial que sua aplicação conheça os serviços disponíveis na web e consumam suas APIs geralmente disponíveis por serviços REST. Legal, mas como ficam meus aplicativos Java EE neste novo cenário? Para quem vem acompanhando a evolução da plataforma, é notório que todo esforço vem sendo utilizado para aumentar a produtividade e a integração com novos serviços. Basicamente duas especificações surgem com muita força para atender este cenário, a JSR - 314 (JSF-2) e JSR - 311 (JAX-RS), neste post exploraremos a JSR-314 (JSF2) e sua nova forma de criar Composite Components. Uma das grandes queixas dos desenvolvedores JSF era a complexidade em criar composite components, era necessário um vasto conhecimento sobre o ciclo de vida de uma aplicação JSF. Agora, você não precisa ser mais um “ninja” em

Gosta de informática e sonha ser programador Java um dia ?

A Globalcode está procurando jovens que queiram ser programadores no futuro, para fazer parte de sua equipe de vendas e operacional na unidade Paraíso em São Paulo somente. O grande diferencial é o planejamento para carreira de programador. O planejamento de cursos do portifólio da Globalcode: Academia do Programador, Academia Java, Academia Web, Robótica, Eletrônica, etc, será realizado periodicamente de acordo com o desempenho e interesse individual. Atenção : Este não é um estágio para trabalhar com Java, são duas vagas CLT administrativas para pessoas que queiram ser programadores no futuro. Perfil : Conhecimentos de informática básica, saber lidar com pessoas e trabalhar em equipe. Deve ter concluído o ensino médio, ter boa escrita, ser organizado, responsável, comprometido e dinâmico. Interesse por computação, programação, internet, robótica, eletrônica,... Temos duas vagas para jovem-aprendiz abertas: 1) Setor operacional No dia a dia Serviços externos Controle de estoqu

Palestras do TDC Business Disponíveis Online

🚨 Atenção, TDC Lovers! O TDC Business em São Paulo acabou, mas os conteúdos mal começaram!  Não pô de aproveitar a STADIUM ao vivo? Não tem problema, porque trouxemos ela até você. Todas as palestras da STADIUM, palco principal do TDC, já estão no ar e liberadas para qualquer pessoa assistir. Essa Trilha incrível conta com palestras de Trilhas Premium e temas variados de forma GRATUITA para você poder maratonar de casa!  Aproveite para prestigiar seu evento de TI favorito com pipoca direto do seu sofá. 🎥 🍿 Gravação da STADIUM, 22 a 24 de Agosto de 2022, disponível aqui: https://www.globalcode.com.br/videos/tdc-2022-business/  Todas as demais trilhas do TDC Business serão publicadas gradualmente nas próximas semanas, fique atento aos nossos e-mails, você será notificado por lá quando sua Trilha estiver disponível. Acompanhe nossas redes sociais para não perder nada e ficar por dentro de todas as novidades do TDC!

TDC INNOVATION lança University Pass

Modalidade de ingresso tem como objetivo ajudar na capacitação dos universitários Uma pesquisa realizada em 2020 pela Associação Brasileira das Empresas de Tecnologia da Informação e Comunicação (Brasscom) diz que até o ano de 2024 o Brasil precisará de cerca de 420 mil profissionais na área de Tecnologia da Informação. Porém, por ano, a mesma pesquisa diz que o país forma apenas 46 mil profissionais capacitados no nicho. Pensando nisso, para ajudar na formação e capacitação desses jovens profissionais, o TDC INNOVATION, segunda edição do ano do The Developer's Conference, lança o University Pass, modalidade de ingresso que possibilita aceso digital gratuito a todas as palestras do evento, ou com 50% de desconto para quem preferir ir pessoalmente. Com o tema central “Desafios para a criação do futuro Digital”, o TDC INNOVATION ocorrerá entre 1 e 3 de junho, de forma híbrida: presencialmente no Centro de Convenções CentroSul, em Florianópolis, e com transmissão simultaneamente pela