English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية
Os filtros em JSP e Servlet são classes Java.
Os filtros podem interceptar dinamicamente solicitações e respostas para transformar ou usar informações contidas nas solicitações ou respostas.
Pode adicionar um ou mais filtros a um Servlet ou a um grupo de Servlets. Os filtros também podem ser adicionados a arquivos JavaServer Pages (JSP) e páginas HTML.
Os filtros são classes Java úteis para programação Servlet, que podem alcançar os seguintes objetivos:
Interceptar essas solicitações antes de acessarem os recursos do back-end.
Tratar essas respostas antes de enviá-las de volta ao cliente.
Tipos de filtros recomendados pelo padrão:
Filtros de Autenticação (Authentication Filters).
Filtros de Compressão de Dados (Data compression Filters).
Filtros de Criptografia (Encryption Filters).
Filtros que Disparam Eventos de Acesso a Recursos.
Filtros de Conversão de Imagem (Image Conversion Filters).
Filtros de Registro e Auditoria (Logging and Auditing Filters).
MIME-TYPE Filtros de Cadeia (MIME-TYPE Chain Filters).
Filtros de Marcadorização (Tokenizing Filters).
XSL/T Filtros (XSL/T Filters), convertindo conteúdo XML.
O filtro é declarado através das etiquetas XML no descriptor de deploy Web (web.xml) e mapeado ao nome Servlet ou padrão de URL no descriptor de deploy do seu aplicativo.
Quando o container Web inicia o aplicativo Web, ele cria um exemplo para cada filtro declarado no descriptor de deploy.
A ordem de execução do Filter é consistente com a ordem de configuração no arquivo web.xml, geralmente configurando o Filter antes de todos os Servlets.
Filtro é uma classe Java que implementou a interface javax.servlet.Filter. A interface javax.servlet.Filter define três métodos:
Número de Ordem | Método & Descrição |
---|---|
1 | public void doFilter(ServletRequest, ServletResponse, FilterChain) Este método realiza a operação de filtragem real, quando a solicitação do cliente coincide com a URL configurada pelo filtro, o container Servlet chama primeiro o método doFilter do filtro. FilterChain é usado para acessar os próximos filtros. |
2 | public void init(FilterConfig filterConfig) Quando um aplicativo web é iniciado, o servidor web cria um exemplo do objeto Filter e chama seu método init, lendo a configuração web.xml para completar a função de inicialização do objeto, preparando-se para interceptar solicitações de usuários posteriores (o objeto Filter será criado apenas uma vez e o método init será executado apenas uma vez). Os desenvolvedores podem obter o objeto FilterConfig que representa as informações de configuração do filter através dos parâmetros do método init. |
3 | public void destroy()} Servlet 容器在销毁过滤器示例前调用该方法,在该方法中释放 Servlet 过滤器占用的资源。 |
Filter 的 init 方法中提供了一个 FilterConfig 对象。
如 web.xml 文件配置如下:
<filter> <filter-name>LogFilter</filter-name> <filter-class>com.w3codebox.test.LogFilter</filter-class> <init-param> <param-name>Site</param-name> <param-value>Base Tutorial Website</param-value> </init-param> </filter>
在 init 方法使用 FilterConfig 对象获取参数:
public void init(FilterConfig config) throws ServletException { // 获取初始化参数 String site = config.getInitParameter("Site"); // 输出初始化参数 System.out.println("网站名称: " + site); }
以下是 Servlet 过滤器的示例,将输出网站名称和地址。本示例让您对 Servlet 过滤器有基本的了解,您可以使用相同的概念编写更复杂的过滤器应用程序:
//导入必需的 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://pt.oldtoolbag.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) //Estender a classe HttpServlet public class DisplayHeader extends HttpServlet // Método para lidar com solicitações GET public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { // Definir tipo de conteúdo da resposta response.setContentType("text/html;charset=UTF-8"); PrintWriter out = response.getWriter(); String title = "Exemplo de Requisição de Header HTTP - Básico Tutorial Net Exemplo"; 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 nome</th><th>Header valor</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>"); } // Método para lidar com solicitações de método POST public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } }
Defina o filtro e mapeie para uma URL ou Servlet, o que é semelhante a definir um Servlet e mapear para um padrão de URL. No arquivo de descrição de deployment web.xml Para criar a entrada a seguir para a tag filter no
<?xml version="1.0" encoding="UTF-8"?> <web-app> <filter> <filter-name>LogFilter</filter-name> <filter-class>com.w3codebox.test.LogFilter</filter-class> <init-param> <param-name>Site</param-name> <param-value>Base Tutorial Website</param-value> </init-param> </filter> <filter-mapping> <filter-name>LogFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <servlet> <!-- o nome da classe --> <servlet-name>DisplayHeader</servlet-name> <!-- o pacote onde está --> <servlet-class>com.w3codebox.test.DisplayHeader</servlet-class> </servlet> <servlet-mapping> <servlet-name>DisplayHeader</servlet-name> <!-- o endereço da URL acessada --> <url-pattern>/TomcatTest/DisplayHeader</url-pattern> </servlet-mapping> </web-app>
Este filtro é aplicável a todos os Servlets, porque especificamos /* . Se você quiser aplicar o filtro a apenas alguns Servlets, você pode especificar um caminho de Servlet específico.
Agora, tente chamar qualquer Servlet da maneira comum e você verá os logs gerados no servidor web. Você também pode usar o Log4O registrador é usado para gravar os logs acima em um arquivo separado.
接下来我们访问这个示例地址 http://localhost:8080/TomcatTest/DisplayHeader,然后在控制台查看输出内容
Web 应用程序可以根据特定的目的定义若干个不同的过滤器。假设您定义了两个过滤器 AuthenFilter 和 LogFilter。您需要创建一个如下所述的不同的映射,其余的处理与上述所讲解的大致相同:
<filter> <filter-name>LogFilter</filter-name> <filter-class>com.w3codebox.test.LogFilter</filter-class> <init-param> <param-name>test-param</param-name> <param-value>Initialization Parameter</param-value> </init-param> </filter> <filter> <filter-name>AuthenFilter</filter-name> <filter-class>com.w3codebox.test.AuthenFilter</filter-class> <init-param> <param-name>test-param</param-name> <param-value>Initialization Parameter</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>
web.xml 中的 filter-mapping 元素的顺序决定了 Web 容器应用过滤器到 Servlet 的顺序。若要反转过滤器的顺序,您只需要在 web.xml 文件中反转 filter-mapping 元素即可。
例如,上面的示例将先应用 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>
<filter>指定一个过滤器。
<filter-name>用于为过滤器指定一个名字,该元素的内容不能为空。
<filter-class>元素用于指定过滤器的完整的限定类名。
<init-param>元素用于为过滤器指定初始化参数,它的子元素<param-name>指定参数的名字,<param-value>指定参数的值。
在过滤器中,可以使用FilterConfig接口对象来访问初始化参数。
<filter-mapping>元素用于设置一个 Filter 所负责拦截的资源。一个Filter拦截的资源可通过两种方式来指定:Servlet 名称和资源访问的请求路径
<filter-name>用于设置filter的注册名称。该值必须在<filter>元素中声明过的过滤器的名字
<url-pattern>define o caminho da requisição que o filter intercepta (estilo de URL associado ao filter)
<servlet-name>especifica o nome do Servlet interceptado pelo Filter
O elemento <dispatcher> especifica a maneira como o contêiner de Servlet chama os recursos interceptados pelo Filter, que pode ser um dos seguintes: REQUEST, INCLUDE, FORWARD e ERROR, o padrão é REQUEST. O usuário pode configurar múltiplos elementos <dispatcher> para especificar várias maneiras de interceptar o Filter para recursos.
Os valores que podem ser configurados no elemento <dispatcher> e seu significado
REQUEST:Quando o usuário acessar diretamente a página, o contêiner web chamará o filtro. Se o recurso alvo for acessado através do método include() ou forward() do RequestDispatcher, o filtro não será chamado.
INCLUDE:Se o recurso alvo for acessado através do método include() do RequestDispatcher, esse filtro será chamado. Além disso, o filtro não será chamado.
FORWARD:Se o recurso alvo for acessado através do método forward() do RequestDispatcher, esse filtro será chamado, além disso, o filtro não será chamado.
ERROR:Se o recurso alvo for chamado através do mecanismo de exceção declarativa, esse filtro será chamado. Além disso, o filtro não será chamado.