Tomcat过滤器简介

weixin_43882265

已于 2023-02-05 20:30:33 修改

阅读量478

点赞数

文章标签： servlet java tomcat

于 2023-02-04 22:06:01 首次发布

本文链接：https://blog.csdn.net/weixin_43882265/article/details/128886264

版权

1.过滤器

1.1 过滤器简介

过滤器本身并不生成 ServletRequest对象和 ServletResponse对象，他只为 Web组件供如下过滤功能：

过滤器能够在 Web组件被调用之前检查 ServletRequest对象，修改请求头和请求正文的内容，或者对请求进行预处理操作。
过滤器能够在 Web组件被调用之后检查 ServletResponse对象，修改响应头和响应正文。

过滤器负责过滤的 Web组件可以是Servlet、JSP或HTML文件。
图1-1 过滤器的过滤过程

图1-1 过滤器的过滤过程

过滤器具有以下特点：

过滤器可以检查ServletRequest对象和 ServletResponse对象，并且利用ServletRequestWrapper和 ServletResponseWrapper包装类来修改 ServletRequest对象和 ServletResponse对象。
可以在 web.xml文件中为过滤器映射特定的 URL.当客户请求访问此 URL时，Servlet容器就会触发过滤器工作。
多个过滤器可以被串联在一起，协同为 Web组件过滤请求对象和响应对象。

1.2 创建过滤器

所有自定义的过滤器类都必须实现 javax.servlet.Filter接口。这个接口含有3个过滤器类必须实现的方法：

init(FilterConfig config)：这是过滤器的初始化方法。在Web应用启动时，Servlet容器先创建包含了过滤器配置信息的 FilterConfig对象，然后创建 Flter的对象，接着调用 Filter对象的 init(FilterConfig config)方法。在这个方法中可通过 config参数来读取web.xml文件中为过滤器配置的初始化参数。
doFilter(ServletRequest req, ServletResponse res, FilterChain chain)：这个方法完成实际的过滤操作。当客户请求访问的 URL与为过滤器映射的 URL匹配时，Servlet容器将先调用过滤器的 doFilter()方法。FilterChain参数用于访问后续过滤器或者 Web组件。
destroy()：Servlet容器在销毁过滤器对象前调用该方法，在这个方法中可以释放过滤器占用的资源。

过滤器由 Servlet容器创建，在它的生命周期中包含以下阶段：

初始化阶段：当 Web应用启动时，Servlet容器会加载过滤器类，创建过滤器配置对象（FilterConfig）和过滤器对象，并调用过滤器对象的 init(FilterConfig config)方法。
运行时阶段：当客户请求访问的 URL与为过滤器映射的 URL匹配时，Servlet容器将先调用过滤器的doFilter()方法。
销毁阶段：当 Web应用终止时，Servlet容器先调用过滤器对象的destroy()方法，然后销毁过滤器对象。

1.3 发布过滤器

发布过滤器有两种办法：

在 web.xml 文件中通过 <filter>元素和 <filter-mapping>元素来配置过滤器。
在过滤器类中用 @WebFilter 标注来配置过滤器。

1.3.1 在 web.xml文件中配置过滤器

<filter>元素用来定义一个过滤器，如下所示：

<filter> 
    <filter-name>NoteFilter</filter-name> <!--指定过滤器名-->
    <filter-class>mypack.NoteFilter</filter-class> <!--指定过滤器的类名-->

    <!--为过滤器实例提供初始化参数，可在init()方法中通过config.getInitParameter(String name)读取-->
    <init-param>
        <param-name>ipblock</param-name>
        <param-value>221.45</param-value>
    </init-param>

    <init-param>
        <param-name>blacklist</param-name>
        <param-value>捣蛋鬼</param-value>
    </init-param>
</filter> 

<!--为过滤器映射特定的URL-->
<filter-mapping> 
    <filter-name>NoteFilter</filter-name> 
    <url-pattern>/note</url-pattern> 
</filter-mapping>

注意：在 web.xml文件中，必须先配置所有过滤器，再配置Servlet。

1.3.2 用 @WebFilter标注来配置过滤器

@WebFilter过滤器标注的常用属性见下：

属性	类型	描述
filterName	String	指定过滤器的名字，等价于<filter-name>
urlPatterns	String[]	指定一组待过滤的URL匹配模式，等价于<url-pattern>
value	String[]	该属性等价于urlPatterns属性，但两者不应该同时使用
initParams	WebInitParam[]	指定一组过滤器初始化参数，等价于</init-param>
asyncSupported	boolean	声明过滤器是否支持异步处理模式，等下于<async-supported>
Description	String	指定过滤器的描述信息，等价于<description>
displayName	String	指定过滤器的显示名，通常配合工具使用，等价于<display-name>
dispatcherTypes	DispatcherType	指定过滤器的调用模式，可以指定多个值，用逗号分隔。具体取值包括：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST

dispatcherTypes属性的具体取值为：

DispatcherType.REQUEST：当客户端直接请求访问待过滤的目标资源时，Web容器会先调用该过滤器。
DispatcherType.FORWARD：当待过滤的目标资源是通过RequestDispatcher 的 forward（请求转发）方式被访问时，Web容器会先调用该过滤器。
DispatcherType.INCLUDE：当待过滤的目标资源是通过RequestDispatcher 的 include（请求包含）方式被访问时，Web容器会先调用该过滤器。
DispatcherType.INCLUDE：当待过滤的目标资源是通过声明式异常处理机制被访问时，Web容器会先调用该过滤器。
DispatcherType.ASYNC：当待过滤的目标资源是被异常访问时，Web容器会先调用该过滤器。

对于 NoteFilter类的过滤器，可以加入如下 @WebFilter标注：

@WebFilter( //用@WebFilter标注配置NoteFilter
    filterName = "NoteFilter", 	
    urlPatterns = "/note", 	
    initParams = {
        @WebInitParam(name = "ipblock", value = "221.45"),			
        @WebInitParam(name = "blacklist", value = "捣蛋鬼")}
)
public class NoteFilter implements Filter {...}