Dostosowywanie aplikacji internetowych za pomocą adnotacji

8.1 Wprowadzenie do adnotacji serwletów

Począwszy od wersji 7, Tomcat zaczął obsługiwać specyfikację serwletów WWW Servlet API 3.0 . W szczególności pojawił się w nim pakiet o nazwie javax.servlet.annotation. Zawiera różne rodzaje adnotacji, których można użyć do opisywania klasy serwletu. Jeśli używasz adnotacji, deskryptor wdrożenia (web.xml) nie jest wymagany.

Lista najbardziej przydatnych adnotacji:

Przykład:

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

Wystarczy jedna adnotacja, aby zadeklarować serwlet i zmapować go tak, aby obsługiwał wszystkie żądania, które będą przychodzić do adresu URL podanego przez plik /api/*.

8.2 Konfigurowanie mapowania serwletów

Adnotacja posiada @WebServletwiele parametrów, które pozwalają na bardzo elastyczną konfigurację opisywanego serwletu. Przyjrzyjmy się głównym z nich:

Jest tu kilka interesujących punktów.

Po pierwsze, zauważ, że valuei urlPatternssą atrybutami wymiennymi. Oba pozwalają określić listę adresów URL, na które aplet powinien być mapowany.

Po drugie, parametr asyncSupportedwskazuje, czy aplet będzie poprawnie przetwarzał żądania asynchroniczne przez protokół HTTP/2.

Trzecim ważnym atrybutem jest initParams, pozwala ustawić listę parametrów, które zostaną umieszczone w ServletContext.

Przykład:

@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 Konfigurowanie mapowania filtrów

Jak wspomniano powyżej, filtry są serwletami typu użytkowego i są konfigurowane jak serwlety. Oto atrybuty adnotacji @WebFilter:

Przykład filtra, który przechwytuje wszystkie żądania do określonych serwletów :

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

Przykład filtra z wieloma parametrami :

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

Przykład filtru podanego typu dla RequestDispatcher :

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

Więcej o przeznaczeniu filtrów i serwletów dowiesz się z kolejnych wykładów.