Anpassa webbapplikationer med anteckningar

8.1 Introduktion till servletkommentarer

Från och med version 7 började Tomcat stödja Servlet API 3.0- webservletspecifikationen . I synnerhet dök det upp ett paket som heter javax.servlet.annotation. Den innehåller olika typer av kommentarer som kan användas för att kommentera en servletklass. Om du använder en anteckning krävs inte distributionsbeskrivningen (web.xml).

Lista över de mest användbara anteckningarna:

Exempel:

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

En anteckning räcker för att deklarera en servlet och mappa den för att betjäna alla förfrågningar som kommer till URL:en som ges av /api/*.

8.2 Ställa in servlet-mappning

Anteckningen har @WebServletmånga parametrar som tillåter mycket flexibel konfiguration av servleten den beskriver. Låt oss ta en titt på de viktigaste:

Det finns flera intressanta punkter här.

Först, notera att valueoch urlPatternsär utbytbara attribut. De låter dig båda ange en lista med webbadresser som servleten ska mappas till.

För det andra indikerar parametern asyncSupportedom servleten korrekt kommer att behandla asynkrona förfrågningar över HTTP/2-protokollet.

Och det tredje viktiga attributet är initParams, det låter dig ställa in en lista med parametrar som kommer att placeras i ServletContext.

Exempel:

@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 Ställa in filterkartläggning

Som nämnts ovan är filter en verktygstyp av servlets, och de är konfigurerade som servlets. Här är attributen som en kommentar har @WebFilter:

Ett exempel på ett filter som fångar upp alla förfrågningar till specifika servlets :

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

Ett exempel på ett filter med flera parametrar :

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

Ett exempel på ett filter givna typer för RequestDispatcher :

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

Du kommer att lära dig mer om syftet med filter och servlets i följande föreläsningar.