Webapplicaties aanpassen met annotaties

8.1 Inleiding tot servletannotaties

Vanaf versie 7 begon Tomcat de Servlet API 3.0 webservletspecificatie te ondersteunen . Er verscheen met name een pakket genaamd javax.servlet.annotation. Het bevat verschillende soorten annotaties die kunnen worden gebruikt om een ​​servletklasse te annoteren. Als u een annotatie gebruikt, is de implementatiedescriptor (web.xml) niet vereist.

Lijst met de meest bruikbare annotaties:

Voorbeeld:

@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!");
    }
}

Eén annotatie is genoeg om een ​​servlet te declareren en toe te wijzen om alle verzoeken te verwerken die naar de URL komen die door het /api/*.

8.2 Instellen van servlettoewijzing

De annotatie heeft @WebServletveel parameters die een zeer flexibele configuratie van de beschreven servlet mogelijk maken. Laten we de belangrijkste eens bekijken:

Er zijn hier verschillende interessante punten.

Merk allereerst op dat valueen urlPatternsverwisselbare attributen zijn. Beide stellen u in staat een lijst met URL's op te geven waarnaar de servlet moet verwijzen.

Ten tweede geeft de parameter asyncSupportedaan of de servlet asynchrone verzoeken via het HTTP/2-protocol correct verwerkt.

En het derde belangrijke attribuut is initParams, hiermee kunt u een lijst met parameters instellen die in de ServletContext worden geplaatst.

Voorbeeld:

@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 Filtermapping instellen

Zoals hierboven vermeld, zijn filters servlets van het type hulpprogramma en ze zijn geconfigureerd als servlets. Dit zijn de kenmerken die een annotatie heeft @WebFilter:

Een voorbeeld van een filter dat alle verzoeken aan specifieke servlets onderschept :

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

Een voorbeeld van een filter met meerdere parameters :

@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...
}

Een voorbeeld van een filter gegeven typen voor RequestDispatcher :

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

In de volgende colleges leer je meer over het doel van filters en servlets.