一、Filter の基本的な動作原理
- 1、Filter プログラムは、特別なインターフェースを実装した Java クラスであり、Servlet と同様に、Servlet コンテナによって呼び出され、実行されます。
- 2、web.xml で Filter を登録して特定の Servlet プログラムをインターセプト(傍受)処理する場合、その Filter は、リクエストを Servlet プログラムに引き続き渡すかどうか、およびリクエストとレスポンスメッセージを変更するかどうかを決定できます。
- 3、Servlet コンテナが Servlet プログラムの呼び出しを開始するとき、その Servlet をインターセプトするために Filter プログラムが登録されていることを検出した場合、コンテナは Servlet の service メソッドを直接呼び出さず、Filter の doFilter メソッドを呼び出し、doFilter メソッドが service メソッドをアクティブにするかどうかを決定します。
- 4、しかし、Filter.doFilter メソッド内では Servlet の service メソッドを直接呼び出すことはできません。代わりに FilterChain.doFilter メソッドを呼び出して、ターゲット Servlet の service メソッドをアクティブにします。FilterChain オブジェクトは Filter.doFilter メソッドのパラメータとして渡されます。
- 5、Filter.doFilter メソッド内で FilterChain.doFilter メソッドを呼び出す文の前後に何らかのプログラムコードを追加するだけで、Servlet が応答する前後で特定の特別な機能を実装できます。
- 6、Filter.doFilter メソッド内で FilterChain.doFilter メソッドを呼び出さない場合、ターゲット Servlet の service メソッドは実行されません。これにより、Filter を介して不正なアクセス要求をブロックできます。
二、Filter チェーン
- 1、Web アプリケーションには複数の Filter プログラムを登録でき、各 Filter プログラムは 1 つまたは 1 組の Servlet プログラムをインターセプトできます。特定の Servlet プログラムへのアクセスを複数の Filter プログラムがインターセプトできる場合、その Servlet へのアクセス要求が到達すると、Web コンテナはこれらの複数の Filter プログラムを 1 つの Filter チェーン(フィルターチェーンとも呼ばれます)にまとめます。
- 2、Filter チェーン内の各 Filter のインターセプト順序は、web.xml ファイル内でのマッピング順序と一致します。前の Filter.doFilter メソッド内で FilterChain.doFilter メソッドを呼び出すと次の Filter の doFilter メソッドがアクティブになり、最後の Filter.doFilter メソッド内で呼び出される FilterChain.doFilter メソッドはターゲット Servlet の service メソッドをアクティブにします。
- 3、Filter チェーン内のいずれかの Filter が FilterChain.doFilter メソッドを呼び出さない限り、ターゲット Servlet の service メソッドは実行されません。
三、Filter インターフェース
Filter プログラムは 1 つの Java クラスであり、このクラスは Filter インターフェースを実装する必要があります。javax.servlet.Filter インターフェースには、init、doFilter、destory の 3 つのメソッドが定義されています。
1、init メソッド
- (1)Web アプリケーションの起動時、Web サーバー(Web コンテナ)は web.xml ファイルの設定情報に基づいて、登録された各 Filter のインスタンスオブジェクトを作成し、メモリ内に保存します。
-
(2)Web コンテナは Filter のインスタンスオブジェクトを作成した後、すぐにその Filter オブジェクトの init メソッドを呼び出します。init メソッドは Filter のライフサイクル中に一度だけ実行されます。Web コンテナは init メソッドを呼び出すとき、Filter の設定と実行環境情報を含む FilterConfig オブジェクトを渡します。
public voic init(FilterConfig filterConfig) throws ServletException
- (3)開発者は init メソッド内でコンストラクタと同様の初期化機能を実行できます。注意すべき点は、初期化コードが FilterConfig オブジェクトを使用する必要がある場合、そのコードは init メソッド内でのみ記述でき、コンストラクタ内では記述できないことです(init メソッドがまだ呼び出されていない、つまり FilterConfig オブジェクトが作成されていないため、それを使用すると必ずエラーになります)。
2、doFilter メソッド
Filter オブジェクトがアクセス要求をインターセプトできる場合、Servlet コンテナは Filter オブジェクトの doFilter メソッドを呼び出します。
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException.ServletException
ここで、パラメータ request と response は、Web コンテナまたは Filter チェーン内の前の Filter から渡されたリクエストオブジェクトとレスポンスオブジェクトです。パラメータ chain は現在の Filter チェーンを表すオブジェクトです。
3、destroy メソッド
このメソッドは、Web コンテナが Filter オブジェクトをアンロードする前に呼び出され、一度だけ実行されます。init メソッドとは逆の機能を実行でき、その Filter オブジェクトによって開かれたリソースを解放します。例:データベース接続と IO ストリームを閉じます。
四、FilterChain インターフェース
このインターフェースは、Filter チェーンのオブジェクトが外部に提供すべきメソッドを定義するために使用されます。このインターフェースには doFilter メソッドが 1 つだけ定義されています。
public void doFilter(ServletRequest request, ServletResponse response) throws java.io.IOException.ServletException
FilterChain インターフェースの doFilter メソッドは、Web コンテナにリクエストを Filter チェーン内の次の Filter に渡して処理するよう通知するために使用されます。現在このメソッドを呼び出している Filter オブジェクトが Filter チェーン内の最後の Filter である場合、リクエストはターゲット Servlet プログラムに渡されて処理されます。
五、FilterConfig インターフェース
- 1、通常の Servlet プログラムと同様に、Filter プログラムも Servlet コンテナにアクセスする必要がある場合があります。Servlet 仕様は、ServletContext オブジェクトと Filter の設定パラメータ情報を表すものを、FilterConfig と呼ばれるオブジェクトにカプセル化します。
- 2、FilterConfig インターフェースは、FilterConfig オブジェクトが外部に提供すべきメソッドを定義するために使用されます。これにより、Filter プログラム内でこれらのメソッドを呼び出して、ServletContext オブジェクトを取得したり、web.xml ファイルで Filter に設定されたフレンドリ名(表示名)と初期化パラメータを取得したりできます。
-
3、FilterConfig インターフェースで定義されている各メソッド:
getFilterName メソッドは、<filter-name> 要素の設定値を返します。
getServletContext メソッドは、FilterConfig オブジェクト内にラップされている ServletContext オブジェクトの参照を返します。
getInitParameter メソッドは、web.xml ファイルで Filter に設定された特定の名前の初期化パラメータ値を返すために使用されます。
getInitParameterNames メソッドは、Enumeration コレクションオブジェクトを返します。
六、Filter の登録とマッピング
1、Filter の登録
1 つの <filter> 要素は 1 つの Filter を登録するために使用されます。そのうち、<filter-name> 要素は必須であり、<filter-class> 要素も必須です。<init-param> 要素はオプションであり、複数の <init-param> 要素を持つことができます。
<filter>
<filter-name>FirstFilter</filter-name>
<filter-class>FirstFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>GB2312</param-value>
</init-param>
</filter>
2、Filter のマッピング
<filter-mapping> 要素は、Filter がインターセプトを担当するリソースを設定するために使用されます。Filter がインターセプトするリソースは、リソースのアクセス要求パスと Servlet 名の 2 つの方法で指定できます。
最初の方法:リソースのアクセスパスを指定する
<filter-mapping>
<filter-name>FirstFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<url-pattern> 要素内のアクセスパスの設定方法は、Servlet の URL マッピング仕様に従います。
- /*:すべてのアクセス要求をインターセプトすることを示します。
- /filter/*:フィルタディレクトリ下のすべてのアクセス要求をインターセプトすることを示します。例:http://localhost:8888/testFilter_001/filter/xxxxxx。
- /test.html:ルートディレクトリ下で test.html をリソース名とするアクセス要求をインターセプトすることを示します。アクセスリンクは http://localhost:8888/test.html のみです。
2つ目:Servlet の名前を指定する
<filter-mapping>
<filter-name>FirstFilter</filter-name>
<servlet-name>default></servlet-name>
<dispatcher>INCLUDE</dispatcher>
<dispatcher>REQUEST</dispatcher>
</filter-mapping>
(1)、<servlet-name> 要素と <url-pattern> 要素は二択一の関係であり、その値は web.xml ファイル内でのある Servlet の登録名です。
(2)、<dispatcher> 要素の設定値には4種類あります:REQUEST、INCLUDE、FORWARD、ERROR。それぞれServletコンテナがリソースを呼び出す4つの方法に対応します:
通常のアクセス要求による呼び出し;
RequestDispatcher.include メソッドによる呼び出し;
RequestDispatcher.forward メソッドによる呼び出し;
エラーレスポンスリソースとして呼び出し。
<dispatcher> 子要素が設定されていない場合、REQUEST の場合と同等です。また、複数の <dispatcher> 子要素を設定して、Filter がリソースへの複数の呼び出し方法すべてをインターセプトするように指定することもできます。
七、Filter プログラムの例
FitstFilter.java
web.xml
test.html(WebContent パスの filter ディレクトリ内にあります)
アクセス:http://localhost:8888/testFilter_001/filter/test.html
記事の出典:https://my.oschina.net/u/1171518/blog/265467