Servlets et JSP : la JSTL

Sommaire

Utiliser le langage d'expression (EL)
Java Standard Tag Library
Récupérer et installer la JSTL
Utiliser la JSTL
Les filtres
Les listeners
Balises personnalisées

Utiliser le langage d'expression (EL)

Depuis la version 2.0 des JSP, il est possible de placer à n'importe quel endroit d'une page JSP des expressions qui sont évaluées et remplacées par le résultat de leur évaluation. La syntaxe est la suivante :

 ${ expression }

Voila quelques exemples d'utilisation :

${bean.property} accès à une propriété d'un bean,
${bean.property1.property2} suivre un chemin pour avoir accès à une propriété d'un bean,
${list[index]} accès à un élément indicé (Array,Map, List),

Travail à faire :

Prenez un peu de temps pour lire cette présentation du langage d'expressions.
Vous pouvez maintenant modifier votre TP précédent en utilisant les expressions à la place des scriptlets pour initialiser les champs de votre formulaire et/ou visualiser les propriétés du bean personne.

Préparez le javabean ci-dessous :

package myapp.servlet;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {

    private String name;
    private Student bestFriend;
    private Integer age;

}

Préparez la servlet ci-dessous. Cette dernière prépare des données et appelle la page students.jsp :

package myapp.servlet;

import java.io.IOException;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

@WebServlet("/students")
public class StudentsServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;

    public void doGet(HttpServletRequest request, //
            HttpServletResponse response//
    ) throws ServletException, IOException {
        // les étudiants
        Student john = new Student("John", null, 23);
        Student anne = new Student("Anne", john, 25);
        Student amine = new Student("Amine", anne, 27);
        // la liste des étudiants
        var students = List.of(john, anne, amine);
        // les étudiants par leur nom
        Map<String, Student> names = new HashMap<>();
        students.forEach((s) -> {
            names.put(s.getName(), s);
            request.setAttribute(s.getName(), s);
        });

        // dans la zone request
        request.setAttribute("students", students);
        request.setAttribute("names", names);
        request.setAttribute("today", new Date());
        // dans la session
        request.getSession().setAttribute("anne", anne);
        request.getSession().setAttribute("today", "Hier");
        // dans la zone application
        request.getSession().getServletContext()//
                .setAttribute("today", "Avant-hier");
        // appel de la page JSP
        request.getRequestDispatcher("/myapp/students.jsp")//
                .forward(request, response);
    }

}

Terminez par la page JSP et testez la servlet :

students.jsp

<html>
<body>
  <p>Age de Anne est ${anne.age}</p>
  <p>Aujourd'hui nous sommes le ${today}</p>
</body>
</html>

Préparez, dans la page JSP, un paragraphe pour afficher le nom du meilleur amie de Anne. Faites de même pour John. Vous observerez la gestion assez souple des null.
Préparez un paragraphe pour afficher le troisième étudiant (en utilisant la liste students).
Il est possible d'appeler une méthode avec la forme nom_de_méthode(). Affichez ainsi le nombre d'étudiants (méthode size()).
Affichez ensuite la date (variable today). Faites de même pour la version stockée en session en utilisant la variable implicite sessionScope. Continuez avec la version stockée dans la zone application (variable implicite applicationScope).
Préparez, dans la servlet, une nouvelle donnée qui regroupe les caractères spéciaux de HTML (<>&'"). Affichez cette donnée avec une EL. Les caractères spéciaux ne sont pas protégés et nous pouvons donc avoir une injection HTML/javascript.

Java Standard Tag Library

Le but de cet exercice est de se familiariser avec l'utilisation de librairie de balises et notamment de la JSTL (Java Standard Tag Library).

Récupérer et installer la JSTL

Documentations :

Travail à faire : Ajoutez la dépendance ci-dessous dans le fichier pom.xml :

<!-- pour utiliser la JSTL -->
<dependency>
    <groupId>jakarta.servlet.jsp.jstl</groupId>
    <artifactId>jakarta.servlet.jsp.jstl-api</artifactId>
</dependency>
<dependency>
    <groupId>org.glassfish.web</groupId>
    <artifactId>jakarta.servlet.jsp.jstl</artifactId>
</dependency>

Remarque : Je vous encourage fortement à lire (après le TP) le cours sur la JSTL (lien ci-dessus). Il explique bien le fonctionnement de ses balises et donne de nombreux exemples.

Utiliser la JSTL

Pour utiliser la JSTL dans une application basée sur un conteneur WEB respectant le standard JSP 2.0, il suffit de copier dans le répertoire WEB-INF/lib de votre application WEB les fichiers *.jar qui se trouvent dans la distribution de la JSTL. Ce travail est déjà réalisé par Maven.

Il est notamment inutile de copier les fichiers .tld. Ceux-ci se trouvent dans les .jar et sont pris en compte automatiquement. Une fois le contexte de votre application relancé, vous pouvez essayer la page suivante :

<html>
<body>

<!-- controle, iterations, tests, variables -->
<%@ taglib prefix="c" uri="jakarta.tags.core" %>
<!-- traitement XML -->
<%@ taglib prefix="x" uri="jakarta.tags.xml" %>
<!-- formattage des donnees -->
<%@ taglib prefix="fmt" uri="jakarta.tags.fmt" %>
<!-- SQL/JDBC -->
<%@ taglib prefix="sql" uri="jakarta.tags.sql" %>

<!-- Un exemple de test -->
<c:if test="${param.size() > 0}">
        <p>Il y a des paramètres.</p>
</c:if>

<!-- Un exemple de boucle -->
<p>Les parametres:</p>
<ul>
<c:forEach var="aParam" items="${param}">
  <li>un parametre :
    <c:out value="${aParam.key}"/> = <c:out value="${aParam.value}"/>
  </li>
</c:forEach>
</ul>

<!-- Une étude de cas -->
<c:choose>
  <c:when test="${param['question'] == 'oui'}">
     <p>OUI</p>
  </c:when>
  <c:otherwise>
     <p>NON</p>
  </c:otherwise>
</c:choose>

</body>
</html>

Travail à faire :

Modifiez vos pages JSP afin d'utiliser la balise c:out (voir exemple ci-dessus). Vous ne devriez plus avoir d'injection de code HTML.
Utilisez dans vos pages JSP la balise c:url pour construire les URL des liens vers les servlets ou les autres pages JSP (exemple ci-dessous). Vérifiez le code généré par cette balise.
```
<%@ taglib prefix="c" uri="jakarta.tags.core" %>

...

<c:url var="lister" value="/lister.jsp" />

<a href="${lister}">Lister</a>
```
Construisez une boucle (avec c:forEach) pour afficher un tableau des étudiants (nom, age et meilleur ami). Si l'age est supérieur à 24, l'afficher en gras (avec c:if ou c:choose). Si l'étudiant n'a pas de meilleur ami, affichez la chaîne personne (avec c:out et l'attribut default).

Les filtres

Créez dans votre application le filtre ci-dessous (en adaptant l'URL des adresses à traiter) :

package myapp.servlet;

import java.io.IOException;
import jakarta.servlet.DispatcherType;
import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpServletRequest;

@WebFilter(
    dispatcherTypes = {
        DispatcherType.REQUEST, DispatcherType.FORWARD,
        DispatcherType.INCLUDE, DispatcherType.ERROR
    },
    urlPatterns = { "*" }
)
public class SimpleFilter implements Filter {

    public void init(FilterConfig fConfig) throws ServletException {
    }

    public void destroy() {
    }

    public void doFilter(ServletRequest request, ServletResponse response,
        FilterChain chain)
        throws IOException, ServletException
    {
        System.err.printf("Before %s\n", request);
        if (request instanceof HttpServletRequest hr) {
            System.err.printf("Before Http Request %s\n", hr);
        }
        chain.doFilter(request, response);
        System.err.printf("After %s\n", request);
    }

}

et vérifier son fonctionnement. Il permet d'insérer des traitements automatisés avant et après chaque requête et donc d'appliquer des politiques de sécurité.

Travail à faire : Avec le filtre, interdisez les requêtes qui ne proviennent pas de l'adresse 127.0.0.1 (utilisez request.getRemoteAddr()). L'interception consiste à ne pas appeler la méthode doFilter.

Les listeners

Ajoutez à votre application, la classe d'écoute :

package myapp.servlet;

import jakarta.servlet.annotation.WebListener;
import jakarta.servlet.http.HttpSessionAttributeListener;
import jakarta.servlet.http.HttpSessionBindingEvent;

@WebListener
public class SimpleListener implements HttpSessionAttributeListener {

    @Override
    public void attributeAdded(HttpSessionBindingEvent event) {
    }

    @Override
    public void attributeRemoved(HttpSessionBindingEvent event) {
    }

    @Override
    public void attributeReplaced(HttpSessionBindingEvent event) {
    }

}

et explorez les possibilités de l'argument passé à chaque méthode. Vous pouvez également vous intéresser aux interfaces

ServletContextListener
ServletContextAttributeListener
ServletRequestListener
ServletRequestAttributeListener
HttpSessionListener création/suppression de sessions

Balises personnalisées

Depuis les JSP 2.0 nous pouvons facilement créer de nouvelles balises JSP définies à partir d'un fichier JSP. Pour ce faire, suivez les étapes ci-dessous :

Placez vous dans l'application WEB de test définie dans les TP précédents.
Créez les répertoires webapp/WEB-INF/tags/mestags/
Créez le fichier webapp/WEB-INF/tags/mestags/message.tag
Fichier message.tag
```
<%@ tag language="java" pageEncoding="UTF-8" %>

Bonjour
```

Testez l'utilisation de votre nouvelle balise message avec la page JSP ci-dessous :

<%@ taglib prefix="mm" tagdir="/WEB-INF/tags/mestags" %>

<html>
<body>
<h1>Tester ma balise</h1>

<mm:message />

</body>
</html>

Les balises personnalisées peuvent également avoir un contenu et utiliser ce contenu. Modifiez le fichier message.tag avec
Nouvelle version de message.tag
```
<%@ tag language="java" pageEncoding="UTF-8"%>

Votre contenu : <jsp:doBody />
```

Testez cette nouvelle version avec :

<%@ taglib prefix="mm" tagdir="/WEB-INF/tags/mestags" %>

<html>
<body>
<h1>Tester ma balise</h1>

<mm:message>
    <b>Bonjour</b>
</mm:message>

</body>
</html>

Nous pouvons aussi déclarer des attributs et les utiliser dans le corps de notre nouvelle balise. Modifiez le fichier message.tag avec
Nouvelle version avec attribut de message.tag
```
<%@ tag language="java" pageEncoding="UTF-8"%>

<%@ attribute name="type" required="true"
 description="Type du message" %>

Votre contenu (type ${type}) : <jsp:doBody />
```

A ce stade la page JSP de test doit avoir une erreur de validation : l'attribut type est manquant. Utilisez maintenant cette nouvelle version :

<%@ taglib prefix="mm" tagdir="/WEB-INF/tags/mestags" %>
<html>

<body>
<h1>Ajouter une balise</h1>

<mm:message type="Important">Mon contenu</mm:message>

</body>
</html>

Nous pouvons aussi ajouter un type pour les attributs. Nous obtenons la nouvelle version ci-dessous :

Nouvelle version avec attribut typé de message.tag

<%@ tag language="java" pageEncoding="UTF-8"%>

<%@ taglib prefix="c" uri="jakarta.tags.core" %>

<%@ attribute name="type"   required="true"  description="Type du message" %>
<%@ attribute name="textes" required="false" type="java.util.List" %>

<p>Votre contenu (type ${type}) : <jsp:doBody /></p>

<c:if test="${textes != null}">
  <p>Vos textes :</p>
  <ul>
  <c:forEach var="texte" items="${textes}">
    <li><c:out value="${texte}"/></li>
  </c:forEach>
  </ul>
</c:if>

Le nouvelle attribut étant facultatif, vous pouvez continuer d'utiliser l'ancienne version de la page de test.

Utilisez maintenant la version ci-dessous pour tester l'utilisation d'un attribut typé :

<%@page import="java.util.Arrays"%>
<%@page import="java.util.List"%>
<%@ taglib prefix="mm" tagdir="/WEB-INF/tags/mestags" %>
<html>

<body>
<h1>Ajouter une balise</h1>

<mm:message type="Important">Mon contenu</mm:message>

<%
List<String> mesTextes = Arrays.asList("Hello", "Salut");
%>

<mm:message type="Alerte" textes="<%= mesTextes %>"/>

</body>
</html>

Comparez avec la nouvelle version ci-dessous :

<%
List<String> mesTextes = Arrays.asList("Hello", "Salut");
pageContext.setAttribute("mesTextes", mesTextes);
%>

<mm:message type="Alerte" textes="${mesTextes}"/>