Escolar Documentos
Profissional Documentos
Cultura Documentos
Guia de Referncia
Cleverson Sacramento Marlon Carvalho Rodrigo Hjort Serge Rehem Thiago Mariano
Sobre o Guia de Referncia ...................................................................................................... v I. Framework ......................................................................................................................... 1 1. Introduo ................................................................................................................ 3 1.1. O que o Demoiselle? ...................................................................................... 3 1.2. Demoiselle 2.0 ................................................................................................. 3 2. Arquitetura/Estrutura .................................................................................................. 5 2.1. Estruturao do Framework ................................................................................. 5 2.2. Pacote Internal ................................................................................................. 2.3. Arqutipo ........................................................................................................ 2.4. Estrutura sugerida s aplicaes ........................................................................... 3. Controlador .............................................................................................................. 5 5 6 7
3.1. Como criar seu controlador ................................................................................. 7 4. Transao ................................................................................................................ 9 4.1. Mtodos transacionais ........................................................................................ 9 4.2. E se acontecer uma Exception? ........................................................................... 9 4.3. O objeto Transaction ........................................................................................ 10 4.4. Escolha a estratgia adequada ........................................................................... 10 4.5. Estratgia JPA ............................................................................................... 10 4.6. Estratgia JTA ............................................................................................... 11 4.7. Crie a sua estratgia ........................................................................................ 12 5. Excees ............................................................................................................... 15 5.1. Tratadores de exceo ..................................................................................... 15 5.2. Mltiplos tratadores .......................................................................................... 15 5.3. Misturando os dois mundos ............................................................................... 16 5.4. Exceo de aplicao ...................................................................................... 16 5.5. Tratamento padro .......................................................................................... 16 6. Configurao .......................................................................................................... 17 6.1. Configuraes em uma aplicao ........................................................................ 17 6.2. As classes de configurao ............................................................................... 17 6.3. Especificando os parmetros .............................................................................. 18 6.4. Usando a configurao na aplicao .................................................................... 20 6.5. Lendo arquivos XML ........................................................................................ 21 6.6. Lendo variveis de ambiente .............................................................................. 21 7. Inicializao ............................................................................................................ 23 7.1. Introduo ao mecanismo .................................................................................. 23 7.2. Implementao na aplicao .............................................................................. 23 7.3. Um exemplo prtico ......................................................................................... 24 8. Tratamento de Mensagens ......................................................................................... 25 8.1. Mensagens em uma aplicao ............................................................................ 25 8.2. Introduo ao mecanismo .................................................................................. 25 8.3. Parametrizao das mensagens .......................................................................... 27 8.4. Internacionalizao das mensagens ..................................................................... 28 8.5. Exemplos de implementao .............................................................................. 30 A. Instalao ....................................................................................................................... 33 A.1. Pr-requisitos ......................................................................................................... 33 A.2. Demoiselle Infra ..................................................................................................... 33
iii
iv
Nota
Esta documentao refere-se release 2.0 do Framework Demoiselle e pode diferir significativamente das verses anteriores.
vi
Parte I. Framework
Introduo
1.1. O que o Demoiselle?
O Demoiselle Framework implementa o conceito de framework integrador. Seu objetivo facilitar a construo de aplicaes minimizando tempo dedicado escolha e integrao de frameworks especialistas, o que resulta no aumento da produtividade e garante a manutenibilidade dos sistemas. Disponibiliza mecanismos reusveis voltados as funcionalidades mais comuns de uma aplicao (arquitetura, segurana, transao, mensagem, configurao, tratamento de excees, etc). O nome Demoiselle uma homenagem srie de aeroplanos construdos por Santos Dummont entre 1907 e 1909. Tambm conhecido como Libellule, as Demoiselles foram os melhores, menores e mais baratos avies da sua poca. Como sua inteno era popularizar a aviao com fabricao em larga escala, o inventor disponibilizava os planos em revistas tcnicas a qualquer um que se interessasse. O Demoiselle Framework usa a mesma filosofia do Pai da Aviao, tendo sido disponibilizado como software livre em abril de 2009, sob a licena livre LGPL version 3. Informaes no portal www.frameworkdemoiselle.gov.br.
Arquitetura/Estrutura
2.1. Estruturao do Framework
Visando uma melhor modularizao, o Demoiselle dividido conforme as funcionalidades disponibilizadas. Isto significa que o framework no um ncleo monoltico, no qual todas as sua funcionalidades esto contidas em um nico pacote. Alis, esta estratgia no a mais indicada, pois projetos com um propsito especfico, que no necessitam de persistncia ou interface Web, por exemplo, teriam dependncias desnecessrias. Assim, o Demoiselle separado em Core, Extenses e Componentes. O core do Demoiselle contm aquelas funcionalidades que so comuns a todas as extenses e aplicaes. O core simples, leve e formado majoritariamente por interfaces e poucas implementaes. O core a base do framework, sem ele, as extenses, e a prpria aplicao, no funcionam. As extenses, como seu prprio nome sugere, estende o Demoiselle com funcionalidades extras e bem especficas a um domnio. Neste contexto, se sua aplicao precisa de persistncia com JPA, o framework fornece facilidades para voc, contudo, estas funcionalidades no esto no core. Alis, mais uma vez, no faz sentido estar no core, pois existem aplicaes que no precisam de persistncia! Para este propsito existe a extenso demoiselle-
jpa. Basta incluir uma dependncia para esta extenso que seu projeto ter disponvel todas as facilidades que o
Demoiselle fornece para o JPA. Cabe destacar que as extenses no possuem vida prpria, pois esto diretamente ligadas ao ncleo do framework, estendendo suas funcionalidades e usando aquelas j fornecidas por ele. Inclusive, as extenses possuem seu ciclo de vida totalmente acoplado ao ciclo de vida do core. J os componentes so artefatos separados e que, portanto, no so dependentes diretamente do core do framework. Alis, os componentes podem at mesmo ter vida sem o Demoiselle. Desta forma, o ciclo de vida de um componente totalmente independente do framework, ao contrrio das extenses. Um componente no precisa, necessariamente, estender as funcionalidades j providas pelo core, mas permitir ao usurio incluir uma nova funcionalidade independente da verso que esteja sendo usada no core.
2.3. Arqutipo
O Demoiselle fornece um arqutipo para facilitar a criao de aplicaes que precisam de uma arquitetura que utilize as tecnologias JSF e JPA. Trata-se do arqutipo demoiselle-jsf-jpa, que j traz uma estrutura padro
Captulo 2. Arquitetura/Estrutura
de pacotes e todas as dependncias necessrias para rodar a aplicao. Ao usar este arqutipo, voc j ter uma pequena aplicao de Bookmarks j pronta para rodar. Para isto, basta instal-la em um servidor da sua preferncia! Para mais detalhes sobre esta aplicao de exemplo e em como usar o arqutipo, acesse nosso Quickstart.
Controlador
No Demoiselle Framework 2.0 os controladores ou controllers servem para identificar as camadas da arquitetura de sua aplicao. comum que as aplicaes utilizem apenas trs camadas: viso, negcio e persistncia. Existem aplicaes que utilizam fachadas. Por esse motivo, foram implementados nessa verso do framework quatro controllers:
ViewController FacadeController BusinessController PersistenceController Alm de identificar as camadas, os controllers so pr-requisitos para utilizao da funcionalidade de tratamento de excees, atravs do uso da anotao @ExceptionHandler. Isso quer dizer que para utilizar essa funcionalidade, a classe precisa usar um dos controllers citados acima ou a prpria anotao @Controller ou ainda um controller criado exclusivamente para sua aplicao. Todos os controllers criados no framework so esteretipos e podem ser usados tambm para definio de caractersticas como, por exemplo, o escopo. Isso quer dizer que se um controller tem um determinado escopo, todas as classes desse controller, tambm tero o mesmo escopo. Foi falado que possvel criar um controller para uso exclusivo em sua aplicao, mas como fazer isso? Veja na seo abaixo.
Neste exemplo foi criado um controlador chamado SeuController quem tem a caracterstica de ter um escopo de View. Isto quer dizer que todo classe que seja desse tipo de controlador, tambm ter o escopo de View.
Transao
Esta funcionalidade utiliza os recursos do CDI para interceptar e delegar o tratamento adequado das transaes para quem de direito. Em outras palavras, no reinvantamos a roda. Criamos algumas estratgias de delegao e controle de transao com base no que est sendo mais utilizado no mercado, algumas mais simples de configurar, outras mais completas para utilizar. Alm de plugar e usar as estratgias prontas que fizemos para voc, possvel tambm criar a sua. Vai que voc precise de algo que no pensamos ainda. O importante que voc tenha opes, e uma das opes tambm no utilizar a nossa soluo. Caso voc esteja utilizando o Demoiselle Framework em conjunto com outro framework (tais como o JBoss Seam, Spring ou Google Guice) que oferea o controle de transao, voc pode us-lo tambm. Viva a liberdade de escolha! Neste captulo apresentaremos para voc como usar a nossa soluo de controle de transao, as estratgias prontas que oferecemos e a criao de sua prpria estratgia.
Se voc desejar que todos os mtodos de sua classe sejam transacionais, anote diretamente a classe:
@Transactional public class Simples { public void inserir() { } public void alterar() { } public void excluir() { } }
Neste exemplo, os mtodos inserir(), alterar() e excluir() da classe Simples participaro do contexto transacional.
Captulo 4. Transao
NoTransaction do pacote br.gov.frameworkdemoiselle.transaction. Contudo, obviamente voc no poder utilizar a anotao @Transactional. Se a utilizar, o Demoiselle lanar uma exceo para que voc
lembre disto. Defina a alternativa NoTransaction no arquivo de configuraes do CDI, o META-INF/beans.xml.
<?xml version="1.0"?> <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_1.xsd"> <alternatives> <class>br.gov.frameworkdemoiselle.transaction.NoTransaction</class> </alternatives> </beans>
<?xml version="1.0"?>
10
Estratgia JTA
<?xml version="1.0"?> <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_1.xsd"> <alternatives> <class>br.gov.frameworkdemoiselle.transaction.JTATransaction</class> </alternatives> </beans>
Feito com
<?xml version="1.0" encoding="UTF-8"?> <persistence version="2.0" xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd"> <persistence-unit name="contactlist-ds"> <jta-data-source>java:/DefaultDS</jta-data-source> <properties> <property name="hibernate.transaction.factory_class" value="org.hibernate.transaction.JTATransactionFactory" />
11
Captulo 4. Transao
package projeto; import javax.enterprise.context.SessionScoped; import javax.enterprise.inject.Alternative; import br.gov.frameworkdemoiselle.transaction.Transaction; @Alternative @SessionScoped public class MegaTransaction implements Transaction { public void begin() { } public void commit() { } public void rollback() { } public void setRollbackOnly() { } public int getStatus() { } public void setTransactionTimeout(int seconds) { } public boolean isActive() { } public boolean isMarkedRollback() { } }
<?xml version="1.0"?> <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_1.xsd"> <alternatives> <class>projeto.MegaTransaction</class> </alternatives>
12
</beans>
13
14
Excees
Esta funcionalidade foi feita para voc que acha muito verboso encher o cdigo de try/catch. E o que dizer de repetir o tratamento de excees em vrios mtodos da mesma classe na base do copiar/colar? Oferecemos voc uma alternativa para resolver estes problemas, mas voc estar livre para us-la: isoladamente, misturando com a forma verbosa ou at mesmo no us-la.
@Controller public class Simples { @ExceptionHandler public void tratador(NullPointerException cause) { } public void inserir() { } public void alterar() { } public void excluir() { } }
Neste exemplo, qualquer exceo do tipo NullPointerException que ocorrer nos mtodos da classe Simples ter o tratamento delegado para o mtodo tratador(). Para as excees no tratadas, o comportamento seguir o padro da linguagem.
@Controller public class Simples { @ExceptionHandler public void tratador(NullPointerException cause) { } @ExceptionHandler public void tratador(AbacaxiException cause) { } public void inserir() { } public void alterar() { } public void excluir() { }
15
Captulo 5. Excees
Caso as excees NullPointerException ou AbacaxiException ocorram nos mtodos da classe Simples, o tratamento ser delegado para o seu tratador.
@Controller public class Simples { @ExceptionHandler public void tratador(NullPointerException cause) { } public void inserir() { try { // tenta algo } catch (AbacaxiException cause ) { // trata o problema } } public void alterar() { } public void excluir() { } }
16
Configurao
6.1. Configuraes em uma aplicao
Em aplicaes no modelo Java EE, as quais so executadas hospedadas em um servidor de aplicaes ou continer Web, existem diversos papis alm do desenvolvedor, tais como assembler e deployer. comum nestas aplicaes que informaes de configurao de ambiente, especialmente por questes de segurana, sejam de conhecimento restrito. Por exemplo, o usurio e senha de um banco de dados ou o nome de uma fila de mensagens so informaes que o desenvolvedor no deve possuir, pelo menos para o ambiente de produo. Alm disso, o profissional responsvel pelo deploy (i.e., a implantao) da aplicao geralmente no pode ser encarregado de recompilar os cdigos fontes para efetivar a alterao desses dados. Para resolver essas questes, faz-se necessrio um mecanismo de configurao para as aplicaes. O desenvolvedor e o assembler constroem inteiramente uma aplicao e entregam o respectivo arquivo para o deployer coloc-la em produo. Paralelamente a isso, o deployer configura arquivos externos e variveis de sistema com as informaes sigilosas e protegidas que sero posteriormente lidas pela aplicao. A aplicao no precisar ser reconstruda caso um dado de configurao precise ser modificado. Frequentemente em Java utilizamos as seguintes abordagens para armazenar as configuraes:
arquivo de propriedades: tratam-se de simples arquivos de texto nomeados com a extenso .properties e que internamente so escritos com a sintaxe chave = valor, armazenando uma nica chave por linha; arquivo XML: so arquivos de texto altamente estruturados com a sintaxe de tags e que permitem uma maior validao de seus valores, sendo geralmente nomeados com a extenso .xml; variveis de ambiente: valores definidos a nvel de sistema operacional, independente de plataforma (Windows, Linux, etc) e que podem ser recuperados durante a execuo da aplicao. Na seo a seguir veremos como o Demoiselle Framework apoia o desenvolvimento de aplicaes nas tarefas de carregamento de configuraes. Tal mecanismo comumente utilizado internamente em diversos componentes do framework.
@Configuration(resource = "bookmark") public class BookmarkConfig { private String applicationTitle; private boolean loadInitialData; public String getApplicationTitle() { return applicationTitle; } public boolean isLoadInitialData() { return loadInitialData;
17
Captulo 6. Configurao
} }
Na classe os atributos devem ser tratados como sendo somente de leitura, possuindo apenas seus respectivos mtodos getter. Valores default podem ser especificados com literais na prpria declarao do atributo (ex: boolean loadInitialData = true).
Nota
As classes anotadas com @Configuration so tratadas de forma diferenciada pelo continer. Elas so instanciadas uma nica vez (seguindo o padro de projeto singleton) e podem ser utilizadas em qualquer ponto da aplicao. Seu ciclo de vida gerenciado automaticamente pela implementao CDI. O arquivo de recursos especificado lido apenas na inicializao da aplicao e os atributos da classe so preenchidos automaticamente nessa etapa.
No exemplo em questo, ser buscado um arquivo de propriedades com o nome bookmark.properties contendo as seguintes chaves:
Nota
Recomenda-se usar o sufixo Config em uma classe de configurao para indic-la como tal.
@Configuration. Caso no sejam especificados, ser considerado o arquivo de propriedades padro do Demoiselle Framework, o demoiselle.properties.
Dica
Para indicar que um determinado atributo da classe no corresponde a um parmetro, utilize a anotao @Ignore nele. Desta forma ele ser desconsiderado no momento de leitura da configurao.
18
Especificando os parmetros
Dica
Para forar a existncia de um parmetro de configurao, utilize a anotao @NotNull no respectivo atributo. Caso ele no seja encontrado no recurso, uma exceo ser lanada na inicializao da aplicao.
No arquivo de recursos ser buscada a chave correspondente ao atributo seguindo convenes pr-determinadas. Por exemplo, no caso do atributo loadInitialData, sero buscadas as seguintes verses de chaves no arquivo de recursos: loadInitialData load.initial.data load_initial_data loadinitialdata
Dica
A fim de utilizar uma nomenclatura de chave diferente dos formatos convencionados, utilize a anotao @Name no atributo.
Em determinadas situaes utilizado um prefixo de chave comum a todos os parmetros de uma classe de configurao. Neste caso, possvel especificar tal prefixo na anotao @Configuration. Isso permite, por exemplo, que um mesmo arquivo de recursos (ex: demoiselle.properties) seja compartilhado por diversas classes de configurao. Veja na listagem abaixo um cdigo fonte que ilustra a utilizao das anotaes descritas nesta seo:
@Ignore private int dummy; public String getApplicationTitle() { return applicationTitle; } public boolean isLoadInitialData() { return loadInitialData; } }
19
Captulo 6. Configurao
Na anotao @Configuration so especificados o arquivo de recursos bookmark.properties e o prefixo general a ser considerado em cada uma das chaves. Ao invs de adotar o padro convencionado, com a anotao @Name ser considerada a chave app.title aps o prefixo. Como o atributo anotado com @NotNull, presume-se que ele sempre estar presente no arquivo de recursos. Caso contrrio, uma exceo ocorrer na inicializao da aplicao. Este atributo, por estar anotado com @Ignore, no ser considerado pelo mecanismo de configuraes. Neste caso, ser buscado um arquivo de propriedades com o nome bookmark.properties contendo as seguintes chaves:
Dica
Alm de String e boolean, existe a possibilidade de se recuperar valores de qualquer tipo primitivo do Java (i.e., int, byte, short, char, long, float, double e boolean) e tambm arrays desses tipos.
public class BookmarkBC { @Inject private BookmarkConfig config; public void startup() { if (config.isLoadInitialData()) { ... } } }
Nota
O Demoiselle Framework utiliza internamente o mecanismo de configuraes na leitura do arquivo demoiselle.properties para outras funcionalidades, tais como transao, persistncia e paginao.
20
Neste caso, na classe de configurao EscolaConfig a anotao @Configuration precisa apontar para o tipo de recursos XML e usar o respectivo arquivo escola.xml. Eis a implementao necessria para que o referido arquivo XML seja lido e os seus valores carregados automaticamente:
@Configuration(resource = "escola", type = ConfigType.XML) public class EscolaConfig { private Integer qtdeInicial = 50; @Name("papeis.papel") private List<String> papeis; private Integer getQtdeInicial() { return qtdeInicial; } public List<String> getPapeis() { return papeis; } }
21
Captulo 6. Configurao
22
Inicializao
7.1. Introduo ao mecanismo
Uma aplicao qualquer, seja do tipo Web ou desktop, geralmente necessita efetuar determinadas tarefas durante a sua inicializao e ou finalizao. Eis alguns exemplos: abertura de conexo a um servidor de banco de dados, carregamento de parmetros de configurao a partir de arquivos externos e execuo de scripts especficos. Ou seja, normalmente essas aes so definidas como funes estruturais da aplicao. Para que a execuo dessas aes ocorra de forma concisa, faz-se necessrio o uso de um mecanismo padronizado para inicializao do ambiente. O Demoiselle Framework fornece esse mecanismo atravs da especificao CDI introduzindo duas anotaes: @Startup e @Shutdown.
Dica
O mecanismo de inicializao do Demoiselle Framework independente da natureza da aplicao Java, isto , visa tanto aplicaes do tipo Web quanto do tipo desktop (ex: Swing).
As instrues contidas em um mtodo anotado com @Startup sero executadas automaticamente quando a aplicao Java for inicializada, seja ela hospedada em um continer Web ou executada atravs de um mtodo
main(). Nenhum outro arquivo ou classe precisa ser definido. A anotao @Startup permite a indicao do argumento priority, um nmero inteiro que serve para definir a prioridade de execuo do respectivo mtodo
na existncia de mais de um inicializador para a aplicao. De maneira anloga, um mtodo anotado com @Shutdown ser executado no momento de finalizao de uma aplicao, obedecendo tambm ordem de prioridade definida com o argumento priority. Eis um exemplo de implementao de inicializador em uma aplicao:
public class BookmarkInitializer { @Startup(priority = 1) public void initialize() { ... } @Shutdown(priority = 5) public void finalize() { ... } }
23
Captulo 7. Inicializao
Dica
Para a definio de prioridade de execuo de um mtodo na inicializao ou finalizao, podem ser utilizadas as constantes MIN_PRIORITY ou MAX_PRIORITY presentes em br.gov.frameworkdemoiselle.annotation.Startup.
import br.gov.frameworkdemoiselle.annotation.Shutdown; import br.gov.frameworkdemoiselle.annotation.Startup; import static br.gov.frameworkdemoiselle.annotation.Startup.MAX_PRIORITY; import static br.gov.frameworkdemoiselle.annotation.Startup.MIN_PRIORITY; public class DatabaseServer { private final org.hsqldb.Server server; public DatabaseServer() { server = new Server(); server.setDatabaseName(0, "db"); server.setDatabasePath(0, "database/db"); server.setPort(9001); server.setSilent(true); } @Startup(priority = MAX_PRIORITY) public void startup() { server.start(); } @Shutdown(priority = MIN_PRIORITY) public void shutdown() { server.stop(); } }
24
Tratamento de Mensagens
8.1. Mensagens em uma aplicao
Uma aplicao bem estruturada, seja na plataforma Web ou desktop, deve exibir mensagens informativas, de aviso ou de erro ao usurio aps efetuar determinadas tarefas. Por exemplo, aps gravar um registro no banco de dados, aconselhvel que a aplicao exiba uma mensagem informativa. Se alguma exceo ocorreu, preciso exibir uma mensagem de erro. Ou seja, a severidade da mensagem deve ser escolhida de acordo com o resultado da execuo. Veja na tabela a seguir a definio de cada um dos nveis de severidade da mensagem em uma aplicao e um exemplo de texto associado:
MessageContext. Esta interface contm mtodos destinados a incluso, recuperao e limpeza de mensagens
no contexto. Para obter uma instncia do contexto de mensagens, basta injet-lo na classe:
25
A maneira mais simples de se inserir uma mensagem no contexto invocando o mtodo add() de
Dica
Quando a severidade no informada (argumento de tipo SeverityType), ser considerado o nvel informativo, isto , INFO.
Para a transmisso das mensagens no contexto tambm fornecida a interface Message, a qual permite com que os textos sejam obtidos de catlogos especializados, tais como arquivos de propriedades ou banco de dados. Essa interface precisa ser implementada em uma classe customizada pelo desenvolvedor. Sua estrutura bem simples:
A classe DefaultMessage fornecida pelo Demoiselle Framework 2.0 uma implementao da interface
Message que faz uso dos arquivos de recurso da aplicao para obteno das descries das mensagens. Especificamente utiliza o arquivo messages.properties.
Nota
A unidade bsica de manipulao de mensagens no Demoiselle Framework 2.0 a interface Message. Basta que ela seja implementada na aplicao para que o contexto de mensagens possa manipul-la. A classe DefaultMessage oferecida como implementao padro dessa interface.
Para incluir uma mensagem no contexto usando o tipo Message preciso invocar o mtodo add() de MessageContext passando o objeto como argumento. Eis um exemplo disso utilizando a classe
DefaultMessage:
26
Uma vez inseridas no contexto em determinada camada da aplicao, as mensagens podem ser posteriormente recuperadas. Para tal, preciso invocar o mtodo getMessages() da interface MessageContext, o qual retornar uma coleo de objetos do tipo Message.
Nota
A extenso para JavaServer Faces no Demoiselle Framework 2.0 transfere automaticamente as mensagens includas no MessageContext para a apresentao durante a renderizao da pgina pelo JSF.
Para remover todas as mensagens existentes no contexto, basta invocar o mtodo clear() da interface MessageContext.
Nota
Especificamente para aplicaes Java Web, o contexto de mensagens automaticamente reinicializado a cada requisio HTTP. Ou seja, as mensagens includas no contexto por uma determinada sesso de usurio no interferem nas demais sesses existentes no servidor de aplicaes. Alm disso, ao final da requisio as mensagens existentes so automaticamente excludas do contexto.
O contexto de mensagens MessageContext tem o seu ciclo de vida gerenciado pelo CDI e pertence ao escopo de sesso (i.e., @SessionScoped). Ou seja, mensagens includas na requisio de um determinado usurio no sero exibidas para um outro usurio, pois cada um possuir a sua sesso.
Nota
O contexto de mensagens, representado pela interface MessageContext, capaz de armazenar diversas mensagens em uma mesma requisio. Ele no restrito aplicaes do tipo Web, isto , pode ser usado tambm para aplicaes do tipo desktop (i.e., Swing).
27
Message message = new DefaultMessage("Aluno {0} inserido com sucesso"); messageContext.add(message, aluno.getNome());
Message message = new DefaultMessage( "As {1,time} do dia {1,date,short} houve {2} na turma {0}"); messageContext.add(message, new Integer(502), new Date(), "falta de professor");
O resultado da execuo deste cdigo seria um texto como: s 13:45:05 do dia 03/01/11 houve falta do professor na turma 502. Ou seja, os argumentos {0}, {1} e {2} so substitudos por seus respectivos elementos na ordem em que so passados no mtodo add(), sendo que ainda podemos formatar esses valores.
Dica
possvel passar mais de um parmetro nas mensagens adicionadas no contexto, usando para isso a sintaxe de formatao da classe java.text.MessageFormat. A ordem dos argumentos passados no mtodo add() reflete nos elementos substitudos na string.
Ou seja, ao invs de usar a string literal, passamos o identificador da chave presente no arquivo de propriedades.
Nota
O smbolo de chaves {} na string do construtor da classe DefaultMessage indica se o texto da mensagem ser recuperado de um arquivo de recursos ou considerado o texto literal.
28
Eis um exemplo de contedo do arquivo messages.properties destinado a manter por padro os textos no idioma portugus brasileiro (i.e., pt-BR). Veja que ele contm a chave ALUNO_INSERIR_OK usada no exemplo anterior:
ALUNO_INSERIR_OK = Aluno {0} inserido com sucesso ALUNO_ALTERAR_OK = Aluno {0} alterado com sucesso ALUNO_EXCLUIR_OK = Aluno {0} excludo com sucesso
A fim de prover internacionalizao para o idioma ingls americano (i.e., en-US) no exemplo em questo, eis o contedo do arquivo messages_en_US.properties:
ALUNO_INSERIR_OK = Student {0} was successfully added ALUNO_ALTERAR_OK = Student {0} was successfully modified ALUNO_EXCLUIR_OK = Student {0} was successfully removed
Similarmente, o arquivo messages_fr.properties se destina a prover as mensagens no idioma francs (independente do pas), contendo as linhas a seguir:
ALUNO_INSERIR_OK = L'tudiant {0} a t ajout avec succs ALUNO_ALTERAR_OK = L'tudiant {0} a t modifi avec succs ALUNO_EXCLUIR_OK = L'tudiant {0} a t supprim avec succs
Nota
As chaves das mensagens (ex: ALUNO_INSERIR_OK) devem ser as mesmas em todos os arquivos de propriedades. So elas que identificam unicamente uma mensagem, que ao final do processo tem o seu texto automaticamente traduzido para o idioma preferido do usurio.
Dica
possvel ainda configurar de modo genrico o idioma, especificando apenas a lngua. Por exemplo, ao invs de ingls britnico (en_GB) e ingls americano (en_US), podemos simplesmente definir o idioma ingls (en). Neste caso, o arquivo dever ser o messages_en.properties.
Nota
Internamente o Demoiselle Framework usa a classe java.util.Locale [http://download.oracle.com/ javase/6/docs/api/java/util/Locale.html] presente na API do Java para manipular os textos das mensages durante a internacionalizao.
29
Nota
A seleo de idioma na internacionalizao de uma aplicao consiste na definio de:
lngua: cdigos formados por duas letras em minsculo listados na ISO-639 (ISO Language Code) - exemplos: pt, en, fr, es, de; pas: cdigos formados por duas letras em maisculo listados na ISO-3166 (ISO Country Code) - exemplos: BR, PT, US, GB.
public interface InfoMessages { final Message BOOKMARK_DELETE_OK = new DefaultMessage("{BOOKMARK_DELETE_OK}"); final Message BOOKMARK_INSERT_OK = new DefaultMessage("{BOOKMARK_INSERT_OK}"); final Message BOOKMARK_UPDATE_OK = new DefaultMessage("{BOOKMARK_UPDATE_OK}"); }
No
exemplo
em
questo,
texto
das
mensagens
ser
recuperado
do
arquivo
de
recursos
BOOKMARK_DELETE_OK = Bookmark exclu\u00EDdo\: {0} BOOKMARK_INSERT_OK = Bookmark inserido: {0} BOOKMARK_UPDATE_OK = Bookmark atualizado: {0}
Dica
Recomenda-se criar uma interface para cada tipo de severidade (ex: InfoMessages, WarningMessages, ErrorMessages e FatalMessages), agrupando nestas as mensagens usadas exclusivamente para o mesmo fim.
30
Exemplos de implementao
J a segunda abordagem consiste no uso de enumeraes para centralizar os modelos de mensagem. utilizado o mesmo arquivo de recursos messages.properties ilustrado na abordagem anterior. Porm, neste caso cada enumerador da enumerao corresponder a uma chave no arquivo de propriedades.
public enum InfoMessages implements Message { BOOKMARK_DELETE_OK, BOOKMARK_INSERT_OK, BOOKMARK_UPDATE_OK; private final DefaultMessage msg; private InfoMessages() { msg = new DefaultMessage("{" + this.name() + "}"); } @Override public String getText() { return msg.getText(); } @Override public SeverityType getSeverity() { return msg.getSeverity(); } }
A fim de adicionar mensagens ao contexto, eis um exemplo de cdigo que faz uso do artefato InfoMessages, que funciona no importa qual abordagem escolhida (interface ou enumerao):
@BusinessController public class BookmarkBC { @Inject private MessageContext messageContext; public void insert(Bookmark bookmark) { ... messageContext.add(InfoMessages.BOOKMARK_INSERT_OK, bookmark.getDescription()); } public void update(Bookmark bookmark) { ... messageContext.add(InfoMessages.BOOKMARK_UPDATE_OK, bookmark.getDescription()); } public void delete(Bookmark bookmark) { ... messageContext.add(InfoMessages.BOOKMARK_DELETE_OK, bookmark.getDescription());
31
} }
No ponto contendo @Inject ser injetado via CDI o contexto de mensagens presente na aplicao, ou seja, uma instncia da interface MessageContext que poder ser utilizada em qualquer mtodo nessa classe. Aqui os mtodos insert(), update() e delete() na classe BookmarkBC manipulam o contexto de mensagens em cada invocao destes. O mtodo add() de MessageContext faz com que a mensagem passada como parmetro seja adicionada ao contexto, que ao final exibida para o usurio na camada de apresentao.
32
Apndice A. Instalao
A.1. Pr-requisitos
Software Java Development Kit (JDK) Apache Maven Eclipse IDE m2eclipse plugin JBoss Application Server Verso 6.0 2.2 3.6 0.10 6.0 Site http://openjdk.org/ http://maven.apache.org/ http://www.eclipse.org/ http://m2eclipse.sonatype.org/ http://www.jboss.org/
Nota
Atualmente so disponibilizados pacotes exclusivamente para a plataforma GNU/Linux e distribuies baseadas no Debian, tal como Ubuntu.
33
34