Trabalhando com o Design Pattern Interceptor no Java EE

Um conceito muito importante ao se estudar os interceptores � a programaç�o orientada a aspectos (Aspect‐oriented Programming ou AOP), que, apesar de n�o estar descrita no livro do GoF e n�o ser um padr�o cl�ssico da literatura, introduziu um novo conceito e um novo paradigma para a programaç�o. A ideia por tr�s � basear a ordem de execuç�o do c�digo atrav�s de aspectos. Assim, cada aspecto intercepta a execuç�o do programa e adiciona seu pr�prio comportamento antes de continuar com a chamada. Os aspectos basicamente adicionam l�gica e comportamento para o c�digo em tempo de execuç�o. Contudo, essa t�cnica tamb�m traz uma ordem de execuç�o do c�digo bastante dif�cil de debugar.

Apesar da AOP possuir muitos seguidores, a plataforma Java EE tem uma implementaç�o bastante limpa que pode ser muito �til para muitos desenvolvedores. No restante do artigo ser� visto o que � a programaç�o orientada a aspectos e como os interceptores podem ser implementados utilizando a t�cnica de AOP.

Programaç�o Orientada a Aspectos

A programaç�o orientada a aspectos visa adicionar comportamento nos c�digos existentes ou nas aplicaç�es para resolver determinados problemas. A AOP tornou-se um paradigma popular na d�cada passada e com isso surgiram diversos frameworks de terceiros a oferecendo. Entre esses frameworks destacam-se o AspectJ e o Spring. Tanto o AspectJ quanto o Spring s�o largamente aceitos e j� s�o utilizados h� um longo tempo nos projetos Java. O Java SE tamb�m possui uma abordagem similar, por�m mais b�sica atrav�s da utilizaç�o de servlet filters, embora essa abordagem seja limitada para requisiç�es na web. Utilizando esses filtros, qualquer requisiç�o ou resposta pode ser interceptada, e assim sendo, qualquer comportamento pode ser adicionado. A plataforma Java EE 7 tamb�m adotou a AOP e introduziu o conceito de interceptores.

A AOP n�o � classificada como um padr�o de projeto, mas � aceita como um paradigma de programaç�o, por isso ela n�o � encontrada na bibliografia de refer�ncia, como o livro do GoF e tampouco em outros livros de padr�es de projeto.

A literatura afirma que a AOP � basicamente a injeç�o de c�digo durante tempo de compilaç�o ou de execuç�o para adicionar comportamento desejado ou funcionalidade.

Os Frameworks que executam a injeç�o em tempo de compilaç�o alteram o arquivo �.class�. O problema disso � que esse arquivo fica incompat�vel com o c�digo fonte devido esse c�digo que foi injetado. Por outro lado, a injeç�o em tempo de execuç�o n�o modifica o c�digo fonte ou o arquivo ".class". Essa injeç�o � realizada atrav�s de chamadas de interceptaç�o e execuç�o do c�digo desejado antes ou depois da ordem de execuç�o original. Isso ser� exemplificado mais adiante quando for discutida a plataforma Java EE.

A AOP � muito �til para adicionar aç�es repetitivas, como logging ou segurança para um c�digo, sendo assim uma �tima ferramenta para encapsular conceitos que n�o envolvem o neg�cio. A desvantagem da AOP � que a sua implementaç�o causa uma descentralizaç�o e distribuiç�o, tornando assim dif�cil testar e debugar o c�digo.

Os aspectos podem ser ligados ou desligados, o que � interessante dependendo do ambiente ou fase do projeto.

O restante do artigo mostra de forma pr�tica o funcionamento do padr�o Interceptor.

Implementando Interceptores em C�digo Puro (POJO)

O Java SE suporta todas as caracter�sticas da AOP apenas atrav�s de frameworks de terceiros utilizando AspectJ ou Spring. Eles tamb�m s�o uma alternativa � implementaç�o do Java EE. Contudo, as aplicaç�es Java web possuem vantagens ao utilizarem Servlets para interceptar requisiç�es ou respostas. Para implementar um servlet filter basta criar uma nova classe e implementar a interface filter e ap�s, � necess�rio implementar o m�todo doFilter(), conforme mostrado no exemplo da Listagem 1.


package br.com.devmedia.interceptor.filter;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class SegurancaFilter implements Filter {

   @SuppressWarnings("unused")
   private FilterConfig filterConfig = null;

   //Implementaç�o de doFilter()
   @Override
   public void doFilter(ServletRequest request, ServletResponse response,
             FilterChain filterChain) throws IOException, ServletException {

             Log.info(((HttpServletRequest) request).getRemoteAddr());

             //executar alguma checagem de segurança aqui

   }

   @Override
   public void init(FilterConfig filterConfig) throws ServletException {
             this.filterConfig = filterConfig;
   }

}

Listagem 1. Implementaç�o de um Servlet Filter

Al�m do c�digo acima, o container web tamb�m precisa das configuraç�es do arquivo web.xml mostrado no c�digo da Listagem 2.


<?xml version= "1.0" encoding="UTF‐8" ?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">

  <filter>
     <filter‐name>SegurancaFilter</filter‐name>
     <filter‐class>br.com.devmedia.interceptor.filter.SegurancaFilter </filter‐class>
  </filter>

  <filter‐mapping>
     <filter‐name>SegurancaFilter</filter‐name>
     <url‐pattern>/*</url‐pattern>
  </filter‐mapping>

</web-app>

Listagem 2. Definindo os mapeamentos do filtro no arquivo web.xml

Como pode ser visto, este arquivo XML faz o mapeamento das URLs para as classes espec�ficas no Java.

Na plataforma Java EE 7 � ainda mais simples implementar os filtros, bastando utilizar anotaç�es, conforme o exemplo da Listagem 3.


package br.com.devmedia.interceptor.filter;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.Filter;
import javax.servlet.annotation.WebFilter;
import javax.servlet.annotation.WebInitParam;

@WebFilter(filterName = "SegurancaFilter", urlPatterns = {"/*"})
public class SegurancaFilter implements Filter {

   @Override
   public void doFilter(ServletRequest request, ServletResponse response,
     FilterChain filterChain) throws IOException, ServletException {

     Log.info(((HttpServletRequest) request).getRemoteAddr());

     //executar alguma checagem de segurança aqui

   }
}

Listagem 3. Exemplo de implementaç�o de um filtro na plataforma Java EE 7

Apesar de serem simples de implementar, os filtros s�o bastante utilizados em aplicaç�es empresariais. Por�m, infelizmente, os filtros s�o limitados apenas para requisiç�es da web. Para interceptar outros tipos de chamadas de m�todos � preciso utilizar outra forma, como CDI ou EJBs como ser� discutido na pr�xima seç�o.

Implementando Interceptores na plataforma Java EE

Os interceptores foram introduzidos no Java EE a partir da vers�o 5, por�m na plataforma Java EE 5 os interceptores estavam limitados ao Enterprise JavaBeans (EJB). Na plataforma Java EE 7 com a introduç�o do Context and Dependency Injection (CDI) os interceptores n�o precisam mais dos EJBs para serem utilizados.

De forma similar aos interceptores utilizados na plataforma Java SE, cada interceptor possui um bloco de c�digo para ser adicionado. O destino a ser decorado � chamado de "Advice". Cada chamada a um "Advice" dentro do escopo do interceptor � interceptado. O local exato do aspecto a ser executado � chamado de "Pointcut".

Interceptadores b�sicos podem apenas trabalhar com EJBs. Um exemplo de uso de um interceptor seria em uma aplicaç�o com centenas de EJBs e configurarmos a aplicaç�o para logar todas as chamadas de EJB atrav�s de um deploy de um interceptor com o destino apontando para todos os EJBs.

A implementaç�o de um interceptor em Java EE � direta. Primeiramente � preciso criar uma nova classe interceptor e anota-la com a anotaç�o @Interceptor. Qualquer m�todo anotado com @AroundInvoke � executado no pointcut (local exato do aspecto a ser executado). No entanto, existem algumas regras de sintaxe para a assinatura do m�todo pointcut. A primeira regra diz que qualquer m�todo pointcut deve retornar um objeto do tipo Object e possuir um par�metro do tipo InvocationContext, e a segunda regra diz que o m�todo pointcut deve lançar uma exceç�o.

Assim, pode ser utilizado o par�metro InvocationContext para acessar informaç�es sobre o contexto atual. Segue na Listagem 4 um exemplo de como essa funcionalidade pode ser realizada.


package br.com.devmedia.interceptor;

import javax.interceptor.AroundInvoke;
import javax.interceptor.InvocationContext;

@Interceptor
public class SegurancaInterceptor {

 @AroundInvoke
 public Object verificaSeguranca(InvocationContext context) throws Exception {

     Logger.getLogger("SecurityLog")
              .info(context.getMethod().getName()+ "foi acessado!");

     return context.proceed();
 }
}

Listagem 4. Implementaç�o de um interceptor na plataforma Java EE

Para colocar a classe interceptor em aç�o � preciso anotar a classe destino Advice com a anotaç�o @Interceptors. A anotaç�o @Interceptors deve ser utilizada apenas em um EJB ou MDB (Message Driven Bean).

Segue na Listagem 5 um exemplo da implementaç�o de um Advice.


package br.com.devmedia.interceptor;

import javax.ejb.Stateless;
import javax.ejb.TransactionAttribute;
import javax.ejb.TransactionAttributeType;
import javax.enterprise.event.Event;
import javax.inject.Inject;
import javax.interceptor.Interceptors;

@Interceptors(SegurancaInterceptor.class)
@Stateless
@TransactionAttribute(TransactionAttributeType.REQUIRED)
public class ExemploServicoNegocio {

 public void iniciaServicoDeNegocio() {
           
   System.out.println(�Exemplo de serviço de neg�cio interceptado.�);

 }

 public void iniciaOutroServicoDeNegocio() {

   System.out.println(�Exemplo de outro serviço de neg�cio interceptado.�);

 }
}

Listagem 5. Implementaç�o do Advice destino

A anotaç�o Interceptors � bastante flex�vel podendo ser utilizada em n�vel de classe e em n�vel de m�todo. A anotaç�o Interceptors tamb�m suporta m�ltiplas entradas de interceptores, que permite habilitar m�ltiplos interceptadores no Advice destino.

O exemplo acima usou interceptadores em n�vel de classe, o que significa que o interceptor SegurancaInterceptor interceptar� qualquer uma das chamadas de serviço. Caso n�o seja necess�rio interceptar todas as chamadas de m�todos na classe pode ser utilizado anotaç�es em n�vel de m�todo conforme exemplo da Listagem 6.


package br.com.devmedia.interceptor;

import javax.ejb.Stateless;
import javax.ejb.TransactionAttribute;
import javax.ejb.TransactionAttributeType;
import javax.enterprise.event.Event;
import javax.inject.Inject;
import javax.interceptor.Interceptors;

@Stateless
@TransactionAttribute(TransactionAttributeType.REQUIRED)
public class ExemploServicoNegocio {

   @Interceptors(SegurancaInterceptor.class)
   public void iniciaServicoDeNegocio() {
   
            System.out.println(�Exemplo de serviço de neg�cio interceptado.�);

   }

   public void iniciaOutroServicoDeNegocio() {
   
             System.out.println(�Exemplo de outro serviço de neg�cio interceptado.�);

   }
}

Listagem 6. Exemplo de intercepç�o em n�vel de m�todo

No exemplo acima apenas chamadas para o m�todo iniciaServicoDeNegocio() s�o interceptadas, diferente da listagem anterior onde todos os m�todos da classe s�o interceptados. Cada m�todo deve ser anotado separadamente.

Al�m das anotaç�es vistas pode-se utilizar a interface InvocationContext para extrair informaç�es de contexto ou interagir com o contexto Advice. Segue na Tabela 1 os m�todos mais �teis utilizados na interface InvocationContext

M�todo	Descriç�o
public Object getTarget();	Retorna o Advice destino.
public Method getMethod();	Retorna o m�todo executado pelo Advice.
public Object[] getParameters();	Acessa os par�metros do m�todo do Advice.
public void setParameters(Object[]);	Configura os par�metros do m�todo do Advice.
public java.util.Map getContextData();	Acessa informaç�es do context.
public Object proceed() throws Exception;	Continua a execuç�o.

Tabela 1. Descriç�o dos m�todos da interface InvocationContext

No exemplo da Listagem 7 o nome do m�todo � acessado. Al�m disso, � verificado se o interceptor havia autorizado o acesso ao usu�rio anteriormente, caso n�o tenha sido o usu�rio � autorizado para acessar esse m�todo.


package br.com.devmedia.interceptor;
 
import javax.interceptor.AroundInvoke;
import javax.interceptor.InvocationContext;
 
@Interceptor
public class SegurancaInterceptor {
 
         @AroundInvoke
         public Object verificaSeguranca(InvocationContext context) throws Exception {
 
                   System.out.println(context.getMethod()
                            .getName()+ " foi acessado!");
 
                   String usuario = context.getContextData.get("usuario");
 
                   if (usuario == null) {
                            usuario = (String) context.getParameters()[0];
                            context.getContextData.put("usuario", usuario);
                   }
 
                   return context.proceed();
         }
}

Listagem 7. Exemplo acessando informaç�o no InvocationContext

Outra forma de utilizar interceptores � utilizar CDI. Antes do surgimento do CDI, os interceptores eram aplic�veis apenas para os EJBs e MDBs. O CDI possui um enorme poder e tornou os interceptores poss�veis funcionando em qualquer objeto.

A implementaç�o dos interceptores utilizando CDI � bastante direta e flex�vel. Primeiramente � preciso especificar um "binding" (ou uma vinculaç�o) que � uma anotaç�o customizada anotada com @InterceptorBinding. Segue na Listagem 8 um exemplo.


@InterceptorBinding
@Target({TYPE, METHOD})
@Retention(RUNTIME)
public @interface Seguranca {}

Listagem 8. Implementando interceptor utilizando CDI

A anotaç�o @InterceptorBinding � utilizada para vincular interceptores com um c�digo destino. Em seguida, pode-se implementar e anotar o interceptor com um binding customizado. Os interceptores CDI s�o implementados da mesma forma que os interceptores EJB, a �nica diferença significativa � a anotaç�o conforme pode ser visto no exemplo abaixo:


package br.com.devmedia.interceptor;

import javax.interceptor.AroundInvoke;
import javax.interceptor.InvocationContext;

@Seguranca
@Interceptor
public class SegurancaInterceptor {

   @AroundInvoke
   public Object verificaSeguranca(InvocationContext context) throws Exception {

      System.out.println(context.getMethod()
        .getName()+ " foi acessado!");

      String usuario = context.getContextData.get("usuario");

      if (usuario == null) {
        usuario = (String)context.getParameters()[0];
        context.getContextData.put("usuario", usuario);
      }

      return context.proceed();
   }

   @PostConstruct
   public void ativa(){
             System.out.println("Ativando�");
   }

   @PreDestroy
   public void desativa(){
             System.out.println("Desativando�");
   }
}

Listagem 9. Vinculando um interceptor com @Seguranca

Assim como os interceptores EJB, a anotaç�o @Interceptor precisa ser usada para promover a classe para um interceptor. A anotaç�o @Seguranca vincula o interceptor. Por fim, a anotaç�o @AroundInvoke marca o m�todo que ser� executado durante as chamadas interceptadas. O pr�ximo passo � anotar o interceptor em um Advice, conforme o exemplo da Listagem 10.


package br.com.devmedia.interceptor;

import javax.interceptor.Interceptors;

@Seguranca
public class ExemploServicoNegocio {

  public void iniciaServicoDeNegocio() {
   
   System.out.println(�Exemplo de serviço de neg�cio interceptado.�);

  }

  public void iniciaOutroServicoDeNegocio() {
   
   System.out.println(�Exemplo de outro serviço de neg�cio interceptado.�);

  }
}

Listagem 10. Implementando o interceptor @Seguranca em um Advice

Interceptores CDI requerem um passo adicional que � declarar os interceptores em um arquivo beans.xml. Este passo � utilizado para determinar a ordem de execuç�o dos interceptores. O container CDI n�o � iniciado se o arquivo beans.xml estiver faltando.

Segue na Listagem 11 um exemplo do arquivo beans.xml.


<beans xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=" http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/beans_1_0.xsd">

  <interceptors>
     <class>br.com.devmedia.interceptor.SegurancaInterceptor</class>
     <class>br.com.devmedia.interceptor.OutroInterceptor</class>
  </interceptors>
</beans>

Listagem 11. Exemplo do arquivo beans.xml com dois interceptores declarados

A ordem de execuç�o do interceptor depende da ordem de declaraç�o no arquivo beans.xml, portanto apenas esse arquivo � respons�vel por ditar a ordem de execuç�o dos interceptores.

Uma situaç�o que pode ocorrer � uma mistura de interceptores CDI e EJB, nesse caso os interceptores EJB executam antes dos interceptores CDI.

Se for preciso fazer essa mistura de interceptores CDI com EJB deve-se saber que isso traz mais complexidade para a aplicaç�o, principalmente na arquitetura do aplicativo, e com isso, desenvolvedores que n�o est�o familiarizados com o c�digo podem ter problemas no entendimento e na codificaç�o da aplicaç�o.

Bibliografia:

Erich Gamma, Ricard Helm, Ralph Johnson, John Vlissides. Design Patterns: Elements of Reusable Object-Oriented Software (Addison-Wesley, 1994).
Eric Freeman, Elisabeth Robson, Bert Bates, Kathy Sierra. Head First Design Patterns. O'Reilly Media, 2004.
Murat Yener, Alex Theedom. Proffesional Java EE Design Patterns. Wrox, 2015.
Documentaç�o Oracle da interface InvocationContext

Trabalhando com o Design Pattern Interceptor no Java EE

Veja neste artigo o que é o padrão de projeto Interceptor, como ele é implementado em código puro (POJO) e como podemos implementar este padrão na plataforma Java EE 7.

Programaç�o Orientada a Aspectos

Implementando Interceptores em C�digo Puro (POJO)

Implementando Interceptores na plataforma Java EE

Artigos relacionados