JUG Sardegna supports Devoxx 2013
Vuoi ricevere uno zainetto? Clicca qui

Java User Groups
Java.net Partner
Get Firefox!

Spring Web Flow

Articolo di MassimilianoDessi
Spring Web Flow
vers 0.2

Spring Web Flow in un esempio pratico :Jug Avis Web (aka MagicBox)


Introduzione

In alcune situazioni, nella realizzazione di Web application, si presenta la necessità di suddividere una elaborazione in un flusso di elaborazione logica composto da più step, normalmente chiamato Page Flow.
Un esempio, può essere il caso in cui si debba effettuare una registrazione, laddove un utente debba fornire molti dati via web, in questo caso, si possono suddividere i dati per raggruppamenti logici e richiederli in pagine diverse.
Un altro esempio può essere una applicazione avente come dominio applicativo lÂ’elaborazione dei work flow.


Soluzioni

Un framework come Struts permette una elaborazione stile wizard, ma al prezzo di legare nel codice e nello struts-config i passi del flusso, rendendo non riutilizzabili i singoli passi di cui è composto il flusso e non isolando chiaramente i flussi stessi.
Spring fornisce appositamente per questo tipo di problematica un modulo chiamato Spring Web Flow (che farà parte della distribuzione dalla versione 1.3).
Esso permette una configurazione da file (anche da codice se si preferisce) dei passi di cui è composto ogni singolo flusso.
Questo approccio “Spring-Ioc Style” risulta molto più maneggevole, flessibile, chiaro, testabile, riutilizzabile ed elegante.
Vedremo come si utilizza Spring Web Flow, prendendo come esempio una applicazione usa la versione PR3.
LÂ’applicazione è una Web App realizzata per lÂ’AVIS (Associazione Donatori Sangue) dal Jug Sardegna, sotto licenza Apache.


Schema flusso logico

Il primo passo da compiere quando si usa Spring Web Flow, è disegnare lo schema del funzionamento desiderato, sotto forma di transizioni tra i vari stati di funzionamento desiderati.



Si passa da uno ad un altro in base alla mappatura nel file di descrizione del flusso.
Lo StartState è il punto di partenza, il flusso si pone in un ViewState, dove viene semplicemente visualizzata una pagina, e viene atteso il submit da parte dellÂ’ utente .
La view di questa pagina, è una JSP che seleziona un file di cui fare lÂ’ upload.
Lo stato successivo è bindAndValidate (ActionState), dove viene fatto il bind del file di cui si è fatto lÂ’upload, nel caso ci sia un errore, lÂ’ utente viene riportato allo stato iniziale per ritentare lÂ’upload in maniera corretta.
Un ActionState è quindi uno stato in cui vengono fatte delle elaborazioni.
Se invece non ci sono stati errori il flusso si porta allo stato insert.donors dove viene valorizzata una List con gli oggetti di dominio Donor.
Se qualcosa è andato male (il file è vuoto) si viene riportati allo stato iniziale in cui viene richiesto il file.
Proseguendo, in caso nella insert.donors sia andato tutto bene, si arriva allo stato confirmation.viewTest, dove vengono mostrati i dati estratti dal file, e dove viene richiesto il messaggio da spedire via sms alle persone elencate, quando si procede con la spedizione dellÂ’ sms, il flusso passa allo stato sendSms (ActionState) dove viene effettuata la spedizione dellÂ’ sms.
Il flusso passa allo statao exit (viewState) dove viene mostrato un messaggio che comunica la buona riuscita o il fallimento della spedizione dellÂ’ sms.


Funzionamento e altre caratteristiche

Oltre agli stati ViewState e ActionState illustrati in precedenza, Web Flow fornisce anche uno stato “decisionale” , da utilizzare ad esempio, nel caso si debba incanalare un flusso in un eventuale sotto flusso, oppure nel caso si debba prendere una decisione rispetto al contesto nel quale si può trovare il flusso.

Es. mappatura decision-state:


<decision-state id="isPassengerInfoRequired">
   <if test="${requestScope.passenger == null}"      then="enterPassengerInformation"/>
   <if test="${requestScope.passenger.preferences.alwaysConfirmPassengerInfo}"
  then="enterPassengerInformation" else="displayReservationVerification"/>
</decision-state>


Es. mappatursa Sotto Flusso:


<subflow-state id="enterPassengerInformation" flow="passenger">
   <attribute-mapper>
  <input value="${requestScope.passenger.id}" as="passengerId"/>
   </attribute-mapper>
   <transition on="finish" to="displayReservationVerification"/>
</subflow-state>


Possono essere definiti anche uno o più stati finali End-State con il quale il flusso viene terminato


<end-state id="displayConfirmation" view="reservationConfirmation"/>

<end-state id="tryAgain" view="tryAgain"/>

<end-state id="cancel" view="home"/>


Nel caso dellÂ’ esempio ciò non è stato fatto perché lÂ’ utente deve avere la possibilità di mandare più sms di seguito.
Invece nel caso di una registrazione uno stato finale avrebbe senso.


File di configurazione sms-flow.xml


<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE webflow PUBLIC "-//SPRING//DTD WEBFLOW//EN"
  "http://www.springframework.org/dtd/spring-webflow.dtd">

<webflow id="upload" start-state="selectFile.view">

   <!-- Selezione file -->
  <view-state id="selectFile.view" view="selectFile.view">
    <transition on="submit" to="bindAndValidate"/>
  </view-state>

   <!—-Validazione file -->
  <action-state id="bindAndValidate">
    <action bean="upload.process"/>
    <transition on="success" to="insertDonors"/>
    <transition on="error" to="selectFile.view"/>
  </action-state>
  
<!—- Creazione List di Donor dal file -->
  <action-state id="insertDonors">
    <action bean="insert.donors"/>
    <transition on="success" to="confirmation.viewTest"/>
    <transition on="error" to="selectFile.view"/>
  </action-state>
  
  <!-- Visualizzazione donatori e attende messaggio da spedire-->
  <view-state id="confirmation.viewTest" view="insertMessage.view">
    <transition on="submit" to="sendSms"/>
  </view-state>
  
      <!-- Spedisce sms -->
  <action-state id="sendSms">
    <action bean="send.sms"/>
    <transition on="success" to="exit"/>
  </action-state>
  
   <!-- Messaggio di buona riuscita o di fallimento spedizione -->
  <view-state id="exit" view="ciao">
    <transition on="submit" to="selectFile.view"/>
  </view-state>
</webflow>


In questo file viene definita la composizione del flusso attraverso gli stati, identificando il flusso stesso con lÂ’ id upload.
Come si vede, tutti i componenti del flusso sono dei POJO, che sono definiti in un altro file di configurazione, compreso il componente principale che agisce da factory per i flussi, vediamo questo file.


jug-servlet.xml

Questo file contiene i bean del Web Tier

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"
   "http://www.springframework.org/dtd/spring-beans.dtd">

<beans>

   <!-- F L O W  C O N T R O L L E R-->
  <bean id="flowFrontController" name="/upload.htm" class="org.springframework.web.flow.mvc.FlowController">
    <property name="flow">
      <ref bean="smsFlow"/>
    </property>
  </bean>
  
  
  <!-- W E B  F L O W  F A C T O R Y-->
  <bean id="smsFlow" class="org.springframework.web.flow.config.XmlFlowFactoryBean">
    <property name="location">
      <value>/WEB-INF/sms-flow.xml</value>
    </property>
  </bean>
  
  
  <!-- A C T I O N -->
  
  <bean id="upload.process" class="org.jugsardegna.avis.web.action.ProcessUploadAction"/>
  
  <bean id="insert.donors" class="org.jugsardegna.avis.web.action.DonorsAction">
    <property name="sender">
      <ref bean="mockSender"/>
    </property>
    <property name="logger">
      <ref bean="logger"/>
    </property>
  </bean>
  
  <bean id="send.sms" class="org.jugsardegna.avis.web.action.MessageSmsAction">
    <property name="sender">
      <ref bean="mockSender"/>
    </property>
  </bean>

  
   <!-- M U L T I P A R T  R E S O L V E R -->
 
  <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"/>



   <!-- V I E W  R E S O L V E R -->

  <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix">
      <value>/WEB-INF/jsp/</value>
    </property>
    <property name="suffix">
      <value>.jsp</value>
    </property>
  </bean>
  Â…
Â…
</beans>


Il primo bean che vediamo è flowFrontController, il controller (il corrispondente delle action in Struts) che mappa lÂ’ URL /upload.htm (.htm negli url usati da Spring è una convenzione come il .do in Struts), e al quale viene iniettato il bean smsFlow che è una XmlFlowFactoryBean che provvede a creare il flusso dal file dei bean.
Nella parte delle action troviamo i bean che vengono usati nel flusso, poi troviamo il bean usato nellÂ’ upload del file, e per ultimo il bean viewResolver che si occupa di far corrispondere i nomi logici delle view(in questo esempio quelle dei viewState)a delle JSP.


Dettagli di funzionamento

Vediamo alcuni dettagli che permettono al flusso di funzionare.
Vediamo la JSP iniziale (selectFile.view) per spiegare gli elementi fondamentali.


<%@ page session="false" %>
<%@ taglib uri="http://java.sun.com/jstl/core" prefix="c" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
  <HEAD>
  </HEAD>
  <BODY>
    <DIV align="left"><c:if test="${!msgGeneric}"><c:out value="${msgGeneric}"/></c:if>(Passo di 3)  Scegli il file contenente i numeri di telefono delle persone a cui inviare l'sms</DIV>
    <HR>
    <DIV align="left">
      <FORM name="submitForm" action="upload.htm" method="post" enctype="multipart/form-data">
        <INPUT type="hidden" name="_flowExecutionId" value="<%=request.getAttribute("flowExecutionId") %>">
        <INPUT type="hidden" name="_eventId" value="submit">
        <INPUT type="hidden" name="_currentState" value="selectFile.view">
        <INPUT type="file" name="file">
      </FORM>
    </DIV>
    <HR>
    <DIV align="left">
      <INPUT type="button" onclick="javascript:document.submitForm.submit()" value="Importa il file">
    </DIV>
  </BODY>
</HTML>


Per prima cosa, diciamo che lÂ’url che viene utilizzato in tutto il flusso è upload.htm, ed è sempre lo stesso, quindi in tutte le JSP lo ritoveremo come url del form action.
Di seguito troviamo ciò che permette al flusso di sapere in quale punto si trova.
_flowExecutionId, è lÂ’ id che permette allÂ’ oggetto che contiene il page flow (nella sessione tipicamente) di identificare il flusso tra le varie richieste al server, esso deve essere presente in tutte le pagine tranne quella iniziale e quella finale ed è associato allo stesso flusso su uno stesso client.
La sua funzione si comprende soprattutto alla luce del fatto che il flusso nei ViewState è “in pausa”.
_eventId, invece serve per sapere quale transizione deve essere effettuata, nel nostro caso sul submit.
_currentState, serve per sapere in quale stato ci si trova nel caso che lÂ’ utente invece di usare i link o i pulsanti per la navigazione, utilizzi il back del browser.
Le action estendono tutte MultiAction di Web Flow.
A tutte le action viene fornito un RequestContext(Non corrispondente alla HttpRequest), i dati possono essere letti e messi con visibilità a livello di request o di flow.
Altra carattersitiche non illustrata nellÂ’ articolo è il binding e il supporto per le portlet.


Testabilità, Code Coverage e metriche

Come detto allÂ’ inizio dellÂ’ articolo, la costruzione di un flusso in maniera Ioc Style porta il beneficio di rendere fortemente disaccopiati tutti gli oggetti, rendendo facile la testabilità, il Code Coverage e la “misurazione” della qualità del codice che viene prodotto, fornendo degli indicatori su dove eventualmente migliorare il codice.
Se sui test non ci dovrebbe ormai essere bisogno di spiegarne i benefici, vediamo in cosa ci aiuta invece il Code Coverage.
Per il Jug Avis viene usato Clover , che segnala nellÂ’ ambiente di sviluppo ( anche con Ant volendo, e genera dei report per la documentazione sui punti in cui il codice non viene eseguito), segnalando codice non usato, o non adeguatamente coperto da test.








Metrics invece come dice il nome stesso, misura il codice scritto , fornendo dati che possono rivelare molte cose sul “come” si stà scrivendo il codice e fornisce anche dei grafi interattivi sulle dipendenze fra le classi.






Conclusioni

NellÂ’ articolo è stata mostrata solo la superficie di questo modulo di Spring che è arrivato alla versione PR5 e ritoveremo nelle prossime versioni di Spring, magari con qualche modifica.
Infatti oltre a supportare il Page flow, è il modulo deputato alla integrazione con le Portlet (con specifica JSR 168).


Bibliografia

J2ee development without EJB: Rod Johnson, Juergen Hoeller Ed. Wrox
ProfessionalJavaDevelopmentWithSpringFramework:
ProSpring : Rob Harrop, Jan Machacek Ed.Apress
SpringInAction :Craig Walls, Ryan Breidenbach Ed. Manning

Riferimenti Tecnologici

Spring Web Flow
Forum Spring Framework
Presentazione Jug Avis Web


Riferimenti Progetto

JugAvis
Progetto Jug Avis su java.net (Vers. Swing e Vers. Web)
Centro pilota (Avis Sestu)

SpringWebFlow is mentioned on: StartingPoints_En | SpringFramework | ExpertSpringMVCandWebFlow


VeryQuickWiki Version 2.7.8 | Admin
Copyright © 2003-20013 Java User Group Sardegna Onlus. - Java, the Java Coffee Cup Logo and the Duke Logo are trademarks or registered trademarks of Oracle corporation in the U.S. and other countries.