Java EE 6 e o CDI � Contexts and Dependency Injection

Fique por dentro

O CDI prov� um mecanismo de injeç�o de depend�ncias entre classes de uma aplicaç�o Java EE 6, permitindo tamb�m o acesso por p�ginas Web a partir da linguagem de express�es unificada (EL). Depend�ncias s�o associadas a contextos e tem seu ciclo de vida gerenciado automaticamente pelo container. Ao redor deste mecanismo, o CDI oferece uma s�rie de funcionalidades como qualificadores, alternativas, decoradores, interceptadores e eventos que permitem uma grande flexibilidade no desenvolvimento da aplicaç�o.

Sistemas de informaç�o desenvolvidos na plataforma Java EE 6, utilizando ou n�o EJBs, podem se beneficiar bastante da utilizaç�o do CDI, pois o mesmo proporciona produtividade ao diminuir consideravelmente a quantidade de c�digo de infraestrutura que deveria ser escrito para gerenciamento de depend�ncias entre componentes, al�m de promover o desacoplamento entre classes, o que facilita a manutenç�o.

CDI � Contextos e Depend�ncias

O CDI � o mecanismo oferecido pela plataforma Java EE 6 para gerenciamento de depend�ncias entre componentes (chamados de beans) de uma aplicaç�o corporativa (com ou sem o uso de EJBs), associando-os a contextos e oferecendo uma s�rie de serviços de infraestrutura � aplicaç�o. Em um artigo dividido em duas partes, apresentamos a maioria das funcionalidades oferecidas pelo CDI. Nesta primeira parte, apresentamos uma vis�o geral do seu funcionamento e aprofundamos nos conceitos de fornecedores e qualificadores. Começamos com um exemplo simples de injeç�o de depend�ncias entre diferentes componentes de uma aplicaç�o (Listagens 1 a 5 e Figuras 1 e 2). Em seguida, explicamos o que � um fornecedor e como o mesmo pode ser uma alternativa para definiç�o de um bean (Listagens 6 a 9 e Figura 3). Finalmente, mostramos como beans e depend�ncias podem ser qualificados (Listagens 10 a 12) para criaç�o de categorias de depend�ncias de uma mesma classe.

O padr�o Java EE 6 foi aprovado e publicado pelo Java Community Process (JCP, veja Links) em dezembro de 2009 e com ele foi publicada tamb�m a JSR 299, chamada �Contexts and Dependency Injection for the JavaTM EE platform� ou, traduzindo em portugu�s, �Contextos e Injeç�o de Depend�ncias para a plataforma JavaTM EE�. Este padr�o, que tamb�m pode ser chamado de �Web Beans�, � mais conhecido pela sigla CDI, seguindo a tradiç�o das tecnologias relacionadas a Java, que s�o geralmente citadas utilizando seus acr�nimos.

Em um artigo dividido em tr�s partes, publicadas nas ediç�es 80, 81 e 82 da Java Magazine, apresentamos de forma pr�tica v�rias das novidades do Java EE 6, inclusive o CDI. Agora, nosso objetivo � apresentar de forma mais aprofundada as funcionalidades do CDI, que compreendem, segundo a pr�pria especificaç�o:

Um ciclo de vida bem definido para objetos que armazenam estado (stateful), associados a contextos, sendo que o conjunto de contextos � extens�vel;
Um mecanismo de injeç�o de depend�ncias type-safe (i.e. verifica erros relacionados ao tipo de objeto em tempo de compilaç�o), inclusive com possibilidade de escolher depend�ncias diferentes em vers�es de desenvolvimento e produç�o, sem uma configuraç�o excessivamente verbosa;
Suporte � modularidade e ao modelo de componentes da plataforma Java EE;
Integraç�o com a linguagem de express�es unificada (Expression Language, ou EL), permitindo que um objeto contextual seja utilizado diretamente em uma p�gina JSF ou JSP. Desta maneira, CDI integra os modelos de programaç�o dos EJBs e do JSF;
Capacidade de decorar objetos injetados e associar interceptadores a estes tamb�m de forma type-safe;
Um modelo para notificaç�o de eventos;
Um contexto de conversaç�o para a Web, al�m dos tr�s contextos j� definidos pela especificaç�o Java Servlets (requisiç�o, sess�o e aplicaç�o);
Uma SPI (Service Provider Interface, ou Interface de Provedor de Serviços), que permite a integraç�o de extens�es port�veis ao container.

Dada a extens�o das funcionalidades do CDI, se fez necess�rio dividir este artigo em duas partes. Nesta primeira parte, apresentaremos uma vis�o geral da utilizaç�o do CDI para conectar beans que, interligados, implementam uma funcionalidade de um sistema. Em seguida, apresentaremos em mais detalhes duas das funcionalidades do padr�o: fornecedores e qualificadores. Na segunda parte do artigo, a ser publicada na pr�xima ediç�o da Java Magazine, falaremos mais sobre escopos e contextos, com foco no contexto da conversaç�o, e apresentaremos as funcionalidades: alternativas, interceptadores, decoradores e eventos.

Ao longo do artigo, leitores familiarizados com o framework JBoss Seam ir�o notar bastante semelhança com o CDI. Tal semelhança n�o � mera coincid�ncia, dado que o l�der da especificaç�o da JSR 299 foi Gavin King, criador do Seam. Gavin King � conhecido tamb�m por ser o criador do framework de mapeamento objeto/relacional Hibernate.

Exemplos e IDE utilizada

Os exemplos trazidos neste artigo fazem parte de um projeto do tipo Java EE / Enterprise Application criado com a IDE NetBeans 6.9.1 e foram testados no servidor GlassFish 3.0.1. Os exemplos fazem parte de uma aplicaç�o Java EE fict�cia com interface Web: uma ag�ncia que vende pacotes tur�sticos chamada �CDI Viagens�.

Nosso foco, no entanto, � o CDI e mostraremos nas listagens somente c�digo-fonte relacionado ao mesmo. Para ver todos os fontes basta fazer o download do projeto associado a este artigo, dispon�vel no site da Java Magazine. Al�m disso, para um melhor entendimento do artigo, � recomendada alguma familiaridade com Java EE 6, EJBs 3.0 e JSF 2.0. Para aprender mais sobre estas tecnologias e o uso do NetBeans para a construç�o da aplicaç�o que utilizamos como exemplo, veja o artigo sobre novidades do Java EE 6 que, como citamos anteriormente, foi publicado nas ediç�es 80, 81 e 82 da revista, al�m de diversos outros artigos sobre estas tecnologias publicados em ediç�es anteriores da revista.

Por fim, � importante destacar que os exemplos mostrados neste artigo foram projetados para fins did�ticos, ou seja, para o aprendizado sobre o CDI. Em muitos casos, utilizamos uma funcionalidade do CDI em um exemplo para poder demonstr�-la, mesmo que ela n�o seja a forma mais aconselh�vel para implementar a funcionalidade em quest�o. Cabe ao leitor, ap�s aprender esta nova ferramenta, utiliz�-la quando cab�vel.

Beans, contextos e depend�ncias

Começaremos pela base do CDI que � a definiç�o dos componentes em contextos, chamados de beans, e sua interligaç�o pelo mecanismo de injeç�o de depend�ncias. Ap�s a criaç�o do projeto e configuraç�o de um leiaute obtido no site Free CSS Templates (veja Links) usando Facelets, implementamos a funcionalidade de cadastro de pacotes tur�sticos, como mostra a Figura 1. A figura mostra os pacotes tur�sticos j� cadastrados (com nome e per�odo no qual o pacote pode ser oferecido aos clientes) e, logo abaixo, um formul�rio para inserç�o de novos pacotes.

Nota: Bean� traduzido literalmente para feij�o, que n�o nos parece um nome adequado para estas classes. Poder�amos tamb�m traduzi-lo como �componente�, por�m esta palavra � muito utilizada em diversos outros contextos. Para evitar confus�o utilizaremos o termo em ingl�s, bean.

Figura 1. Tela de cadastro de pacotes tur�sticos do sistema CDI Viagens

Exceto para sistemas realmente muito simples, quando desenvolvemos sistemas de informaç�o � interessante separar diferentes atribuiç�es do sistema � como representaç�o do dom�nio do problema, l�gica de neg�cio e l�gica de persist�ncia � em m�dulos (em nosso caso, classes) diferentes. Por�m isso nos cria um problema a ser resolvido: como estas classes ir�o comunicar-se entre si?

Na plataforma Java EE 6, o CDI prov� uma soluç�o a esta quest�o, permitindo-nos declarar tais classes como beans e indicar suas depend�ncias, ou seja, de quais outras classes cada uma delas depende para realizar o seu objetivo. A Figura 2 mostra os principais componentes que implementam o cadastro de pacotes tur�sticos, divididos nas seguintes camadas:

Vis�o: a p�gina JSF cadastrarPacotes.xhtml prov� a interface com o usu�rio mostrada na Figura 1 � campos de formul�rio, bot�es, links e informaç�es impressas na p�gina;
Neg�cio: a classe CadastrarPacote, implementada como um Stateful EJB sem interface, cont�m a implementaç�o da l�gica de neg�cio do caso de uso �Cadastrar Pacote Tur�stico�. A p�gina JSF obt�m desta classe as informaç�es exibidas, al�m de enviar-lhe os campos do formul�rio para o cadastro de novos pacotes;
Persist�ncia: a gravaç�o dos dados em um banco de dados � feita utilizando o padr�o de projeto DAO � Data Access Object (Objeto de Acesso a Dados). A interface PacoteTuristicoDAO e um Stateless EJB que utiliza JPA 2.0 encontram-se nesta camada e s�o utilizados pela camada de neg�cio para o cadastro dos pacotes tur�sticos;
Dom�nio: a classe PacoteTuristico representa o elemento do dom�nio do problema com o qual estamos lidando, isto �, o pacote tur�stico que ser� cadastrado. A classe � utilizada pelos componentes das outras tr�s camadas.

Figura 2. Componentes do cadastro de pacotes tur�sticos

Começando pela camada de persist�ncia, as Listagens 1 e 2 mostram, respectivamente, a interface PacoteTuristicoDAO e a classe PacoteTuristicoDAOJPA2, que a implementa. Como podemos ver na Listagem 1, o DAO oferece m�todos cl�ssicos de persist�ncia: recuperaç�o, gravaç�o e exclus�o. A implementaç�o � feita utilizando JPA 2.0, por�m a Listagem 2 n�o mostra a implementaç�o dos m�todos. Como j� dissemos, nosso foco neste artigo ser�o as funcionalidades do CDI.


package br.com.javamagazine.cdiviagens.persistencia;
 
import br.com.javamagazine.cdiviagens.dominio.PacoteTuristico;
import java.util.List;
import javax.ejb.Local;
 
@Local
public interface PacoteTuristicoDAO {
 long recuperarContagem();
 
 List<PacoteTuristico> recuperarTodos();
 
 List<PacoteTuristico> recuperarAlguns(int[] intervalo);
 
 PacoteTuristico recuperarPorId(Long id);
 
 PacoteTuristico salvar(PacoteTuristico objeto);
 
 void excluir(PacoteTuristico objeto);
}

Listagem 1. Interface (local) do DAO para inst�ncias de PacoteTuristico


package br.com.javamagazine.cdiviagens.persistencia;
 
import javax.ejb.Stateless;
import javax.persistence.*;
 
@Stateless
public class PacoteTuristicoDAOJPA2 implements PacoteTuristicoDAO {
 @PersistenceContext
 private EntityManager em;
 
 /* Implementaç�o dos m�todos declarados na interface... */
}

Listagem 2. Stateless EJB que implementa o DAO de PacoteTuristico

� interessante notar, por�m, as anotaç�es que definem estes dois artefatos como um Stateless EJB: @Local indica que PacoteTuristicoDAO � uma interface local para um EJB, enquanto @Stateless define PacoteTuristicoDAOJPA2 como um EJB que n�o armazena estado. Al�m disso, no DAO j� realizamos a primeira injeç�o de depend�ncias. Uma inst�ncia da classe EntityManager (gerenciador de entidades), necess�ria para realizaç�o das operaç�es de persist�ncia via JPA, � injetada automaticamente pelo container na propriedade em, pois a mesma foi anotada com @PersistenceContext.

Recursos do Java EE, portanto, podem ser injetados por meio da utilizaç�o da anotaç�o adequada. A plataforma prov� as seguintes anotaç�es para recursos Java EE:

@PersistenceContext: para o gerenciador de entidades (ou contexto de persist�ncia);
@PersistenceUnit: para a unidade de persist�ncia;
@EJB: para EJBs, sejam eles remotos, locais ou sem interface;
@WebServiceRef: para Web Services;
@Resources: para outros recursos da plataforma Java EE.

Sendo assim, para ter o DAO de PacoteTuristico injetado automaticamente na classe CadastrarPacotes, que implementa a l�gica de neg�cio, utilizamos a anotaç�o @EJB, como mostra a Listagem 3. Ao declarar um atributo utilizando a interface do EJB e a anotaç�o acima, o container cuida do resto e injeta automaticamente uma inst�ncia de PacoteTuristicoDAOJPA2 logo ap�s ter criado a inst�ncia de CadastrarPacotes.


package br.com.javamagazine.cdiviagens.beans;
 
import br.com.javamagazine.cdiviagens.dominio.PacoteTuristico;
import br.com.javamagazine.cdiviagens.persistencia.PacoteTuristicoDAO;
import java.text.*;
import java.util.List;
import java.util.logging.*;
import javax.ejb.*;
import javax.enterprise.inject.Model;
import javax.faces.application.FacesMessage;
import javax.faces.context.FacesContext;
import javax.inject.Inject;
 
@Stateful
@LocalBean
@Model
public class CadastrarPacotes {
 private static final Logger logger = 
 Logger.getLogger(CadastrarPacotes.class.getCanonicalName());
 
 @EJB
 private PacoteTuristicoDAO pacoteTuristicoDAO;
 
 @Inject
 private Localizacao loc;
 
 private List<PacoteTuristico> pacotes;
 
 private PacoteTuristico pacote = new PacoteTuristico();
 
 @Inject
 void carregarPacotes() {
  pacotes = pacoteTuristicoDAO.recuperarTodos();
  logger.log(Level.INFO, "Carregando pacotes tur�sticos:  
  pacotes carregados", pacotes.size());
 }
 
 public List<PacoteTuristico> getPacotes() {
  return pacotes;
 }
 
 public PacoteTuristico getPacote() {
  return pacote;
 }
 
 public void cadastrar() {
  DateFormat df = loc.getFormatadorDatas();
  NumberFormat cf = loc.getFormatadorDinheiro();
 
  logger.log(Level.INFO, "Cadastrando pacote tur�stico: 
  [nome = ; in�cio = ; fim = ; preço = ]", new Object[] 
{pacote.getNome(), df.format(pacote.getInicioPeriodo()), 
  df.format(pacote.getFimPeriodo()), cf.format(pacote.getPreco())});
  pacoteTuristicoDAO.salvar(pacote);
  pacotes.add(pacote);
 
  FacesContext context = FacesContext.getCurrentInstance();
  context.addMessage(null, new FacesMessage("Pacote tur�stico 
  \"" + pacote.getNome() + "\" cadastrado com sucesso!"));
  pacote = new PacoteTuristico();
 }
}"

[...] continue lendo...

Java EE 6 e o CDI � Contexts and Dependency Injection

CDI � Contextos e Depend�ncias

Exemplos e IDE utilizada

Beans, contextos e depend�ncias

Artigos relacionados