ARCHIV

Apache Struts (6) - akce Struts

Dostáváme se k části řadiče rámce Struts, probereme si jednotlivé druhy akcí a ukážeme jejich konfiguraci ve struts-config.xml.

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

org.apache.struts.action.Action

je základem celého rámce, v potomcích této abstraktní třídy se nachází veškerá rozhodovací logika, jenž určuje řízení toku, a zároveň tvoří můstek mezi požadavkem klienta a business logikou naší aplikace. Každý potomek této třídy by se měl zabývat jedním specifickým úkolem, který by měl předat do vnitřní logiky k vyřízení, a posléze vyhodnotit výsledek a určit kam předat další řízení toku. Typickým představitelem je dialog pro změnu hesla uživatele. Uživatel odešle do akce formulář s hodnotou starého hesla a nového zadaného pro kontrolu dvakrát. Konfigurace v souboru struts-config.xml vypadá takto:

  <form-beans>
    <form-bean name="PasswordForm" type="org.apache.struts.validator.DynaValidatorForm">
      <form-property name="oldPassword" type="java.lang.String" />
      <form-property name="password" type="java.lang.String" />
      <form-property name="password2" type="java.lang.String" />
    </form-bean>
  </form-beans>
  
  <action-mappings>
    <action path="/password/change" 
               type="cz.linuxsoft.web.struts.shop.actions.PasswordAction" 
	       name="PasswordForm" 
	       scope="request" 
	       input="/pages/password.jsp" 
	       validate="true">
      <forward name="failure" path="/pages/password.jsp" />
      <forward name="success" path="/pages/welcome.jsp" />
    </action>
  </action-mappings>

Veškerou kontrolu dat na úrovni prezentační části provedeme validátorem Struts. Všechny políčka formuláře jsou nutné, nové heslo má minimální delku 5 znaků a validátor ještě musí ověřit, zda jsou nová hesla stejná. Řešení můžete brát jako domácí úkol, každopádně pokud byste si nevěděli rady, nezoufejte a stahujte z odkazu uvedeného níže...

Samotná akce dědí metodu nadtřídy pojmenovanou execute(), jenž vrací objekt typu ActionForward, což je vlastně přesměrování na další akci či JSP stránku. Následuje komentovaný kód, myslím si, že je natolik čitelný, že už nepotřebuje další výklad. Snad jen ukládání zpráv do requestu (požadavku) si zaslouží menší ujasnění - nejprve je nutné vytvořit objekt ActionMessages, do kterého postupně přidáváme samotné zprávy, které nakonec uložíme do requestu pomocí metody saveMessages() nebo saveErrors().

public class PasswordAction extends Action
{

  public ActionForward execute(ActionMapping       mapping, 
                               ActionForm          form, 
                               HttpServletRequest  request, 
                               HttpServletResponse response) 
                               throws Exception
  {
    //vytvoř nový objekt messages pro předání informací zpět na stránku jsp
    ActionMessages messages = new ActionMessages();
    //zkopíruj form do objektu DTO
    Password password = new Password();
    BeanUtils.copyProperties(password, form);
    //vytvoř novou business funkci
    BeanBusiness function = new PasswordChange();
    //směruj tok dle úspěchu změny hesla
    if (function.perform(password) == null)
    {
      messages.add(ActionMessages.GLOBAL_MESSAGE, 
                   new ActionMessage("password.change.failure"));
      //ulož chyby do requestu
      super.saveErrors(request, messages);
      return (mapping.findForward(Forwards.FAILURE));
    }
    else
    {
      messages.add(ActionMessages.GLOBAL_MESSAGE, 
                   new ActionMessage("password.change.success"));
      //ulož zprávy do requestu
      super.saveMessages(request, messages);
      return (mapping.findForward(Forwards.SUCCESS));
    }
  }
}

Akce je zadefinována v konfiguraci Struts značkou action, viz. níže. Attribut path je povinný a určuje mapování url na tuto akci, type určuje javovskou třídu akce, která bude prováděna. name je nepovinným attributem a tvoří spojnici mezi přiřazením formuláře a akce, zatímco scope určuje oblast jeho uložení (request nebo session, přičemž výchozí je session!!!). Následuje input, který je nutný v případě zapnuté validace (ono validate="true"). Pokud dojde k chybě při kontrole, akce předá řízení na jsp stránku nebo akci určenou právě pomocí input, kde se pomocí značky <html:errors /> chyby objeví.

Vnořené značky forward slouží k předávání toku dále. K tomuto účelu slouží objekty ActionForward, které vrací samotné metody akcí. Zde se např. příkazem return (mapping.findForward("succes")); předá tok na stránku /pages/welcome.jsp.

  <action path="/password/change" 
             type="cz.linuxsoft.web.struts.shop.actions.PasswordAction" 
	     name="PasswordForm" 
	     scope="request" 
	     input="/pages/password.jsp" 
	     validate="true">
    <forward name="failure" path="/pages/password.jsp" />
    <forward name="success" path="/pages/welcome.jsp" />
  </action>

org.apache.struts.action.DispatchAction

Mnohdy by se nám hodilo, použít akci s jedním formulářem na vícero použití. Objekt Action se k tomuto účelu použít nedá, z toho důvodu, že obsahuje pouze jedinou metodu. Právě v těchto případech použijeme třídu DispatchAction. Její použití je obdobné jako u Action, s tím rozdílem, že nemá předdefinovanou metodu execute(), ale může obsahovat těchto metod se stejnými parametry jako execute() několik. Tyto metody lze poté volat rovnou dle určeného parametru příchozího požadavku. Použití je zřejmé, akce, která provádí podobné operace se stejným formulářem, tím pádem není nutné definovat zvlášť. Třída obsahuje možnost definovat dvě speciální metody, jedna unspecified(mapping,form,request,response) je volána pokaždé, když v requestu není definována hodnota parametru, dle kterého má být určena metoda, jenž se bude volat. Druhou jest cancelled(mapping,form,request,response), která se provede pokud stiskneme tlačítko Cancel definované značkou html:cancel. Jednoduchým příkladem je katalog zboží, kde můžeme zboží přídávat, odebírat a měnit - tyto tři metody lze nadefinovat do jediné třídy, přičemž mají definovaný společný formulář a validaci. Následuje jednoduchý příklad třídy...

public class CommodityAction extends DispatchAction
{

  public ActionForward update (ActionMapping       mapping, 
                               ActionForm          form, 
                               HttpServletRequest  request, 
                               HttpServletResponse response) 
                               throws Exception
  {
    //proveď business logiku
    return (mapping.findForward(Forwards.SUCCESS));
  }

  public ActionForward add    (ActionMapping       mapping, 
                               ActionForm          form, 
                               HttpServletRequest  request, 
                               HttpServletResponse response) 
                               throws Exception
  {
    //proveď business logiku
    return (mapping.findForward(Forwards.SUCCESS));
  }

}

... a její definice ve Struts configu. Důležitý je atribut parametr, který říká, jak je pojmenována v requestu proměnná, jenž definuje název metody, kterou budeme volat. Tuto můžeme nastavit na jsp stránce buďto pomocí značky html:hidden, nebo pomocí přidání parametru přímo do odkazu /commodity/change?do=update.

  <action path="/commodity/change" 
             type="cz.linuxsoft.web.struts.shop.actions.CommodityAction" 
	     name="CommodityForm" 
	     scope="request" 
	     input="/pages/commodity.jsp"
	     parameter="do"
	     validate="true">
    <forward name="failure" path="/pages/commodity.jsp" />
    <forward name="success" path="/pages/commodity.jsp" />
  </action>

org.struts.action.ForwardAction, org.struts.action.RedirectAction

Zvláštním typem tříd je ForwardAction a RedirectAction. Jsou určeny pro naše přímé použití, nemusíme tedy vytvářet jejich přímé potomky, přičemž slouží k přesměrování toku aplikace, nejčastěji přímo na JSP stránku. Dosáhnout přesměrování přímo odkazem totiž není příliš vhodné vzhledem k tomu, že je důležité, abychom měli veškeré řízení toku na jednom místě, aby veškerý provoz šel přes část Řadič (Controller) a to bychom přímým směrováním obešli. Definice této akce vypadá následovně:

    <action path="/password" 
               forward="/pages/password.jsp" 
	       name="PasswordForm" 
	       input="/pages/welcome.jsp" 
	       validate="false" 
	       scope="request" 
	       parameter="/pages/password.jsp" />

Struts poznají, že se jedná o tyto třídy použitím atributu forward nebo redirect. Obě třídy dosahují stejného cíle, tedy přesměrování, používají však jiné metody. ForwardAction toho docílí vnitřním přesměrováním, klient tedy vůbec netuší, že byl přesměrován, nedochází k přepisu URL a důležité je, že jsou zachovány atributy v requestu. Narozdíl od tohoto přístupu, RedirectAction pošle klientovi zprávu, aby načetl jinou URL - ten to ovšem nemusí umět nebo to může jinak ignorovat, a další nevýhodou pak je, že ztratíme veškeré informace předtím uložené v requestu.

Ke stažení

Současná podoba aplikace

Příště

Rozšíříme si objekt řadiče Struts, konkrétně ActionController, a ukážeme si jednoduché ověřování business logiky.

Verze pro tisk