7.1 A web.xml általános sémája
A web.xml fájl az alkalmazás konfigurációs adatait tárolja. Ennek nem kötelező része, de igen széles körben használják webalkalmazások konfigurálására.
Ennek a fájlnak a WEB-INF mappában kell lennie . Amikor a Tomcat elindul, beolvassa a tartalmát, és a benne lévő konfigurációt használja. Ha a fájl hibákat tartalmaz, akkor a Tomcat is hibát jelenít meg.
Példa web.xml:
<?xml version="1.0" encoding="UTF-8"?>
<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_4_0.xsd" version="4.0">
<servlet>
<servlet-name>HelloWorld</servlet-name>
<servlet-class>HelloServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>HelloWorld</servlet-name>
<url-pattern>/welcome</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
</welcome-file-list>
</web-app>
"HelloWorld"
A szervlet nevének és a szervlet osztályának leképezése itt zölddel van írva"HelloServlet"
. A szervlet nevének és az URL-darabnak a leképezése kékkel van írva"HelloWorld"
"http://localhost/welcome"
. Így itt azt írja, hogy a /welcome elérési út elérésekor meg kell hívni a servletet HelloServlet.class
.
A piros szín azt a fájlt jelöli, amelyet kérésre meg kell adni http://localhost/
- ez az úgynevezett üdvözlő oldal . Ha a felhasználó egyszerűen beírja a böngészőbe a webalkalmazásunk gyökerének megfelelő nevet, akkor a tartalom index.html
.
7.2 szervlet, szervlet-leképezés
Egy servlet különböző URL-eken képes kiszolgálni a kéréseket, ezért a web-xml-ben a szervlet és az URL-ekhez való hozzárendelése külön van írva. Először is leírjuk a servleteket, mindegyiknek egyedi karakterláncnevet adva, majd megadjuk, hogy az egyes szervletek milyen URL-hez legyenek leképezve.
Példa web.xml:
<web-app>
<servlet>
<servlet-name>remoting</servlet-name>
<servlet-class>com.codegym.RemotingServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>remoting</servlet-name>
<url-pattern>/remoting/*</url-pattern>
</servlet-mapping>
<servlet>
<servlet-name>restapi</servlet-name>
<servlet-class>com.codegym.RestApiServlet</servlet-class>
<load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>restapi</servlet-name>
<url-pattern>/api/*</url-pattern>
</servlet-mapping>
</web-app>
Ebben a példában két szervlet van deklarálva, és mindegyik más-más URL-sablonra van leképezve. A szervlet RemotingServlet
minden olyan kérést kiszolgál, amely a címre érkezik/remoting/*
. A szervlet RestApiServlet
minden olyan kérést kiszolgál, amely a címre érkezik/api/*
. A szervletek betöltési sorrendje is van – a load-on-startup paraméter.
7.3 Szervlet-beállítások
A web.xml segítségével a paraméterek átadhatók a servletnek az inicializálása során, ezek a felületen keresztül lesznek elérhetők ServletConfig
. A teljes webalkalmazáshoz is beállíthatunk paramétereket, ezek a következőn keresztül lesznek elérhetők ServletContext
.
Példa web.xml:
<web-app>
<context-param>
<description>Server production mode</description>
<param-name>productionMode</param-name>
<param-value>false</param-value>
</context-param>
<context-param>
<param-name>appPropertiesConfig</param-name>
<param-value>
classpath:local-app.properties
classpath:web-app.properties
</param-value>
</context-param>
<servlet>
<servlet-name>mainservlet</servlet-name>
<servlet-class>com.codegym.ApplicationServlet</servlet-class>
<init-param>
<param-name>application</param-name>
<param-value>com.codegym.App</param-value>
</init-param>
<init-param>
<param-name>widgetset</param-name>
<param-value>com.codegym.WidgetSet</param-value>
</init-param>
<init-param>
<param-name>ui</param-name>
<param-value>com.codegym.AppUI</param-value>
</init-param>
</servlet>
</web-app>
A zölddel kiemelt kódban állítjuk be a paramétereketServletContext
. Ebből kettő van:
productionMode
hamis értékkelappPropertiesConfig
két karakterlánc tömbjével:classpath:local-app.properties
classpath:web-app.properties
A servlet paraméterei kék színnel vannak jelölveApplicationServlet
, a következőn keresztül lesznek elérhetők ServletConfig
:
application
értékkel com.codegym.Appwidgetset
com.codegym.WidgetSet értékkelui
com.codegym.AppUI értékkel
7.4 szűrő, szűrő-leképezés
A webalkalmazás speciális utility servlets - filters
. Különféle szolgáltatási feladatokat látnak el: hívások átirányítása, jogosultság ellenőrzése stb.
Példa web.xml:
<web-app>
<servlet>
<servlet-name>remoting</servlet-name>
<servlet-class>RemotingServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>remoting </servlet-name>
<url-pattern>/remoting/*</url-pattern>
</servlet-mapping>
<filter>
<filter-name>total_filter</filter-name>
<filter-class>com.javrush.TotalFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>total_filter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
Mielőtt a kérés elérné a szervletet RemotingServlet
, a szűrő feldolgozza azt TotalFiler
. Ez a szűrő úgy van beállítva, hogy elfogja a webalkalmazásunkhoz érkező összes kérést . Erre egyértelműen utal az URL-sablon, amelyhez hozzá van rendelve: /*
.
A servletekről és a szűrőkről a következő előadásokban olvashat bővebben.