Struts 2 (Basics)


Inhalt:

Konfiguration
Action "GeometricModelAction"
struts.xml
JSP
Anwendung starten

Eine aktuelle Version für JakartaEE10, WildFly 33 und Struts 7 findet sich hier.

Dieses Beispiel baut auf der gleichen Logik auf wie die JSP-Beispiel, es existiert also nur eine Web-Anwendung mit minimaler Programmlogik. Bereits durchgeführte Berechnungen werden in der Session gespeichert.

Hier gibt es das Projekt als WAR-Export-Datei: StrutsBasics.war.

Die Seite des Struts-Projekts: http://struts.apache.org/

Ein Struts 2-Tutorial: http://www.roseindia.net/struts/struts2/index.shtml.


Konfiguration

Wir benötigen Struts 2.3.16.
Folgende Dateien müssen nach WEB-INF\lib kopiert werden damit die simple Anwendung sich deployen läßt (falls man die Dateien nicht über Eclipse kopiert, dann muss anschließend im Project Explorer-Contextmenü "Refresh" gewählt werden, damit Eclipse die Dateien sieht):

Hinweis: frühere Struts2-Versionen können beim Deploy zu Fehlern oder Warnungen führen, zum Teil weil JBoss-spezifischer Code fehlt, oder auch wegen Validierungsfehlern in Deploymentdescriptoren.


Außerdem muss folgendes in web.xml eingetragen werden:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns="http://java.sun.com/xml/ns/javaee"
  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" 
  id="WebApp_ID" version="3.0">
  
  <display-name>StrutsBasics</display-name>
  <welcome-file-list>
    ...
  </welcome-file-list>
    <filter>
    <filter-name>struts</filter-name>
    <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>struts</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
</web-app>

Hinweis: vor Struts 2.1.3 war folgender Filter zu deklarieren:
  <filter>
    <filter-name>struts</filter-name>
    <filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>struts</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
Das führt in späteren Versionen zu einer "deprecated"-Warnung beim Deploy!

Action "GeometricModelAction"

Zuallererst fügen wir die Struts-Action "GeometricModelAction" zu, die die Anwendungslogik enthält.
Ihr Klassenrumpf sieht so aus: 
import org.apache.struts2.interceptor.SessionAware;
import com.opensymphony.xwork2.ActionSupport;

public class GeometricModelAction extends ActionSupport implements SessionAware
{
  private Map<String, Object> session;

  @Override
  public void setSession(Map<String, Object> session)
  {
    this.session = session;
  }
  
  ...
}
Die Parentklasse com.opensymphony.xwork2.ActionSupport markiert die Klasse als Struts-Action, d.h. eine Klasse die bei einem Form-Submit aufgerufen wird. Anmerkung: diese Parentklasse muss nicht zwingend angegeben werden.
Das Interface org.apache.struts2.interceptor.SessionAware wird implementiert damit die Session-Daten als Map mittels der Interface-Methode setSession in die Klasse geschrieben wird. Wir benutzen sie um die Historie der Berechnungen zu speichern.

Jetzt werden der Klasse Properties zugefügt: 
  private double dblA = 0;
  private double dblB = 0;
  private double dblC = 0;
  
  private double dblOberflaeche = 0;
  private double dblVolumen = 0;
  
  private Historie historieGesamt = null;
  
  public double getA()
  {
    return dblA;
  }
  public void setA(double dblA)
  {
    this.dblA = dblA;
  }

  public double getB()
  {
    return dblB;
  }
  public void setB(double dblB)
  {
    this.dblB = dblB;
  }

  public double getC()
  {
    return dblC;
  }
  public void setC(double dblC)
  {
    this.dblC = dblC;
  }

Es gibt get-Properties für die aktuell berechneten Werte sowie die Historie: 
  private double dblOberflaeche = 0;
  private double dblVolumen = 0;
  
  private Historie historieGesamt = new Historie();

  public Historie getHistorieGesamt()
  {
    if (this.session == null)
    {
      throw new NullPointerException("session nicht gesetzt !");
    }
    if (this.session.get("historieGesamt") == null)
    {
      this.session.put("historieGesamt", new Historie() );
    }
    this.historieGesamt = (Historie) this.session.get("historieGesamt");
    return this.historieGesamt;
  }
  
  public double getVolumen()
  {
    return this.dblVolumen;
  }
  
  public double getOberflaeche()
  {
    return this.dblOberflaeche;
  }
getHistorieGesamt hat eine Besonderheit: beim ersten Abrufen innerhalb des Requests wird die Historie aus der Session geholt. Ist dieses nicht vorhanden (erster Aufruf der Seite), so wird es gesetzt. Struts 2 bietet leider keine so eleganten Wege wie JSF, Daten in der Session zu speichern.


Schließlich wird die Methode execute der Basisklasse ActionSupport überladen, die beim Klick auf "Submit" aufgerufen wird und die Berechnung durchführt sowie die aktuelle Berechnung der Historie zufügt. 
  public String execute() throws Exception
  {
    //Ausrechnen:
    this.dblVolumen = this.dblA * this.dblB * this.dblC;
    this.dblOberflaeche = 2 * (this.dblA * this.dblB) + 2 * (this.dblA * this.dblC) + 2 * (this.dblB * this.dblC);
    
    //Zufügen zur Historie !
    Seitenlaengen seitenlaengeAktuell = new Seitenlaengen();
    seitenlaengeAktuell.setA(this.dblA);
    seitenlaengeAktuell.setB(this.dblB);
    seitenlaengeAktuell.setC(this.dblC);
    
    //Die Historie per Get-Methode abrufen damit sie bei Bedarf erzeugt wird.
    this.getHistorieGesamt().addSeitenlaenge( seitenlaengeAktuell );

    return Action.SUCCESS;
  }
Zur Rückgabe einer Execute-Methode wird in der Config-Datei die zugehörige Zielseite deklariert.


Zur Info: falls man auf den eigentlichen Servlet-Request zugreifen will, so muss man das Interface org.apache.struts2.interceptor.ServletRequestAware implementieren, das zu einer Methode setServletRequest führt: 
public class GeometricModelAction extends ActionSupport implements ServletRequestAware
{
  private HttpServletRequest request;

  public void setServletRequest(HttpServletRequest httpServletRequest)
  {
    this.request = httpServletRequest;
  }
  
  ...
}
Falls man nur Daten in den Request stecken will, die z.B. auf der Zielseite verfügbar sein sollen, so kann man das Interface org.apache.struts2.interceptor.RequestAware implementieren, das analog zum Servlet-Request die Attribute in einer Map ablegt.
Vorteil dieser Maps ist, dass dadurch die Actions unabhängig vom Webserver werden, und z.B. in Unit-Tests angesprochen werden können.


struts.xml

Die Konfiguration des Struts-Frameworks erfolgt primär in der Datei "struts.xml". Diese liegt NICHT in WEB-INF, sondern muss ins Verzeichnis "src" (im Eclipse: "Java Resources:src") gepackt werden damit sie beim Compilieren und Deploy in "classes" landet, wo Struts sie sucht. 
<DOCTYPE struts PUBLIC
    "-//Apache Software Foundation//DTD Struts Configuration 2.3//EN"
    "http://struts.apache.org/dtds/struts-2.3.dtd">
<struts>
    <constant name="struts.devMode" value="true"/>
    <package name="strutsbasics" extends="struts-default">
        <action name="geometricmodel" class="de.fhw.komponentenarchitekturen.knauf.strutsbasics.actions.GeometricModelAction">
            <result>/geometricmodel.jsp</result>
            <result name="input">/geometricmodel.jsp</result>
        </action>
    </package>
</struts>

Hier wird ein Konfigurationspaket deklariert, das seine nicht explizit gesetzten Werte von einer Struts-internen Konfiguration "struts-defaults" erbt und "strutsbasics" heißen soll.
Es wird die Action GeometricModelAction registriert und es wird angegeben zu welcher Seite man von der execute-Methode springen soll. Im Element result gibt man normalerweise den Rückgabewert der execute-Methode an, für die diese Regel gilt. In unserem Fall gibt es nur die Rückgabe "success", dies ist gleichzeitig Default-Wert des Elements. Die Langversion würde so aussehen: 
   <result name="success">/geometricmodel.jsp</result>
Ein zweites Element result namens input gilt für den Fehlerfall: wenn man z.B. Buchstaben ins Zahlenfeld eingibt, dann erkennt Struts, dass es diese Eingabe nicht in die entsprechende Feldproperty (die den Datentyp java.lang.Integer hat) setzen kann, und wird erneut das Eingabeformular anzeigen - mit einer Fehlermeldung versehen.
   <result name="input">/geometricmodel.jsp</result>



Hinweis: "devMode":
Das Struts-Framework mittels der Konstantendeklaration "struts.devMode" in den Entwicklermodus versetzt werden, der strenger auf z.B. Konfigurationsfehler reagiert und uns zu sauberem Arbeiten zwingt ;-).
Das führt z.B. dazu, dass bei Fehleingaben (Buchstaben in Textfeldern) ohne eine Konfiguration des result name="input" eine Exception fliegt, statt einfach wieder die Eingabeseite anzuzeigen: 
No result defined for action de.fhw.komponentenarchitekturen.knauf.strutsbasics.actions.GeometricModelAction and result input
Deshalb wird ein Result namens "input" deklariert ("input" bedeutet hier: "wegen Fehlern in der Seite erneut zur Eingabe springen"). Bei nicht aktiviertem "devMode" springt die Anwendung automatisch zur Seite mit dem fehlerhaften Formular, im "devMode" sind wir gezwungen, diesen Fall sauber zu konfigurieren.

Außerdem führt der "devMode" allgemein zu mehr Konsolenausgaben bei Fehlern, die Struts intern abfängt, deshalb sollte er immer aktiviert werden.
Mehr Infos: http://struts.apache.org/release/2.3.x/docs/devmode.html



JSP

Wir fügen eine JSP-Seite "geometricmodel.jsp" zu.
Sie sieht so aus: 
<?xml version="1.0" encoding="ISO-8859-1" ?>
<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%>
<%@ taglib prefix="s" uri="/struts-tags" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Test für Struts2</title>
</head>
<body>

  <s:form action="geometricmodel">
    <s:if test="volumen > 0.0">
      Volumen: <s:property value="volumen"/> <br/>
      Oberfläche: <s:property value="oberflaeche"/> <br/>
    </s:if>
  
    <s:textfield name="a" label="Kante a"></s:textfield> <br/>
    <s:textfield name="b" label="Kante b"></s:textfield> <br/>
    <s:textfield name="c" label="Kante c"></s:textfield> <br/>
    <br/>
    <s:submit value="Berechnen"></s:submit>
  </s:form>
  
  <%--Historie ausgeben: --%>
  <s:if test="historieGesamt.size > 0">
    Historie:<br/>
    <s:iterator value="historieGesamt.iterator" status="currentStatus">
      <s:property value="#currentStatus.index"/>: a=<s:property value="a"/>, b=<s:property value="b"/>, c=<s:property value="c"/> <br/>
    </s:iterator>
  </s:if>

</body>
</html>

Die Elemente im Einzelnen:


Anwendung starten

Die Anwendung wird durch Aufruf von http://localhost:8080/StrutsBasics/geometricmodel.jsp gestartet.
Stand 04.02.2014
Historie:
07.10.2011: Erstellt aus Vorjahresbeispiel, Struts 2.2.3.1, Anpassungen an JBoss6
02.05.2013: Struts 2.3.14
05.05.2013: Deployment-Deskriptoren korrigiert (unnötige "xmlns"-Deklaration entfernt).
04.02.2014: Struts 2.3.16