I. Основной принцип работы Filter

  • 1. Программа Filter — это Java-класс, реализующий специальный интерфейс. Подобно Servlet, она также вызывается и выполняется контейнером Servlet.
  • 2. Когда Filter регистрируется в web.xml для перехвата программы Servlet, он может решить, продолжать ли передавать запрос программе Servlet и нужно ли изменять сообщения запроса и ответа.
  • 3. Когда контейнер Servlet начинает вызывать программу Servlet, если он обнаруживает, что для перехвата этого Servlet зарегистрирована программа Filter, контейнер больше не вызывает напрямую метод service Servlet. Вместо этого он вызывает метод doFilter Filter, который затем решает, активировать ли метод service.
  • 4. Однако в методе Filter.doFilter нельзя напрямую вызвать метод service Servlet. Вместо этого вы вызываете метод FilterChain.doFilter, чтобы активировать метод service целевого Servlet. Объект FilterChain передаётся через параметры метода Filter.doFilter.
  • 5. Достаточно добавить немного программного кода до и после оператора, вызывающего FilterChain.doFilter в методе Filter.doFilter, и можно реализовать определённые специальные функции до и после ответа Servlet.
  • 6. Если в методе Filter.doFilter не вызывается метод FilterChain.doFilter, метод service целевого Servlet не будет выполнен. Таким образом, Filter может блокировать некоторые недопустимые запросы доступа.

II. Цепочка фильтров

  • 1. В Web-приложении можно зарегистрировать несколько программ-фильтров, и каждая программа-фильтр может перехватывать одну или группу программ Servlet. Если несколько программ-фильтров могут перехватывать процесс доступа к некоторой программе Servlet, то при поступлении запроса доступа к этому Servlet Web-контейнер объединит эти несколько программ-фильтров в цепочку фильтров (также называемую Filter chain).
  • 2. Порядок перехвата фильтров в цепочке фильтров совпадает с порядком их сопоставления в файле web.xml. Вызов метода FilterChain.doFilter в методе doFilter предыдущего Filter активирует метод doFilter следующего Filter, а вызов метода FilterChain.doFilter в методе doFilter последнего Filter активирует метод service целевого Servlet.
  • 3. Если хотя бы один Filter в цепочке фильтров не вызывает метод FilterChain.doFilter, метод service целевого Servlet не будет выполнен.

III. Интерфейс Filter

Программа-фильтр — это Java-класс, и этот класс должен реализовывать интерфейс Filter. Интерфейс javax.servlet.Filter определяет три метода: init, doFilter и destroy.

1. Метод init

  • (1) При запуске Web-приложения Web-сервер (Web-контейнер) создаст объект-экземпляр для каждого зарегистрированного Filter на основе конфигурационной информации в его файле web.xml и сохранит его в памяти.
  • (2) После создания объекта-экземпляра Filter Web-контейнер немедленно вызовет метод init этого объекта Filter. Метод init выполняется только один раз в жизненном цикле Filter. Когда Web-контейнер вызывает метод init, он передаёт объект FilterConfig, содержащий информацию о конфигурации Filter и среде выполнения.

    public voic init(FilterConfig filterConfig) throws ServletException
  • (3) Разработчики могут выполнять функции инициализации, аналогичные конструкторам, в методе init. Обратите внимание, что если код инициализации должен использовать объект FilterConfig, этот код можно написать только в методе init, а не в конструкторе (так как метод init ещё не был вызван, объект FilterConfig ещё не создан, и его использование наверняка приведёт к ошибке).

2. Метод doFilter

Когда объект Filter способен перехватывать запросы доступа, контейнер Servlet вызовет метод doFilter объекта Filter.

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException.ServletException

Среди них параметры request и response — это объекты запроса и ответа, переданные веб-контейнером или предыдущим Filter в цепочке Filter; параметр chain — это объект, представляющий текущую цепочку Filter.

3. Метод destroy

Этот метод вызывается перед тем, как веб-контейнер выгружает объект Filter, и он также выполняется только один раз. Он может выполнять противоположную функцию метода init, освобождая ресурсы, открытые объектом Filter, например закрывая соединения с базой данных и потоки IO.


IV. Интерфейс FilterChain

Этот интерфейс используется для определения методов, которые объект цепочки Filter должен предоставлять извне. Этот интерфейс определяет только один метод doFilter.

public void doFilter(ServletRequest request, ServletResponse response) throws java.io.IOException.ServletException

Метод doFilter интерфейса FilterChain используется для уведомления веб-контейнера о передаче запроса следующему Filter в цепочке Filter для обработки. Если текущий объект Filter, вызывающий этот метод, является последним Filter в цепочке Filter, запрос будет передан целевой программе Servlet для обработки.


V. Интерфейс FilterConfig

  • 1. Как и обычные программы Servlet, программы Filter также могут нуждаться в доступе к контейнеру Servlet. Спецификация Servlet инкапсулирует объект ServletContext и информацию о параметрах конфигурации Filter в объект под названием FilterConfig.
  • 2. Интерфейс FilterConfig используется для определения методов, которые объект FilterConfig должен предоставлять извне, чтобы в программе Filter эти методы можно было вызывать для получения объекта ServletContext, а также дружественного имени и параметров инициализации, заданных для Filter в файле web.xml.
  • 3. Методы, определённые интерфейсом FilterConfig:

    • Метод getFilterName: возвращает значение, заданное в элементе <filter-name>.

    • Метод getServletContext: возвращает ссылку на объект ServletContext, инкапсулированный в объекте FilterConfig.

    • Метод getInitParameter: используется для возврата значения параметра инициализации с указанным именем, заданным для Filter в файле web.xml.

    • Метод getInitParameterNames: возвращает объект коллекции Enumeration.


VI. Регистрация и сопоставление Filter

1. Регистрация Filter

Элемент <filter> используется для регистрации 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.

Первый способ: указать путь доступа к ресурсу

<filter-mapping>
    <filter-name>FirstFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

Настройка пути доступа в элементе <url-pattern> следует спецификации сопоставления URL сервлетов.

  • /*Указывает, что все запросы доступа перехватываются.
  • /filter/*Указывает на перехват всех запросов доступа в каталоге filter, например: http://localhost:8888/testFilter_001/filter/xxxxxx.
  • /test.htmlУказывает на перехват запросов доступа с test.html в качестве имени ресурса в корневом каталоге; ссылка для доступа будет только: http://localhost:8888/test.html.

Второй способ: указать имя сервлета

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

(2) Элемент <dispatcher> имеет четыре возможных значения: REQUEST, INCLUDE, FORWARD, ERROR, соответствующих четырём способам вызова ресурсов контейнером сервлетов:

  • Вызывается через обычные запросы доступа;

  • Вызывается через метод RequestDispatcher.include;

  • Вызывается через метод RequestDispatcher.forward;

  • Вызывается как ресурс ответа об ошибке.

Если дочерний элемент <dispatcher> не установлен, это эквивалентно случаю REQUEST. Также можно установить несколько дочерних элементов <dispatcher>, чтобы указать, что Filter перехватывает несколько способов вызова ресурса.


VII. Пример программы фильтра

FitstFilter.java

import java.io.IOException; import java.io.PrintWriter; import java.util.Enumeration; import javax.servlet.Filter; import javax.servlet.FilterChain; import javax.servlet.FilterConfig; import javax.servlet.ServletException; import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.http.HttpServletRequest; public class FirstFilter implements Filter { private FilterConfig filterConfig = null; String paramValue = null; @Override public void init(FilterConfig filterConfig) throws ServletException { this.filterConfig = filterConfig; paramValue = filterConfig.getInitParameter("encoding"); } @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { System.out.println("начало заголовков-------------------"); Enumeration<?> headerNames = ((HttpServletRequest)request).getHeaderNames(); while(headerNames.hasMoreElements()) { String headerName = (String)headerNames.nextElement(); System.out.println(headerName + ": " + ((HttpServletRequest)request).getHeader(headerName)); } System.out.println("конец заголовков-------------------"); //Запишите содержимое ответа перед вызовом целевого объекта response.setContentType("text/html; charset=gb2312"); PrintWriter out = response.getWriter(); out.println("IP-адрес:" + request.getRemoteHost() + "<br>"); chain.doFilter(request, response); //Запишите содержимое ответа после возврата целевого объекта out.println("<br>Значение параметра инициализации с именем encoding:" + paramValue); out.println("<br>Реальный путь текущего веб-приложения:" + filterConfig.getServletContext().getRealPath("/")); //out.println("<br>файл test.html был изменён!"); } @Override public void destroy() { this.filterConfig = null; } }

web.xml

<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> <filter-mapping> <filter-name>FirstFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>

test.html (находится в каталоге filter в пути WebContent)

<html> <head> <meta charset="UTF-8"> <title>Вставьте заголовок здесь</title> </head> <body>Это исходное содержимое страницы test.html!</body> </html>

Доступ:http://localhost:8888/testFilter_001/filter/test.html

Источник статьи: https://my.oschina.net/u/1171518/blog/265467