Struts

Besoin

Fournir un framework Web Java Open Source prenant en charge :

• la séparation des IHM et des processus métiers
• le contrôle de saisie des formulaires
• diverses optimisations (pooling)

Analyse

Struts externalise les interactions entre requête et actions ainsi que le contrôle de validité des formulaires.

Conception

Struts applique le DP MVC qui répartit les responsabilités entre :

• (M)odèle : les form beans représentant les données saisies dans des formulaires. D'un point de vue global, les form beans ne représentent qu'un modèle de présentation, c'est-à-dire un moyen de récolter les informations saisies par l'utilisateur mais qui ne correspond pas forcément au véritable modèle, généralement situé dans des JavaBeans ou des EJB métier annexes.
• (V)ue : les JSP, utilisant des balises Struts.
• (C)ontrôleur MVC2, combinaison de :
  • une servlet unique
  • des actions déclenchées par cette servlet (DP Commande/Action).

Lors de la réception d'une requête Web, la servlet de Struts examine l'URL demandé et lui cherche une correspondance (mapping) dans les classes d'actions spécifiées par le développeur. Une instance de cette classe d'action est récupérée (d'un pool) et exécutée.

Cette exécution effectue divers appels métiers, prépare généralement un formulaire (form bean) nécessaire à la vue. et retourne un code symbolique indiquant le résultat de son action. La servlet reçoit ce code et lui troue une correspondance (mapping) de vue (JSP) à afficher.

La JSP importe les balises Struts et les utilise pour insérer simplement des données du formulaire (form bean) dans la page retournée à l'utilisateur.

Implémentation

Les formulaires sont des JavaBeans héritant de org.apache.struts.action.ActionForm. Etant gérés dans un pool, ils doivent avoir un constructeur par défaut.

Les vues sont des JSP utilisant des TagLibs Struts telles que :

• struts-html pour la construction de code HTML (y compris formulaires depuis Struts 1.1)
• struts-bean pour l'accès aux propriétés de JavaBeans (modèles)
• struts-nested pour la version de ces TagLib intégrant la notion de hiérarchie
• etc.

Tout formulaire se :

1. réinitialise via sa méthode reset()
2. remplit à partir d'une requête (soumission d'un formulaire HTML) via sa méthode populate()
3. valide (accepte ou rejete les données qu'il contient) via sa méthode validate().

Contrôleur

Le contrôleur est constitué de :

• une servlet unique : org.apache.struts.action.ActionServlet fournie par Struts ou dérivée
• des actions à implémenter, dérivant de org.apache.struts.action.Action. En tant que commande, une action n'a qu'à redéfinir le code de sa méthode execute() pour indiquer ce qu'elle fait lorsqu'on l'invoque. Cette méthode retourne un ActionForward représentant le résultat de l'exécution. C'est en fonction de ce résultat que la prochaine vue à afficher (ou autre action à exécuter) est choisie d'après la configuration Struts. Cependant, plusieurs autres actions plus spécialisées sont disponibles :
  • DispachAction, qui exécute telle ou telle méthode (pas uniquement execute()) en fonction d'un paramètre de la requête soumise. Ceci est pratique lorsque l'action varie fortement en fonction des paramètres (création, suppression, mise à jour par exemple).
    • LookupDispatchAction qui considère le paramètre d'action comme provenant directement des boutons de l'interface utilisateur.
  • ForwardAction, qui n'effectue rien d'autre que de rediriger vers une destination (une vue typiquement). Ceci évite d'avoir à écrire des classes d'action aussi simples.

Configuration

Une WebApp utilisant Struts ajoute sous son répertoire WEB-INF un (ou plusieurs) fichier(s) de configuration Struts définissant :

• les sources de données éventuelles.
• les formulaires (form-beans)
• les redirections globales (global forwards)
• les correspondances (action-mappings) entre requêtes, actions à exécuter et formulaires utilisés
• les ressources d'internationalisation

Struts		Version	1		Commentaire
		Release	0	1
Module	Technologie	FixPack	1
Java	J2SE		1.2
	JDBC		2.0		Optionnel
	Servlet		2.2
	JSP		1.1
Commons	DBCP		GenericDataSource (non JNDI)	Oui	DataBase Connection Pool
	File Upload			Oui
	Logging			Oui
	Pool			Oui	Pooling d'objets
	Services			Oui
	Validator		Contribution	Oui	Validation de formulaires via expressions régulières, code JavaScript généré
	BeanUtils		org.apache. struts.utils	Oui	Introspection via des scriplets
	Collections		org.apache. struts.utils	Oui
	Digester		org.apache. struts.digester	Oui	XMLMapping XML vers Java, souvent utilisé pour la lecture de fichiers de configuration.
XML	JAXP		1.0	1.1
DTD	Message-Resources		Non	Oui	Internationalisation
Erreurs	Declarative		Non	Oui
Formulaires	ActionForm		Oui		Formulaires implémentés (classes)
	DynaBeans		Non	Oui	Formulaires déclaratifs (XML)
Actions	Action		Oui
	DispachAction		Non	Oui
		LookupDispatchAction
	ForwardAction		Non	Oui
TagLib	Tiles				Framework d'assemblage de JSP
	Html	options	Oui
		option	Oui
		optionsCollection	Non	Oui	Remplir des options HTML à partir d'une collection.
		message	Oui		Insertion d'un libellé.
		messages	Non	Oui	Itération d'une collection de messages dans la classe ActionMessages.
		ActionForm	Oui
		image	Oui
		img	Oui
		SubmitTag, SelectTag, LinkTag.java, CheckboxTag, ButtonTag, ImageTag, RadioTag, and TextArea tags	Oui
	Logic	empty/notEmpty	Non	Oui
	Nested				Taglib
	Beans	write	Non	Oui
		cookie	Non	Oui
		header	Non	Oui
		parameter	Non	Oui
Util	LocalStrings		Non	Oui
	LabelValueBean		Non	Oui	Collection clés/valeurs utilisables pour la baslise <html:options> ou ailleurs.
	MessageResources		Non	Oui	Escape any single quote characters that are included in the specified message string.
	computeParameters		Non	Oui	Allow a transaction token to be the only parameter in .
	RequestUtils		Non	Oui	Change to encode ampersands when building a query string.

Notes

• les formulaires
  • peuvent stocker des données relatives à une ou plusieurs pages
• Les actions
  • appliquent le DP Commande.
  • sont le prolongement du code de la servlet contrôleur, ce qui implique que :
    • elles ne sont pas thread-safe
    • elles adaptent les requête HTTP à la véritable logique métier indépendante du Web (DP adaptateur)
• les sources de données Struts
  • (obsolète) une (GenericDataSource) est livrée pour les infrastructures qui en manquent (Tomcat par exemple).
  • ne sont pas recommandées à moins de ne disposez d'aucun pool de connexion (dans Tomcat par exemple). En effet elles ne sont pas performantes et ne sont accessibles qu'à partir du ServletContext de la WebApp. Mieux vaut leurs préferer les sources de données fournies par le serveur applicatif (WAS, WLS), qui ont l'avantage d'être plus performantes et accessibles via le service de nommage (API JNDI). Des DataSource JNDI existent depuis Struts 1.1
• Le travail d'initialisation/de terminaison peut être réalisé via un plugin Struts plutôt que par une servlet de contrôle spécialisant celle de Struts.

Exemples

• Actions
  • Gestion des compétences KiCsa
• Configuration Struts
  • Configuration Struts de KiCsa
• JSP Struts
  • JSP de la WebApp KiCsa

Limitations

• Pas de vérification de la provenance lors de l'exécution d'une action (pas d'automate en somme).
• Commence à être relativement obsolète, notamment à cause de sa contraire de compatibilité ascendante. Voir son successeur Shale.

Voir

• Struts
  • Téléchargement
  • Guide de l'utilisateur
  • API
  • Validateur
    • Struts validator par David winterfeldt
  • Didacticiel
    • Struttin' with Struts de Rick Reumann
    • Jakarta Struts : Seven lessons from the trenches de Chuck Cavaness (onJava.com)
• Alternatives/compléments
  • JSTL
  • JSF
  • Tapestry
• Développement
  • Javanovic Karapan Sapi Struts Generator
• Test
  • Struts TestCase for JUnit - Test des actions Struts hors ou à l'intérieur d'un conteneur Web.
• Husted - More about Struts
• Struts controller UML diagram par Jean-Michel Garnier
• 2002 AJUG Meeting - Struts: MVC framework for JSP
• 2002 AJUG Meeting - Java Struts 1.1: Ready for prime time