Servlet Écriture de filtres
Les filtres Servlet peuvent intercepter dynamiquement les requêtes et les réponses afin de transformer ou d'utiliser les informations contenues dans la requête ou la réponse.
Un ou plusieurs filtres Servlet peuvent être attachés à une Servlet ou à un groupe de Servlets. Les filtres Servlet peuvent également être attachés à des fichiers JavaServer Pages (JSP) et à des pages HTML. Tous les filtres Servlet attachés sont appelés avant l'invocation de la Servlet.
Un filtre Servlet est une classe Java qui peut être utilisée dans la programmation Servlet et peut remplir les objectifs suivants :
- Intercepter les requêtes client avant qu'elles n'accèdent aux ressources backend.
- Traiter les réponses du serveur avant qu'elles ne soient renvoyées au client.
Divers types de filtres suggérés par la spécification :
- Filtres d'authentification.
- Filtres de compression de données.
- Filtres de chiffrement.
- Filtres qui déclenchent des événements d'accès aux ressources.
- Filtres de conversion d'images.
- Filtres de journalisation et d'audit.
- Filtres de chaîne MIME-TYPE.
- Filtres de tokenisation.
- Filtres XSL/T, qui transforment le contenu XML.
Les filtres sont déclarés avec des balises XML dans le descripteur de déploiement Web (web.xml), puis associés à des noms de Servlet ou à des motifs d'URL dans le descripteur de déploiement de votre application.
Lorsque le conteneur Web démarre l'application Web, il crée une instance pour chaque filtre que vous avez déclaré dans le descripteur de déploiement.
L'ordre d'exécution des filtres correspond à l'ordre de configuration dans le fichier de configuration web.xml ; généralement, les filtres sont configurés avant toutes les Servlets.
Méthodes des filtres Servlet
Un filtre est une classe Java qui implémente l'interface javax.servlet.Filter. L'interface javax.servlet.Filter définit trois méthodes :
| Non. | Metode & Deskripsi |
|---|---|
| 1 | public void doFilter (ServletRequest, ServletResponse, FilterChain) Cette méthode effectue l'opération de filtrage proprement dite. Lorsque la méthode de requête du client correspond à l'URL définie pour le filtre, le conteneur de servlets appelle d'abord la méthode doFilter du filtre. FilterChain permet à l'utilisateur d'accéder aux filtres suivants. |
| 2 | public void init(FilterConfig filterConfig) Lorsque l'application Web démarre, le serveur Web crée une instance du Filtre et appelle sa méthode init, lit la configuration web.xml et termine l'initialisation de l'objet, se préparant ainsi à intercepter les requêtes utilisateur suivantes (l'objet filtre n'est créé qu'une seule fois, et la méthode init n'est également exécutée qu'une seule fois). Grâce au paramètre de la méthode init, les développeurs peuvent obtenir l'objet FilterConfig représentant les informations de configuration du filtre actuel. |
| 3 | public void destroy() Le conteneur de servlets appelle cette méthode avant de détruire l'instance de filtre, et dans cette méthode, il libère les ressources occupées par le filtre de servlets. |
Utilisation de FilterConfig
La méthode init de Filter fournit un objet FilterConfig.
Par exemple, le fichier web.xml est configuré comme suit :
<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>
Utilisez l'objet FilterConfig dans la méthode init pour obtenir des paramètres :
public void init(FilterConfig config) throws ServletException {
// 获取初始化参数
String site = config.getInitParameter("Site");
// 输出初始化参数
System.out.println("网站名称: " + site);
}
Exemple de filtre Servlet
Voici un exemple de filtre Servlet qui affichera le nom et l'adresse du site Web. Cet exemple vous donne une compréhension de base des filtres Servlet. Vous pouvez utiliser les mêmes concepts pour écrire des applications de filtrage plus complexes :
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 容器从服务移除之前调用 */
}
}
Ici, nous utilisons le DisplayHeader.java mentionné précédemment comme exemple :
//导入必需的 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);
}
}
Mappage de filtre Servlet dans Web.xml
Définir un filtre puis le mapper à une URL ou à un Servlet revient à peu près au même que définir un Servlet puis le mapper à un modèle d'URL. Dans le fichier descripteur de déploiementweb.xmlcréez l'entrée suivante pour la balise 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>
Le filtre ci-dessus s'applique à tous les Servlets, car dans la configuration nous avons spécifié/*Si vous souhaitez appliquer le filtre à seulement quelques Servlets, vous pouvez spécifier un chemin de Servlet spécifique.
Essayez maintenant d'invoquer n'importe quel Servlet de la manière habituelle, et vous verrez les journaux générés dans le serveur Web. Vous pouvez également utiliser un enregistreur Log4J pour enregistrer les journaux ci-dessus dans un fichier séparé.
Ensuite, nous visitons cette adresse d'exemplehttp://localhost:8080/TomcatTest/DisplayHeader, puis regardons la sortie dans la console, comme indiqué ci-dessous :

Utilisation de plusieurs filtres
Les applications Web peuvent définir plusieurs filtres différents à des fins spécifiques. Supposons que vous définissiez deux filtresAuthenFilteretLogFilter. Vous devez créer un mappage différent comme décrit ci-dessous ; le reste du traitement est à peu près le même que celui expliqué ci-dessus :
<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>
Ordre d'application des filtres
L'ordre des éléments filter-mapping dans web.xml détermine l'ordre dans lequel le conteneur Web applique les filtres aux Servlets. Pour inverser l'ordre des filtres, il vous suffit d'inverser les éléments filter-mapping dans le fichier web.xml.
Par exemple, l'exemple ci-dessus appliquera d'abord LogFilter, puis AuthenFilter, mais l'exemple suivant inversera cet ordre :
<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>
Explication de chaque nœud dans la configuration web.xml
<filter>Spécifie un filtre.<filter-name>Utilisé pour spécifier un nom pour le filtre ; le contenu de cet élément ne peut pas être vide.<filter-class>Cet élément sert à spécifier le nom de classe pleinement qualifié du filtre.<init-param>Cet élément est utilisé pour spécifier les paramètres d'initialisation du filtre. Ses éléments enfants<param-name>spécifient le nom du paramètre,<param-value>et spécifient la valeur du paramètre.- Dans le filtre, vous pouvez utiliser
FilterConfigl'objet d'interface FilterConfig pour accéder aux paramètres d'initialisation.
<filter-mapping>Cet élément sert à définir les ressources qu'un filtre est chargé d'intercepter. Les ressources interceptées par un filtre peuvent être spécifiées de deux façons : le nom de Servlet et le chemin de requête pour l'accès à la ressource.<filter-name>L'élément enfant sert à définir le nom d'enregistrement du filtre. Cette valeur doit être le nom d'un filtre déclaré dans<filter>l'élément <filter>.<url-pattern>Définit le chemin de requête intercepté par le filtre (le modèle d'URL associé au filtre).
<servlet-name>Spécifie le nom de la Servlet interceptée par le filtre.<dispatcher>Spécifie la manière dont la ressource interceptée par le filtre est invoquée par le conteneur de Servlets ; elle peut êtreREQUEST,INCLUDE,FORWARDetERRORl'une de, la valeur par défaut estREQUEST. Les utilisateurs peuvent définir plusieurs<dispatcher>éléments enfants pour spécifier que le filtre intercepte plusieurs méthodes d'invocation de la ressource.<dispatcher>Les valeurs que l'élément enfant peut prendre et leurs significationsREQUEST: Lorsque l'utilisateur accède directement à la page, le conteneur Web appellera le filtre. Si la ressource cible est accédée via les méthodes include() ou forward() de RequestDispatcher, alors le filtre ne sera pas appelé.INCLUDE: Si la ressource cible est accédée via la méthode include() de RequestDispatcher, alors le filtre sera appelé. Sinon, le filtre ne sera pas appelé.FORWARD: Si la ressource cible est accédée via la méthode forward() de RequestDispatcher, alors le filtre sera appelé. Sinon, le filtre ne sera pas appelé.ERROR: Si la ressource cible est invoquée via le mécanisme déclaratif de gestion des exceptions, alors le filtre sera appelé. Sinon, le filtre ne sera pas appelé.