Filtro Servlet Escrito

Os filtros Servlet 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 Servlet a um Servlet ou a um grupo de Servlets. Os filtros Servlet também podem ser adicionados a arquivos JavaServer Pages (JSP) e páginas HTML. Chamam todos os filtros Servlet adicionados antes de chamar o Servlet.

Os filtros Servlet são classes Java utilizáveis em programação Servlet, que podem alcançar os seguintes objetivos:

• Interceptar essas solicitações antes de acessar os recursos do back-end pelo cliente.

• Tratar essas respostas antes de enviá-las de volta ao cliente.

De acordo com as sugestões de vários tipos de filtros normativos:

• Filtros de Autenticação (Authentication Filters).

• Filtros de Compressão de Dados (Data compression Filters).

• Filtros de Criptografia (Encryption Filters).

• Filtros que Geração 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 Chain (MIME-TYPE Chain Filters).

• Filtros de Marcadores (Tokenizing Filters).

• XSL/T Filtros (XSL/T Filters), convertindo conteúdo XML.

O filtro é declarado através de uma etiqueta XML no descriptor de deploy Web (web.xml) e mapeado ao nome do Servlet ou ao padrão de URL no descriptor de deploy da aplicação.

Quando o contêiner Web inicia a aplicação web, ele cria uma instância de exemplo para cada filtro declarado no descriptor de deploy.

A ordem de execução do Filter é a mesma que a ordem de configuração no arquivo web.xml, geralmente colocando o Filter antes de todos os Servlets.

Métodos do Filtro Servlet

O filtro é uma classe Java que implementa a interface javax.servlet.Filter. A interface javax.servlet.Filter define três métodos:

FilterConfig 使用

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 过滤器的示例，将输出网站名称和地址。本示例让您对 Servlet 过滤器有基本的了解，您可以使用相同的概念编写更复杂的过滤器应用程序：

package com.w3codebox.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://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)
//Extensão da 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 Site 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>Nome do Header</th><th>Valor do 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>");
　　　　}
　　　　//　Método para lidar com solicitações de método POST
　　　　public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
　　　　　　　　doGet(request, response);
　　　　}
}

Mapeamento de Filtro Servlet no Web.xml

Defina o filtro e mapeie para uma URL ou Servlet, o que é basicamente o mesmo que definir um Servlet e mapear para um padrão de URL. No arquivo de descrição de deployment web.xml crie a seguinte entrada 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 usual e você verá os logs gerados no servidor web. Você também pode usar o Log4O registrador J é usado para gravar os logs acima em um arquivo separado.

A seguir, acessamos este endereço de exemplo http://localhost:8080/TomcatTest/DisplayHeader, e então verifique o conteúdo de saída no console, conforme mostrado a seguir:

Uso de múltiplos filtros

O aplicativo web pode definir vários filtros diferentes para fins específicos. Suponha que você tenha definido dois filtros AuthenFilter e LogFilterVocê precisa criar um mapeamento diferente conforme descrito acima:

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

Ordem de aplicação do filtro

filter no web.xml-A ordem do elemento mapping determina a ordem em que o container web aplica os filtros aos Servlets. Para inverter a ordem dos filtros, é necessário inverter a ordem dos elementos filter no arquivo web.xml-mapping>elemento é suficiente.

Por exemplo, no exemplo acima, o LogFilter será aplicado primeiro, seguido pelo AuthenFilter, mas no exemplo a seguir, a ordem será invertida:

<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>Define um filtro.

• <filter-name>Usado para definir um nome para o filtro, o conteúdo deste elemento não pode estar vazio.

• <filter-class>Elemento usado para definir o nome completo qualificado da classe do filtro.

• <init-param>Elemento usado para definir parâmetros de inicialização para o filtro, seus elementos filhos <param-name>Define o nome do parâmetro, <param-value>Define o valor do parâmetro.

• No filtro, pode-se usar o objeto de interface FilterConfig para acessar os parâmetros de inicialização.

• <filter-mapping>Elemento usado para definir os recursos interceptados por um Filter. Um Filter intercepta recursos de duas maneiras: nome do Servlet e caminho de acesso ao recurso

• <filter-name>Elemento usado para definir o nome de registro do filtro. Este valor deve ser o nome do filtro declarado no elemento <filter>.

• <url-pattern> configura o caminho da solicitação interceptada pelo filter (estilo de URL associado ao filtro)

• <servlet-name> especifica o nome do Servlet interceptado pelo filtro.

• <dispatcher> especifica a maneira como o Servlet Container chama os recursos interceptados pelo filtro, que pode ser um dos seguintes: REQUEST, INCLUDE, FORWARD e ERROR, o padrão é REQUEST. O usuário pode configurar vários elementos <dispatcher> para especificar vários tipos de chamadas de recursos interceptados pelo Filter.

• Os valores que podem ser configurados para o 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 de destino for acessado pelo método include() ou forward() do RequestDispatcher, então o filtro não será chamado.

• INCLUDE: Se o recurso de destino for acessado pelo método include() do RequestDispatcher, então o filtro será chamado. Além disso, o filtro não será chamado.

• FORWARD: Se o recurso de destino for acessado pelo método forward() do RequestDispatcher, então o filtro será chamado, além disso, o filtro não será chamado.

• ERROR: Se o recurso de destino for chamado pelo mecanismo de tratamento de exceções declarativo, então o filtro será chamado. Além disso, o filtro não será chamado.