Skip to content

15. Przykład 12 – Różne konwersje i walidacje

Nowa aplikacja umożliwia wprowadzanie różnych elementów wyposażonych w walidatory Struts:

  • w [1], formularz wprowadzania danych
  • w [2] – potwierdzenie wprowadzonych danych

Aplikacja działa podobnie jak poprzednie, dlatego omówimy tylko te elementy, które się różnią.

15.1. Projekt NetBeans

Projekt NetBeans wygląda następująco:

  • w [1], widoki aplikacji
    • [Accueil.JSP]: strona główna
    • [FormDivers.JSP]: formularz wprowadzania danych
    • [ConfirmationFormDivers.JSP]: strona potwierdzenia
  • w [2], plik komunikatów [messages.properties] oraz główny plik konfiguracyjny Struts
  • w [3]:
    • [FormDivers.java]: akcja wyświetlająca i przetwarzająca formularz
    • [FormDivers-validation.xml]: reguły walidacji akcji [FormDivers]. Plik ten przekazuje te walidacje do modelu.
    • [FormDiversModel]: model akcji [FormDivers]
    • [ FormDiversModel-validation.xml]: reguły walidacji modelu
    • [FormDiversModel.properties]: plik komunikatów modelu
    • [example.xml]: dodatkowy plik konfiguracyjny Struts

15.2. Konfiguracja projektu

Projekt jest konfigurowany głównie za pomocą następującego pliku [example.xml]:


<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
        "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
        "http://struts.apache.org/dtds/struts-2.0.dtd">

<struts>
  <package name="example" namespace="/example" extends="struts-default">
    <action name="Accueil">
      <result name="success">/example/Accueil.JSP</result>
    </action>
    <action name="FormDivers" class="example.FormDivers">
      <result name="input">/example/FormDivers.JSP</result>
      <result name="cancel" type="redirect">/example/Accueil.JSP</result>
      <result name="success">/example/ConfirmationFormDivers.JSP</result>
    </action>
  </package>
</struts>

Jest on analogiczny do tego, który był omawiany w poprzednich wersjach.

15.3. Pliki komunikatów

Plik [messages.properties] ma następującą postać:


Accueil.titre=Accueil
Accueil.message=Struts 2 - Conversions et validations
Accueil.FormDivers=Saisies diverses (email, URL, chaine de caract\u00e8res avec contr\u00f4le du nombre de caract\u00e8res)
Form.titre=Conversions et validations
FormDivers.message=Struts 2 - Conversions et validations de types divers
Form.submitText=Valider
Form.cancelText=Annuler
Form.clearModel=Raz mod\u00e8le
Confirmation.titre=Confirmation
Confirmation.message=Confirmation des valeurs saisies
Confirmation.champ=champ
Confirmation.valeur=valeur
Confirmation.lien=Formulaire de test
xwork.default.invalid.fieldvalue=Valeur invalide pour le champ "{0}".

Plik [FormDiversModel.properties] ma następującą treść:


email.prompt=1-Tapez une adresse \u00E9lectronique (x@y.z)
email.error=Format invalide
URL.prompt=2-Tapez une URL (http://www.ibm.com)
URL.error=Format invalide
chaine.prompt=3-Tapez une chaine de 5 caract\u00E8res
chaine.error=Format invalide

15.4. Formularz wprowadzania danych

Widok [FormDivers.JSP] wygląda następująco:


<%@ page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
  <head>
    <title><s:text name="Form.titre"/></title>
    <s:head/>
  </head>

  <body background="<s:url value="/ressources/standard.jpg"/>">
    <h2><s:text name="FormDivers.message"/></h2>
    <s:form name="formulaire" action="FormDivers">
      <s:textfield name="email" key="email.prompt" size="30"/>
      <s:textfield name="URL1" key="URL.prompt" size="30"/>
      <s:textfield name="chaine" key="chaine.prompt" size="10"/>
      <s:submit key="Form.submitText" method="execute"/>
    </s:form>
    <br/>
    <s:url id="URL" action="FormDivers" method="cancel"/>
    <s:a href="%{URL}"><s:text name="Form.cancelText"/></s:a>
      <br/>
    <s:url id="URL" action="FormDivers" method="clearModel"/>
    <s:a href="%{URL}"><s:text name="Form.clearModel"/></s:a>
  </body>
</html>

Wiersze od 12 do 14 to trzy pola wprowadzania danych.

15.5. Widok potwierdzenia

Ekran potwierdzenia [ConfirmationFormDivers.JSP] wygląda następująco:


<%@ page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
  <head>
    <title><s:text name="Confirmation.titre"/></title>
    <s:head/>
  </head>

  <body background="<s:url value="/ressources/standard.jpg"/>">
    <h2><s:text name="Confirmation.message"/></h2>
    <table border="1">
      <tr>
        <th><s:text name="Confirmation.champ"/></th>
        <th><s:text name="Confirmation.valeur"/></th>
      </tr>
      <tr>
        <td><s:text name="email.prompt"/></td>
        <td><s:text name="email"/></td>
      </tr>
      <tr>
        <td><s:text name="URL.prompt"/></td>
        <td><s:text name="URL1"/></td>
      </tr>
      <tr>
        <td><s:text name="chaine.prompt"/></td>
        <td><s:text name="chaine"/></td>
      </tr>
     </table>
    <br/>
    <s:url id="URL" action="FormDivers!input"/>
    <s:a href="%{URL}"><s:text name="Confirmation.lien"/></s:a>
  </body>
</html>

15.6. Szablon [FormDiversModel]

Pola wprowadzania danych z formularza [FormDivers.JSP] są wstawiane do poniższego szablonu [FormDiversModel]:


package example;

public class FormDiversModel {

  // konstruktor bez parametrów
  public FormDiversModel() {
  }
  
  // pola
  private String email;
  private String URL1 ;
  private String chaine;

    // wyzerowanie modelu
  public void clearModel() {
    email = null;
    URL1 = null;
    chaine = null;
  }

  // metody pobierające i ustawiające
   ...
}

15.7. Walidacja szablonu

Walidacja szablonu jest kontrolowana przez dwa pliki: [FormDivers-validation.xml] i [FormDiversModel-validation.xml].

Plik [FormDivers-validation.xml] przekazuje zadania walidacji do następującego pliku [FormDiversModel-validation.xml]:


<!--
<!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0.2//
EN" "http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd">
-->
<!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0.2//
EN" "http://localhost:8084/przykład-10/example/xwork-validator-1.0.2.dtd">

<validators>
  <field name="model" >
    <field-validator type="visitor">
      <param name="appendPrefix">false</param>
      <message/>
    </field-validator>
  </field>
</validators>

Z tym plikiem mieliśmy już do czynienia.

Plik [FormDateModel-validation.xml] zawiera następujące reguły walidacji:


<!--
<!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0.2//
EN" "http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd">
-->

<!DOCTYPE validators PUBLIC "-//OpenSymphony Group//XWork Validator 1.0.2//
EN" "http://localhost:8084/przykład-12/example/xwork-validator-1.0.2.dtd">

<validators>

  <field name="email" >
    <field-validator type="requiredstring" short-circuit="true">
      <message key="email.error"/>
    </field-validator>
    <field-validator type="email" short-circuit="true">
      <message key="email.error"/>
    </field-validator>
  </field>

  <field name="URL1" >
    <field-validator type="requiredstring" short-circuit="true">
      <message key="URL.error"/>
    </field-validator>
    <field-validator type="URL" short-circuit="true">
      <message key="URL.error"/>
    </field-validator>
  </field>

  <field name="chaine" >
    <field-validator type="requiredstring" short-circuit="true">
      <message key="chaine.error"/>
    </field-validator>
    <field-validator type="stringlength" short-circuit="true">
      <param name="minLength">5</param>
      <param name="maxLength">5</param>
      <message key="chaine.error"/>
    </field-validator>
  </field>

</validators>
  • wiersze 11–18: sprawdzają poprawność pola email
  • wiersze 15–17: sprawdzają, czy ciąg znaków email jest prawidłowym adresem e-mail
  • wiersze 20–27: sprawdzają poprawność pola URL1
  • wiersze 24–26: sprawdzają, czy ciąg znaków URL1 jest prawidłowym URL
  • wiersze 29–38: sprawdzają poprawność pola chaine
  • wiersze 33–37: sprawdzają, czy ciąg znaków chaine ma dokładnie 5 znaków.

15.8. Akcja [FormDivers]

Akcja [FormDivers] wygląda następująco:


package example;

import com.opensymphony.xwork2.ActionSupport;
import com.opensymphony.xwork2.ModelDriven;
import java.util.Map;
import org.apache.struts2.interceptor.SessionAware;
import org.apache.struts2.interceptor.validation.SkipValidation;

public class FormDivers extends ActionSupport implements ModelDriven, SessionAware {

  // konstruktor bez parametrów
  public FormDivers() {
  }

  // szablon akcji
  public Object getModel() {
    if (session.get("model") == null) {
      session.put("model", new FormDiversModel());
    }
    return session.get("model");
  }

  @SkipValidation
  public String clearModel() {
    // dane modelu
    ((FormDiversModel) getModel()).clearModel();
    // wynik
    return INPUT;
  }

  public String cancel() {
    // oczyszczamy model
    ((FormDiversModel) getModel()).clearModel();
    // wynik
    return "cancel";
  }

  // SessionAware
  Map<String, Object> session;

  public void setSession(Map<String, Object> session) {
    this.session = session;
  }
}

Akcja [FormDivers] jest zbudowana na tej samej zasadzie, co akcje omówione wcześniej. W tym przypadku po prostu nie ma metody validate, która uzupełniałaby walidację przeprowadzoną przez plik [FormDiversModel-validation.xml].