Artigo Invista em voc�! Saiba como a DevMedia pode ajudar sua carreira.

Criando um Lazy Loading Remoto com Annotations e APT

O artigo visa explorar o uso dos annotations e do APT para criar um solu��o Lazy Loading para as entidades que s�o detachada do container Java EE. OBS: Este artigo deu origem a um produto opensource chamado DataSlim e que pode ser baixado em http://code.google.com/p/dataslim/

Lazy Loading � o mecanismo utilizado pelos frameworks de persist�ncia para carregar informa��es sobre demanda. Esse mecanismo torna as entidades mais leves, pois suas associa��es s�o carregadas apenas no momento em que o m�todo que disponibiliza o dado associativo � chamado. No JPA (Java Persistence API), todo atributo associativo de uma entidade � por padr�o Lazy, podendo ser alterado para Eager atrav�s dos annotations @Basic, @ManyToOne, @OneToOne, @OneToMany, @ManyToMany. Quando definimos o fetch para Eager, estamos dizendo para o framework de persist�ncia carregar al�m da entidade desejada, tamb�m o relacionamento que ela possui com o atributo annotado. Neste artigo, vamos tratar especificamente do carregamento Lazy quando a entidade � acessada fora do container, onde n�o existe escopo transacional.

Para ficar claro porque � necess�rio um tratamento especial para o caso onde a entidade � acessada fora do escopo transacional, vamos fazer um acesso bem simples a uma entidade que possui um relacionamento com outra, e ver o que acontece quando fazemos acesso ao m�todo �get� que retorna a entidade associativa.

Cen�rio

O cen�rio proposto � de criar um cadastro simples de endere�o, onde o mesmo ter� um relacionamento �muitos-para-um� com o tipo de logradouro.Quando um endere�o for pesquisado, sua entidade s� poder� carregar sua associa��o com tipo de logradouro, quando o usu�rio acessar o m�todo getTipoLogradouro.

Relacionamento muitos-para-um entre EnderecoBean e TipoLogradouroBean

Vamos criar as classes de persist�ncia EnderecoBean e TipoLogradouroBean.

N�o � escopo deste artigo entrar em detalhes sobre os Annotations do JPA.

Para isso visite o site http://jcp.org/en/jsr/detail?id=220.

Classe TipoLogradouroBean.java
package com.artigo.apt.persistence;
import java.io.Serializable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.persistence.TableGenerator;@Entity(name="TipoLogradouroBean")
@Table(name="TIPO_LOGRADOURO")
public class TipoLogradouroBean implements Serializable{
private Long id;
private String tipo;

@Id
@TableGenerator(
  name="TABLE_SEQUENCE_GENERATOR",
  table="TABLE_SEQUENCE_GENERATOR",
  pkColumnName="GEN_KEY",
  valueColumnName="GEN_VALUE",
  pkColumnValue="tipo_logradouro_id",
  allocationSize=1
)
@GeneratedValue(strategy=GenerationType.TABLE,
  generator="TABLE_SEQUENCE_GENERATOR")
@Column(name="ID")
public Long getId() {
  return id;
} public void setId(Long id) {
this.id = id;
} public void setTipo(String tipo){
  this.tipo = tipo;
} public String getTipo(){
  return tipo;
}
}

Classe EnderecoBean.java

package com.artigo.apt.persistence;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.Table;
import javax.persistence.TableGenerator;

@Entity(name="EnderecoBean")
@Table(name="ENDERECO")
public class EnderecoBean implements java.io.Serializable{
private Long id;
private String endereco;
private String complemento;
private TipoLogradouroBean tipoLogradouro;

@Id
@TableGenerator(
  name="TABLE_SEQUENCE_GENERATOR",
  table="TABLE_SEQUENCE_GENERATOR",
  pkColumnName="GEN_KEY",
  valueColumnName="GEN_VALUE",
  pkColumnValue="endereco_id",
  allocationSize=1
)
@GeneratedValue(strategy=GenerationType.TABLE,
  generator="TABLE_SEQUENCE_GENERATOR")
@Column(name="ID")
public Long getId() {
  return id;
}

public void setId(Long id) {
this.id = id;
}

public String getEndereco() {
return endereco;
}

public void setEndereco(String endereco) {
this.endereco = endereco;
}

public String getComplemento(){
return complemento;
}

public void setComplemento(String complemento){
this.complemento = complemento;
}

@ManyToOne(optional=false)
@JoinColumn(name="TIPO_LOGRADOURO_ID", referencedColumnName="ID")
public TipoLogradouroBean getTipoLogradouro(){
return tipoLogradouro;
}

public void setTipoLogradouro(TipoLogradouroBean tipoLogradouro){
this.tipoLogradouro = tipoLogradouro;
}
}

Analisando o c�digo EnderecoBean, vimos que a associa��o no banco de dados

entre endere�o e tipo logradouro ser� atrav�s da coluna TIPO_LOGRADOURO_ID

e que a associa��o ser� do tipo muitos-para-um definido pela annotation

@ManyToOne. Por padr�o, o framework de persist�ncia j� assume que o fetch

ser� Lazy por ser uma defini��o do JPA, logo n�o � necess�rio ter o

elemento fetch=FetchType.Lazy no annotation @ManyToOne.

Agora vamos criar os sessions beans que ir�o popular as tabelas e fazer as

buscas nas mesmas.

O Session Bean EnderecoFacade ser� respons�vel pela inclus�o dos dados de

tipo de logradouro e endere�o.

Interface IEnderecoFacade.java

package com.artigo.apt.interfaces;

import javax.ejb.Remote;
import com.artigo.apt.persistence.EnderecoBean;
import com.artigo.apt.persistence.TipoLogradouroBean;

@Remote
public interface IEnderecoFacade {

public EnderecoBean persist(EnderecoBean endereco);
public TipoLogradouroBean persist(TipoLogradouroBean logradouroBean);
}

Classe EnderecoFacade.java

package com.artigo.apt.ejb;

import javax.ejb.Stateless;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;
import com.artigo.apt.interfaces.IEnderecoFacade;
import com.artigo.apt.persistence.EnderecoBean;
import com.artigo.apt.persistence.TipoLogradouroBean;

@Stateless(name="EnderecoFacade")
public class EnderecoFacade implements IEnderecoFacade {

@PersistenceContext(unitName="Artigo")
EntityManager em;

   public EnderecoBean persist(EnderecoBean endereco){
      em.persist(endereco);
      return endereco;
   }

   public TipoLogradouroBean persist(TipoLogradouroBean logradouro){
      em.persist(logradouro);
      return logradouro;
   }
}

O Session Bean EnderecoQueryFacade ser� respons�vel pelas buscas feitas no

componente Endere�o.

Classe IEnderecoQueryFacade.java

package com.artigo.apt.interfaces;

import javax.ejb.Remote;
import com.artigo.apt.persistence.EnderecoBean;

@Remote
public interface IEnderecoQueryFacade {

public EnderecoBean findEnderecoById(Long id);

}

Classe EnderecoQueryFacade.java

package com.artigo.apt.ejb;

import javax.ejb.Stateless;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;
import com.artigo.apt.interfaces.IEnderecoQueryFacade;
import com.artigo.apt.persistence.EnderecoBean;

@Stateless(name="EnderecoQueryFacade")
public class EnderecoQueryFacade implements IEnderecoQueryFacade{

@PersistenceContext(unitName="Artigo")
EntityManager em;
public EnderecoBean findEnderecoById(Long id) {
return em.find(EnderecoBean.class, id);
}
}

Build/Deploy

Agora que j� temos nosso componente criado, precisamos apenas fazer o

build e deploy no servidor. Neste estaremos usando o jboss-4.0.4.GA no

fedora 4, por consequ�ncia disso, estou usando os jars :

� /usr/jboss-4.0.4.GA/server/default/lib/ejb3-persistence.jar

� /usr/jboss-4.0.4.GA/server/default/deploy/ejb3.deployer/jboss-ejb3x.jar

� /usr/jboss-4.0.4.GA/server/default/lib/jboss-j2ee.jar

para fazer a compila��o das classes. Para o ciclo de build/deploy, nada

melhor que recorrer ao ant para execu��o desta tarefa. O build.xml e os

artefatos necess�rios para o build encontram-se dispon�veis para download.

Depois de rodar o build.xml o diret�rio com os pacotes fica assim:

Agora � s� copiar o arquivo artigo-apt-core.ear para o diret�rio de deploy

do jboss /usr/jboss-4.0.4.GA/server/default/deploy e subir o servidor.

Agora vamos criar nossa classe cliente.

A classe cliente ser� respons�vel por inserir um tipo de logradouro e um

endere�o, associando um ao outro. Depois de feita a inclus�o, vamos

recuperar o endere�o cadastrado e verificar o retorno do tipo de logradouro

que associamos no cadastro.

Classe APTClient.java

package com.artigo.apt.client;

import javax.naming.InitialContext;

import com.artigo.apt.interfaces.IEnderecoFacade;

import com.artigo.apt.interfaces.IEnderecoQueryFacade;

import com.artigo.apt.persistence.EnderecoBean;

import com.artigo.apt.persistence.TipoLogradouroBean;

public class APTClient {

public TipoLogradouroBean persistLogradouro(String tipo)

throws Exception{

TipoLogradouroBean tipoLogradouroBean = new TipoLogradouroBean();

tipoLogradouroBean.setTipo(tipo);

IEnderecoFacade ief = getEnderecoFacade();

tipoLogradouroBean = ief.persist(tipoLogradouroBean);

return tipoLogradouroBean;

}

public EnderecoBean persistEndereco(TipoLogradouroBean tipoLogradouro, String

endereco, String complemento)

throws Exception{

EnderecoBean enderecoBean = new EnderecoBean();

enderecoBean.setEndereco(endereco);

enderecoBean.setComplemento(complemento);

enderecoBean.setTipoLogradouro(tipoLogradouro);

IEnderecoFacade ief = getEnderecoFacade();

enderecoBean = ief.persist(enderecoBean);

return enderecoBean;

}

public void test() throws Exception{

TipoLogradouroBean logradouroCadastrado = persistLogradouro("Rua");

persistEndereco(logradouroCadastrado, "Mao Tse Tung", "Apto 12E");

}

public void testGetLazy() throws Exception{

IEnderecoQueryFacade ieqf = getEnderecoQueryFacade();

EnderecoBean enderecoCadastrado = ieqf.findEnderecoById(new Long(1));

System.out.println(enderecoCadastrado.getTipoLogradouro().getTipo());

}

public IEnderecoQueryFacade getEnderecoQueryFacade(){

try{

InitialContext ctx = new InitialContext();

Object ref = ctx.lookup("artigo-aptcore/EnderecoQueryFacade/remote");

IEnderecoQueryFacade facade = IEnderecoQueryFacade.class.cast(ref);

return facade;

}catch(Exception e){

e.printStackTrace();

}

return null;

}

public IEnderecoFacade getEnderecoFacade(){

try{

InitialContext ctx = new InitialContext();

Object ref = ctx.lookup("artigo-apt-core/EnderecoFacade/remote");

IEnderecoFacade facade = IEnderecoFacade.class.cast(ref);

return facade;

}catch(Exception e){

e.printStackTrace();

}

return null;

}

public static void main(String argv[]) throws Exception{

APTClient apt = new APTClient();

apt.test();

apt.testGetLazy();

}

Para rodar o cliente, precisamos de alguns pacotes extras do container

para poder ter acesso ao servidor e nos comunicarmos com o componente

Endere�o. Usaremos o ant para gerar o client.jar que cont�m todas as

interfaces e classes que precisamos para ter o cliente pronto pra rodar. O

build-client.xml tamb�m se encontra dispon�vel para download.

Depois que o build-client.xml � rodado o diret�rio de pacotes fica assim:

Agora � s� rodar a target run-client do build-client.xml para executar a

aplica��o, repare que a target faz refer�ncia a pacotes que s�o do

container para ser executado.

Build-client.xml

.....

......

Quando rodamos a aplica��o, vimos que uma exce��o � lancada pelo client

quando o m�todo testGetLazy � executado. Mas por que isso acontece?

run-client:

[java] Sep 8, 2006 9:08:40 AM org.hibernate.LazyInitializationException

[java] SEVERE: could not initialize proxy - no Session

[java] org.hibernate.LazyInitializationException: could not initialize proxy -

no Session

[java] at

org.hibernate.proxy.AbstractLazyInitializer.initialize(AbstractLazyInitializer.java

:57)

[java] at

org.hibernate.proxy.AbstractLazyInitializer.getImplementation(AbstractLazyInitializ

er.java:111)

[java] at

org.hibernate.proxy.pojo.javassist.JavassistLazyInitializer.invoke(JavassistLazyIni

tializer.java:196)

[java] at

com.artigo.apt.persistence.TipoLogradouroBean_$$_javassist_0.getTipo(TipoLogradouro

Bean_$$_javassist_0.java)

[java] at com.artigo.apt.client.APTClient.testGetLazy(APTClient.java:49)

[java] at com.artigo.apt.client.APTClient.main(APTClient.java:79)

Quando executamos o m�todo testGetLazy, recuperamos uma entidade

EnderecoBean leve, ou seja, sem a materializa��o do Tipo de Logradouro, j�

que o padr�o do framework � que o carregamento seja Lazy. Por�m a entidade

que recebemos do container � uma entidade detachada, ou seja, n�o existe

v�nculo nenhum com o container e consequentemente n�o existe sess�o

transacional aberta, o que impossibilita o framework de fazer qualquer

consulta ao banco de dados a partir do cliente. Mas a� fica a duv�da: quer

dizer que o Lazy s� poder� ser usado se estivermos fazendo opera��es dentro

do container, onde existe escopo transacional? A resposta � sim, a n�o ser

que... :).

Soluc�o:

O intuito deste artigo � fazer um Lazy Loading Remoto, utilizando os

Annotations e o APT para isso. Vamos analisar como ser� feito toda essa

m�gica.

O que � Annotation?

Os annotations (JSR-175) s�o um tipo especial de modificador e que podem

ser usados em qualquer lugar onde qualquer outro modificador possa ser usado.

Quando criamos um annotation, indicamos onde o mesmo se encaixa dentro da

estrutura do c�digo Java. Por conven��o os annotations precedem outros modificadores,

e consistem de um sinal �@� seguido pelo tipo do annotation e uma lista de

pares chave-valor quando houver. Os annotations foram criados para �marcar� o

c�digo, essas marca��es servir�o como fonte de informa��o para um comportamento

diferente quando a marca��o colocada for lida.

Estaremos usando a palavra �marcar� para nos referirmos aos annotations em

certos pontos do artigo.

O que � APT?

O APT (Annotation Processing Tool) � uma ferramenta incorporada no Java SE

5.0 para processar os annotations inseridos nos c�digos Java. Sua API

possui novas funcionalidades reflections para analisar o c�digo criado a

procura dos annotations desejado. No nosso exemplo, iremos usar o APT para

verificar alguns annotations criados por n�s para podermos gerar um Proxy.

Mais a frente diremos porque esse Proxy ser� importante.

O APT � acionado por linha de comando que executa um Processador de

Annotations que � instanciado e retornado atrav�s de uma Factory. Sua

principal finalidade � analisar c�digos marcados com annotations e gerar

atrav�s das informa��es fornecidas pelos mesmos arquivos de suporte �

aplica��o, como novos c�digos fontes, classes, arquivos de configura��o

etc. O mecanismo do APT funciona da seguinte forma:

1. O APT verifica quais annotations est�o presente nos c�digos fonte que

ser�o processados.

2. O APT olha para a Factory de Processador de Annotations.

3. O APT pergunta para a Factory quais annotations ser�o processados.

4. O APT solicita ao Factory a inst�ncia do Processador de Annotation

para processar os annotations existentes nos c�digos fonte.

5. O Processador de Annotation � executado para processar o annotation.

Se o processador gerar novos c�digos fontes, o APT vai repetir este

processo at� que nenhum c�digo novo seja gerado.

Criando nossos annotations

Pensando friamente sobre o problema, vimos que o desejado � que no momento

que o m�todo getTipoLogradouro for acionado, uma chamada a facade

EnderecoQueryFacade seja feita, e execute uma consulta no banco de dados

retornando o Tipo de Logradouro associado ao Endereco que estou

manipulando.

Agora vamos analisar que tipos de marca��es precisamos ter, para que tudo

funcione transparentemente.

1 � Precisamos de uma marca��o que nos diga qual classe precisa de um

proxy. Isso � importante para que o Processador de Annotations leia essa

marca��o e gere a nova classe Proxy.

Annotation Proxied.java

package com.artigo.apt.annotations;

import java.lang.annotation.Documented;

import java.lang.annotation.ElementType;

import java.lang.annotation.Inherited;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/**

* Annotation responsavel por marcar as classes que serao proxiadas

* Estando este annotation presente na classe, faz com que o Gerador de

* Proxy gere um proxy para a classe.

* @author rdias

@Documented

@Retention(value=RetentionPolicy.RUNTIME)

@Target(value={ElementType.TYPE})

@Inherited

public @interface Proxied {

}

2 � Precisamos de uma marca��o que nos diga que o m�todo � Lazy, e que

forne�a informa��es de como recuperar essa associa��o.

Annotation ProxiedLazy.java

package com.artigo.apt.annotations;

import java.lang.annotation.Documented;

import java.lang.annotation.ElementType;

import java.lang.annotation.Inherited;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

@Documented

@Retention(RetentionPolicy.RUNTIME)

@Target(value={ElementType.METHOD})

@Inherited

public @interface ProxiedLazy {

String mappedBy() default "";

String jndiName() default "";

String factoryClass() default "";

String factoryMethod() default "";

String[] parameters();

}

3 � Precisamos de uma marca��o que informe que a partir daquele ponto da

aplica��o o retorno do objeto dever� ser um objeto proxiado.

Annotation ProxiedReturn.java

package com.artigo.apt.annotations;

import java.lang.annotation.Documented;

import java.lang.annotation.ElementType;

import java.lang.annotation.Inherited;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/**

* Annotation responsavel por marcar os metodos cujo retorno devera

* ser convertido para um tipo Proxied.

* @author rdias

@Documented

@Retention(value=RetentionPolicy.RUNTIME)

@Target(value={ElementType.METHOD})

@Inherited

public @interface ProxiedReturn {

}

4 � Precisamos de uma marca��o que indique que o m�todo find em quest�o �

um m�todo que pode ser utilizado para recuperar informa��es associativas.

Annotation ProxiedFind.java

package com.artigo.apt.annotations;

import java.lang.annotation.Documented;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/**

* Annotation responsavel por marcar os metodos que recuperam informacoes

associativas

* O key eh importante pois ele coloca unicidade em metodos de mesmo nome.

* @author rdias

@Documented

@Retention(value=RetentionPolicy.RUNTIME)

@Target(value={ElementType.METHOD})

public @interface ProxiedFind {

String key() default "";

}

5 � Precisamos de uma marca��o para ser colocada no proxy gerado, pois o

cliente poder� manipular o proxy achando que est� trabalhando com o objeto

real �smart-reference�, e quando esse proxy for passado de volta pra o

container o mesmo dever� saber que se trata de um proxy e que uma a��o deve

ser tomada para que o objeto real seja recuperado do proxy.

Annotation ProxiedClass.java

package com.artigo.apt.annotations;

import java.lang.annotation.Documented;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/***

* Annotation responsavel por marcar a classe proxiada

* Estando este annotation presente na classe proxiada, indicara

* ao engineer de injection que o que ele esta vendo na verdade

* eh um proxy de uma classe e nao a classe em si, toda a classe

* que possui este annotation devera ter um metodo getUnProxied() que

* retorna a classe real.

* @author rdias

@Documented

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.TYPE)

public @interface ProxiedClass {

}

Atualizando as classes para que usem as marca��es

A primeira atualiza��o que vamos fazer, ser� marcar a classe EnderecoBean

como sendo uma que dever� ter um proxy, e indicar que o m�todo

getTipoLogradouro ter� um comportamento Lazy Loading.

Atualizando a classe EnderecoBean.java

import com.artigo.apt.annotations.Proxied;
import com.artigo.apt.annotations.ProxiedLazy;

...

@Proxied

@Entity(name="EnderecoBean")

@Table(name="ENDERECO")

public class EnderecoBean implements java.io.Serializable{

...

@ProxiedLazy(mappedBy="findLogradouroByEnderecoId",

jndiName="artigo-apt-core/EnderecoQueryFacade/remote",

parameters={"id"})

@ManyToOne(optional=false)

@JoinColumn(name="TIPO_LOGRADOURO_ID", referencedColumnName="ID")

public TipoLogradouroBean getTipoLogradouro(){

return tipoLogradouro;

}

...

}

Agora vamos colocar na interface IEnderecoQueryFacade a marca��o que

indica que o retorno do m�todo no caso o findEnderecoById, dever� na

verdade retornar um proxy do EnderecoBean e n�o o pr�prio. Vamos tamb�m

inserir o m�todo que ir� retornar o tipo do logradouro pelo id do endere�o.

Atualizando a interface IEnderecoQueryFacade.java

import com.artigo.apt.annotations.ProxiedReturn;
import com.artigo.apt.annotations.ProxiedFind;

...

@Remote

public interface IEnderecoQueryFacade {

@ProxiedReturn

public EnderecoBean findEnderecoById(Long id);

@ProxiedFind(key=� findLogradouroByEnderecoId�)
public TipoLogradouroBean findLogradouroByEnderecoId(Long id);

}

Com isso, j� temos quatro marca��es nas nossas classes, das cinco que

precisamos para poder fechar a solu��o. Mas at� agora a �nica coisa que

fizemos foi colocar as marca��es; em momento algum criamos mecanismos que

ir�o ler essas marca��es, ent�o... vamos a isso.

Primeiramente vamos criar o Processador de Annotations que ir� olhar

especificamente para o Annotation @Proxied.

Classe APTFactory.java

package com.artigo.apt.processor;

import java.util.ArrayList;

import java.util.Collection;

import java.util.Collections;

import java.util.Set;

import com.sun.mirror.apt.AnnotationProcessor;

import com.sun.mirror.apt.AnnotationProcessorEnvironment;

import com.sun.mirror.apt.AnnotationProcessorFactory;

import com.sun.mirror.apt.AnnotationProcessors;

import com.sun.mirror.declaration.AnnotationTypeDeclaration;

public class APTFactory implements AnnotationProcessorFactory

{

/**

* Retorna o processador para os annotations do artigo

* @return Um annotation processor para o note annotations se requisitado,

* senao, retorna NO_OP annotation processor.

public AnnotationProcessor getProcessorFor(

Set declarations,

AnnotationProcessorEnvironment env){

AnnotationProcessor result;

if (declarations.isEmpty()){

result = AnnotationProcessors.NO_OP;

}else{

result = new APTAnnotationProcessor(env);

}

return result;

}

public Collection supportedAnnotationTypes(){

Collection list = new ArrayList();

list.add("com.artigo.apt.annotations.Proxied");

return list;

}

public Collection supportedOptions(){

return Collections.emptyList();

}

A classe acima possui a responsabilidade de informar ao APT quais

annotations o processador vai analisar. Posterior a isso, o APT solicita �

factory a inst�ncia da classe processor, para ser acionada pelo APT atrav�s

do m�todo process().

Criando a classe que ir� processar o annotation.

Classe APTAnnotationProcessor.java

package com.artigo.apt.processor;

import java.util.ArrayList;

import java.util.Collection;

import java.util.List;

import com.sun.mirror.apt.AnnotationProcessor;

import com.sun.mirror.apt.AnnotationProcessorEnvironment;

import com.sun.mirror.declaration.AnnotationMirror;

import com.sun.mirror.declaration.AnnotationTypeDeclaration;

import com.sun.mirror.declaration.Declaration;

import com.sun.mirror.declaration.TypeDeclaration;

import com.sun.mirror.util.DeclarationVisitor;

import com.sun.mirror.util.DeclarationVisitors;

public class APTAnnotationProcessor implements AnnotationProcessor{

private AnnotationProcessorEnvironment environment;

private TypeDeclaration proxiedDeclaration;

private Collection declarations = null;

public APTAnnotationProcessor(AnnotationProcessorEnvironment env){

environment = env;

proxiedDeclaration =

environment.getTypeDeclaration("com.artigo.apt.annotations.Proxied");

declarations =

environment.getDeclarationsAnnotatedWith((AnnotationTypeDeclaration)

proxiedDeclaration);

}

public void process(){

for( Declaration declaration : declarations ){

selectVisitor(declaration);

}

private void selectVisitor(Declaration declaration){

Collection annotations =

declaration.getAnnotationMirrors();

for(AnnotationMirror mirror : annotations){

DeclarationVisitor scanner;

if (mirror.getAnnotationType().getDeclaration().equals

(proxiedDeclaration)){

scanner = DeclarationVisitors.getDeclarationScanner(

new ProxiedVisitor(environment),

DeclarationVisitors.NO_OP);

declaration.accept(scanner);

}

No momento que o m�todo process() � acionado pelo APT, o mesmo percorre

todas as declara��es que possuem o annotation @Proxied. O objeto

Declaration armazena internamente a estrutura da classe que possui o

annotation. Quando passamos este objeto para o ProxiedVisitor, o APT se

responsabiliza por acionar o m�todo visitor designado para ler a declara��o

espec�fica que possui o annotation. No nosso caso, o @Proxied foi colocado

para marcar uma classe, ent�o o APT vai acionar o m�todo

visitClassDeclaration passando um objeto ClassDeclaration. Caso tivessemos

colocado nossa annotation na declara��o de um m�todo, o APT iria acionar o

visitMethodDeclaration da nossa classe ProxiedVisitor e assim por diante.

Para maiores detalhes veja o Pattern Visitor.

Classe ProxiedVisitor.java

package com.artigo.apt.processor;

import com.sun.mirror.apt.AnnotationProcessorEnvironment;

import com.sun.mirror.declaration.ClassDeclaration;

import com.sun.mirror.util.SimpleDeclarationVisitor;

public class ProxiedVisitor extends SimpleDeclarationVisitor{

private AnnotationProcessorEnvironment env = null;

public ProxiedVisitor(AnnotationProcessorEnvironment env){

this.env = env;

}

@Override

public void visitClassDeclaration(ClassDeclaration cd) {

GeneratorProxiedClass gpc = new GeneratorProxiedClass(cd, env);

gpc.accept();

}

Como j� dissemos anteriormente, o fato de termos colocado o annotation

@Proxied na declara��o da classe EnderecoBean, faz com que o APT acione o

m�todo visitClassDeclaration(..) passando a classe que foi anotada. Tendo

em m�os essa classe podemos come�ar a criar a nova classe proxy a partir

dessa. :)

Criando o gerador de c�digo Proxy

Neste momento temos um objeto do tipo ClassDeclaration, que cont�m todas

as informa��es pertinentes a classe que possui o annotation @Proxied. O que

temos que fazer agora, � analisar a classe e gerar um proxy dela mesma. Uma

informa��o importante � que o APT tem poderes para criar qualquer arquivo

seja �.java� ou �.class� por�m n�o possui poderes para alter�-las. O que

quero dizer � que o ClassDeclaration por exemplo n�o possui m�todos do tipo

addNewMethod para inserir um novo m�todo na classe que ele est� analisando,

ou seja, toda classe analisada pelo APT � read-only. Mas o nosso intuito

n�o � alterar a classe que possui o annotation @Proxied, o que queremos �

fazer um proxy dela. Bom.. poder�amos fazer algo bem simples, do tipo olhar

a classe e come�ar a criar a outra, mas vamos fazer diferente, vamos criar

um template do que ser� nossa nova classe proxy e gerar um parser para

poder mold�-la do jeito que quisermos. Isso se tornar� �t�l caso seja

necess�rio fazer uma atualiza��o no proxy, como por exemplo, criar um cache

das associa��es j� retornadas, ou analisar um novo annotation contido no

objeto retornada. Enfim, a id�ia do template � agilizar o processo de

atualiza��o do novo c�digo (Proxy), sem que aja a necessidade de abrir o

c�digo do gerador para tal.

Arquivo Proxied.template (O template completo esta dispon�vel para download)

...

@ProxiedClass

public class Proxied extends {

...

//Neste metodo vamos analisar a presen�a do annotation

//@ProxiedLazy e @ProxiedFind

public Object getProxiedValue(String nameMethod){

Class c = this.getClass().getSuperclass();

Method[] methods = c.getMethods();

for(Method m : methods ){

if (m.getName().equals(nameMethod)){

ProxiedLazy lazyRemote = m.getAnnotation(ProxiedLazy.class);

if (lazyRemote != null){

try{

String factoryClass = lazyRemote.factoryClass();

String jndiName = lazyRemote.jndiName();

String mappedBy = lazyRemote.mappedBy();

String[] parameters = lazyRemote.parameters();

Object objectWithLazyProxiedFind = null;

if (!factoryClass.equals("")){

Object factoryObject =

Class.forName(factoryClass, true,

Thread.currentThread().getContextClassLoader()).newInstance();

Method factoryMethod =

factoryObject.getClass().getMethod(

lazyRemote.factoryMethod(), new Class[]{});

objectWithLazyProxiedFind = factoryMethod.invoke

(factoryObject, new Object[]{});

}else if(!jndiName.equals("")){

try {

Context ct = new InitialContext();

objectWithLazyProxiedFind = ct.lookup(jndiName);

}catch (Exception e){

e.printStackTrace();

}

Method objectWithLazyFindMethod = null;

Class[] arrClazz = objectWithLazyProxiedFind.getClass().getInterfaces();

for(Class clazz : arrClazz ){

Method[] methodsClazz = clazz.getMethods();

for(Method methodClazz : methodsClazz){

ProxiedFind ProxiedFind = methodClazz.getAnnotation

(ProxiedFind.class);

if (ProxiedFind != null && ProxiedFind.key().equals(mappedBy)){

objectWithLazyFindMethod =

objectWithLazyProxiedFind.getClass().getMethod(

methodClazz.getName(), methodClazz.getParameterTypes() );

break;

}

if (objectWithLazyFindMethod != null)

break;

}

System.out.println("Executando o metodo proxiado:

" + objectWithLazyFindMethod.getName() +

" com " + (parameters.length + 1) + " parametros.");

return objectWithLazyFindMethod.invoke

(objectWithLazyProxiedFind, toObject(parameters) );

}catch(Exception ee){

ee.printStackTrace();

}

return null;

}

...

}

Vamos criar uma classe abstrata SimpleTemplateVisitor.java que ir� percorrer

o template linha a linha atr�s das diretivas que incluimos no template.

Sempre que ele achar uma diretiva ir� direcionar a linha do arquivo para um

determinado m�todo que trata aquela diretiva em quest�o. Recorreremos ao

Pattern Visitor j� que o APT o utiliza por padr�o.

Classe SimpleTemplateVisitor.java

(O c�digo completo est� dispon�vel para download)

...

public abstract class SimpleTemplateVisitor {

AnnotationProcessorEnvironment env;

Map mapMethods = new HashMap(){{

put("package.qualifiedName", "visitorPackage");

put("class.simpleName", "visitorNameClass");

put("class.type", "visitorTypeClass");

put("class.simpleName.field", "visitorField");

put("class.methods", "visitorMethods");

}};

public SimpleTemplateVisitor(AnnotationProcessorEnvironment env){

this.env = env;

}

...

public abstract String visitorPackage(String line);

public abstract String visitorNameClass(String line);

public abstract String visitorTypeClass(String line);

public abstract String visitorField(String line);

public abstract String visitorMethods(String line);

public abstract URL getTemplate();

public void endTemplate(){

}

...

}

Agora vamos criar a classe que ir� utilizar o template para poder gerar o

nosso c�digo Proxy. Repare no template, que o nome da nova classe ser� o

mesmo nome da classe marcada com @Proxied seguido de Proxied:

Classe GeneratorProxiedClass.java

(O c�digo completo est� dispon�vel para download)

...

public class GeneratorProxiedClass extends SimpleTemplateVisitor {

final String PATH_TEMPLATE =

"/home/rdias/projects/TigerSistafe/Artigos/resources/";

...

public void endTemplate(){

System.out.println(".........Gerando Codigo....................");

System.out.println(newPackage + ".proxied." + newClass+"Proxied");

try{

PrintWriter writer = env.getFiler().createSourceFile(newPackage +

".proxied." + newClass+"Proxied");

writer.append(newSource.toString());

System.out.println(".........Codigo Gerado.................");

}catch(Exception e){

e.printStackTrace();

}

public String visitorPackage(String line){

String packageName = classDeclaration.getPackage().getQualifiedName();

this.newPackage = packageName;

return replace(line, "", packageName);

}

public String visitorNameClass(String line){

String nameClass = classDeclaration.getSimpleName();

this.newClass = nameClass;

return replace(line, "", nameClass);

}

public String visitorTypeClass(String line){

return "";

}

public String visitorField(String line){

String nameField = "my"+classDeclaration.getSimpleName();

return replace(line, "", nameField);

}

public String visitorMethods(String line){

StringBuffer sourceString = new StringBuffer("");

Collection methods = classDeclaration.getMethods();

System.out.println("Tamanho de methods:" + methods.size() );

setHierarquicalMethods( classDeclaration, methods );

System.out.println("Tamanho de methods:" + methods.size() );

for(MethodDeclaration m : methods){

if (!isMethodAbstractOrPrivate(m)){

//verifica os anotations presente no metodo

Collection annotations =

m.getAnnotationMirrors();

boolean processLazy = false;

for(AnnotationMirror mirror : annotations){

if(mirror.getAnnotationType().getDeclaration()

.getSimpleName().equals("ProxiedLazy")){

sourceString.append(

generatorMethodBody(m, mirror, line));

processLazy = true;

}

if (!processLazy){

sourceString.append(generatorMethodBody(m));

}

return sourceString.toString();

}

...

}

A classe acima simplesmente recupera as diretivas e altera as mesmas por

nomes retirados da classe original.

Vamos executar o APT pra ver se ele gera nossa classe Proxy.

Para rodar via linha de comando, v� para o diret�rio onde est�o suas

entidades. Isso � necess�rio para que n�o seja preciso colocar o caminho

completo de todas as entidades marcadas com o annotation @Proxied l�

embaixo onde est� o �*.java �:

/home/rdias/projects/TigerSistafe/Atigos/scr/com/artigo/apt/persistence

-> Digite:

-> apt -cp /home/rdias/projects/TigerSistafe/Artigos/build/:

/usr/jboss-4.0.4.GA/server/default/lib/ejb3-persistence.jar/

-s /home/rdias/projects/TigerSistafe/Artigos/src -nocompile

-factory com.artigo.apt.processor.APTFactory *.java

� A opc�o -s informa onde est�o os fontes

� A opc�o -cp informa onde est�o as classes

� A opc�o -nocompile n�o compila as novas classes geradas.

� A opc�o -factory diz quem � a factory que ir� processar os Annotations.

Outra informac�o importante � que a API com.sun.mirror* utilizada pelas

nossas classes para criar o Processador, se encontra dentro do pacote

tools.jar no diret�rio jdk1.5.0_05/lib/tools.jar.

Uma observa��o interessante, � que depois que a classe EnderecoBeanProxied

foi gerada o APT verificou que nela existe o annotation @ProxiedClass que

n�o est� sendo processado por ningu�m, o que refor�a o passo 5 do ciclo do

APT. Veja que foi criado no seu diret�rio source um novo pacote:

com.artigo.apt.persistence.proxied

e nele est� contido a classe EnderecoBeanProxied.java que possui a mesma

estrutura definida no seu template. :).

No build existe uma target chamada aptProxied que executa o APT via ant,

sem a necessidade de abrir o console e fazer isso por linha de comando. O

incoveniente � que neste caso toda classe que possui o annotation @Proxied

dever� ser colocada como argumento para execu��o do APT.

Build.xml

...

Revisando um pouco, afinal j� se foram muitas linhas de c�digo.

Inicialmente criamos 5 annotations, depois colocamos esses annotations em

algumas classes. Agora estamos analisando essas marca��es e gerando

resultados em cima delas. Por enquanto s� analisamos os annotation @Proxied

pelo gerador. O @ProxiedLazy e @ProxiedFind est�o sendo analisados pela

classe proxy gerada, faltando agora o @ProxiedReturn e @ProxiedClass. O

annotation @ProxiedReturn deve ser verificado quando o usu�rio solicitar ao

componente EnderecoQueryFacade o endere�o pelo Id, para isso vamos fazer o

seguinte, criaremos um proxy din�mico que encapsula o componente

EnderecoQueryFacade, e retorna pro cliente esse proxy din�mico. No momento

que o cliente acessar o m�todo findEnderecoById, nosso proxy din�mico ir�

analisar se o m�todo acionado pelo cliente tem o annotation @ProxiedReturn.

Caso sim, o proxy din�mico gera uma inst�ncia do proxy gerado por n�s,

passando como argumento o EnderecoBean retornando o proxy para o cliente,

calma que olhando o c�digo fica mais simples:

Classe ProxiedInvocationHandler.java

package com.artigo.apt.processor;

import java.lang.reflect.InvocationHandler;

import java.lang.reflect.Method;

import java.util.Collection;

import java.util.Iterator;

import java.util.Map;

import com.artigo.apt.annotations.ProxiedReturn;

public class ProxiedInvocationHandler implements InvocationHandler{

private Object delegate;

private Class delegateClass;

public ProxiedInvocationHandler(Object delegate, Class interfaceClass)

{

this.delegate = delegate;

this.delegateClass = delegate.getClass();

}

public Object invoke(Object proxy, Method method, Object[] args)

throws Exception{

try {

Method methodForInvoke =

delegateClass.getMethod(method.getName(), method

.getParameterTypes());

Object result = methodForInvoke.invoke(delegate, args);

if (method.isAnnotationPresent(ProxiedReturn.class)){

if (result instanceof Collection){

proxiedCollection( (Collection)result );

}else if (result instanceof Map){

//nao implementado ainda

}else{

return proxied(result);

}

return result;

}catch (Throwable e){

e.printStackTrace();

throw new Exception("Erro:" + e.getMessage() + " Causado por: " +

e.getCause());

}

private Object proxied(Object result) throws Exception{

Class resultClass = result.getClass();

String packageName = resultClass.getPackage().getName()+".proxied.";

String nameClassProxied = packageName +

resultClass.getSimpleName()+"Proxied";

Class c = Class.forName(nameClassProxied, false,

Thread.currentThread().getContextClassLoader());

return c.getConstructor(new Class[]{resultClass}).newInstance(result);

}

private void proxiedCollection(Collection resultCollection) throws Exception{

for(Iterator it = resultCollection.iterator(); it.hasNext();){

Object o = it.next();

resultCollection.remove( o );

resultCollection.add( proxied(o) );

}

private void proxiedMap(Map resultMap){

//TODO: Nao implementar por enquanto

}

Vamos agora criar uma EnderecoFacadeFactory que faz uso do

InvocationHandler criado acima. Essa Facade ser� responsav�l por retornar

os objetos EnderecoFacade e EnderecoQueryFacade para o cliente.

Classe EnderecoFacadeFactory.java

package com.artigo.apt;

import java.lang.reflect.Proxy;

import javax.naming.Context;

import javax.naming.InitialContext;

import com.artigo.apt.interfaces.IEnderecoFacade;

import com.artigo.apt.interfaces.IEnderecoQueryFacade;

import com.artigo.apt.processor.ProxiedInvocationHandler;

public class EnderecoFacadeFactory{

static final String ENDERECO_FACADE_JNDI = "EnderecoFacade";

static final String ENDERECO_QUERY_FACADE_JNDI = "EnderecoQueryFacade";

static final String ENDERECO_COMPONENT = "artigo-apt-core";

public static IEnderecoFacade getEnderecoFacade() throws Exception{

return (IEnderecoFacade)getProxiedFacade(

ENDERECO_COMPONENT,

ENDERECO_FACADE_JNDI,

"remote",

IEnderecoFacade.class);

}

public static IEnderecoQueryFacade getEnderecoQueryFacade() throws Exception{

return (IEnderecoQueryFacade)getProxiedFacade(

ENDERECO_COMPONENT,

ENDERECO_QUERY_FACADE_JNDI,

"remote",

IEnderecoQueryFacade.class);

}

private static Object getProxiedFacade(

String jndiContext,String jndiName,

String typeAccess,Class interfaceClass) throws Exception{

try{

Context ct = new InitialContext();

Object ref =

ct.lookup(jndiContext+"/"+jndiName+"/"+typeAccess);

return Proxy.newProxyInstance(

Thread.currentThread().getContextClassLoader(),

new Class[]{interfaceClass},

new ProxiedInvocationHandler(interfaceClass.cast(ref),

interfaceClass));

}catch (Exception e){

throw e;

}

Esta classe dever� estar dispon�vel para o cliente, pois ser� atrav�s dela

que o cliente ir� ter acesso aos componentes EnderecoFacade (para a��es de

persist�ncia) e EnderecoQueryFacade (para ac�es de consulta).

Alterar a classe APTClient.java:

....

public IEnderecoQueryFacade getEnderecoQueryFacade(){

try{

return EnderecoFacadeFactory.getEnderecoQueryFacade();

}catch(Exception e){

e.printStackTrace();

}

return null;

}

public IEnderecoFacade getEnderecoFacade(){

try{

return EnderecoFacadeFactory.getEnderecoFacade();

}catch(Exception e){

e.printStackTrace();

}

return null;

}

...

Agora � s� fazer o build-deploy do componente endere�o e rodar o buildclient

para que o client.jar sej� gerado novamente, rode a target runclient

para executar:

Buildfile: /home/rdias/projects/TigerSistafe/Artigos/build-client.xml

run-client:

[java] Executando o metodo proxiado:findLogradouroByEnderecoId com 1

parametro(s).

[java] Rua

BUILD SUCCESSFUL

Total time: 1 second

Pronto!

Agora o acesso ao tipo logradouro foi feito via nosso proxy. Caso n�o

deseje que o proxy gerado seja usado, simplesmente retire o annotation

@ProxiedReturn e fa�a redeploy da aplica��o, e gera��o do client.jar. No

momento que o cliente for executado o erro original ir� voltar a acontecer,

pelos mesmo motivos j� explicado no inicio do artigo.

Conclus�o

Lazy Loading � um recurso poderoso na obten��o de relacionamentos entre

entidades, pois nos d� a oportunidade de trabalharmos com entidades leves

tornando as consultas mais rapidas e enxutas. Essas caracteristicas

justificam sua ado��o como padr�o para os fetches no JPA, por�m o fato de s�

termos esse recurso enquanto tivermos no container, deixa uma limita��o quanto

ao seu uso. Neste artigo resolvemos parte desse problema com o uso do APT e

dos annotations.

Tecnologias:

Confira outros conte�dos:

Introdu��o ao JDBC

Novidades do Java

Teste unit�rio com JUnit

Assista grátis a nossa aula inaugural

Perguntas frequentes

Quem somos?

Por que a programação se tornou a profissão mais promissora da atualidade?

Como faço para começar a estudar?

Em quanto tempo de estudo vou me tornar um programador?

Sim, você pode se tornar um programador e não precisa ter diploma de curso superior!

O que eu irei aprender estudando pela DevMedia?

Principais diferenciais da DevMedia

Qual o investimento financeiro que preciso fazer para me tornar um programador?

Como funciona a forma de pagamento da DevMedia?

Por Rodolfo Em 2006

Nossos casos de sucesso

Leonardo Carlos

Eu sabia pouqu�ssimas coisas de programa��o antes de come�ar a estudar com voc�s, fui me especializando em v�rias �reas e ferramentas que tinham na plataforma, e com essa bagagem consegui um est�gio logo no in�cio do meu primeiro per�odo na faculdade.

Lucas Rodrigues

Estudo aqui na Dev desde o meio do ano passado! Nesse per�odo a Dev me ajudou a crescer muito aqui no trampo.
Fui o primeiro desenvolvedor contratado pela minha empresa. Hoje eu lidero um time de desenvolvimento!
Minha meta � continuar estudando e praticando para ser um Full-Stack Dev!

Her�clito J�nior

Economizei 3 meses para assinar a plataforma e sendo sincero valeu muito a pena, pois a plataforma � bem intuitiva e muuuuito did�tica a metodologia de ensino. Sinto que estou EVOLUINDO a cada dia. Muito obrigado!

Julio Cablen

Nossa! Plataforma maravilhosa. To amando o curso de desenvolvimento front-end, tinha coisas que eu ainda n�o tinha visto. A did�tica � do jeito que qualquer pessoa consegue aprender. S�rio, to apaixonado, adorando demais.

Joelberth Sena

Adquiri o curso de voc�s e logo percebi que s�o os melhores do Brasil. � um passo a passo incr�vel. S� n�o aprende quem n�o quer. Foi o melhor investimento da minha vida!

Felipe Nunes

Foi um dos melhores investimentos que j� fiz na vida e tenho aprendido bastante com a plataforma. Voc�s est�o fazendo parte da minha jornada nesse mundo da programa��o, irei assinar meu contrato como programador gra�as a plataforma.

Wanderson Oliveira

Comprei a assinatura tem uma semana, aprendi mais do que 4 meses estudando outros cursos. Exerc�cios pr�ticos que n�o tem como n�o aprender, est�o de parab�ns!

Jos� Lucas

Obrigado DevMedia, nunca presenciei uma plataforma de ensino t�o presente na vida acad�mica de seus alunos, parab�ns!

Eduardo Dorneles

Aprendi React na plataforma da DevMedia h� cerca de 1 ano e meio... Hoje estou h� 1 ano empregado trabalhando 100% com React!

Adauto Junior

J� fiz alguns cursos na �rea e nenhum � t�o bom quanto o de voc�s. Estou aprendendo muito, muito obrigado por existirem. Est�o de parab�ns... Espero um dia conseguir um emprego na �rea.

Ver todos os casos de sucesso