ARCHIV

Apache Struts (5) - modul Validator

Dnes si projdeme standardní pravidla tohoto modulu, které nám vystačí v naprosté většině běžných webových aplikací. Na konci článku si vytvoříme pravidlo vlastní , jehož validace bude založena na širokých možnostech regulárních výrazů a mrkneme na použití modulu Validator ve vícejazyčném prostředí.

14.4.2005 06:00 | Miroslav Holubec | Články autora | přečteno 11183×

Předdefinovaná pravidla

Začneme výčtem předdefinovaných pravidel modulu Validator, které nám pro většinu běžných aplikací vystačí. Všechny pravidla mají jeden povinný argument, kterým je klíč názvu položky formuláře ze souborů zdrojových svazků zpráv (messages resources). Nadpisy jednotlivých pravidel ubsahují stručný popis pravidla, jeho název a kód klíče chybové hlášky. Pokud bychom chtěli předefinovat výhozí kód chybové hlášky, použijeme XML element <msg /> (viz příklad u short).

Nutná hodnota - required - errors.required

Toto zřejmě nejpoužívanější pravidlo určuje, že uživatel nemůže nechat políčko nevyplněné, jeho hodnota je tedy povinná. Použití je jednoduché, pravidlo vyžaduje jako argument pouze název položky, jak ukazuje následující ukázka ze souboru validation.xml:

      
  <field property="username" depends="required">
    <arg0 key="login.username"/>
  </field>

Pokud dojde k porušení pravidla, použije se klíč errors.required, jejíž výchozí překlad je {0} is required. Místo {0} se v tomto příkladě použije hodnota klíče login.username.

Minimální délka - minlength - errors.minlength

Určuje minimální délku položky, přičemž kromě povinného argumentu vyžaduje ještě jeden, nazvaný minlength, kterým je právě minimální počet znaků. Atribut resource použijeme vždy, když nechceme aby se hodnota parametru nehledala v klíčích zdrojových svazků zpráv, ale použila se přímo. Stejně jako definujeme argument, který slouží k nahrazování parametrů ve zprávách, musíme definovat i proměnnou minlength, která je určující pro validátor.

      
  <field property="password" depends="required,minlength">
    <arg0 key="login.password"/>
    <arg1 name="minlength" key="${var:minlength}" resource="false"/>
    <var>
      <var-name>minlength</var-name>
      <var-value>5</var-value>
    </var>
  </field>

Maximální délka - maxlength - errors.maxlength

Určuje maximální délku položky, použití je obdobné jako u pravidla maxlength.

Mask - mask - errors.invalid

Je nejsilnější pravidlo, dovoluje aplikovat na položku regulární výraz. Jeho použití si ukážeme ke konci článku.

typ Byte - byte - errors.byte

Použití tohoto pravidla využijeme, pokud v aplikační logice pracujeme s typem Byte. Hodnota bude tedy akceptována v rozmezí celočíselných hodnot -128 až 127.

      
  <field property="age" depends="required, byte">
    <arg0 key="registration.age"/>
  </field>

typ Short - short - errors.short

Obdobné jako typ Byte, až na rozmezí od -32768 do 32767. U tohoto pravidla si ukážeme jak předefinovat výchozí klíč chybové hlášky na námi definovaný.

      
  <field property="pin" depends="required, short">
    <arg0 key="registration.pin"/>
    <msg  name="short" key="registration.pin.low"/>
  </field>

typ Integer - integer - errors.integer

Celočíselné hodnoty v mezích od -2147483648 do 2147483647.

typ Long - long - errors.long

Celočíselné hodnoty v mezích od -9223372036854775808 do 9223372036854775807.

typ Float - float - errors.float

Reálné hodnoty dle IEEE 754 v mezích od ±1.4E-45 do ±3.4028235E+38.

typ Double - double - errors.double

Reálné hodnoty dle IEEE 754 v mezích od ±4.9E-324 to ±1.7976931348623157E+308.

Datum - date - errors.date

Validace probíhá pomocí třídy java.text.SimpleDateFormat, které se zadává proměnná, jejíž hodnotou je formát data. Jsou dvě možosti rozlišení dle názvu proměnné, obvykle použijeme datePattern, pokud bychom chtěli kontrolovat i pevný počet znaků, museli bychom použít datePatternStrict ( 1.12.2005 by formátem dd.MM.yyyy neprošlo ).

      
  <field property="date" depends="required,date">
    <arg0 key="registration.date"/>
    <var>
      <var-name>datePattern</var-name>
      <var-value>dd.MM.yyyy</var-value>
    </var>
  </field>

Email - email - errors.email

Pravidlo využijeme u validace emailové adresy, adresa musí obsahovat zavináč a tečku.

      
  <field property="email" depends="required,email">
    <arg0 key="registration.email"/>
  </field>

Kreditní karta - creditCard - errors.creditcard

Jak již název napovídá, validací projdou jen skutečně aktivní čísla kreditních karet :)

URL - url - errors.url

Dokáže zvalidovat formát adresy url pro specifické protokoly. Můžeme zadat čtyři nepovinné proměnné, které ovlivňují kontrolu.

• allowallschemes Povoluje všechny protokoly, možné hodnoty jsou true nebo false, přičemž standartně je nastaveno na false. Pokud proměnnou nastavíme na true, pak bude proměnná schemes ignorována.
• allow2slashes Říká jestli je povoleno uvádět dvojité lomítko '/'. Výchozí hodnota je false).
• nofragments Povoluje necelé adresy url. Výchozí je true, tedy nepovoleno.
• schemes Definuje protokoly, které lze použít v adresách URL. Výchozím nastavením je http, https a ftp.

      
  <field property="url" depends="url">
    <arg0 key="registration.url"/>
    <var>
      <var-name>schemes</var-name>
      <var-value>http,https</var-value>
    </var>
  </field>

Rozmezí celočíselných čísel - intRange - errors.range

Pravidlo akceptuje všechna celočíselná čísla, která se nachází mezi zadanou dvojicí proměnných, vyžaduje tedy celkem tři argumenty (pro MessagesResources) a dvě proměnné.

      
  <field property="age" depends="required,integer,intRange">
    <arg0 key="registration.age"/>
    <arg1 name="intRange" key="${var:min}" resource="false"/>
    <arg2 name="intRange" key="${var:max}" resource="false"/>
    <var>
      <var-name>min</var-name>
      <var-value>18</var-value>
    </var>
    <var>
      <var-name>max</var-name>
      <var-value>60</var-value>
    </var>
  </field>

Rozmezí reálných čísel - floatRange - errors.range

Použití je stejné jako u předchozího pravidla s tím, že hodnoty mohou být s v rámci reálných čísel.

Větvení kontrol - validwhen - errors.invalid

Od Struts v1.2 je možnost použít tohoto pravidla, které určuje závislosti na ostatních položkách formuláře. Pravidlu je nutné nadefinovat proměnnou test, do níž zadáme výraz jazyka Java. Např. výraz z následujícího příkladu říká: toto pole sendNews je validní pouze tehdy, je-li uveden email a věk je větší nežli 17, nebo není-li zadána hodnota.

      
  <field property="sendNews" depends="validwhen">
    <arg0 key="registration.sendNews"/>
    <var>
      <var-name>test</var-name>
      <var-value>(((email != null) && (age>17)) or (*this* == null))</var-value>
    </var>
  </field>

Vytváření vlastních pravidel na bázi regulárních výrazů

K tomuto účelu nám poslouží mocné pravidlo mask. Chceme-li definovat například formát PSČ, odpovídající regulární výraz je \d{3}(\ )?\d{2}. Každý regulární výraz validátoru musí začínat znakem ^ a končit znakem $. Jednoduchý příklad by tedy vypadal takto:

      
  <field property="zip" depends="mask">
    <arg0 key="registration.zip"/>
    <msg  name="mask" key="registration.zip.invalid"/>
    <var>
      <var-name>mask</var-name>
      <var-value>^\d{3}(\ )?\d{2}$</var-value>
    </var>
  </field>

Modul Validator a i18n

Validátor obsahuje stejně jako ostatní části Struts plnou podporu internacionalizace. Obvyklým postupem je, že definujeme sadu globálních konstant (např. některé univerzální regulární výrazy) společných pro většinu lokalizací. Dále již definujeme formuláře pro danou lokalizaci uvnitř elementu formset, včetně společných konstant pro danou lokalizaci. Příklad ukazuje kontrolu formuláře s jednou položkou pro britské a české prostředí.

      
<form-validation>
  
  <global>
    <constant>
      <constant-name>zip</constant-name>
      <constant-value>^[\d|\w]{3}(\ )?[\d|\w]{3}$</constant-value>
    </constant>
  </global>
  
  <formset language="cs" country="CZ">
    <constant>
      <constant-name>zip</constant-name>
      <constant-value>^\d{3}(\ )?\d{2}$</constant-value>
    </constant>
    <form name="RegistrationForm">
      <field property="zip" depends="required,mask,minlength">
        <arg0 key="registration.zip"/>
        <arg1 name="minlength" key="${var:minlength}" resource="false"/>
        <msg  name="mask" key="registration.zip.invalid"/>
        <var>
          <var-name>minlength</var-name>
	  <var-value>5</var-value>
        </var>
        <var>
          <var-name>mask</var-name>
	  <var-value>${zip}</var-value>
        </var>
      </field>
    </form>
  </formset>

  <formset language="en" country="UK">
    <form name="RegistrationForm">
      <field property="zip" depends="required,mask,minlength">
        <arg0 key="registration.zip"/>
        <arg1 name="minlength" key="${var:minlength}" resource="false"/>
        <msg  name="mask" key="registration.zip.invalid"/>
        <var>
          <var-name>minlength</var-name>
	  <var-value>5</var-value>
        </var>
        <var>
          <var-name>mask</var-name>
	  <var-value>${zip}</var-value>
        </var>
      </field>
    </form>
  </formset>

</form-validation>

Příště

Probereme část Controller, konkrétně akce Struts.

Verze pro tisk

DISKUZE nepíše se standardní s D? 14.4.2005 06:57 Petr Šigut   Re: nepíše se standardní s D? 14.4.2005 10:27 Miroslav Holubec Zobrazit označené Zobrazit vše Příspívat do diskuze mohou pouze registrovaní uživatelé.