Escolar Documentos
Profissional Documentos
Cultura Documentos
Guia do Usurio
Guia do usurio ..................................................................................................................... v 1. Sobre Demoiselle Nimble .................................................................................................... 1 1.1. O que ................................................................................................................. 1 1.2. Templates Disponveis ............................................................................................... 1 2. Instalao ........................................................................................................................ 3 2.1. Via pacotes Debian GNU/Linux .................................................................................... 3 2.2. Instalao a partir do download .................................................................................... 3 3. Guia Rpido ..................................................................................................................... 3.1. Interface Grfica ....................................................................................................... 3.1.1. Templates de Criao de Aplicaes ................................................................... 3.1.2. Templates de Gerao de CRUD para JSF e VAADIN com Demoiselle v2.x .................... 5 5 6 6
3.1.3. Template de Gerao de CRUD para JSF com Demoiselle v1.x .................................. 7 3.2. Linhas de comando ................................................................................................... 8 3.2.1. Executando em ambiente LINUX ........................................................................ 8 3.2.2. Executando em ambiente MS-Windows ................................................................ 9 4. Plugin para Eclipse IDE .................................................................................................... 11 4.1. Instalao ............................................................................................................. 11 4.1.1. Instalao no Eclipse Indigo ou superior .............................................................. 11 4.1.2. Instalao em verses antigas. ......................................................................... 15 4.2. Instrues de Uso ................................................................................................... 17 5. Plugin para NetBeans IDE ................................................................................................. 19 5.1. Instalao ............................................................................................................. 19 5.2. Instrues de Uso ................................................................................................... 22 6. Exemplo usando Eclipse IDE ............................................................................................. 25 6.1. Prepararao ......................................................................................................... 25 6.2. Gerando uma aplicao Web Tradicional ....................................................................... 30 6.3. Gerando uma aplicao Web Mobile ............................................................................ 33
iii
iv
Guia do usurio
Apresentamos o guia do usurio do Demoiselle Nimble, que uma ferramenta de apoio ao Desenvolvimento do Demoiselle Framework a partir da verso 2.0.
Importante
O Demoiselle Nimble est disponvel para o usurio final nas seguintes opes:
vi
1.1. O que
O Demoiselle Nimble um processador automatizado de templates , sendo estes genricos e podendo inclusive ser criados pelo prprio utilizador. Podemos consider-lo como uma evoluo da ferramenta atual o Demoiselle Wizard Eclipse Plugin [http:// demoiselle.sourceforge.net/wizard/] que como o prprio nome j diz um especificamente um plugin para a IDE Eclipse
1
Nota
Um processador de templates (i.e., template processor, tambm conhecido como template engine ou template parser) um software ou um componente de software projetado para combinar um ou mais templates com um modelo de dados a fim de produzir um ou mais documentos resultantes, podendo estes serem pginas web, arquivos de texto ou cdigos fontes.
No caso especfico do Demoiselle Nimble, no template so definidas estruturas de arquivos e scripts de transformao utilizando linguagens como Velocity e Groovy. Uma vez iniciado o processamento, este faz uso de variveis cujos valores foram definidos pelo usurio e que permitem com que os diretrios e arquivos resultantes possam ser dinamicamente criados e ou modificados.
Framework verso 2.x com JSF e JPA (usa internamente um arqutipo Maven da verso mais recente do
Para informaes gerais sobre utilitrios processadores de template, acesse o site http://en.wikipedia.org/wiki/ Template_processor
Demoiselle v2 Generate JSF2 (PrimeFaces 3) CRUD: cria todos os artefatos necessrios para o CRUD (Create, Read, Update and Delete) de uma dada entidade baseando-se no Demoiselle Framework verso 2.x, e utilizando a biblioteca JSF2 PrimeFaces verso 3.x Demoiselle v2 Generate Vaadin CRUD: cria os artefatos para o CRUD de uma entidade na extenso Demoiselle Vaadin (com Demoiselle Framework verso 2.x)
Instalao
Orientaes de instalao e configurao para o modo Desktop Atualmente h dois modos para fazer a instalao do Demoiselle Nimble, que so:
Nota
Recomendamos utilizar a soluo Demoiselle Infra, que ir resolver as outras questes de ambiente de desenvolvimento para o Demoiselle
Exemplo SO LINUX.
export JAVA_HOME=/usr/lib/jvm/java-6-openjdk/
Exemplo SO ms-windows.
Captulo 2. Instalao
Para ms-windows, o indicado abrir as configuraes de ambiente (Icone Meu Computador) e incluir uma nova varivel de ambiente.
Nota
Recomenda-se utilizar a verso 1.5 ou superior da JDK. Porm se seu objetivo utilizar a verso 2.0 do Demoiselle a verso mnima recomendada a 1.6
Para utilizar alguns dos templates de criao de aplicaes (create-app-*), tambm preciso ter instalado e configurado o APACHE MAVEN [http://maven.apache.org] No ambiente LINUX Ubuntu/Debian o pacote Demoiselle Infra tambm j fornece um pacote para esta ferramenta:
Exemplo SO LINUX.
Exemplo SO ms-windows.
Guia Rpido
Guia de uso para o modo Desktop Aps a instalao e configurao do Demoiselle Nimble no ambiente Desktop (Linux ou ms-windows) a ferramenta estar pronta para execuo. As formas de execuo esto dividas em 2(dois) modos:
demoiselle -g
Para usurios do ms-windows acostumados a usar o windows Explorer para encontrar os arquivos instalados no computador, basta tambm procurar o arquivo demoiselle.bat localizado na pasta /bin do diretrio onde foi "instalado" o Demoiselle Nimble. Ao acionar este arquivo desta maneira o "defaul" a interface grfica.
Interface Grfica do Demoiselle Nimble. Tela Principal Nesta tela Inicial h o boto Browse... que permite que seja selecionado o diretrio onde esto os Templates a serem executados. Com a instalao do Demoiselle Nimble o diretrio /templates criado com os "defaults" disponibilizados pelo Demoiselle. Lembrando que tambm possvel serem criados novos. Nesta tela, alm da possibilidade de escolha dos diretrios de templates, deve ser selecionado o Template que deseja executar. E clicar no boto Next > para prossegir a execuo. As funes dos demais botes, na parte inferior da tela, so:
Next >: Segue para a ao seguinte (prxima tela) Cancel: Cancela a operao e fecha a interface grfica. Finish Aciona a execuo do Template. S habilitado quando todas as variveis (informaes) necessrias foram completadas Para os Templates fornecidos pelo Demoiselle, conforme forem escolhidos na tela principal, sero apresentadas as seguintes telas:
Tela dos Templates de Criao de Aplicao As informaes solicitadas nas telas so as mesmas para criao de aplicaes JSF com Demoiselle v1, JSF com Demoiselle v2 e Vaadin com Demoiselle v2, pois o Template faz somente a chamada ao Maven e aciona o arqutipo Demoiselle j disponvel no repositrio no SourceForge Sendo elas: 1.Output Folder: Informar ou selecionar (usando boto "Browse...") em qual diretrio deseja que o projeto seja criado. A dica aqui usar o diretrio do workspace, se deseja usar o Eclipse como IDE de Desenvolvimento 2.Package Name: Informar o nome do pacote JAVA padro da sua aplicao (ex: br.org.frameworkdemoiselle.) 3.Project Name: O nome da aplicao/Projeto a ser criada. 4.Version O nmero da verso inicial.
3.1.2. Templates de Gerao de CRUD para JSF e VAADIN com Demoiselle v2.x
Um CRUD acrnimo de Create, Retrieve, Update e Delete em lngua Inglesa, so as operaes bsicas relacionadas ao uso de bancos de dados em aplicaes, assim nestes Templates, os produtos gerados so as classes para implementao destas operaes, e tambm todos os artefatos de configurao e interface (pginas XHTML).
Tela dos Templates de Gerao de CRUD para Aplicaes JSF e VAADIN com Demoiselle v2.x So estas as informaes necessrias para o processamento destes templates
1.Output Folder: Informar ou selecionar (usando boto "Browse...") em qual diretrio deseja que o projeto seja criado. A dica aqui usar o diretrio do workspace, se deseja usar o Eclipse como IDE de Desenvolvimento 2.Package Name: Informar o nome do pacote JAVA padro da sua aplicao (ex: br.org.frameworkdemoiselle.) 3.Entity Name: O nome da Entidade para qual ser gerado o CRUD
Tela do Templates de Gerao de CRUD para Aplicaes JSF com Demoiselle v1.x So estas as informaes necessrias para o processamento deste template 1.Output Folder: Informar ou selecionar (usando boto "Browse...") em qual diretrio deseja que o projeto seja criado. A dica aqui usar o diretrio do workspace, se deseja usar o Eclipse como IDE de Desenvolvimento 2.Package Name: Informar o nome do pacote JAVA padro da sua aplicao (ex: br.org.frameworkdemoiselle.) 3.Entity Name: O nome da Entidade para qual ser gerado o CRUD 4.Use CRUD component: Esta opo deve ser marcada quando a aplicao alvo utiliza o componente DemoiselleCRUD.
demoiselle create-app-jsf
demoiselle <<Nome do Template>> <<Parmetros>> Exemplo
-o
/temp/
-o
/temp/
Embora os usurio de sistemas operacionais MS-windows no costumem utilizar terminais de linhas de comandos, o Demoiselle-Nimble tambm oferece este opo. Atualmente com algumas diferenas no uso, por ser a primeira verso do script (.bat) Novamente, preciso que tenham sido configuradas corretamente as variveis de ambiente, e abrir um "Prompt de Comando" para que as seguintes operaes possam ser executadas:
-o
c:\temp
-v
10
4.1. Instalao
Aqui, lembramos novamente que para usurios LINUX/DEBIAN existe o projeto Infra http:// demoiselle.sourceforge.net/infra/ que facilita a instalao das ferramentas que o Demoiselle recomenda para uso em seu desenvolvimento. Usando o pacote mais atual no necessrio fazer a instalao. Neste caso s seguir para o item: Seo 4.2, Instrues de Uso
11
Eclipse Marketplace No prximo passo, digete a palavra Demoiselle no campo de busca e clique no boto GO Aps carregado o resultado da pesquisa localize o item Demoiselle Nimble Eclipse Plugin e clique no boto Install
12
Localizando Demoiselle Nimble no Eclipse Marketplace Na tela seguinte, verifique se os itens esto selecionados e clique no boto Next >
Selecionando o plugin Na tela seguinte, preciso aceitar a licena, clicar no boto Finish
13
Aceitando a licena Durante este processo, a tela abaixo pode ser apresentada, apenas um aviso sobre a assinatura da bibliteca , basta clicar no boto OK
14
Imagem da Tela de instalao de Plugins para Eclipse Clique no boto Add... para incluir um novo repositrio, conforme a figura abaixo
15
Nesta tela preecha as seguintes informaes: Name:Demoiselle Nimble Location:http://demoiselle.sourceforge.net/nimble/updatesite Voltando tela anterior, que dever ser atualizada assim:
Imagem da Tela de instalao de Plugins para Eclipse, com novo repositrio No quadro onde aparecem as opes Name e Version Procure e marque a verso mais atual.Em seguida clique no boto Next >
16
Instrues de Uso
Imagem da Tela de detalhes da instalao do Plugin Se no houver erros ou avisos, clique no boto Next > Na ltima tela marque a opo de aceite da licena e clique no boto Finish
Imagem da Tela de aceite da licena Aguarde a instalao e reinicie o Eclipse, conforme ser sugerido pelo prprio
Icone do Demoiselle Nimble na barra de ferramentas Para saber mais sobre o uso com eclipse veja Captulo 6, Exemplo usando Eclipse IDE
17
18
5.1. Instalao
Os pr-requisitos para o uso da Plugin so os mesmos para o Modo Desktop alm claro da IDE NetBeans instalada (Testada com v 7.0) Baixe o arquivo de instalao do pluguin do endereo: http://demoiselle.sourceforge.net/nimble/netbeans/br-govframeworkdemoiselle-tools-nimble-netbeans.nbm No ambiente de desenvolvimento do NetBeans acione o menu Ferramentas Plugins A tela seguinte dever ser apresentada
Tela de instalao de Plugins para NetBeans Selecione a aba Baixados e clique no boto Adicionar Plug-ins... para incluir um novo repositrio, conforme a figura abaixo Na tela abaixo selecione o arquivobr-gov-frameworkdemoiselle-tools-nimble-netbeans.nbm no diretrio onde foi baixado o Plugin
19
Tela para incluso de novo repositrio de plugin Voltando tela anterior, que dever ser atualizada assim:
Tela de instalao de Plugins para NetBeans, com novo plugin No quadro onde aparecem as colunas Instalar e Nome Marque a coluna Instalar.Em seguida clique no boto com o mesmo nome Instalar no canto inferior esquerdo da tela
20
Instalao
Imagem da Tela de detalhes da instalao do Plugin Se no houver erros ou avisos, clique no boto Prximo > Na prxima tela marque a opo de aceite da licena e clique no boto Instalar
21
22
Instrues de Uso
23
24
6.1. Prepararao
Antes de iniciar o uso do Demoiselle-Nimble, vamos criar um projeto usando um arqutipo do Demoiselle. Selecione o projeto e veja onde esto os acionadores do Plugin Demoiselle Nimble Um cone na barra de ferramentas:
Sub-item Demoiselle Nimble Acione o Demoiselle-Nimble atravs dos atalhos acima, aps alguns segundos a tela seguinte dever ser apresentada:
25
Criando uma aplicao Maven com Demoiselle Nimble Selecione a opo: Demoiselle V2 Create JSF Application, e clique no boto Next >
Criando uma aplicao JSF com Demoiselle Nimble Nesta tela, na opo: 1. Output Folder, no Eclipse estar selecionado o Workspace atual, caso contrrio utilize o boto Browse... para encontrar o diretrio correto Informe as seguintes informaes nos campos seguintes: 2. Package Name: br.org.frameworkdemoiselle 3. Project Name: testeV2 4. Version: 1.0.0 Em seguinda clique no boto Finish e aguarde que o processo seja concludo pelo Eclipse. Verifique o arquivo /src/main/resources/persistence.xml e remova os comentrios para escolher a estratgia de transao. Conforme mostrado abaixo:
<?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"> <!-- If you are using JBoss AS7 with non JTA transaction then use this persistence-unit --> <!---> <persistence-unit name="testeV2-ds" transaction-type="RESOURCE_LOCAL"> <non-jta-data-source>java:jboss/datasources/ExampleDS</non-jta-data-source> <properties> <property name="hibernate.show_sql" value="true" /> <property name="hibernate.format_sql" value="false" /> <property name="hibernate.hbm2ddl.auto" value="create-drop" /> </properties> </persistence-unit> </persistence>
26
Prepararao
No arquivo /src/main/resources/messages.properties, encontre e muda a propriedade: main.app.title=TesteV2 O passo seguinte identificar o Projeto no Eclipse como um projeto Maven, para isso selecione o projeto recmcriado e clique com o boto direito do mouse para acionar o menu e selecione as opes Configure -> Convert to Maven Project
Configurando aplicao Maven no Eclipse Aps criado o projeto, vamos localizar o pacote Domian conforme a figura abaixo:
27
Localizando o pacote das classes de domnio Crie neste pacote uma classe chamada Pessoa, conforme o cdigo abaixo
@MappedSuperclass public abstract class Pessoa { @Id @GeneratedValue private Long id; @Column private Long cpf; @Column(nullable=false, private String nome; length=255)
28
Prepararao
public void setId(Long id) { this.id = id; } public Long getId() { return id; } public void setNome(String nome) { this.nome = nome; } public String getNome() { return nome; } public void setCpf(Long cpf) { this.cpf = cpf; } public Long getCpf() { return cpf; } public void setDataNascimento(Date dataNascimento) { this.dataNascimento = dataNascimento; } public Date getDataNascimento() { return dataNascimento; } }
import java.io.Serializable; import java.util.Date; import javax.persistence.Column; import import import import javax.persistence.Entity; javax.persistence.Table; javax.persistence.Temporal; javax.persistence.TemporalType;
@Entity @Table(name="Estudante") public class Estudante extends Pessoa implements Serializable { /** * */ private static final long serialVersionUID = 1L; @Column(nullable=false) @Temporal(value=TemporalType.DATE) private Date dataMatricula; @Column private int numeroMatricula; public Date getDataMatricula() { return dataMatricula; }
29
public void setDataMatricula(Date dataMatricula) { this.dataMatricula = dataMatricula; } public int getNumeroMatricula() { return numeroMatricula; } public void setNumeroMatricula(int numeroMatricula) { this.numeroMatricula = numeroMatricula; } }
Isso tudo que precisamos criar manualmente para comear o uso do Demoiselle-Nimble.
Sub-item Demoiselle Nimble Com o projeto selecionado, use uma das opes acima para acionar a interface do Demoiselle Nimble, onde selecionaremos o Template para gerao de um CRUD (Create, Read, Update e Delete) que so as operaes bsicas de criar, ler, atualizar e apagar Selecione o Template adequado ao arqutipo que foi criado, neste exemplo optamos pelo Primefaces 3, que compatvel com a verso 2.2.2 (ou superior) do Demoiselle conforme a figura abaixo:
30
Escolhendo o template de CRUD Na tela seguinte, devero ser informados os parmetros para gerao dos artefatos 1. Output Folder*: Use o boto Browse... para selecionar o projeto dentro do diretrio de Workspace do Eclipse 2. Entity Name*: Use o boto Click to select an entity class file... e procure no diretrio (/src/main/java/br/org/ frameworkdemoiselle/domain/) a classe Estudante 3. Package Name*: Ser preenchido automticamente com br.org.frameworkdemoiselle
Informando os parmetros para criao dos artefatos Aguarde o processamento at que a tela de confirmao aparecea
31
Processamento do Template OK Confira os artefatos que foram gerados nos pacotes de negcio(business), persistncia (persistence) e de viso (view) Na pasta /src/main/webapp tambm devero ser geradas as pginas XHTML de edio e listagem
Listagem dos artefatos criados Veja tambm nos arquivos: persistence.xml, messages.properties e menu.xhml, que novas informaes foram includas. Para testar as funcionalidade criadas, adicione o projeto no servidor JBoss e inicie o mesmo. No exemplo a aplicao estar em http://localhost:8080/testeV2
32
Escolhendo o template de CRUD para Mobile Na tela seguinte, devero ser informados os parmetros para gerao dos artefatos 1. Output Folder*: Use o boto Browse... para selecionar o projeto dentro do diretrio de Workspace do Eclipse 2. Entity Name*: Use o boto Click to select an entity class file... e procure no diretrio (/src/main/java/br/org/ frameworkdemoiselle/domain/) a classe Estudante
33
Cuidado
Os procedimentos seguintes devem ser observados atentamente
Ao clicar no boto Finish da tela anterior, algumas mensagens sero apresentadadas A primeira ser perguntando sobre o arquivo index.html, como estamos gerando uma aplicao Mobile o template poder sobrepor esse arquivo para implementar uma forma bem simplificada de identificar qual tipo de dispositivo est acessando a aplicao. Neste caso s uma forma de gerar um exemplo, mas caso sua aplicao possua uma forma mais elaborada, basta responder negativamente (clique no boto:No ) ao pedido de sobrescrio mostrado na pgina abaixo, no caso deste exemplo vamos permitir que sobrescreva clicando no boto: Yes
Sobrescrevendo o arquivo index.html Neste exemplo, a sequncia mostrar uma tela que pergunta para sobrescrever as classes java de Persistncia (DAO), Negcio (BC) e Viso(MB). Pois j havamos criado essas classes no item anterior, caso esteja gerando apenas para mobile essa pergunta no aparecer e as classes sero criadas. Note que so exatamente as mesmas pois a nica diferena justamente a parte de viso que so as pginas. No nosso caso, vamos ignorar isso clicando no boto No to All
34
Sobrescrevendo as classes java Ao final ser apresentada a tela informando que o processamento foi executado
Processamento do Template OK Com isso poderemos conferir no diretrio /src/main/webapp/ os artefatos que foram criados:
Artefatos para web-mobile criados. Alm o novo arquivo index.html, tambm podemos verificar que foi criado o arquivo mobile.html. E um novo diretrio (/mobile) tambm foi includo e conter todas pginas para a interface mobile. Antes de testarmos a aplicao vamos vericar o arquivo POM.XML para certificarmos se est correto. Clique no arquivo e selecione a aba Dependecy Hierachy Veja se h a dependncia para o Primefaces-Mobile importante verificar tambm a verso do Primefaces que deve ser no mnimo a 3.4
35
Viso de Dependency Hierarchy no POM.XML Com isso a aplicao j est pronta para ser testada. Republique novamente no servidor de aplicaes e inicie o servidor. Obviamente no haver nenhuma diferena ao acessar do navegador (browser) web do seu computador, o ideal publicar na internet e para isso h alguns servios em nuvem que fornecem ambiente gratuto e compatvel com o Demoiselle como o Openshift [http://openshift.redhat.com/] da RedHat. E depois testar em um tablet ou celular com navegador web. Uma estratgia que adotamos foi usar o software VirtualBox [https://www.virtualbox.org/] e criar uma mquina virtual com Android [https://www.buildroid.org/] Acessando de um navegador em dispositivo mvel a intefaces ser assim:
36
Tela de listagem
37
Tela de Edio
38