iBATOR - Introdução

iBATOR é um gerador de código para iBATIS. O iBATOR examina uma ou mais tabelas do banco de dados e gera artefatos iBATIS que podem ser usados ​​para acessar as tabelas.

Posteriormente, você pode escrever seu código SQL personalizado ou procedimento armazenado para atender aos seus requisitos. O iBATOR gera os seguintes artefatos -

  • Arquivos XML SqlMap
  • Classes Java para corresponder à chave primária e aos campos da (s) tabela (s)
  • Classes DAO que usam os objetos acima (opcional)

O iBATOR pode ser executado como um arquivo JAR autônomo, ou como uma tarefa Ant, ou como um plugin do Eclipse. Este tutorial descreve a maneira mais simples de gerar arquivos de configuração iBATIS a partir da linha de comando.

Baixar iBATOR

Baixe o JAR independente se estiver usando um IDE diferente do Eclipse. O JAR autônomo inclui uma tarefa Ant para executar o iBATOR ou você pode executar o iBATOR a partir da linha de comando do código Java.

Gerando arquivo de configuração

Para executar o iBATOR, siga estas etapas -

Passo 1

Crie e preencha um arquivo de configuração ibatorConfig.xml apropriadamente. No mínimo, você deve especificar -

  • UMA <jdbcConnection> elemento para especificar como se conectar ao banco de dados de destino.

  • UMA <javaModelGenerator> elemento para especificar o pacote de destino e o projeto de destino para os objetos de modelo Java gerados.

  • UMA <sqlMapGenerator> elemento para especificar o pacote de destino e o projeto de destino para os arquivos de mapa SQL gerados.

  • UMA <daoGenerator> elemento para especificar o pacote de destino e o projeto de destino para as interfaces e classes DAO geradas (você pode omitir o elemento <daoGenerator> se não desejar gerar DAOs).

  • Pelo menos um banco de dados <table> elemento

NOTE −Consulte a página XML Configuration File Reference para obter um exemplo de arquivo de configuração iBATOR.

Passo 2

Salve o arquivo em um local conveniente, por exemplo, em: \ temp \ ibatorConfig.xml.

etapa 3

Agora execute o iBATOR a partir da linha de comando da seguinte maneira -

java -jar abator.jar -configfile \temp\abatorConfig.xml -overwrite

Ele dirá ao iBATOR para rodar usando seu arquivo de configuração. Também dirá ao iBATOR para sobrescrever todos os arquivos Java existentes com o mesmo nome. Se você deseja salvar qualquer arquivo Java existente, omita o−overwrite parâmetro.

Se houver um conflito, o iBATOR salva o arquivo recém-gerado com um nome exclusivo.

Depois de executar o iBATOR, você precisa criar ou modificar os arquivos de configuração iBATIS padrão para usar o código recém-gerado. Isso é explicado na próxima sessão.

Tarefas após executar o iBATOR

Depois de executar o iBATOR, você precisa criar ou modificar outros artefatos de configuração do iBATIS. As principais tarefas são as seguintes -

  • Crie ou modifique o arquivo SqlMapConfig.xml.
  • Crie ou modifique o arquivo dao.xml (somente se você estiver usando o iBATIS DAO Framework).

Cada tarefa é descrita em detalhes abaixo -

Atualizando o arquivo SqlMapConfig.xml

O iBATIS usa um arquivo XML, comumente denominado SqlMapConfig.xml, para especificar informações para uma conexão de banco de dados, um esquema de gerenciamento de transações e arquivos XML de mapa SQL que são usados ​​em uma sessão iBATIS.

O iBATOR não pode criar este arquivo para você porque ele não sabe nada sobre o seu ambiente de execução. No entanto, alguns dos itens neste arquivo estão diretamente relacionados aos itens gerados pelo iBATOR.

As necessidades específicas do iBATOR no arquivo de configuração são as seguintes -

  • Os namespaces de instrução devem ser ativados.
  • Os arquivos XML de mapas SQL gerados pelo iBATOR devem ser listados.

Por exemplo, suponha que o iBATOR tenha gerado um arquivo XML de Mapa SQL chamado MyTable_SqlMap.xml e que o arquivo foi colocado no pacote test.xml do seu projeto. O arquivo SqlMapConfig.xml deve ter essas entradas -

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sqlMapConfig PUBLIC "-//ibatis.apache.org//DTD SQL Map Config 2.0//EN" "http://ibatis.apache.org/dtd/sql-map-config-2.dtd">

<sqlMapConfig>
   <!-- Statement namespaces are required for Abator -->
   <settings useStatementNamespaces="true" />

   <!-- Setup the transaction manager and data source that are
   appropriate for your environment
   -->
	
   <transactionManager type="...">
      <dataSource type="...">
      </dataSource>
   </transactionManager>

   <!-- SQL Map XML files should be listed here -->
   <sqlMap resource="test/xml/MyTable_SqlMap.xml" />

</sqlMapConfig>

Se houver mais de um arquivo XML de Mapa SQL (como é bastante comum), os arquivos podem ser listados em qualquer ordem com elementos <sqlMap> repetidos após o elemento <transactionManager>.

Atualizando o arquivo dao.xml

A estrutura iBATIS DAO é configurada por um arquivo xml comumente chamado dao.xml.

A estrutura iBATIS DAO usa esse arquivo para controlar as informações de conexão do banco de dados para DAOs e também para listar as classes de implementação DAO e as interfaces DAO.

Nesse arquivo, você deve especificar o caminho para o arquivo SqlMapConfig.xml e todas as interfaces DAO geradas pelo iBATOR e classes de implementação.

Por exemplo, suponha que o iBATOR tenha gerado uma interface DAO chamada MyTableDAO e uma classe de implementação chamada MyTableDAOImpl, e que os arquivos foram colocados no pacote test.dao do seu projeto.

O arquivo dao.xml deve ter essas entradas -

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE daoConfig PUBLIC "-//ibatis.apache.org//DTD DAO Configuration 2.0//EN" "http://ibatis.apache.org/dtd/dao-2.dtd">

<daoConfig>

   <context>
	
      <transactionManager type="SQLMAP">
         <property name="SqlMapConfigResource" value="test/SqlMapConfig.xml"/>
      </transactionManager>

      <!-- DAO interfaces and implementations should be listed here -->
      <dao interface="test.dao.MyTableDAO" implementation="test.dao.MyTableDAOImpl" />
   </context>
	
</daoConfig>

NOTE − Esta etapa é necessária apenas se você gerou DAOs para a estrutura iBATIS DAO.