目录
一:Filter简介
二:关于Filter
(一)如何使用Filter进行过滤
(二)过滤器链 (FilterChain)
(三)Filter的配置
1.通过web.xml文件配置
2.通过注解配置
(四)Filter的生命周期
(五)中文乱码过滤器
三:测试案例
1.单个过滤器
2.多个过滤器
一:Filter简介
Filter也称之为过滤器,它是Servlet技术中最实用的技术,Web开发人员通过Filter技术,对web服务器管理的所有web资源:例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截,从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
它主要用于对用户请求进行预处理,也可以对HttpServletResponse进行后处理。使用Filter的完整流程:Filter对用户请求进行预处理,接着将请求交给Servlet进行处理并生成响应,最后Filter再对服务器响应进行后处理。
客户端请求到达的时候,经过一次过滤器。
服务器处理完请求的时候,经过一次过滤器。
虽然经过两次过滤器,但不代表同样的代码执行了两次。
二:关于Filter
(一)如何使用Filter进行过滤
Filter接口中有一个doFilter方法,当开发人员编写好Filter,并配置对哪个web资源进行拦截后,Web服务器每次在调用web资源的service方法之前,都会先调用一下filter的doFilter方法。而此时过滤器就会执行某些操作,最后确定是否让用户继续访问web资源。
(二)过滤器链 (FilterChain)
在一个web应用中,可以开发编写多个Filter,这些Filter组合起来称之为一个Filter链。
过滤器的执行顺序有两种。第一种是按照过滤器的名称来执行,例如有两个过滤器分别为AFilter、BFilter,则默认先执行AFilter;第二种是根据Filter在web.xml文件中的配置顺序来决定先调用哪个Filter,先配置的先执行。
当第一个Filter的doFilter方法被调用时,web服务器会创建一个代表Filter链的FilterChain对象传递给该方法。FilterChain是一个接口,里面又定义了doFilter()方法。在doFilter方法中,开发人员如果调用了FilterChain对象的doFilter方法,则web服务器会检查FilterChain对象中是否还有filter,如果有,则调用第2个filter,如果没有,则调用目标资源。
当多个过滤器进行请求和响应时,执行顺序遵循 “先进后出” 的原则。
(三)Filter的配置
1.通过web.xml文件配置
<filter>
<filter-name>FilterDemo1</filter-name>
<filter-class>FilterDemo1</filter-class>
<init-param>
<param-name>word_file</param-name>
<param-value>/WEB-INF/word.txt</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>FilterDemo1</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>设置 filter 所拦截的请求路径(过滤器关联的URL样式)<servlet-name>指定过滤器所拦截的Servlet名称。
<dispatcher>指定过滤器所拦截的资源被 Servlet 容器调用的方式,可以是REQUEST,INCLUDE,FORWARD和ERROR之一,默认REQUEST。用户可以设置多个<dispatcher>子元素用来指定 Filter 对资源的多种调用方式进行拦截。<dispatcher>子元素可以设置的值及其意义
REQUEST:当用户直接访问页面时,Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时,那么该过滤器就不会被调用。
INCLUDE:如果目标资源是通过RequestDispatcher的include()方法访问时,那么该过滤器将被调用。除此之外,该过滤器不会被调用。
FORWARD:如果目标资源是通过RequestDispatcher的forward()方法访问时,那么该过滤器将被调用,除此之外,该过滤器不会被调用。
ERROR:如果目标资源是通过声明式异常处理机制调用时,那么该过滤器将被调用。除此之外,过滤器不会被调用。
2.通过注解配置
@WebFilter(filterName = "FilterDemo1", urlPatterns = "/*")
// "/*" 是对所有web资源进行过滤
// 如果想要部分的Web资源进行过滤器过滤则指定urlPatterns为Web资源的名称即可
(四)Filter的生命周期
// 初始化
public void init(FilterConfig filterConfig) throws ServletException;
/*和我们编写的Servlet程序一样,Filter的创建和销毁由WEB服务器负责。web应用程序启动时,web服务器将创建Filter 的实例对象,并调用其init方法,
读取web.xml配置,完成对象的初始化功能,从而为后续的用户请求作好拦截的准备工作(filter对象只会创建一次,init方法也只会执行一次)。
开发人员通过init方法的参数,可获得代表当前filter配置信息的FilterConfig对象。*/
// 过滤操作
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException;
/*这个方法完成实际的过滤操作。当客户请求访问与过滤器关联的URL的时候,Servlet过滤器将先执行doFilter方法。FilterChain参数用于访问后续过滤器。*/
// 销毁
public void destroy();
/*Filter对象创建后会保存在内存中,当web应用移除或服务器停止时才销毁。在Web容器卸载Filter对象之前被调用。该方法在Filter的生命周期中仅执行一次。在这个方法中,可以释放过滤器使用的资源。*/
(五)中文乱码过滤器
无论在做什么web应用的开发中,中文乱码的问题是很常见的,所以这类问题应该被重视。中文乱码出现的场景非常多,每次都去处理很麻烦,还有可能出现遗漏的情况,所以一个处理中文乱码的过滤器就能很好的解决这个问题。
<filter>
<filter-name>encoding</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name><!--用来指定一个具体的字符集-->
<param-value>UTF-8</param-value>
</init-param>
<init-param>
<param-name>forceEncoding</param-name>
<!--true:无论request是否指定了字符集,都是用encoding;false:如果request已指定一个字符集,则不使用encoding-->
<param-value>false</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encoding</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
三:测试案例
1.单个过滤器
源码:
// 过滤器
public class MyFilter01 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
// 相当于是模拟预设工作
System.out.println("过滤器 这是准备工作.....");
// 放行【如果没有下面的doFilter过程,即为拦截了】,放行后可以到达servlet
chain.doFilter(request, response);
// 相当于是模拟善后工作【servlet工作完后,再回到这里】
System.out.println("过滤器 这是善后工作.....");
}
@Override
public void destroy() {
}
}
// servlet
public class MyServlet extends HttpServlet {
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// 模拟核心业务
System.out.println("我的Servlet在工作...");
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doGet(request, response);
}
}
运行结果:
2.多个过滤器
源码:
// 过滤器1
public class MyFilter01 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
// 过滤器也可以给出响应,但不是处理业务,它只是准备的需要
response.setContentType("text/html;charset=utf-8");
PrintWriter out = response.getWriter();
// 让客户端也可以看到过滤效果,相当于是把核心内容包装成了一个HTML页【HTML标签首】
out.write("<html>"
+ "<head><title>Filter and Servlet</title></head>"
+ "<body>");
out.write("这里是过滤器01工作中开始...模拟的是一号过滤器<br />");
// 但核心业务仍然得放行,交给相应的Servlet去处理,项目中,职责要清晰
chain.doFilter(request, response);
// 【HTML标签尾】
out.write("<br />这里是过滤器01工作中结束...<br />");
out.write("</body></html>");
}
@Override
public void destroy() {
}
}
// 过滤器2
public class MyFilter02 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
// 过滤器在这里做的工作,与之前对比,仅只是想在客户端,即浏览器中也可以看到它的存在
PrintWriter out = response.getWriter();
out.write("这里是过滤器02工作中开始...模拟的是二号过滤器<br />");
// 放行后,核心业务仍然走Servlet处理
chain.doFilter(request, response);
out.write("<br />这里是过滤器02工作中结束...<br />");
}
@Override
public void destroy() {
}
}
// servlet
public class MyServlet extends HttpServlet {
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// 1这里不用再设置编码和处理中文乱码问题,因为过滤器已经预设过了
// 2这里只需要处理核心业务
PrintWriter out = response.getWriter();
out.write("这里是Servlet的输出,Servlet工作中...模拟的是核心业务");
}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doGet(request, response);
}
}
运行结果: