com jcompany Extensions Capítulo Expandindo o Poder do jcompany Developer Suite - Entendendo as melhores práticas de customização

Transcrição

1 A6Extensões Arquiteturais cm jcmpany Extensins Capítul 21 Expandind Pder d jcmpany Develper Suite - Entendend as melhres práticas de custmizaçã Exercitams em váris capítuls as pssibilidades de extensã d jcmpany FS Framewrk através de herança, especialmente através d DP Template Methd nas camadas de cntrle (*Actin) e mdel (*Manager u *BO). Além diss, vims que jcmpany também traz uma arquitetura rica e extensível na camada visã, seja de "cliente" (Javascript, Ajax, CSS, HTML), seja de se rvidr (XHTML/Facelets, JSF). Mas em tdas as práticas que simulams até agra estávams precupads em slucinar um prblema de negóci específic, em nível de um Cas de Us. N mund real, muitas regras de negóci e custmizações em geral terã utilidade para além deste escp, para cert númer de cass de us u mesm para tds eles! Para cada um destes cenáris, um cnjunt diferente de Design Patterns mais aprpriads deve ser utilizad. Vejams quais s principais cenáris de demanda pr prgramaçã candidata a reús - e respectivs padrões de implementaçã recmendads: 1. Prblema Específic de um Cas de Us: Se nã há uma perspectiva visível de demanda pela reutilizaçã de uma determinada implementaçã especializada, para além d escp de um Cas de Us, a melhr abrdagem (mais prdutiva, fácil de entender e evluir) é utilizar s DP Template Methds cnfrme abrdams até aqui, nas práticas deste livr. 2. Prblema Mais Genéric, de Reus Ptencial em um subcnjunt de Cass de Us de uma aplicaçã: Quand percebems que uma especializaçã pssui artefats de implementaçã de interesse em uma categria de cass de us (mais de um) dentr de uma mesma aplicaçã, a melhr abrdagem ainda é a utilizaçã d DP Template Methd, prém cm us cmplementar d DP Delegatin (Delegaçã). Este últim Design Pattern cnsiste em basicamente se mver as implementações de classes "pivôs" (cntrladras u rquestradras) para POJOs externs, que passam a ser chamads pelas primeiras. Estes POJOs encapsulam segment reutilizável d códig de custmizaçã e pdem ser reutilizads de maneira elegante, via Injeçã de Dependência simples d CDI, a partir das utras classes cntrladras (de utrs cass de us). 3. Prblema Mais Genéric, de Reus Ptencial em Um Sub-Cnjunt de Cass de Us de Aplicações Distintas: Quand percebems que uma extensã u custmizaçã será útil para uma determinada categria de Cass de Us, além das frnteiras da própria aplicaçã (pr exempl, n cas de um nv padrã de Cas de Us própri da rganizaçã, basead em variações ds padrões d jcmpany), entã passa a ser recmendável cnsiderar-se DP Observer cm alternativa a DP Template Methd/Delegatin. O jcmpany utiliza este DP cm base na implementaçã recmendada pel nv padrã CDI (Cntext Dependency Injectin), cnfrme será fc deste capítul. 4. Prblema Bastante Genéric, para Tda a Crpraçã u Prtfóli de Aplicações: Quand percebems que uma mdificaçã será demandada em nível crprativ u mesm pr um cnjunt inteir de aplicações cm características similares (ex: aplicativs de e -Cmmerce u de B2B u administrativs), entã a recmendaçã vlta a ser us d DP Template Methd! Prém, neste cas cm us d DP Bridge. Nesta arquitetura, a empresa dispnibiliza estas especializações de us geral em suas próprias camadas (layers) arquiteturais, que vã embaladas em tdas as suas aplicações (u ns prtfólis indicads), de md a garantir que sejam usadas.

2 Capítul 21 Cnfrme citad, neste capítul irems discutir a nva pssibilidade descrita n item três, uma vez que smente fi incrprada a partir d suprte a padrã CDI, iniciad nas versões 5.5.x e aprimrad n ram 6.0.x. - jcmpany Extensin = jcmpany Plugin (OO) + Eclipse Plugin (Geraçã de Códig) Quant mais uma empresa amadurece na cmpreensã da arquitetura d jcmpany Develper Suite, mais ela especializa. Apesar ds padrões "prnts para us" cm fram demnstrads ns primeirs móduls deste livr, cm a expansã d us espera-se de um arquitet crprativ que identifique grandes prtunidades de derivaçã ds padrões existentes, seja para adequá-ls a uma nva expectativa de seus usuáris, seja para expandir sua pssibilidade de aplicaçã em utrs cenáris - que, a final, resulta em aument d índice de reus e, em última análise, da prdutividade. Os maires benefícis d nv mecanism "jcmpany Extensin" sã vltads para Arquitet de Sftware. Cm este nv recurs, ele pde nã smente criar nvs padrões cm base em técnicas de Orientaçã a Objets cm também cmplementá-ls cm geradres de artefats (sejam eles Java, XHTML, Prperties u utrs frmats), para a parte "nã generalizável" d padrã. Prtant, um "jcmpany Extensin" cmplet agrupa, em um únic prjet Eclipse: Mecanism OO: Classes POJO genéricas, atuand em diversas camadas MVC2-P, que intrduzem códig de especializaçã (u sbrepõem s existentes) através de interceptações n padrã CDI (DP Observer) definids em pnts chave d jcmpany FS Framewrk - s mesms pnts chaves utilizads ns Template Methds, prém sem us de herança! Mecanism de Geraçã de Códig: N mesm prjet Eclipse pde-se cnstruir uma sluçã de geraçã de códig cmplementar, que se trna imediatamente dispnível n Eclipse. E iss, apenas via declarações em um XML e cnfecçã de templates de arquivs em frmats diverss, sem a necessidade de implementar nvs plugins d Eclipse! - Bridge x Extensin Mas pr que nã implementams estes nvs padrões via DP Template Methds e s d ispnibilizams na camada Bridge, pr exempl? A experiência em instalações mais avançadas demnstra que, muit embra a Bridge seja uma sluçã bastante útil para prver um espaç para custmizações "glbais" (u, a mens, úteis para um prtfóli inteir de aplicações), ela cmeça a ferecer limitações quand um mair númer de padrões "pcinais" cmeça a ser incrprad em seu nível. Os prjets que frmam a Bridge sã um "espaç arquitetural" ideal para: regras de segurança, lgging/auditria, custmizações de "webdesign crprativ" (lg, tps de impressã, cres, etc.), custmizações glbais de mensagens, etc.. Ou seja, para implementações crprativas u de grande amplitude de reús. Aprveitar este mesm espaç para catalgar padrões pcinais, digams que sejam úteis em três u quatr cass de us distints de uma u utra aplicaçã - pde levar a uma rápida deteriraçã da estabilidade desta camada. Iss se nta através de cnflits entre diferentes padrões "cmpetind" pels mesms "extentins pints", pr exempl, nde evluções em um padrã A acabam instabilizand um padrã B existente e já estável. A final, pde-se sfrer cm perda de cesã, trnand-se difícil identificar e manter cada padrã individualmente. Pr tud iss e pelas facilidades adicinais de geraçã de códig é que precnizams us d nv DP Observer via jcmpany Extensin, para a categria três d tópic anterir. Criand um jcmpany Extensin - Identificand uma demanda para us de "Extensin": Imprtaçã de Objets Simples Supnhams que nss negóci necessite imprtar muits arquivs pequens (tabelas de códigs diversas) e desejams, cm arquitets, prver uma variaçã d padrã "Manter Classe" que garanta para a empresa uma implementaçã mais rápida e hmgênea para estes cass. Obs.: Uma fábrica de sftware também pde querer expandir suas pssibilidades cm nvs padrões deste tip, que pssam inclusive ser reutilizads "de um cliente para utr".

3 Extensões Arquiteturais cm jcmpany Extensins N nv padrã prpst, além de um nv btã de imprtaçã e um métd de cntrle padrã (dispnível para que desenvlvedr implemente a imprtaçã em si*), querems impedir que usuári exclua u inclua nvs itens. Ele pderá, n entant, alterar as descrições ds itens imprtads. Se este fsse um prblema pntual, específic de um Cas de Us, entã reslveríams cm citams na intrduçã deste capítul, cm DP Template Methd e especializações de camada visã. Prém, se cm Arquitets de Sftware julgarms "arquiteturalmente significante" (haverá um vlume mair de cass e há uma ba parcela repetitiva e nersa de cdificaçã similar), melhr encaminhament é generalizar parcialmente uma sluçã na frma de um nv padrã, para maximizar ganh de escala. Vams entã iniciar a criaçã deste nv padrã, cm nss primeir "jcmpany Extensin": 1. N Eclipse, acine menu "File -> New Prject -> Pwerlgic Jaguar Cde Generatr", e em seguida "Criar nv módul Jaguar Extensin". Cnfrme a Figura G21.1. Figura G21.1. Assistente para criaçã de um nv "jcmpany Extensin" 2. Preencha próxim frmulári cnfrme a Figura G21.2. Nte que nme dad a nv padrã é "plx_imprtaca". * P erc eba que nss fc aqui é em reus d arc abuç M VC2-P, rganizaçã de c lasses e artefats, etc. - e nã em generalizar algritm de imprtaç ã em s i!

4 Capítul 21 Figura G21.2. Frmulári de criaçã de um nv "jcmpany Extensin". #1. Nme d nv prjet de extensã, cnfrme dit anterirmente nss padrã chamará "plx_imprtaca". Nte que prefix "plx" separad pr um underline indica que prjet é um Extensin. #2. Diretóri em que a aplicaçã será salva. Cas checkbx "Use default" esteja marcad ela será enviada para wrkspace d eclipse. #3. Nme d pacte base d prjet. Usarems padrã já citad n livr, uma vez que ele garante a especificidade d prjet. #4. Arquiv de template para prjet de extensã jcmpany. Selecine arquiv padrã "jcmpany_ini_extensin.zip" encntrad na pasta "meus prjets" d Eclipse u arquiv persnalizad criad para sua empresa. #5. Sigla d módul de extensã, usarems "Imp". Esta sigla é usada em algumas cnfigurações que verems mais a frente. #6. Caminh da aplicaçã raiz. Usarems a aplicaçã "rhtutrial". 3. Agra prjet de extensã esta prnt, cnfira a geraçã na Figura G21.3. Figura G21.3. Pasta raiz d jcmpany Extensin "plx_imprtaca". - Entendend um prjet jcmpany Extensin Nte que um prjet jcmpany Extensin englba pactes para tdas as camadas MVC2-P em um únic prjet Eclipse, evitand assim a prliferaçã desnecessária de estruturas neste nível, até prque um padrã tende a nã pssuir quantidades massivas de classes u artefats. Cm iss, cnsegue-se uma cesã e simplicidade imprtantes para a reutilizaçã, u seja: "um prjet Eclipse = um padrã", encapsuland generalizações OO e também geraçã de códig suplementar!. Se algum Arquitet de Sftware percebeu neste mecanism uma grande prtunidade de catalgar padrões de md simples e cmpreensiv, parabéns! É iss mesm que jcmpany Extensin pssibilita.

5 Extensões Arquiteturais cm jcmpany Extensins Vams entender agra, cm um puc mais de detalhes, a estrutura interna de um prjet jcmpany Extensin. A Figura G21.4 mstra s diretóris criads. Figura G21.4. Diretóris padrões gerads para prjet jcmpany Extensin "plx_imprtaca" #1. Diretóri que deve cnter códig fnte (Java) d prjet jcmpany Extensin "plx_imprtaca". #2. Diretóri padrã META-INF para JARs. Os arquivs deste diretóri sã interpretads pel plugin "Geradr Dinâmic" pssibilitand funcinament ds assistentes de geraçã de códig integrads a prjet jcmpany Extensin "plx_imprtaca". #3. Pasta cm tda a bibliteca nativa d JRE. #4. Pasta que cntém s arquivs de dependência d Maven. #5. Pasta padrã de arquivs templates (também para a geraçã de códig). #6. Pasta cm tds s arquivs target (tempráris) gerads pel Maven. #7. Prjets de extensã também sã gerenciads pel Maven, bviamente, prtant pssuem seu própri arquiv "pm.xml". Prvend generalizações OO para um jcmpany Extensin - Custmizand s cmprtaments de cntrle via DP Observer Agra que entendems a hierarquia d prjet plx_imprtaca, criarems s artefats que mdificam cmprtament da aplicaçã, adequand-s a nss bjetiv. Iniciarems cm a criaçã das classes que implementam s "Observers" e sã, prtant, respnsáveis pr especializar cmprtament da aplicaçã. Lembrand que fi dit na intrduçã, nss bjetiv será criar um nv padrã cm base em variaçã d padrã "Manter Classe" que cnsistirá basicamente em: Prver um nv btã padrã para acinar a imprtaçã de arquiv e um métd de cntrle padrã para a implementaçã da imprtaçã em si (futuramente, própri algritm de imprtaçã pderia ser também generalizad nesta extensã). Também querems impedir que usuári exclua u inclua nvs itens. Ele pderá, n entant, alterar as descrições ds itens imprtads. Para implementar a demanda acima será necessári criar duas classes, descritas abaix:

6 Capítul 21 pac kage c m.empresa.rhtutrial.plx_imprtaca.c ntrle.jsf; public c lass E mpimprtacaactinobserver { PlcMetamdelUtil metamdelutil; /* * M étd respnsavel pr c ultar bta F7 -Nv e c hec k-bx de exclusã*/ public vid P lcbasejsfactin ac tin) thrws P lcexceptin { P lccnfigimprtaca c nfigtabular = E mpimprtacahelper.getinstance().getc nfigtabularcnsulta(); if (c nfigt abular! = null) { if (c nfigt abular.ehcnsultatabular()) { P lccntextutil c ntextutil = P lc CDIUtil.getInstance().getI ns tancebytype(plccntextutil.class,qplcdefaultliteral.instance); H ttpservletrequest request = c ntextutil.getrequest(); getservicevisaplc().naexibir(cntexthelperplc.getrequest(), P lc Cnstantes.ACAO.E XIBE_BT_INCLUIR); ac tin.getvisajsfutil().naexibircmcrrelats("indexcplc"); /* * M etd respnsavel pr des abilitar a func a d F7 -Nv* / public vid tabularnvantes(@o P lcbasejsfactin ac tin) thrws P lc Exceptin { P lccnfigimprtaca c nfigtabular = E mpimprtacahelper.getinstance().getc nfigtabularcnsulta(); if (c nfigt abular! = null) { if (c nfigt abular.ehcnsultatabular()) { ac tin.s etcntinuaflux(false); els e { ac tin.s etcntinuaflux(true); els e { ac tin.s etcntinuaflux(true); /* * M etd respnsavel pr impedir que nvs registrs s ejam ins erids.* / public vid PlcBaseJsfActin actin) thrws P lc Exceptin { P lccnfigimprtaca c nfigtabular = E mpimprtacahelper.getinstance().getc nfigtabularcnsulta(); if (ins tance.getid() == null && StringU tils.isblank(instance.getidaux())) { itens P lc.remve(i); els e { ins tanc e.s etindexcplc(false); ins tanc e.s etindexcplc("n"); Códig G21.1. Classe "EmpimprtacaActinObserver.java". Nv metadad: A classe "PlcCnfigimprtaca.java" é um metadad que nã smente define a ativaçã d nv padrã cm também permite que se parametrize a funcinalidade de inserir e excluir registrs, através da prpriedade encapsulada ehcnsultamanterclasse (iss trna

7 Extensões Arquiteturais cm jcmpany Extensins pssível, pr exempl, reus deste padrã cas desenvlvedr precise destas perações). A classe pde ser vista n pac kage c lcmetacnfig(raiz = true, es c p = E s cp.app, c amada = C lcmetaeditr(rtul = "C nsulta M anterclasse", des crica = "C nfigurações c mplementares para M anterclasse Smente C nsulta") // C nfigurações glbais de definiç ã de lgica manterclasse s mente c nsulta P lccnfigplx_imprtaca { blean ehc nsultamanterclasse(); Códig G21.2: pac kage c lcmetacnfig(raiz = true, es c p = E s cp.app, c amada = C lcmetaeditr(rtul = "C nsulta M anterclasse", des crica = "C nfigurações c mplementares para M anterclasse Smente C nsulta") // C nfigurações glbais de definiç ã de lgica manterclasse s mente c nsulta P lccnfigplx_imprtaca { blean ehc nsultamanterclasse(); Códig G21.2. Classe "PlcCnf igimprtaca.java". Cm a implementaçã da classe "Observer" e métds de extensã declarads, cria -se um "pnt de crte" n flux de execuçã padrã d jcmpany, de md que a implementaçã d Extensin sempre será executada. Nte que é teste d metadad "PlcCnfigimprtaca" que impedirá que a extensã crra genericamente, para tds s padrões d jcmpany! Neste pnt, para utilizar nv padrã manualmente desenvlvedr pderia partir da geraçã de um Cas de Us Padrã "Manter Classe" e realizar pequens ajustes adicinais para acinar e bter resultad prpst pel nv padrã. Basicamente, ele iria declarar n arquiv "package-inf.java" da camada de cntrle a nva antaçã de metadad e incluiria nv btã JSF para imprtaçã n XHTML aprpriad. É um padrã que, prtant, pderia ser dispnibilizad imediatamente, apenas cm alguma dcumentaçã adicinal em Javadc e pssivelmente em algum dcument padrã da empresa (em algum sistema de gestã de reus u de ativs de sftware). Esta dcumentaçã traria a rientaçã de us de nss nv padrã, partind da geraçã de um Cas de Us padrã "Manter Classe". Prvend geradres de artefats para um jcmpany Extensin - Apiand a sluçã OO cm geraçã de artefats Se estivéssems na situaçã de liberar exatamente padrã que usams para ilustrar neste capítul, pssivelmente pararíams na seçã anterir, pis sua btençã a partir de um padrã "próxim" é muit simples.

8 Capítul 21 Prém, pdem existir padrões bastante distints de algum existente n jcmpany e/u númer de intervenções extras pde também ser bem mair d que n cas que ilustrams. Se iss crrer, as falhas ptenciais durante reús aumentam bastante. Nestes cass, para melhrar nssas chances de reús bem sucedid pr parte ds desenvlvedres, pdems suplementar as técnicas OO que utilizams até aqui cm técnicas de geraçã de artefats, também previstas n mecanism d jcmpany Extensin. Imprtante: nã gstams de usar term "geradr de códig" prque, em nssa estratégia, nã estams gerand "códig java", que pr ser generalizável é melhr tratad via OO. Cm gerams artefats "nã Java", nã generalizáveis, utilizams term "geradr de artefats". Perceba que a uniã das duas técnicas em uma sluçã de mais alt nível é bem a frma cm que própri jcmpany trabalha. Pde parecer mens imprtante, mas a geraçã de artefats assistida e integrada a uma sluçã OO acelera aprendizad e diminui errs ns reúss iniciais. - Definind um nv assistente de geraçã de códig Para segment da sluçã que envlve a geraçã de artefats, uma primeira sluçã pssível seria a criaçã de plugins d Eclipse similares as d jcmpany. Iss envlveria a necessidade de que desenvlvedres Java EE cm fc na Web apreendessem Java Desktp cm SWT, utilizad n Eclipse, além de APIs diversas desta IDE - que pde ser uma "bala de canhã para matar msquit", n dit ppular, se que precisams fr gerar alguns artefats padrões. Para evitar esta curva de aprendizad, jcmpany Extensins traz um mecanism que permite que criems assistentes Eclipse dinâmics e pderss, especializads pa ra geraçã ds artefats típics que utilizams em aplicações Java EE em seus váris frmats. Para tant, ns basearems principalmente na definiçã de um arquiv XML (que serve cm base para definiçã ds passs, frmuláris e camps d assistente dinâmic n Eclipse) e também de arquivs "template" cntend códig Grvy e Velcity para permitir a geraçã de artefats finais em frmat XHTML de páginas, Menu, metadads cm antações padrã Java, ApplicatinResurces, etc.. Cmeçarems criand XML que abrigará as cnfigurações para assistente Eclipse de geraçã d padrã "plx_imprtaca". 1. Cpie arquiv "manterclasse.plx_imprtaca.padra.xml" d diretóri "[jcmpany_base]/jcmpany_dcumentaca/rhtutrial/plx_imprtaca" e salve- n diretóri "plcextensin" d prjet de extensã, cm nme "manterclasse.plx_imprtaca.padra.xml" cnfrme mstrad na Figura G21.5. Figura G21.5. Def iniçã d arquiv de cnf iguraçã de assistente dinâmic.

9 Extensões Arquiteturais cm jcmpany Extensins <! --Declaraçã d s cript - I nfrmaçã c ntend T itul d P adrã, exibid na tela inic ial d wizard - E x.: (M anterclasse - M estre Detalhe - C nsulta)--> <plc -padra titul="cas de U s P adra 'Manter C lasse I mprtaçã' (M anterclasse)"> <! --E xempl de U tilizaçã d P lugin Dinâmic para geraçã de uma lógic a M anterclasse M anter C lasse Smente A lteraçã. N este script, vc ê encntrara exempls de utilizaçã ds cmpnentes d P lugin Dinâmic. - Definiçã de T elas - Definiçã de C amps - I nvcaçã das tarefas para c riaçã u alteraçã ds arquivs.--> <! -- Definiçã d íc ne que s erá exibid na tela inicial --> <padra-imagem> plx_imprtaca/plcextensin/img/cmuns/flder_aberta.gif </padra-imagem> <padra-des crica> Bem-vind a tutrial d jc mpany para C as de U s 'M anter Classe I mprtaçã'. N es te tutrial vcê irá gerar tds s artefats necessáris para realizar manutenç ã em regis trs de menr es cala. V ams c meçar! </padra-descrica> <! -- E s tereótip utilizad internamente pel P lugin Dinâmic. Deve ter nme únic --> <padra-es teretip> M anterclasse_imprtaca </padra-es teretip> <! -- E xempl de definiç ã de c mpnentes da primeira página d geradr c m um c amp String --> <pagina titul="p ágina 1 - Definiçã d C as de U s"> <c amp> <c dig>prjet</c dig> <rtul>p rjet Selecinad: </rtul> <ajuda>digite aqui nme d prjet.</ajuda> <dmini>st RING</dmini> <brigatriedade>true</brigatriedade> <valr-default></valr-default> <s c ript>grvy/cmuns/valresdefault</s cript> </c amp> </pagina> Códig G21.3. Estrutura d arquiv de cnf iguraçã cm explicaçã de segments mais imprtantes..

10 Capítul 21 <! -- E xempl de definiç ã de c mpnentes da s egunda página d ns s geradr c m um c amp String--> <pagina titul="p ágina 2 - Definiçã d E vent E specífic"> <c amp> <c dig>nmee vent</c dig> <rtul>nmee vent Especific</rtul> < ajuda> Digite nme d E vent E specífic (E x.: gravar, imprtar, inic iarsincrnizaca) </ajuda> < dmini>st RING</dmini> < brigatriedade>true</brigatriedade> < valr-default></valr-default> </c amp> </pagina> <! -- E xempl de definiç ã de c mpnentes da terc eira página d ns s geradr c m um c amp Grid --> <pagina titul="p ágina 3 - Definiçã c mpnentes da tela"> <c amp> <c dig>prpriedades</cdig> <rtul>p rpriedades da E ntidade</rtul> <ajuda>p rpriedades da E ntidade</ajuda> <dmini>gri D</dmini> <grid-def> <c amp> <c dig>tip</c dig> <rtul>t ip P rpriedade</rtul> <ajuda>t ip da prpriedade</ajuda> <dmini>c OMBO</dmini> <dminidiscret> <pc a> <rtul>t ext</rtul> <valr>text</valr> </pc a> </dminidis cret> </pagina> <! -- C riaçã de uma página xhtml através da c hamada a uma c las se Grvy. O C rp d xhtml s erá c nteúd d template velcity/extensins/manterclasse/crp-xhtml- M anterclasse.vm. P s sibilita a us uári esclher arquiv de des tin. E xempl de func inament em C riarpagina.grvy--> <ac a> <tip-ac a>grvy/cmuns/plccriarpagina</tip-aca> <template-rigem> /s c ripts/velcity/extensin/manterclasse/c rp-xhtml-manterclasse-alteraca.vm </template-rigem> <diretri-arq-destin> /s rc /main/webapp/web- I NF/fc ls/${subdiretri / $ {c asustab.xhtml </diretri-arq-destin> </ac a> </plc -padra> O arquiv XML criad define um nv "assistente Eclipse" que cleta dads em três passs e utiliza estes dads para gerar tds s artefats necessáris para execuçã d nv padrã. Nesta técnica, cada camp cletad n assistente pde ser referenciad pr arquivs de template para geraçã d resultad final.

11 Extensões Arquiteturais cm jcmpany Extensins Os passs d assistente fram prjetads segund s bjetivs abaix (cnfira s cmentáris n arquiv XML para entender cm cada bjetiv fi atingid): Pass um: assistente pede infrmações elementares para geraçã d Cas de Us, cm nme (identificadr da URL), subdiretóri para armazenar as páginas XHTML geradas, títul d frmulári e classe de entidade principal já devidamente mapeada. Pass dis: cleta de infrmações referentes a btã específic JSF que será criad para imprtaçã, cm nme d event e rótul d Btã, bem cm nme da Actin que abrigará Template Methd para implementaçã d algritm de imprtaçã em si (irems neste cas gerar uma classe Java, mas cm fins arquiteturais, u seja, sem algritm e fcand smente em sua estrutura). Pass três: cleta infrmações sbre frmulári, permitind que usuári persnalize s camps a serem gerads n XHTML própri, e em cnfrmidade cm s dads da entidade principal selecinada n pass um. Para que geradr dinâmic utilize as entradas de dads frnecidas pel usuári e gere artefats dinâmics cm base nelas, é precis cnfigurar as ações n arquiv "manterclasse.plx_imprtaca.padra.xml". Uma açã é a execuçã de um prgrama Grvy, que pderá u nã invcar um template cm instruções Velcity que permite a geraçã refinada de arquivs de váris frmats. A ações mais cmuns, tant em Grvy quant em Velcity já sã dispnibilizadas na criaçã d prjet dentr d diretóri "META- INF/plcextensin/script". Elas pdem ser utilizadas diretamente, sem mdificaçã, mas também sã ttalmente persnalizáveis pel desenvlvedr, que pde ainda criar utras, ttalmente nvas. As ações Grvy dispnibilizadas sã: PlcAlterarArquiv: Altera um arquiv qualquer prcurand pels tkens (cmentáris pel arquiv), cas nã encntre, insere cnteúd n final d arquiv. Este artefat pde ser utilizad para alterar qualquer arquiv de text, inserind cnteúd definid em um arquiv Velcity. PlcAlterarMenu: Altera arquiv de menu d jcmpany, adicinand s links para acessar as lógicas. Este artefat pde ser utilizad em tda lógica que acesse menu. O fat de ter sid desenvlvida para alterar menu trna esta classe incmpatível cm utras situações. PlcCriarClasse: Cria uma Classe Java cm base em um mdel Velcity pré definid. Este artefat pde ser utilizad em tda lógica que necessite da criaçã de Classes Java, cm Beans pr exempl. PlcCriarPackageInf: Cria uma Classe "package-inf.java" cm base em um mdel velcity pré definid. Este artefat pde ser utilizad em tda lógica que necessite da criaçã de Packge- Inf. PlcCriarPagina: Permite a criaçã de páginas (HTML, JSP, XHTML) em um prjet. Este artefat pde ser utilizad em td padrã que utilize páginas para apresentaçã na camada de visã. PlcRecuperarPrpsClasse: Recupera infrmações sbre a entidade para ppular grid utilizad internamente pel plugin dinâmic para varrer a entidade infrmada pel usuári, retrnand tds s atributs para geraçã d Grid cm essas entidades. Este artefat pde ser utilizad após a definiçã de uma página que vai cnter dads da entidade. PlcValresDefault: Utilizad para preencher valres defaults ns camps d assistente. Este artefat pde ser utilizad a definir um camp para uma página, usuári pde definir um valr padrã para esse camp. Os artefats Velcity dispníveis sã: plc-applicatin-resurces.vm: Template Velcity que insere cnteúd definid em assistentes n arquiv ApplicatinResurces.prperties. plc-item-menu.vm: Template Velcity utilizad pel AlteraMenu.grvy para inserir cnteúd definid em seu crp n arquiv geralmenu.xhtml. Nte que tems ações especializadas na geraçã u alteraçã da mairia ds artefats típics da arquitetura Java EE. As linguagens Grvy e Velcity sã linguagens ppulares de script, dinâmicas e simples de se entender e alterar. Recmendams uma leitura e explraçã de alterações sbre s arquivs padrões, para seu plen entendiment.

12 Capítul 21 - Criand um template Velcity para geraçã de páginas XHTML para frmuláris. A açã Grvy "PlcCriarPagina" é definida cm um parâmetr da seçã "aca" d XML exemplificad ( XML que define assistente dinâmic), que cntém n ttal três arguments: tip-aca: Define a açã Grvy em si, que rquestra td prcess. template-rigem: Um arquiv Velcity que cntém trechs de códig cnstantes (fixs) e cmands Velcity utilizads para gerar segments dinâmics de códig - de md a prduzir nvs arquivs cmplets n frmat XHTML (u seja, arquiv d frmulári específic). diretri-arq-destin: Este argument define um padrã de nme (e diretóri) para cnter resultad final de transfrmaçã n arquiv definid em template-rigem. Neste cas específic, tken ${casus, pr exempl, será substituíd pel valr infrmad pel desenvlvedr n camp "Cas de Us" d assistente, definid na primeira página. E assim pr diante: utrs tkens também funcinam de frma similar. Prtant, cnfrme definid n template-rigem para esta açã, precisams criar template Velcity "crp-xhtml-manterclasse-alteraca.vm" n diretóri padrã indicad na Figura G21.7. Figura G21.6. Diretóri para inserir s arquivs d extensin. O cnteúd d template pde ser vist n Códig G21.4. Nte que, enquant algumas estruturas sã fixas (cnstantes), utras serã mdificadas dinamicamente pel Velcity (texts iniciads cm "#" e "$"), cnfrme infrmações cletadas n assistente. Códig G21.4. Cnteúd d arquiv Velcity (.vm) que gera arquiv "XHTML" para f rmulári. - Criand (s) template(s) Velcity para geraçã de arquivs "package-inf.java" (metadads) De md análg a anterir, a açã Grvy "PlcCriarPackageInf" espera um arquiv de template Velcity para gerar, respectivamente, um arquiv final "package-inf.java", padrã d jcmpany para cnter metadads de Cass de Us Padrões. Cm sabems, irems precisar de dis destes arquivs: um para prjet principal (metadads de camada cntrle) e utrs para prjet de dmíni (metadads de camada cmuns). Cm segund "package-inf.java" nã será gerad n prjet Eclipse principal um atribut adicinal "<prjet-destin>" deve ser adicinad à segunda declaraçã de açã, alterand prjet n qual arquiv será criad. Observe us d tken na declaraçã da Figura G21.7.

13 Extensões Arquiteturais cm jcmpany Extensins Figura G21.7. Cnteúd d arquiv "package-inf.java" cm a declaraçã "prjet-destin". Para satisfazer à primeira "aca" definida, crie arquiv "package-inf-manterclasse-grupcntrleactin-especifica.vm" n mesm diretóri que citams n tópic anterir. O cnteúd d arquiv pde ser cnferid n Códig G21.5 abaix. /* * M eta-dads para a c amada de c ntrle. Define preferências e inversões de c ntrle de us s mente da c amada c ntrle * lccnfiggrupcntrle( ac tin = $ {c ntext.pactebase.c ntrle.jsf.$ {cntext.nmeactin.class, /* * U s a layut universal * / layutu niversal lccnfiglayutuniversal(dirbasefacelets = "/WE B -INF/fcls/$ {cntext.subdiretri" ), #s et ($ flagdespresar = '') #freac h ($ umap rp in $ c ntext.prpsentidade.listaprpriedades) #if ($ umap rp.nme!= 'dataultalteraca' && $ umap rp.nme!= 'us uariultalteraca' && $ umap rp.nme!= 'vers a' && $ umaprp.nme! = 'id' && $ umap rp.nme!= 'has hcdeplc' && $ umaprp.nme!= 'inde xcplc') #if ($ flagdespresar == '') #s et ($ flagdespresar = $ umap rp.nme) #end #end #end tabular lccnfigtabular( prpreferenc iadesprezar = "$ flagdespresar", tes taduplicataflagdesprezar = true, numern vs = 4 ), c mprtament lccnfigcmprtament(detalhelembra = true) ) pac kage c m.pwerlgic.jc mpany.c nfig.app.$ {cntext.c asus; Códig G21.5. Cnteúd d arquiv "package-inf.java"para satisf azer a primeira "aca". Crie em seguida arquiv "package-inf-manterclasse-grupagregaca-alteraca.vm" n mesm diretóri, para a segunda "aca".

14 Capítul lccnfiggrupagregaca( entidade = $ {c ntext.entidade.class, padra lccnfigpadra(lgica = P lccnfigpadra.lgica.manterclasse, c mplexidade = P lccnfigpadra.cmplexidade.simples, exc lusamd = P lccnfigpadra.exclusamd.fisica) lccnfigimprtaca(ehcnsultamanterclasse=true) P ac kage c m.pwerlgic.jc mpany.cnfig.dmini.app.${cntext.casus; Códig G21.6. Cnteud d arquiv "package-inf.java" para satisf azer a segunda "aca". - Cnfigurand a geraçã de texts I18n n arquiv "ApplicatinResurces.prperties". A açã "PlcAlterarArquiv" definida abaix realiza a inserçã de chaves e texts cm mensagens e rótuls n arquiv "ApplicatinResurces.prperties ". Neste cas específic, nenhum template nv precisa ser criad. O jcmpany Extensins já prvê um template genéric suficiente e a açã Grvy é capaz de alterar arquiv padrã, acrescentand as nvas entradas a seu final. Figura G21.8. Açã utilizand template genéric "applicatin-resurces.v m". - Cnfigurand a alteraçã de Menu (inclusã de chamadas). A alteraçã d menu também dispensa a criaçã de nvs template Velcity u ações Grvy. Basta que se infrme endereç para lcalizaçã d arquiv de menu, cnfrme ilustrad na figura abaix. Figura G21.9. Metadad def inid pel jcmpany n arquiv "package-inf.java" - Criand template para classe Actin (para estimular us d Template Methd crret) Cnfrme explicad n iníci d capítul, é esperad que seja definida uma classe que estende (herda) de utra que implementa um DP Template Methd, que prvê um lcal padrnizad para que usuári pssa implementar algritm de imprtaçã ds dads em si. Um esquelet desta classe pde ser gerad para adiantar este trabalh e estimular us crre t pr parte d desenvlvedr. Nte que, nvamente, nã há pretensã aqui de gerar "códig Java", mas smente estruturas da sluçã arquitetural - que evita anti-pattern "geraçã de códig OO generalizável". A figura abaix ilustra a açã cm deve ser declarada n XML de definiçã d assistente. Figura G Template "actin-event-especif ic-manterclasse -criaca.v m" def inid na açã PlcCriarClasse.

15 Extensões Arquiteturais cm jcmpany Extensins O grvy "PlcCriarClasse" irá utilizar cm template arquiv "actin-event-especific-manterclassecriaca.vm", que está definid n códig abaix. pac kage $ {cntext.pactebase.cntrle.js lctratamentexceca public c lass $ {cntext.nmeactin extends A ppactin { prtec ted s tatic final Lgger lg = Lgger.ge tlgger(${cntext.nmeactin.class); public String $ {cntext.nmeevent() thrws P lcexceptin { return P lc JsfCnstantes.NAVEGACAO.IND_MESMA_PAGINA; Códig G21.7. Cnteúd d template Velcity para geraçã da classe. - Cnfigurand a geraçã de btã específic n arquiv "geralacescmplement.xhtml" A cntrári ds cass anterires, este últim ilustra um tip de mdificaçã que nã é realizada pr nenhum assistente padrã d jcmpany, cmprvand a flexibilida de e pder ds assistentes dinâmics prvids pel jcmpany Extensins. Querems definir um nva açã que reutilize Grvy "PlcAlterarArquiv" para alterar arquiv "geralacescmplement.xhtml", utilizad cm padrã n jcmpany para cnter btões adicinais as básics de manutençã. Este btã deverá aparecer junt à barra de ações e disparar a imprtaçã em si, implementada na classe Java cuj esquelet gerams ns pass anteri r. Figura G Def iniçã da açã que irá utilizar template "altera-geral-aces.v m". Precisarems entã criar template Velcity "altera-geral-aces.vm" cnfrme vist n Códig G21.8. ## C riand declaraçã d event para C as de U s P adrã <plc f:btaaca urlicne="ic ie specific" label="jc mpany.evt.$ {cntext.nmeevent" ac tin="#{plcactin.${cntext.nmeevent" rendered="#{requestscpe.plcactinsembarra == '$ {c ntext.casus'"/> Códig G21.8. Cnteúd d arquiv "altera-geral-aces.v m". Imprtante: Além diss, neste cas precisams definir ainda um pnt de inserçã n arquiv "geralacescmplement.xhtml", para evitar errs de interpretaçã d geradr, em situações nde existam cnteúds cmplexs neste arquiv. Nte que é pssível se definir este pnt (um cmentári padrã) ns templates INI utilizads pela rganizaçã, de md que já venham pré -cnfigurads em tds s seus prjets:

16 Capítul 21 Figura G Exempl de cmentári def inind pnt de inserçã n arquiv "geralacescmplement.xhtml" Cm iss, finalizams tdas as cnfigurações necessárias para dispnibilizar nss nv cmpnente OO cm um assistente que apóie decisivamente seu reús, inclusive gerand tdas as partes específicas e que nã fram pssível de ser generalizadas. Dispnibilizand e Reutilizand um Nv Padrã jcmpany Extensin - Dispnibilizand nv padrã para a empresa Para dispnibilizar este e utrs padrões de Cas de Us criads via jcmpany Extensin, Arquitet de Sftware deve manter um catálg de ativs reutilizáveis em algum repsitóri crprativ, cm Maven Archiva, pr exempl, que é aplicativ hmlgad pel jcmpany QA Suite. Para dispnibilizar 'plugin eclipse dinâmic' em seu ambiente, cas desenvlvedr pssua prjet jcmpany Extensin, a tarefa Maven "instalar prjet n repsitóri lcal" deve ser executada n prjet relacinad. Cas cntrári, a infrmar essa dependência n arquiv pm.xml, artefat será baixad para repsitóri lcal autmaticamente. O próxim pass será fazer cm que ambiente Eclipse ds desenvlvedres recnheça nv assistente. Para tant é necessári mdificar arquiv "extensins.prperties" que se encntrad na pasta raiz d plugin "Geradr Dinâmic", instalad cm padrã em "[jcmpany_base]/eclipse/pluginsplc/pwerlgic/eclipse/plugins/ cm.pwerlgic.jcmpany.ide.geradrdinamic_[versa]" *. Esse arquiv frnece a plugin a lcalizaçã ds arquivs JAR ds jcmpany Extensins criads. Nvs padrões devem ser inserids n padrã abaix: [nmedprjetextensin] = [Subdiretóri d jcmpany Extensin criad, cmeçand d repsitóri]. Imprtante: Esta cnfiguraçã é na verdade uma limitaçã atual da sluçã, que deverá "descbrir" dinamicamente estes diretóris em versões futuras d jcmpany Extensins. Deste md, a cnfiguraçã pr parte d desenvlvedr se limitará a seu trabalh típic d dia a dia, de apenas cnfigurar cmpnente Maven! A Figura G mstra arquiv extensins.prperties cnfigurad para a cmpnente "plx_imprtaca". Figura G A rquiv extensins.prperties. Cm iss, mecanism d jcmpany Extensin irá identificar e dispnibilizar nv padrã, para que apareça ns assistentes d Eclipse. * C as a s ua vers ã d jc mpany tenha sid atualizada via "Eclipse U pdate (nline)", a url c rreta para enc ntrar plugin é: "[jcmpany_base]/ec lips e/plugins /c m.pwerlgic.jc mpany.ide.geradrdinamic_[versa]" *.

17 Extensões Arquiteturais cm jcmpany Extensins - Cnsiderand sbre usar u nã a geraçã de artefats O trabalh de criaçã ds assistentes e geradres que tivems até aqui, embra nã seja muit extensiv, também nã é desprezível. Certamente ele será mais eficaz d que se cmpararms a trabalh para se criar plugins Eclipse "d zer", mas ainda assim deve -se julgar cm critéri qual a real prbabilidade de reus d padrã e valr que a geraçã de códig trará, em cada cntext. Pr exempl, cas Arquitet de Sftware estime que um nv padrã recrrente crra dezenas de vezes pelas aplicações da empresa, cust/benefíci pssivelmente irá cmpensar. Nã smente na frma de prdutividade, mas também n refrç a aprendizad e padrnizaçã (ganhs na manutençã). Mas cas ele perceba que haja menr previsibilidade u prbabilidade de crrer, talvez valha à pena ficar apenas na parte OO da sluçã, rientand seu reús apenas cm dcumentaçã. - Reutilizand padrã "plx_imprtaca" n prjet "rhtutrial" Retrnand a nss cas, vams agra à parte final. Após terms nv padrã dispnibilizad, identificad e cnfigurad, verems cm irems melhrar trabalh n dia a dia. Neste pnt é nde verificams s ganhs de prdutividade e qualidade finais, que deverã trazer retrn a nss esfrç investid. Vams entã criar uma "Imprtaçã de UF" simulada, n prjet "rhtutrial". Após a criaçã da classe e mapeament da mesma através da pçã "01 Mapear Objet Relacinal" acine s assistentes d jcmpany para criaçã de Cas de Us, através d atalh "Ctrl + n" d Eclipse. Selecine a seguir assistente de plugin "X - Pwerlgic Outrs Assistentes", cnfrme mstra a Figura G Figura G Assistente padrã exibind pçã para assistentes dinâmics. A clicar em "next" vams para a tela de seleçã de assistente dinâmics. Perceba que tds s nvs padrões sã exibids n segund pass, cnfrme mstra a Figura G21.15.

18 Capítul 21 Figura G Pass de seleçã de nvs assistentes de geraçã d jcmpany Extensins. Após selecinar Cas de Us Padrã "Manter Classe Imprtaçã" clique nvamente em " Next" para seguir para primeir pass d assistente dinâmic, ilustrad na Figura G Figura G Primeir pass d assistente dinâmic, exibind camps cnf rme cnf igurações d arquiv XML. Uma vez definida a entidade e infrmações básicas, vams para pass de cnfiguraçã da classe de Actin. A Figura G21.17 mstra resultad das cnfigurações feitas para pass 2.

19 Extensões Arquiteturais cm jcmpany Extensins Figura G Segund pass, cm as cnf igurações criadas n arquiv XML. Clique nvamente em "Next" para seguir para últim pass. Nte que este retrna tdas as prpriedades da entidade selecinada n pass 1 e ainda frnece pções de cnfiguraçã para geraçã para cada uma delas. A Figura G21.18 mstra este pass já devidamente preenchid. Figura G Últim pass, de ediçã de prpriedades da Entidade para geraçã d f rmulári. Após clicar n btã "Finish", geradr dinâmic irá prcessar e executar as ações Grvy definidas a final d XML, cnfrme vims, gerand entã tds s artefats necessáris para que desenvlvedr já btenha Cas de Us em estági próxim a final. Neste cas, restand apenas a implementaçã d algrítim específic de imprtaçã em si (futuramente Arquitet de Sftware também pderia cnsiderar generalizar até este algritm, até cert pnt). Neste pnt, se desenvlvedr desejar, ele ainda pde editar cada um ds artefats gerads e efetuar ajustes manuais para variações sutis necessárias em cada cas específic - mas se já fizer a liberaçã de imediat ele pde cmprvar que resultad final já tem qualidade de prduçã e está bastante finalizad e em cnfrmidade cm padrã definid!

20 Capítul 21 Figura G Frmulári cm nv padrã f uncinal. - Prgramaçã d códig de imprtaçã Cm vims, n pnt em que está nss padrã já impede a criaçã u exclusã manual, pel usuári, de nvas entradas de UF, além de prver um btã e classe especificamente prjetads para a implementaçã da imprtaçã em si. Na hipótese deste exempl imaginams que endereç d arquiv será btid de md genéric neste algritm. Mas vcê seria capaz de mdificar padrã para incluir um camp de seleçã de arquiv para imprtaçã, pr exempl, n iníci d frmulári?