Servlet Написание фильтров

Фильтры Servlet могут динамически перехватывать запросы и ответы, чтобы преобразовывать или использовать информацию, содержащуюся в запросе или ответе.

Один или несколько фильтров Servlet могут быть прикреплены к Servlet или группе Servlet. Фильтры Servlet также могут быть прикреплены к файлам JavaServer Pages (JSP) и HTML-страницам. Все прикреплённые фильтры Servlet вызываются перед вызовом Servlet.

Фильтр Servlet — это класс Java, который можно использовать в программировании Servlet и который позволяет достичь следующих целей:

  • Перехватывать клиентские запросы до того, как они получат доступ к серверным ресурсам.
  • Обрабатывать ответы сервера до того, как они будут отправлены обратно клиенту.

Различные типы фильтров, предлагаемые спецификацией:

  • Фильтры аутентификации.
  • Фильтры сжатия данных.
  • Фильтры шифрования.
  • Фильтры, инициирующие события доступа к ресурсам.
  • Фильтры преобразования изображений.
  • Фильтры журналирования и аудита.
  • Фильтры цепочки MIME-TYPE.
  • Фильтры токенизации.
  • Фильтры XSL/T, которые преобразуют XML-содержимое.

Фильтры объявляются с помощью XML-тегов в дескрипторе развёртывания веб-приложения (web.xml), а затем сопоставляются с именами Servlet или шаблонами URL в дескрипторе развёртывания вашего приложения.

Когда веб-контейнер запускает веб-приложение, он создаёт экземпляр для каждого фильтра, объявленного вами в дескрипторе развёртывания.

Порядок выполнения фильтров соответствует порядку конфигурации в файле конфигурации web.xml; обычно фильтры настраиваются перед всеми Servlet.

Методы фильтра сервлета

Фильтр — это класс Java, реализующий интерфейс javax.servlet.Filter. Интерфейс javax.servlet.Filter определяет три метода:

Нет.Метод и описание
1public void doFilter (ServletRequest, ServletResponse, FilterChain)
Этот метод выполняет фактическую операцию фильтрации. Когда метод клиентского запроса совпадает с URL-адресом, заданным для фильтра, контейнер сервлетов сначала вызывает метод doFilter фильтра. FilterChain позволяет пользователю получить доступ к последующим фильтрам.
2public void init(FilterConfig filterConfig)
При запуске веб-приложения веб-сервер создаёт экземпляр Filter и вызывает его метод init, читает конфигурацию web.xml и завершает инициализацию объекта, тем самым подготавливаясь к перехвату последующих запросов пользователя (объект фильтра создаётся только один раз, и метод init также выполняется только один раз). Через параметр метода init разработчики могут получить объект FilterConfig, представляющий информацию о конфигурации текущего фильтра.
3public void destroy()
Контейнер сервлетов вызывает этот метод перед уничтожением экземпляра фильтра и в этом методе освобождает ресурсы, занятые фильтром сервлетов.

Использование FilterConfig

Метод init класса Filter предоставляет объект FilterConfig.

Например, файл web.xml настроен следующим образом:

<filter>
    <filter-name>LogFilter</filter-name>
    <filter-class>com.example.test.LogFilter</filter-class>
    <init-param>
        <param-name>Site</param-name>
        <param-value>Example</param-value>
    </init-param>
</filter>

Используйте объект FilterConfig в методе init для получения параметров:

public void  init(FilterConfig config) throws ServletException {
    // 获取初始化参数
    String site = config.getInitParameter("Site"); 
    // 输出初始化参数
    System.out.println("网站名称: " + site); 
}

Пример фильтра сервлетов

Ниже приведён пример фильтра сервлетов, который выводит имя и адрес веб-сайта. Этот пример даёт базовое представление о фильтрах сервлетов. Вы можете использовать те же концепции для написания более сложных приложений с фильтрами:

package com.example.test;

//导入必需的 java 库
import javax.servlet.*;
import java.util.*;

//实现 Filter 类
public class LogFilter implements Filter  {
    public void  init(FilterConfig config) throws ServletException {
        // 获取初始化参数
        String site = config.getInitParameter("Site"); 

        // 输出初始化参数
        System.out.println("网站名称: " + site); 
    }
    public void  doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException, ServletException {

        // 输出站点名称
        System.out.println("站点网址:http://www.example.com");

        // 把请求传回过滤链
        chain.doFilter(request,response);
    }
    public void destroy( ){
        /* 在 Filter 实例被 Web 容器从服务移除之前调用 */
    }
}

Здесь мы используем ранее упомянутый DisplayHeader.java в качестве примера:

//导入必需的 java 库
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Enumeration;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@WebServlet("/DisplayHeader")

//扩展 HttpServlet 类
public class DisplayHeader extends HttpServlet {

    // 处理 GET 方法请求的方法
    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
    {
        // 设置响应内容类型
        response.setContentType("text/html;charset=UTF-8");

        PrintWriter out = response.getWriter();
        String title = "HTTP Header 请求实例 - Example实例";
        String docType =
            "<!DOCTYPE html> \n";
            out.println(docType +
            "<html>\n" +
            "<head><meta charset=\"utf-8\"><title>" + title + "</title></head>\n"+
            "<body bgcolor=\"#F0F0F0\">\n" +
            "<h1 align=\"center\">" + title + "</h1>\n" +
            "<table width=\"100%\" border=\"1\" align=\"center\">\n" +
            "<tr bgcolor=\"#949494\">\n" +
            "<th>Header 名称</th><th>Header 值</th>\n"+
            "</tr>\n");

        Enumeration headerNames = request.getHeaderNames();

        while(headerNames.hasMoreElements()) {
            String paramName = (String)headerNames.nextElement();
            out.print("<tr><td>" + paramName + "</td>\n");
            String paramValue = request.getHeader(paramName);
            out.println("<td> " + paramValue + "</td></tr>\n");
        }
        out.println("</table>\n</body></html>");
    }
    // 处理 POST 方法请求的方法
    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doGet(request, response);
    }
}

Сопоставление фильтра Servlet в Web.xml

Определение фильтра и последующее сопоставление его с URL или сервлетом примерно то же самое, что определение сервлета и последующее сопоставление его с шаблоном URL. В файле дескриптора развёртыванияweb.xmlсоздайте следующую запись для тега filter:

<?xml version="1.0" encoding="UTF-8"?>  
<web-app>  
<filter>
  <filter-name>LogFilter</filter-name>
  <filter-class>com.example.test.LogFilter</filter-class>
  <init-param>
    <param-name>Site</param-name>
    <param-value>Example</param-value>
  </init-param>
</filter>
<filter-mapping>
  <filter-name>LogFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>
<servlet>  
  <!-- 类名 -->  
  <servlet-name>DisplayHeader</servlet-name>  
  <!-- 所在的包 -->  
  <servlet-class>com.example.test.DisplayHeader</servlet-class>  
</servlet>  
<servlet-mapping>  
  <servlet-name>DisplayHeader</servlet-name>  
  <!-- 访问的网址 -->  
  <url-pattern>/TomcatTest/DisplayHeader</url-pattern>  
</servlet-mapping>  
</web-app>  

Вышеуказанный фильтр применяется ко всем сервлетам, потому что в конфигурации мы указали/*Если вы хотите применить фильтр только к нескольким сервлетам, можно указать конкретный путь сервлета.

Теперь попробуйте вызвать любой сервлет обычным способом, и вы увидите журналы, сгенерированные в веб-сервере. Вы также можете использовать логгер Log4J для записи вышеуказанных журналов в отдельный файл.

Далее мы переходим по адресу этого примераhttp://localhost:8080/TomcatTest/DisplayHeader, а затем смотрим вывод в консоли, как показано ниже:

Использование нескольких фильтров

Веб-приложения могут определять несколько различных фильтров для конкретных целей. Предположим, вы определяете два фильтраAuthenFilterиLogFilter. Вам нужно создать другое сопоставление, как описано ниже; остальная обработка примерно такая же, как объяснено выше:

<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>com.example.test.LogFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>

<filter>
   <filter-name>AuthenFilter</filter-name>
   <filter-class>com.example.test.AuthenFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>

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

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

Порядок применения фильтров

Порядок элементов filter-mapping в web.xml определяет порядок, в котором Web-контейнер применяет фильтры к сервлетам. Чтобы изменить порядок фильтров на обратный, достаточно изменить порядок элементов filter-mapping в файле web.xml.

Например, в приведённом выше примере сначала будет применён LogFilter, а затем AuthenFilter, но следующий пример изменит этот порядок на обратный:

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

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

Объяснение каждого узла в конфигурации web.xml

  • <filter>Указывает фильтр.
    • <filter-name>Используется для указания имени фильтра; содержимое этого элемента не может быть пустым.
    • <filter-class>Этот элемент используется для указания полного имени класса фильтра.
    • <init-param>Этот элемент используется для указания параметров инициализации фильтра. Его дочерние элементы<param-name>указывают имя параметра,<param-value>и задают значение параметра.
    • В фильтре можно использоватьFilterConfigобъект интерфейса FilterConfig для доступа к параметрам инициализации.
  • <filter-mapping>Этот элемент используется для задания ресурсов, которые фильтр должен перехватывать. Ресурсы, перехватываемые фильтром, можно задать двумя способами: по имени сервлета и по пути запроса для доступа к ресурсу.
    • <filter-name>Дочерний элемент используется для задания регистрационного имени фильтра. Это значение должно быть именем фильтра, объявленного в<filter>элементе <filter>.
    • <url-pattern>Задаёт путь запроса, перехватываемый фильтром (шаблон URL, связанный с фильтром).
  • <servlet-name>Задаёт имя сервлета, перехватываемого фильтром.
  • <dispatcher>Указывает способ, которым ресурс, перехватываемый фильтром, вызывается контейнером сервлетов; он может бытьREQUEST,INCLUDE,FORWARDиERRORодним из, по умолчанию —REQUEST. Пользователи могут задать несколько<dispatcher>дочерние элементы, указывающие, что фильтр перехватывает несколько методов вызова ресурса.
  • <dispatcher>Значения, которые можно задать для дочернего элемента, и их смысл
    • REQUEST: Когда пользователь напрямую обращается к странице, веб-контейнер вызовет фильтр. Если доступ к целевому ресурсу осуществляется через методы include() или forward() класса RequestDispatcher, фильтр не будет вызван.
    • INCLUDE: Если доступ к целевому ресурсу осуществляется через метод include() класса RequestDispatcher, фильтр будет вызван. В противном случае фильтр не будет вызван.
    • FORWARD: Если доступ к целевому ресурсу осуществляется через метод forward() класса RequestDispatcher, фильтр будет вызван. В противном случае фильтр не будет вызван.
    • ERROR: Если целевой ресурс вызывается через декларативный механизм обработки исключений, фильтр будет вызван. В противном случае фильтр не будет вызван.
Другие расширения