Il descrittore di deployment: web.xml

Le applicazioni web Java utilizzano un file descrittore di deployment per determinare la mappatura degli URL ai servlet, quali URL richiedono l'autenticazione e altre informazioni. Questo file è denominato web.xml e fa parte della specifica del servlet per le applicazioni web. Per ulteriori informazioni sul descrittore di deployment web.xml, consulta la specifica del servlet.

Se esegui la migrazione da Java 8 e devi utilizzare i servizi legacy pacchettizzati con la versione Java supportata più recente, devi aggiungere l'elemento <app-engine-apis> e impostarlo su true nel file web.xml:

<app-engine-apis>true</app-engine-apis>

Descrittori di deployment

Il descrittore di deployment di un'applicazione web descrive le classi, le risorse e la configurazione dell'applicazione e come il server web le utilizza per gestire le richieste web. Quando il server web riceve una richiesta per l'applicazione, utilizza il descrittore di deployment per mappare l'URL della richiesta al codice che deve gestirla.

Il descrittore di deployment è un file denominato web.xml. Si trova nel file WAR dell'app nella directory WEB-INF/. Il file è un file XML il cui elemento principale è <web-app>.

Il seguente esempio web.xml mappa tutti i percorsi dell'URL (/*) alla classe servlet mysite.server.ComingSoonServlet per la versione 21 e successive su EE10 (predefinita), la versione 21 su EE8 e la versione 17 e precedenti. Per utilizzare la versione supportata più recente nella configurazione predefinita, devi aggiornare i servlet e le dipendenze dell'applicazione in modo da includere lo spazio dei nomi Jakarta. Per scoprire di più sulle opzioni di configurazione, consulta Eseguire l'upgrade di un'applicazione esistente.

<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_6_0.xsd"
     version="6.0">
    <runtime>java21</runtime> <!-- or another supported version -->
    <servlet>
        <servlet-name>comingsoon</servlet-name>
        <servlet-class>mysite.server.ComingSoonServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>comingsoon</servlet-name>
        <url-pattern>/*</url-pattern>
    </servlet-mapping>
</web-app>

<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
        http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
        version="3.1">
   <runtime>java21</runtime>

  <system-properties> <!-- run your apps on EE8  -->
      <property name="appengine.use.EE8" value="true"/>
  </system-properties>

    <servlet>
        <servlet-name>comingsoon</servlet-name>
        <servlet-class>mysite.server.ComingSoonServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>comingsoon</servlet-name>
        <url-pattern>/*</url-pattern>
    </servlet-mapping>
</web-app>

  <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
          http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
          version="3.1">
      <runtime>java17</runtime>
      <servlet>
          <servlet-name>comingsoon</servlet-name>
          <servlet-class>mysite.server.ComingSoonServlet</servlet-class>
      </servlet>
      <servlet-mapping>
          <servlet-name>comingsoon</servlet-name>
          <url-pattern>/*</url-pattern>
      </servlet-mapping>
  </web-app>

Se suddividi l'applicazione in servizi, ogni servizio ha i propri parametri di configurazione.

Servlet e percorsi URL

web.xml definisce le mappature tra i percorsi degli URL e i servlet che gestiscono le richieste con questi percorsi. Il server web utilizza questa configurazione per identificare il servlet da utilizzare per gestire una determinata richiesta e chiamare il metodo di classe corrispondente al metodo di richiesta. Ad esempio, il metodo doGet() per le richieste HTTP GET.

Per mappare un URL a un servlet, dichiara il servlet con l'elemento <servlet>, quindi definisci un mapping da un percorso URL a una dichiarazione del servlet con l'elemento <servlet-mapping>.

L'elemento <servlet> dichiara il servlet, incluso un nome utilizzato per fare riferimento al servlet da altri elementi del file, la classe da utilizzare per il servlet e i parametri di inizializzazione. Puoi dichiarare più servlet utilizzando la stessa classe con parametri di inizializzazione diversi. Il nome di ogni servlet deve essere univoco nel descrittore di deployment.

    <servlet>
        <servlet-name>redteam</servlet-name>
        <servlet-class>mysite.server.TeamServlet</servlet-class>
        <init-param>
            <param-name>teamColor</param-name>
            <param-value>red</param-value>
        </init-param>
        <init-param>
            <param-name>bgColor</param-name>
            <param-value>#CC0000</param-value>
        </init-param>
    </servlet>

    <servlet>
        <servlet-name>blueteam</servlet-name>
        <servlet-class>mysite.server.TeamServlet</servlet-class>
        <init-param>
            <param-name>teamColor</param-name>
            <param-value>blue</param-value>
        </init-param>
        <init-param>
            <param-name>bgColor</param-name>
            <param-value>#0000CC</param-value>
        </init-param>
    </servlet>

L'elemento <servlet-mapping> specifica un pattern URL e il nome di un servlet dichiarato da utilizzare per le richieste il cui URL corrisponde al pattern. Il modello di URL può utilizzare un asterisco (*) all'inizio o alla fine del modello per indicare zero o più caratteri. Il pattern URL non supporta i caratteri jolly nel mezzo di una stringa e non consente più caratteri jolly in un pattern. Il pattern corrisponde al percorso completo dell'URL, iniziando con la barra (/) che segue il nome di dominio e includendola. Il percorso dell'URL non può iniziare con un punto (.).

    <servlet-mapping>
        <servlet-name>redteam</servlet-name>
        <url-pattern>/red/*</url-pattern>
    </servlet-mapping>

    <servlet-mapping>
        <servlet-name>blueteam</servlet-name>
        <url-pattern>/blue/*</url-pattern>
    </servlet-mapping>

In questo esempio, una richiesta per l'URL http://www.example.com/blue/teamProfile viene gestita dalla classe TeamServlet, con il parametro teamColor uguale a blue e il parametro bgColor uguale a #0000CC. Il servlet può ottenere la parte del percorso dell'URL corrispondente al carattere jolly utilizzando il metodo getPathInfo() dell'oggetto ServletRequest.

Il servlet può accedere ai suoi parametri di inizializzazione recuperando la configurazione del servlet utilizzando il proprio metodo getServletConfig(), quindi chiamando il metodo getInitParameter() sull'oggetto di configurazione utilizzando il nome del parametro come argomento.

String teamColor = getServletConfig().getInitParameter("teamColor");

JSPs

Un'app può utilizzare JavaServer Pages (JSP) per implementare pagine web. Le JSP sono servlet definiti utilizzando contenuti statici, come HTML, combinati con codice Java.

App Engine supporta la compilazione automatica e la mappatura degli URL per le JSP. Un file JSP nella WAR dell'applicazione (al di fuori di WEB-INF/) il cui nome file termina con .jsp viene compilato automaticamente in una classe servlet e mappato al percorso dell'URL equivalente al percorso del file JSP dalla radice WAR. Ad esempio, se un'app contiene un file JSP denominato start.jsp in una sottodirectory denominata register/ nel file WAR, App Engine lo compila e lo mappa al percorso dell'URL /register/start.jsp.

Se vuoi avere un maggiore controllo sul modo in cui la JSP viene mappata a un URL, puoi specificare la mappatura in modo esplicito dichiarandola con un elemento <servlet> nel descrittore di deployment. Anziché un elemento <servlet-class>, specifica un elemento <jsp-file> con il percorso del file JSP dalla radice WAR. L'elemento <servlet> per il JSP può contenere parametri di inizializzazione.

    <servlet>
        <servlet-name>register</servlet-name>
        <jsp-file>/register/start.jsp</jsp-file>
    </servlet>

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

Puoi installare librerie di tag JSP con l'elemento <taglib>. Una libreria di tag ha un percorso al file TLD (TLD, descrittore della libreria di tag JSP) (<taglib-location>) e un URI utilizzato dalle JSP per selezionare la libreria da caricare (<taglib-uri>). Tieni presente che App Engine fornisce la libreria di tag standard JavaServer Pages (JSTL) e non devi installarla.

    <taglib>
        <taglib-uri>/escape</taglib-uri>
        <taglib-location>/WEB-INF/escape-tags.tld</taglib-location>
    </taglib>

Sicurezza e autenticazione

Un'applicazione App Engine può utilizzare gli Account Google per l'autenticazione degli utenti. L'app può utilizzare l'API Account Google per rilevare se l'utente ha eseguito l'accesso, recuperare l'indirizzo email dell'utente che ha eseguito l'accesso e generare URL di accesso e di uscita. Un'app può anche specificare limitazioni di accesso per i percorsi degli URL in base agli Account Google, utilizzando il descrittore di deployment.

L'elemento <security-constraint> definisce un vincolo di sicurezza per gli URL che corrispondono a un pattern. Se un utente accede a un URL il cui percorso presenta una limitazione di sicurezza e non ha eseguito l'accesso, App Engine lo reindirizza alla pagina di accesso degli Account Google. Gli Account Google reindirizzano l'utente all'URL dell'applicazione dopo aver eseguito l'accesso o aver registrato un nuovo account. L'app non deve fare altro per assicurarsi che solo gli utenti che hanno eseguito l'accesso possano accedere all'URL.

Una limitazione di sicurezza include una limitazione di autorizzazione che specifica gli utenti degli Account Google che possono accedere al percorso. Se la limitazione di autorizzazione specifica un ruolo utente *, tutti gli utenti che hanno eseguito l'accesso con un Account Google possono accedere all'URL. Se la limitazione specifica un ruolo utente admin, solo gli sviluppatori registrati dell'applicazione possono accedere all'URL. Il ruolo admin semplifica la creazione di sezioni del sito riservate agli amministratori.

    <security-constraint>
        <web-resource-collection>
            <web-resource-name>profile</web-resource-name>
            <url-pattern>/profile/*</url-pattern>
        </web-resource-collection>
        <auth-constraint>
            <role-name>*</role-name>
        </auth-constraint>
    </security-constraint>

    <security-constraint>
        <web-resource-collection>
            <web-resource-name>admin</web-resource-name>
            <url-pattern>/admin/*</url-pattern>
        </web-resource-collection>
        <auth-constraint>
            <role-name>admin</role-name>
        </auth-constraint>
    </security-constraint>

App Engine non supporta i ruoli di sicurezza personalizzati (<security-role>) o i meccanismi di autenticazione alternativi (<login-config>) nel descrittore di deployment.

I vincoli di sicurezza si applicano ai file statici e ai servlet.

URL sicuri

App Engine supporta le connessioni sicure con HTTPS per gli URL che utilizzano il dominio REGION_ID.r.appspot.com. Quando una richiesta accede a un URL utilizzando HTTPS e l'URL è configurato per utilizzare HTTPS nel file web.xml, sia i dati della richiesta sia i dati della risposta vengono criptati dal mittente prima di essere trasmessi e decriptati dal destinatario dopo essere stati ricevuti. Le connessioni sicure sono utili per proteggere i dati dei clienti, come dati di contatto, password e messaggi privati.

Per dichiarare che per un URL deve essere utilizzato HTTPS, devi configurare un vincolo di sicurezza nel descrittore di deployment (come descritto in Sicurezza e autenticazione) con un <user-data-constraint> il cui <transport-guarantee> è CONFIDENTIAL. Ad esempio:

    <security-constraint>
        <web-resource-collection>
            <web-resource-name>profile</web-resource-name>
            <url-pattern>/profile/*</url-pattern>
        </web-resource-collection>
        <user-data-constraint>
            <transport-guarantee>CONFIDENTIAL</transport-guarantee>
        </user-data-constraint>
    </security-constraint>

Le richieste che utilizzano HTTP (non sicuro) per gli URL la cui garanzia di trasporto è CONFIDENTIAL vengono reindirizzate automaticamente allo stesso URL utilizzando HTTPS.

Qualsiasi URL può utilizzare la garanzia di trasporto CONFIDENTIAL, inclusi JSP e file statici.

Il server web di sviluppo non supporta le connessioni HTTPS. Ignora la garanzia di trasporto, pertanto i percorsi destinati all'utilizzo con HTTPS possono essere testati utilizzando connessioni HTTP regolari al server web di sviluppo.

Quando testi i gestori HTTPS dell'app utilizzando l'URL appspot.com con versione, come https://1.latest.your_app_id.REGION_ID.r.appspot.com/, il browser ti avvisa che il certificato HTTPS non è stato firmato per quel percorso del dominio specifico. Se accetti il certificato per il dominio, le pagine si caricano correttamente. Gli utenti non vedranno l'avviso relativo al certificato quando accedono https://your_app_id.REGION_ID.r.appspot.com/.

Puoi anche utilizzare una forma alternativa dell'URL appspot.com con versione progettata per evitare questo problema sostituendo i punti che separano i componenti del sottodominio con la stringa "-dot-". Ad esempio, all'esempio precedente è possibile accedere senza un avviso sul certificato all'indirizzo https://VERSION_ID-dot-default-dot-PROJECT_ID.REGION_ID.r.appspot.com.

L'accesso e la disconnessione dagli Account Google vengono sempre eseguiti utilizzando una connessione sicura e non sono correlati alla configurazione degli URL dell'applicazione.

Come accennato in precedenza, i vincoli di sicurezza si applicano ai file statici e ai servlet. È inclusa la garanzia di trasporto.

Nota: Google consiglia di utilizzare il protocollo HTTPS per inviare richieste alla tua app. Google non emette certificati SSL per i domini con due caratteri jolly ospitati su appspot.com. Pertanto, con HTTPS devi utilizzare la stringa "-dot-" anziché "." per separare i sottodomini, come mostrato negli esempi riportati di seguito. Puoi utilizzare un semplice "." con il tuo dominio personalizzato o con indirizzi HTTP.

Elenco dei file di benvenuto

Quando gli URL del tuo sito rappresentano percorsi a file statici o JSP nel file WAR, spesso è buona norma che anche i percorsi alle directory facciano qualcosa di utile. Un utente che visita il percorso dell'URL /help/accounts/password.jsp per informazioni sulle password dell'account potrebbe provare a visitare /help/accounts/ per trovare una pagina che illustra la documentazione del sistema dell'account. Il descrittore di deployment può specificare un elenco di nomi file che il server deve provare quando l'utente accede a un percorso che rappresenta una sottodirectory WAR non ancora mappata esplicitamente a un servlet. La specifica del servlet definisce questo elemento come welcome file list.

Ad esempio, se l'utente accede al percorso dell'URL /help/accounts/, il seguente elemento <welcome-file-list> nel descrittore di deployment indica al server di verificare la presenza di help/accounts/index.jsp e help/accounts/index.html prima di segnalare che l'URL non esiste:

    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
        <welcome-file>index.html</welcome-file>
    </welcome-file-list>

Filtri

Un filtro è una classe che agisce su una richiesta come un servlet, ma può consentire la gestione della richiesta di continuare con altri filtri o servlet. Un filtro può eseguire un'attività ausiliaria, ad esempio eseguire il logging, eseguire controlli di autenticazione specializzati o annotare gli oggetti di richiesta o risposta prima di invocare il servlet. I filtri ti consentono di comporre attività di elaborazione delle richieste dal descrittore di deployment.

Il seguente esempio di implementazione del filtro registra un messaggio e passa il controllo lungo la catena, che può includere altri filtri o un servlet, come descritto dal descrittore di deployment per la versione 21 e successive su EE10 (valore predefinito), la versione 21 su EE8 e la versione 17 e precedenti. Per utilizzare la versione supportata più recente nella configurazione predefinita, devi aggiornare i servlet e le dipendenze dell'applicazione in modo da includere lo spazio dei nomi Jakarta. Per scoprire di più sulle opzioni di configurazione, consulta Eseguire l'upgrade di un'applicazione esistente.

package mysite.server;

import java.io.IOException;
import java.util.logging.Logger;
import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;

public class LogFilterImpl implements Filter {

    private FilterConfig filterConfig;
    private static final Logger log = Logger.getLogger(LogFilterImpl.class.getName());

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain)
        throws IOException, ServletException {
        log.warning("Log filter processed a " + getFilterConfig().getInitParameter("logType")
            + " request");

        filterChain.doFilter(request, response);
    }

    public FilterConfig getFilterConfig() {
        return filterConfig;
    }

    public void init(FilterConfig filterConfig) {
        this.filterConfig = filterConfig;
    }

    public void destroy() {}

}

package mysite.server;

import java.io.IOException;
import java.util.logging.Logger;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

public class LogFilterImpl implements Filter {

    private FilterConfig filterConfig;
    private static final Logger log = Logger.getLogger(LogFilterImpl.class.getName());

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain)
        throws IOException, ServletException {
        log.warning("Log filter processed a " + getFilterConfig().getInitParameter("logType")
            + " request");

        filterChain.doFilter(request, response);
    }

    public FilterConfig getFilterConfig() {
        return filterConfig;
    }

    public void init(FilterConfig filterConfig) {
        this.filterConfig = filterConfig;
    }

    public void destroy() {}

}

package mysite.server;

import java.io.IOException;
import java.util.logging.Logger;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

public class LogFilterImpl implements Filter {

    private FilterConfig filterConfig;
    private static final Logger log = Logger.getLogger(LogFilterImpl.class.getName());

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain)
        throws IOException, ServletException {
        log.warning("Log filter processed a " + getFilterConfig().getInitParameter("logType")
            + " request");

        filterChain.doFilter(request, response);
    }

    public FilterConfig getFilterConfig() {
        return filterConfig;
    }

    public void init(FilterConfig filterConfig) {
        this.filterConfig = filterConfig;
    }

    public void destroy() {}

}

Come per i servlet, puoi configurare un filtro nel descrittore di deployment dichiarandolo con l'elemento <filter> e poi mappandolo a un pattern URL con l'elemento <filter-mapping>. Puoi anche mappare i filtri direttamente ad altri servlet.

L'elemento <filter> contiene elementi <filter-name>, <filter-class> e <init-param> facoltativi.

    <filter>
        <filter-name>logSpecial</filter-name>
        <filter-class>mysite.server.LogFilterImpl</filter-class>
        <init-param>
            <param-name>logType</param-name>
            <param-value>special</param-value>
        </init-param>
    </filter>

L'elemento <filter-mapping> contiene un <filter-name> che corrisponde al nome di un filtro dichiarato e un elemento <url-pattern> per applicare il filtro agli URL oppure un elemento <servlet-name> che corrisponde al nome di un servlet dichiarato per applicare il filtro ogni volta che viene chiamato il servlet.

    <!-- Log for all URLs ending in ".special" -->
    <filter-mapping>
        <filter-name>logSpecial</filter-name>
        <url-pattern>*.special</url-pattern>
    </filter-mapping>

    <!-- Log for all URLs that use the "comingsoon" servlet -->
    <filter-mapping>
        <filter-name>logSpecial</filter-name>
        <servlet-name>comingsoon</servlet-name>
    </filter-mapping>

Gestione degli errori

Puoi personalizzare i dati inviati dal server all'utente quando si verifica un errore utilizzando il descrittore di deployment. Il server può mostrare una posizione della pagina alternativa quando sta per inviare un determinato codice di stato HTTP o quando un servlet genera una determinata eccezione Java.

L'elemento <error-page> contiene un elemento <error-code> con un valore del codice di errore HTTP (ad esempio 500) o un elemento <exception-type> con il nome della classe dell'eccezione prevista (ad esempio java.io.IOException). Contiene inoltre un elemento <location> contenente il percorso dell'URL della risorsa da mostrare quando si verifica l'errore.

    <error-page>
        <error-code>500</error-code>
        <location>/errors/servererror.jsp</location>
    </error-page>

Non puoi configurare gestori degli errori personalizzati per le seguenti condizioni di errore:

• Pagina di risposta 404 quando non è definita alcuna mappatura del servlet per un URL.
• Pagina di errore di quota di 403
• 500 pagina di errore del server visualizzata dopo un errore interno di App Engine.

Funzionalità web.xml non supportate

Le seguenti funzionalità di web.xml non sono supportate da App Engine:

• App Engine supporta l'elemento <load-on-startup> per le dichiarazioni dei servlet. Tuttavia, il caricamento si verifica effettivamente durante la prima richiesta gestita dall'istanza del web server, non prima.
• Alcuni elementi del descrittore di deployment possono avere un nome visualizzato, una descrizione e un'icona leggibili per l'utilizzo nelle IDE. App Engine non le utilizza e le ignora.
• App Engine non supporta le variabili di ambiente JNDI (<env-entry>).
• App Engine non supporta le risorse EJB (<resource-ref>).
• La notifica della distruzione di servlet, contesto servlet o filtri non è supportata.
• L'elemento <distributable> viene ignorato.
• La pianificazione dei servlet con <run-at> non è supportata.