Suporte aos Processadores de Anotação no NetBeans IDE

Amostra contribuída por Jesse Glick.

O conteúdo desta página se aplica ao NetBeans IDE 6.9, 7.0 e 7.1

Esse tutorial de duas partes demonstra como é possível anexar processadores de anotação a um projeto e utilizá-los enquanto estiver trabalhando no código no IDE. O NetBeans IDE possui suporte incorporado a processadores de anotações personalizados. Agora é possível especificar convenientemente processadores de anotação para serem executados com o projeto e visualizar os resultados do processo de anotação diretamente no editor Java usando o recurso autocompletar código e navegação.

A primeira parte do tutorial exibe a utilização do processador de anotação de terceiros, Projeto Lombok, no NetBeans IDE.

A segunda parte do tutorial fornece explicações sobre como adicionar um processador de anotação de autoescrita em um projeto. O código amostra para essa parte do tutorial é uma colaboração de Jesse Glick.

Para concluir este tutorial, você precisa dos seguintes recursos e softwares.

Software ou Recurso Versão Necessária
NetBeans IDE 7.1, 7.2, 7.3
Java Development Kit (JDK) versão 6

Observações:

  • O suporte a processadores de anotações personalizadas foi adicionado na release 6.9 do NetBeans IDE. Este tutorial não funcionará com versões anteriores do IDE.

Introdução

Anotações são mecanismos da linguagem de programação Java que são utilizados para manter metadados sobre os elementos da aplicação. Anotações mantêm metainformações sobre como os elementos anotados devem ser processados pelo compilador, durante uma implantação ou runtime. Em outras palavras, anotações são comentários do código que podem ser processadas por outros programas e ferramentas.

É possível utilizar anotações personalizadas para realizar uma variedade de tarefas: marcar partes da aplicação (por exemplo, a informação de direitos autorais, métodos de teste, etc.), gerar código automaticamente, fazer parsing das opções de linha de comandos, desenvolver Web services, e outros. As informações sobre como anotações personalizadas devem ser processadas são passadas para o compilador Java por meio dos processadores de anotação personalizados. JSR 269 implementado em JDK 6 fornece uma API original para processadores de anotação escrita. É possível escrever seu próprio processador de anotação personalizado ou utilizar as soluções de terceiros.

Para informações iniciais sobre anotações no JDK 6, consulte os recursos a seguir:

Na prática, anotações são mais utilizadas combinadas com Java Persistence API (JPA), que é parte da especificação Java EE e algumas outras tecnologias, como o JAXB (Java Architecture para vinculação de XML). Utilizando JPA, as classes Java podem ser anotadas como entidades que mais tarde podem ser persistidas em um dispositivo de armazenamento. Para desenvolver aplicações com base em JPA, é conveniente utilizar frameworks, como por exemplo o EclipseLink, que é agrupado com o IDE. Como ponto inicial para mais informações sobre como escrever aplicações com base em JPA no NetBeans IDE, consulte Iniciar com Aplicações Java EE 6.

Mapa das Opções do javac e comandos IDE para Processamento de Anotação

Como mencionado acima, no Java SE 6 javac, o processamento de anotação foi incorporado como funcionalidade integral do compilador Java. O compilador pesquisa automaticamente processadores de anotação por default, como caminho de classe de usuário (a menos que o processamento de anotação estiver desativado explicitamente). Além disso, o caminho de pesquisa ou o caminho para processadores de anotação específicos podem ser especificados utilizando opções javac. Na tabela abaixo, é possível visualizar um mapa das opções javac relacionado ao processamento de anotação e os comandos correspondentes no IDE. Para mais informações sobre opções javac no JDK 6, consulte javac - Compilador da linguagem de programação Java.

Observação. No IDE, as opções de processamento da anotação para todas as aplicações Java, com exceção das aplicações da plataforma Netbeans são especificados na janela Propriedades do Projeto. Para abrir a janela Propriedades do projeto, clique com o botão direito do mouse em seu projeto e selecione Propriedades.

Opções Java 6 javac Comando IDE Descrição
-processador

Propriedades do Projeto > Construção > Compilação > campo Processadores de Anotação.

Especifique um nome completo qualificado do processador de anotação no campo Processador da Anotação.

Especifique explicitamente o processador de anotação para executar. Esta opção elimina a necessidade de criar arquivos de configuração do serviço do provedor (META-INF/services/javax.annotation.processing.Processor)
-proc:none

Propriedades do Projeto > Construção > Compilação > caixa de seleção Ativar Processamento de Anotação

Quando a caixa de seleção estiver desativada, o projeto será compilado sem qualquer processamento de anotação.

A compilação continua sem qualquer processamento de anotação. O mecanismo de descoberta do processador de anotação não é usado durante a compilação.
-processorpath

Propriedades do Projeto > Bibliotecas > guia Processador

Especifique o caminho para um projeto IDE, biblioteca ou um arquivo Jar que contém um processador de anotação. Utilize esta opção se um processador de anotação e anotações são encapsulados em arquivos JAR separados.

Especifica onde localizar processadores de anotação; se essa opção não for oferecida, o caminho da classe é localizado por processadores (veja abaixo).
-classpath

Propriedades do projeto > Bibliotecas > guia Compilador

Especifique o caminho para um projeto IDE, biblioteca ou um arquivo Jar que contém um processador de anotação e declarações de anotação. Utilize esta opção se um processador de anotação e anotações forem encapsulados em um único arquivo JAR.

Especifica onde localizar arquivos de classe de usuário e (opcionalmente) processadores de anotação e arquivos código-fonte. Esse caminho é localizado para processadores de anotação se a opção -processorpath não for especificada.
-Akey[=value]

Propriedades do Projeto > Construção > Compilação > campo Opções do processador

Adicione opções que devem ser passadas para o processador de anotação associado ao projeto. Esse valor é opcional.

(Opcional) Opções para passar para processadores de anotação.

 

Próximas Etapas

Leia as partes a seguir do tutorial para aprender como utilizar anotações no IDE.

get support for the NetBeans

Support


By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2013, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo