Ferramentas: jar e javadoc

Transcrição

1 Ferramentas: jar e javadoc Material baseado na apostila FJ-11: Java e Orientação a Objetos do curso Caelum, Ensino e Inovação, disponível para download em 1

2 Objetivos criar o JAR do seu aplicativo executar o JAR do seu projeto ler um javadoc criar o javadoc do seu aplicativo 2

3 Arquivos.jar Um aplicativo em Java é composto por dezenas, ou mesmo centenas de classes; Além das classes escritas especificamente para a aplicação, o programa pode usar diversas bibliotecas de classes escritas por terceiros. Seria complicado enviar todo esse conjunto de classes para que alguém pudesse rodar o aplicativo 3

4 Arquivos.jar A maneira mais fácil de distribuir um aplicativo Java é zipar o conjunto de classes em um único arquivo. O arquivo criado tem a extensão.jar e é descompactado na máquina virtual, em tempo de execução 4

5 Criação de arquivos.jar no NetBeans Vamos seguir o passo a passo para a criação de um arquivo.jar no NetBeans. Vamos usar como exemplo o projeto cujo diagrama de classes é mostrado a seguir. 5

6 Criação de arquivos.jar no NetBeans 1. No NetBeans, vá até o menu Arquivo e selecione a opção Novo projeto Na janela que se abre, deixe marcadas as opções default Java e Aplicativo Java e clique no botão Próximo > 6

7 Criação de arquivos.jar no NetBeans 3. Na janela que se abre, dê o nome Projeto1 ao projeto e desmarque a opção Criar classe principal 4. Clique sobre o botão Finalizar 7

8 Criação de arquivos.jar no NetBeans 5. Clique com o botão direito sobre o nó do projeto e selecione a opção Novo, Pacote Java Na janela que se abre, dê o nome pacote1 ao novo pacote e clique sobre o botão Finalizar. 8

9 Criação de arquivos.jar no NetBeans 7. Repita o procedimento e crie o pacote pacote2 no projeto. 8. Seu projeto agora deve se parecer com: 9. Clique com o botão direito sobre o nó do pacote1 e selecione a opção Novo, Classe Java Na caixa de diálogo que se abre, dê o nome C1 à nova classe e clique no botão Finalizar 9

10 Criação de arquivos.jar no NetBeans 11. Digite o seguinte código para a classe C1 12. Clique com o botão direito sobre o nó do pacote2 e selecione a opção Novo, Classe Java Na caixa de diálogo que se abre, dê o nome C2 à nova classe e clique no botão Finalizar 10

11 Criação de arquivos.jar no NetBeans 14. Digite o código a seguir para a classe C2 15. Clique com o botão direito sobre o nó do pacote2 e selecione a opção Novo, Classe Java Na caixa de diálogo que se abre, dê o nome Main à nova classe e clique no botão Finalizar 11

12 Criação de arquivos.jar no NetBeans 17. Digite o código a seguir para a classe Main 18. Nesse ponto você poderia rodar o seu programa pelo NetBeans, mas isso não seria nenhuma novidade. Vamos, ao contrário, ver como executar o seu aplicativo em linha de comando. 12

13 Criação de arquivos.jar no NetBeans 19. Vá ao menu Executar e selecione a opção Construir Main Project, ou use a tecla de atalho F Você verá na janela de saída algo como: 21. Observe o caminho para o arquivo *.jar gerado 22. Vamos executar esse arquivo em linha de comando. Abra uma janela de comando e digite o comando: java jar <caminho do jar>\projeto1.jar 13

14 Criação de arquivos.jar no NetBeans 23. Observe o resultado. 14

15 Criação de arquivos.jar no NetBeans 24. Vamos abrir o arquivo Projeto1.JAR no NetBeans e ver o seu conteúdo. Vá até a aba Arquivos e, expanda completamente a pasta dist do Projeto1, até encontrar: 25. Como você pode observar, o JAR gerado corresponde ao conjunto dos bytecodes das classes do projeto. 15

16 Usando arquivos JAR como bibliotecas de classes Vamos agora criar um outro projeto, Projeto2, que utilize a classe C1, criada no projeto anterior. Observe que, no Projeto2, queremos reaproveitar a classe C1, mas não a nível de código fonte. Queremos reaproveitar os bytecodes gerados e encapsulados no arquivo Projeto1.jar Siga então os seguintes passos: 16

17 Usando arquivos JAR como bibliotecas de classes 1. No NetBeans, vá até o menu Arquivo e selecione a opção Novo projeto Na janela que se abre, deixe marcadas as opções default Java e Aplicativo Java e clique no botão Próximo > 3. Na janela que se abre, dê o nome Projeto2 ao projeto e deixe marcada a opção Criar classe principal 4. Modifique o código da classe Main para que ela se pareça com: 17

18 Usando arquivos JAR como bibliotecas de classes 5. Observe os erros de compilação gerados. Por que isso ocorreu? O pacote pacote1 e a classe C1 não pertencem a esse projeto e não são conhecidos pelo compilador. Como resolver esse problema? 6. Clique com o botão direito do mouse sobre o nó Bibliotecas do Projeto2 e selecione a opção Adicionar JAR/pasta Na caixa de diálogo que se abre, localize o arquivo Projeto1.jar e clique sobre o botão Open 18

19 Usando arquivos JAR como bibliotecas de classes 8. Observe que os erros de compilação desapareceram do código da classe Main. A figura a seguir mostra que o arquivo Projeto1.jar foi adicionado ao projeto. 19

20 Usando arquivos JAR como bibliotecas de classes 9. Vamos agora gerar o JAR do novo projeto. Vá ao menu Executar e selecione a opção Construir Main Project, ou use a tecla de atalho F Você verá na janela de saída algo como: 11. Observe o caminho para o arquivo *.jar gerado 20

21 Usando arquivos JAR como bibliotecas de classes 12. Vamos executar esse arquivo em linha de comando. Abra uma janela de comando e digite o comando: java jar <caminho do jar>\projeto2.jar 13. Observe o resultado. 21

22 Usando arquivos JAR como bibliotecas de classes 14. Vamos abrir o arquivo Projeto2.JAR no NetBeans e ver o seu conteúdo. Vá até a aba Arquivos e, expanda completamente a pasta dist do Projeto2, até encontrar: 15. Observe que o arquivo JAR do Projeto1 foi incluído no JAR do Projeto2 22

23 Javadoc 23

24 Javadoc Javadoc é uma ferramenta para a geração automática de documentação HTML de uma API. A idéia é tentar aproximar a atividade de documentação da tarefa de geração do código. A documentação HTML é gerada a partir de comentários inseridos no código fonte O NetBeans suporta a geração e a visualização de documentação Javadoc 24

25 Gerando Javadoc A documentação Javadoc pode ser gerada a partir de comentários com formato especial, colocados no código fonte. A idéia é inserir comentários para cada classe, cada atributo e cada método no projeto, bem como para os parâmetros recebidos e os valores retornados pelos métodos. Esses comentários devem explicar a intenção de cada um desses componentes do software. Você pode facilmente inserir comentários Javadoc no seu código fonte usando uma ferramenta da IDE. 25

26 Gerando Javadoc Considere a classe Conta pertencente ao projeto prjconta 26

27 Gerando Javadoc Clique com o botão direito do mouse sobre o nó do projeto representando a classe Conta e selecione a opção Ferramentas, Analisar Javadoc 27

28 Gerando Javadoc O NetBeans lhe dá a opção de acrescentar comentários Javadoc a cada uma das classes, atributos e métodos do projeto. 28

29 Gerando Javadoc Vamos marcar todas as sugestões e ver o código gerado pelo NetBeans. A classe Conta 29

30 Gerando Javadoc A classe Conta (continuação) 30

31 Gerando Javadoc Vamos agora preencher os comentários Javadoc 31

32 Gerando Javadoc 32

33 Gerando Javadoc 33

34 Gerando Javadoc Vamos agora gerar a documentação HTML propriamente dita. Vá ao menu Executar e selecione a opção Gerar Javadoc. Após alguns segundos, o arquivo HTML é gerado e exibido em seu browser padrão. 34

35 35