注釈を使用した Web アプリケーションのカスタマイズ

8.1 サーブレットのアノテーションの概要

Tomcat は、バージョン 7 以降、Servlet API 3.0 Web サーブレット仕様のサポートを開始しました。特に、 と呼ばれるパッケージがその中に登場しましたjavax.servlet.annotation。これには、サーブレット クラスに注釈を付けるために使用できるさまざまなタイプの注釈が含まれています。注釈を使用する場合、デプロイメント記述子 (web.xml) は必要ありません。

最も役立つ注釈のリスト:

例：

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

サーブレットを宣言し、 で指定された URL に届くすべてのリクエストを処理するようにマッピングするには、1 つのアノテーションで十分です/api/*。

8.2 サーブレットマッピングの設定

アノテーションには、@WebServlet記述されるサーブレットの非常に柔軟な構成を可能にする多くのパラメーターがあります。主なものを見てみましょう。

ここにはいくつかの興味深い点があります。

まず、valueと はurlPatterns交換可能な属性であることに注意してください。どちらも、サーブレットのマッピング先となる URL のリストを指定できます。

次に、このパラメータは、asyncSupportedサーブレットが HTTP/2 プロトコルを介して非同期リクエストを正しく処理するかどうかを示します。

3 番目の重要な属性は ですinitParams。これにより、ServletContext に配置されるパラメーターのリストを設定できます。

例：

@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 フィルタマッピングの設定

前述したように、フィルターはサーブレットのユーティリティ タイプであり、サーブレットのように構成されます。アノテーションが持つ属性は次のとおりです@WebFilter。

特定のサーブレットへのすべてのリクエストをインターセプトするフィルターの例:

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

複数のパラメーターを指定したフィルターの例:

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

RequestDispatcher のタイプを指定したフィルターの例:

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

フィルタとサーブレットの目的については、次の講義で詳しく学びます。