O que mudou no Demoiselle?

Transcrição

1 Framework Demoiselle 2.0 O que mudou no Demoiselle? Robson Ximenes <robsonximenes@gmail.com> Thiago Mariano <marianothiago.demoiselle@gmail.com>

2

3 Para que serve este documento?... v 1. Introdução Arquitetura Organização Integração entre camadas Mensagens Tratamento de exceção Entidade Transação Persistência Abstrações Transação Estratégia Filtros Negócio Visão demoiselle-jsf Abstrações Mensagem Tratamento de exceções Regras de navegação Passagem de parâmetros demoiselle-swing iii

4 iv

5 Para que serve este documento? Este documento tem como objetivo identificar as principais mudanças no Framework Demoiselle 2.0, exemplificando e comparando as funcionalidades presentes na versão anterior e na versão atual. Cada sessão apresentará uma área que o framework atua, mostrando apenas as funcionalidades que tiveram mudança na forma de utilização. Sempre a explicação vem acompanhada de um bloco de código que exemplifica o que foi mencionado. v

6 vi

7 Introdução O framework demoiselle passou por um período em que se buscou a padronização das aplicações, para facilitar o intercâmbio de pessoas/projetos sem todo aquele período de adaptação. Em meados de 2010, iniciou-se um estudo sobre as técnicas/tecnologias utilizadas e suas possíveis substitutas. Foi iniciado um processo de especificação da nova versão com o objetivo de tornar o demoiselle mais simples, flexível e de acordo com as especificações JEE. Este documento foi elaborado seguindo a sequência de assuntos abordados nos tutoriais da versão anterior que podem ser encontrados em: 1

8 2

9 Arquitetura 2.1. Organização Esta é a parte que sofre as maiores modificações. Agora o Demoiselle está implementado sobre o JEE 6 visando possibilitar o uso em vários tipos de aplicações (swing, jsf, javafx...) para isto o framework foi dividido em core e extensions. O core é a parte principal e mínima para se construir uma aplicação. As extensions complementam as funcionalidades do framework, por exemplo a camada de persistencia e a camada de apresentação. Os pacotes mudaram para normalizar com a url do projeto br.gov.frameworkdemoiselle e as interfaces de marcação, sem definições, foram substituidas por public interface IDisciplinaBC { public void inserir(disciplina disciplina);... Esta abordagem permite que o projetista crie quando necessário suas interfaces, precisando apenas anotar a implementação com o estereótipo que lhe convier. Algumas já vem no framework(businesscontroller, PersistenceController, ViewController e FacadeController) substituindo as interfaces antigas, porém é possivel criar controladores customizados apenas construindo uma anotação que seja segue @Retention(RUNTIME) MeuController { 2.2. Integração entre camadas Agora a integração ficou mais flexível, utilizando a especificação oficial do JEE (CDI), removendo do projeto a utilização de orientação a aspectos. Isso elimina a nessecidade também da utilização de plugins para a IDE(que muitas vezes ocasionavam problemas). Antes: 3

10 Capítulo 2. Arquitetura public class DisciplinaBC implements IDisciplinaBC // Implementa##o do demoiselle private IDisciplinaDAO disciplinadao;... Agora: public class DisciplinaBC implements IDisciplinaBC // Padr#o JEE private IDisciplinaDAO disciplinadao;... Nota Observem que a mudança foi sutil: (classe do demoiselle) (classe do JEE) Mensagens O contexto de mensagens agora pode ser injetado em qualquer classe bastando inserir a MessageContext messagectx; Antes para utilizar o contexto de mensagem não se usava injeção. Funcionava da seguinte forma: ContextLocator.getinstance().getMessageContext(); A interface IMessage agora sem o prefixo I ficou mais simples: 4

11 Tratamento de exceção public interface Message { String gettext(); SeverityType getseverity(); E também foi disponibilizada uma implementação DefaultMessage que facilita o processo de internacionalização e interpolação. Nota Para entender os detalhes de transação acesse a documentação de referência: demoiselle.sourceforge.net/docs/reference/2.0.1/html/mensagem.html 2.4. Tratamento de exceção As exceções de aplicação não precisam estender ou implementar uma classe/interface do framework, e isto dá ao projetista a liberdade de criar a sua hierarquia de exceções tranquilamente. A única coisa que precisa ser feita é anotar a exceção para que o framework possa utilizar esta exceção para controlar, por exemplo, a public class MinhaException extends RuntimeException { public String getmessage() { return "Minha mensagem!"; Uma grande e boa novidade é a possibilidade de tratar as exceções lançadas por diversos métodos em um só lugar com o exceptions handler, para isto basta criar um método na classe que receba como parâmetro a exceção que você deseja tratar e anotar esse public void trataminhaexcecao(minhaexception cause) { &. // Aqui voc# faz o tratamento: Mensagem, Log... 5

12 Capítulo 2. Arquitetura Nota Para entender os detalhes de transação acesse a documentação de referência: demoiselle.sourceforge.net/docs/reference/2.0.1/html/excecao.html 2.5. Entidade Na versão anterior foi criada a interface IPojo que servia apenas como marcação para identificar mais facilmente quais eram as classes de persistencia. Nesta versão esta interface deixa de existir Transação O controle de transação ganhou algumas funcinalidades. É possível agora definir quais métodos serão transacionais ou a classe inteira. É possivel interagir com a transação ou ainda criar estratégias de transação. Atualmente existem duas já disponibilizadas: JPATransaction e JTATransaction além da NoTransaction, que é utilizada quando nenhuma estratégia de transação é definida. Para ativar a transação, tanto por classe quanto por método, basta anotar a classe/método Isto indicará ao framework para gerenciar aquela public void insert(contact contact) { validateinsert(contact); this.getdelegate().insert(contact); auditbc.insert(new Audit("Inserting contact: " + contact.getcpf())); messagecontext.add(infomessages.contact_insert_ok, contact.getname()); Para definir qual estratégia de transação deverá ser utilizada, basta indicá-la no arquivo beans.xml que fica na pasta resources/meta-inf, como é mostrado no exemplo abaixo: <beans xmlns=" xmlns:xsi=" XMLSchema-instance" xsi:schemalocation=" beans_1_1.xsd"> <alternatives> <class>br.gov.frameworkdemoiselle.transaction.jpatransaction</class> </alternatives> </beans> 6

13 Persistência A camada de persistência é tratada pela extensão demoiselle-jpa, sendo possível o lançamento de outros mecanismos como JDO. Neste momento é disponibilizado apenas a persistência com JPA 2. Logo, o mapeamento de entidades permanece como na versão anterior apenas removendo a dependência da interface IPojo, que não existe mais Abstrações A classe JPACrud foi disponibilizada para abstrair as operações de CRUD( create, retrieve, update e public class ContactDAO extends JPACrud<Contact, Long> {... Neste exemplo você percebe que a classe tem dois parâmetros. O primeiro representa a entidade que será tratada e o segundo indica qual o tipo de ID Transação A interatividade com a transação agora independe do antigo TransactionContext, que deixou de existir. Bastando apenas ter na classe uma propriedade do tipo Transaction injetada; public class Simples private Transaction transaction; Estratégia Existem 3 tipos disponibilizados: NoTransaction JPATransaction JTATransaction 7

14 Capítulo 3. Persistência Dica Viste o guia de referência para maiores detalhes: reference/2.0.1/html/transacao.html 3.3. Filtros A realização de filtros deve ser feita utilizando os novos recursos oferecidos pelo JPA 2 8

15 Negócio A camada de negócio deixa de utilizar a interface IBussinessController para adotar a estratégia de utilização da anotação public class ContactBC extends DelegateCrud<Contact, Long, ContactDAO> {... Foi disponibilizada também uma abstração para as operações de CRUD. Para utiliza-la basta herdar da classe DelegateCrud, informando a entidade, o tipo de ID e uma classe que implemente a interface CRUD. 9

16 10

17 Visão A camada de visão é tratada através de extensões. No momento duas estão disponibilizadas: demoiselle-jsf(jee) e demoiselle-swing(se) demoiselle-jsf Esta é a extensão mais utilizada e recomendada para aplicações web. Nela é disponibilizado o JSF 2. O JSF 2 melhorou muito a maneira de configurar a aplicação, permitindo inclusive que configurações sejam feitas dentro de bibliotecas. Desta forma, a utilização da extensão reduz significativamente as configurações no arquivo web.xml e faces-config.xml Abstrações As abstrações são implementações da interface PageBean public interface PageBean extends Serializable { public String getcurrentview(); public String getnextview(); public String getpreviousview(); public String gettitle(); Desta interface derivam as abstrações de edição e listagem, que implementam os métodos de navegação e operações de edição ou listagem, dependendo de qual abstração foi utilizada: AbstractEditPageBean ou AbstractListPageBean Mensagem O contexto de mensagem pode ser injetado em qualquer camada da aplicação e o programador poderá escolher se adiciona a mensagem no contexto de mensagem ou se adiciona diretamente no FacesContext. Abaixo é um exemplo de como usar o utilitário Faces para public void handleexception(final DuplicatedCpfException cause) { Faces.addMessage("cpf", cause); Porém caso outras camadas estejam adicionando mensagens no contexto de mensagens, existe uma listener que varrerá as mensagens do contexto de mensagens a passará para o contexto do jsf de forma transparente. 11

18 Capítulo 5. private MessageContext public void insert(contact contact) { this.getdelegate().insert(contact); messagecontext.add(infomessages.contact_insert_ok, contact.getname()); Tratamento de exceções Regras de navegação As abstrações de Page Bean utilizam as anotações de navegação para descobrir qual a tela que deve ser renderizada. As anotações são: public class ContactEditMB { Passagem de parâmetros A passagem de parâmetros para o Bean ficou muito simples, basta criar uma propriedade no pagebean do tipo Parameter e sempre que estiver na classe esta propriedade estará sincronizada com public class ContactListMB extends PagedListPageBean<Contact, Long> private Parameter<Long> private ContactBC contactbc; 12

19 protected List<Contact> handleresultlist() { List<Contact> result = null; if (groupid.getvalue()!= null) { result = contactbc.find(new Group(groupId.getValue())); else { result = contactbc.findall(); return result; Nota Observem no exemplo que a propriedade groupid é utilizada no método handleresultlist, sem a necessidade de explícitamente obter o valor do request. Vale lembrar também que é possível criar uma propriedade com o scopo diferente do pagebean utilizando o Parameter. Para isto, basta anotar a propriedade com o scopo desejado demoiselle-swing Na versão anterior não era simples criar uma aplicação swing, agora basta utilizar o arquétipo de swing. 13

20 14