Webes alkalmazások testreszabása megjegyzésekkel

8.1 Bevezetés a szervlet megjegyzésekbe

A 7-es verziótól kezdődően a Tomcat támogatni kezdte a Servlet API 3.0 webservlet specifikációját . Konkrétan egy csomag jelent meg benne, melynek neve javax.servlet.annotation. Különféle típusú annotációkat tartalmaz, amelyekkel egy szervlet osztály annotációját lehet használni. Ha megjegyzést használ, akkor a telepítési leíró (web.xml) nem szükséges.

A leghasznosabb megjegyzések listája:

Példa:

@WebServlet( urlPatterns = {"/api/*"} )
public class Example extends HttpServlet {
    protected void doGet( HttpServletRequest request, HttpServletResponse response) throws Exception {
         response.setContentType("text/html");
         PrintWriter out = response.getWriter();
         out.println("Hello World!");
    }
}

Egy annotáció elegendő egy szervlet deklarálásához és leképezéséhez, hogy kiszolgálja az összes olyan kérést, amely a . által megadott URL-re érkezik /api/*.

8.2 Szervlet-leképezés beállítása

A megjegyzés @WebServletszámos paraméterrel rendelkezik, amelyek lehetővé teszik az általa leírt szervlet nagyon rugalmas konfigurálását. Nézzük a főbbeket:

Itt van néhány érdekes pont.

Először is vegye figyelembe, hogy a valueés urlPatternscserélhető attribútumok. Mindkettő lehetővé teszi azoknak az URL-címeknek a meghatározását, amelyekhez a szervlet hozzá kell rendelnie.

Másodszor, a paraméter asyncSupportedjelzi, hogy a szervlet megfelelően feldolgozza-e az aszinkron kéréseket a HTTP/2 protokollon keresztül.

A harmadik fontos attribútum pedig initParamslehetővé teszi a ServletContextben elhelyezett paraméterek listájának beállítását.

Példa:

@WebServlet(
        urlPatterns = {"/sendFile", "/uploadFile"},
        loadOnStartup = 1,
        asyncSupported = true,
        initParams = {
            @WebInitParam(name = "saveDir", value = "c:/uploaded"),
            @WebInitParam(name = "allowedTypes", value = "jpg,gif,png")
        }
)
public class ImageUploadServlet extends HttpServlet {

    public void doGet(HttpServletRequest request, HttpServletResponse response) throws Exception {
        String saveDir = getInitParameter("saveDir");
        String fileTypes = getInitParameter("allowedTypes");

        PrintWriter writer = response.getWriter();

        writer.println("saveDir = " + saveDir);
        writer.println("fileTypes = " + fileTypes);
    }
}

8.3 Szűrőleképezés beállítása

Amint fentebb említettük, a szűrők a szervletek segédprogramtípusai, és úgy vannak beállítva, mint a szervletek. Íme az annotáció attribútumai @WebFilter:

Példa egy szűrőre, amely elfogja az összes kérést meghatározott szervletekhez :

@WebFilter(servletNames = {"MyOwnServlet", "UploadServlet"})
public class MyFilter implements Filter {
    // implements Filter's methods here...
}

Példa több paraméterrel rendelkező szűrőre :

@WebFilter(
        urlPatterns = "/uploadFilter",
        initParams = @WebInitParam(name = "fileTypes", value = "doc;xls;zip;txt;jpg;png;gif")
)
public class UploadFilter implements Filter {
    // implements Filter's methods here...
}

Példa egy adott típusú szűrőre a RequestDispatcher számára :

@WebFilter(
        urlPatterns = "/admin",
        dispatcherTypes = {DispatcherType.REQUEST, DispatcherType.FORWARD}
)
public class MyFilter implements Filter {
    // implements Filter's methods here...
}

A következő előadásokból többet megtudhat a szűrők és szervletek céljáról.