7. Ferramentas: jar e javadoc

Arquivos, bibliotecas e versões

Assim que um programa fica pronto, é meio complicado enviar dezenas ou centenas de classes para cada cliente que quer utilizá-lo.

O jeito mais simples de trabalhar com um conjunto de classes é compactá-los em um arquivo só. O formato de compactação padrão é o ZIP com a extensão do arquivo compactado JAR.

Para criar um arquivo jar do nosso programa de banco, basta ir ao diretório onde estão contidas as classes e usar o comando a seguir para criar o arquivo banco.jar com todas as classes dos pacotes br.com.caelum.util e br.com.caelum.banco:

Para usar esse arquivo banco.jar para rodar o TesteDoBanco basta rodar o javacom o arquivo jar como argumento:

Para adicionar mais arquivos .jar, que podem ser bibliotecas, ao programa basta rodar o java da seguinte maneira:

Vale lembrar que o ponto e vírgula utilizado só é válido em ambiente Windows. Em Linux, Mac e outros Unix, é o dois pontos (varia de acordo com o sistema operacional).

Há também um arquivo de manifesto que contém informações do seu jar como, por exemplo, qual classe ele vai rodar quando o jar for chamado. Mas não se preocupe pois, com o Eclipse, esse arquivo é gerado automaticamente.

Criando um .jar automaticamente

Existem diversas ferramentas que servem para automatizar o processo de deploy, que consiste em compilar, gerar documentação, bibliotecas etc. As duas mais famosas são o ANT e o MAVEN, ambos são projetos do grupo Apache.

O Eclipse pode gerar facilmente um jar, porém, se o seu build é complexo e precisa preparar e copiar uma série de recursos, as ferramentas indicadas acima possuem sofisticadas maneiras de rodar um script batch.

Gerando o JAR pelo Eclipse

Neste exemplo, vamos gerar o arquivo JAR do nosso projeto a partir do Eclipse:

Clique com o botão direito em cima do nome do seu projeto e selecione a opção Export.

 

 

Na tela Export (como mostra a figura abaixo), selecione a opção “JAR file” e aperte o botão “Next”.

 

 

Na opção “JAR file:”, selecione o local que você deseja salvar o arquivo JAR. E aperte “Next”.

 

 

Na próxima tela, simplesmente clique em next, pois não há nenhuma configuração a ser feita.

Na tela abaixo, na opção “select the class of the application entry point”, você deve escolher qual classe será a classe que vai rodar automaticamente quando você executar o JAR.

 

 

Entre na linha de comando: java -jar banco.jar

É comum dar um nome mais significativo aos JARs, incluindo nome da empresa, do projeto e versão, como caelum-banco-1.0.jar.

Javadoc

Como vamos saber o que cada classe tem no Java? Quais são seus métodos, o que eles fazem?

E, a partir da Internet, você pode acessar através do link: http://www.oracle.com/technetwork/indexes/downloads/index.html

No site da Oracle, você pode (e deve) baixar a documentação das bibliotecas do Java, frequentemente referida como “javadoc” ou API (sendo na verdade a documentação da API).

 

 

Nesta documentação, no quadro superior esquerdo, você encontra os pacotes e, no inferior esquerdo, está a listagem das classes e interfaces do respectivo pacote (ou de todos, caso nenhum tenha sido especificado). Clicando-se em uma classe ou interface, o quadro da direita passa a detalhar todos atributos e métodos.Repare que métodos e atributos privados não estão aí. O importante é documentar o que sua classe faz, e não como ela faz: detalhes de implementação, como atributos e métodos privados, não interessam ao desenvolvedor que usará a sua biblioteca (ou, ao menos, não deveriam interessar).

Você também consegue gerar esse javadoc a partir da linha de comando, com o comando: javadoc.

Gerando o Javadoc

Para gerar o Javadoc a partir do Eclipse é muito simples, siga os passos abaixo:

Na barra de menu, selecione o menu Project, depois a opção “Generate Javadoc…”. (apenas disponível se estiver na perspectiva Java, mas você pode acessar o mesmo wizard pelo export do projeto).

 

 

Em seguida, aparecerão as opções para gerar a documentação do seu sistema, selecione todas as classes do seu sistema e deixe as outras opções como estão. Não esqueça de marcar o caminho da opção “Destination”, pois é lá que estará sua documentação.

 

 

Abra a documentação através do caminho que você marcou e abra o arquivo index.html

Para colocarmos comentários na documentação, devemos adicionar ao código, sob forma de comentário, abrindo o texto com /** e fechando com */ e, nas outras linhas, apenas colocando *. Também podemos definir outras informações neste texto, como: autor, versão, parâmetros, retorno, etc. Adicione alguns comentários ao seu projeto como abaixo:

Ou adicione alguns comentários em algum método seu:

 

  • 8. Herança, reescrita e polimorfismo