Servlet 3.0: @WebServlet

DOMANDA:

Come si configurano le Servlet 3.0 con l'Annotation @WebServlet?

RISPOSTA:

Le Servlet 3.0 possono essere configurate in modo tradizionale aggiungendo le seguenti righe al web.xml:

<servlet>
   <servlet-name>MiaServlet</servlet-name>
   <servlet-class>it.blogspot.lancill.TestServlet</servlet-class>
   <init-param> 
      <param-name>parametro1</param-name>
      <param-value>http://lancill.blogspot.it</param-value> 
   </init-param> 
</servlet> 


<servlet-mapping> 
   <servlet-name>MiaServlet</servlet-name> 
   <url-pattern>/servlet/*</url-pattern> 
</servlet-mapping>

Con questa configurazione la nostra Servlet, di nome MiaServlet, riceverà un parametro di inizializzazione (parametro1) valorizzato con "http://lancill.blogspot.it" e risponderà a qualunque url che comincerà per "/servlet/". Quindi se digitiamo nell'url http://www.nomesito.it/servlet/qualsiasicosavabene oppure http://www.nomesito.it/servlet/pippo, il file web.xml indirizzerà la richiesta sempre alla Servlet MiaServlet.

Purtroppo capita spesso, in progetti medio-grandi, di avere miriadi di Servlet che fanno crescere a dismisura il file web.xml rendendolo di difficile consultazione e manutenibilità. 

In tal caso è perfetta la soluzione delle Annotations, introdotte di recente anche per le Servlet nella versione 3.0, che ci permettono di spostare tutti i parametri di configurazione dal web.xml al file .java della Servlet stessa.

Guardiamo come si fa con l'Annotation @WebServlet:

package it.blogspot.lancill;

@WebServlet(name="MiaServlet",
urlPatterns={"/servlet/*"},
initParams={ @InitParam(name="parametro1", 
             value="http://lancill.blogspot.it")})
public class TestServlet extends javax.servlet.http.HttpServlet {
   public void doGet(HttpServletRequest request,
                     HttpServletResponse response){

      String value = getServletConfig().getInitParameter("parametro1"); // prendo il parametro di inizializzazione
      System.out.println("Hai richiamato il metodo GET con il parametro1: " + parametro1);
   }
}

Praticamente abbiamo inserito nell'Annotation tutto quello che ci serviva (e che era contenuto nel file web.xml).

Avviando il webserver su cui gira MiaServlet e digitando da url http://www.nomesito.it/servlet/qualunquecosa, la Servlet restituirà a console il seguente output:

"Hai richiamato il metodo GET con il parametro1: http://lancill.blogspot.it"

ATTENZIONE: un problema frequente che si verifica durante la migrazione di vecchi progetti alle Servlet 3.0 è che la nuova configurazione sembra non rispondere alle richieste come accadeva invece con il file web.xml.

In tal caso è necessario assicurarsi di aver importato correttamente la nuova versione della libreria servlet-api.jar e che all'interno del web.xml stesso ci sia il tag root <web-app> con gli attributi aggiornati come quelli qui di seguito:

<web-app 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns="http://java.sun.com/xml/ns/javaee" 
      xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
      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">