Filter 过滤器
以【栈】的入栈和出栈思考过滤器的执行过程！注意，某些条件下的转发过程，不是把一个过滤器的入栈和出栈执行完了在执行其他的过滤器，而是全压栈，然后全出栈执行
一、概念
Filter过滤器图解.png
Filter应该也是单例模式
- web中的过滤器：当访问服务器的资源时，过滤器可以将请求拦截下来，完成一些特殊的功能，【请求和响应都可以被拦截下来进行处理】。
- 过滤器的作用：完成一些通用的操作
- 登录验证
- 统一编码处理
- 敏感字符过滤等
二、快速入门
1.Filter的使用步骤
- 定义一个类，实现接口
javax.servlet.Filter - 复写方法
- 配置拦截路径的两种方式【访问那些路径将会被拦截】
web.xml- 实现类的注解配置：
@WebFilter("/*"):所有路径都会被拦截器拦截判断
@WebFilter的部分源码
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WebFilter {
String[] value() default {}; // 拦截路径
String[] urlPatterns() default {}; // 拦截路径们
// 限制被拦截的方式
DispatcherType[] dispatcherTypes() default {DispatcherType.REQUEST};
...
}
2.入门代码实现
使用注解的方式配置拦截路径
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter("/*")
public class FilterImplA implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("Filter拦截器的方法init被执行了");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("Filter拦截器中doFilter方法被执行了");
// 放行
filterChain.doFilter(servletRequest, servletResponse);
}
@Override
public void destroy() {
System.out.println("Filter拦截器的方法destroy被执行了");
}
}
三、过滤器细节
1.web.xml配置【配置在根标签内】
配置格式和servlet的web.xml如出一辙
<filter>
<filter-name>FilterImplA</filter-name>
<filter-class>cn.itcast.filter.FilterImplA</filter-class>
</filter>
<filter-mapping>
<filter-name>FilterImplA</filter-name>
<!-- 配置的拦截路径 -->
<url-pattern>/*</url-pattern>
</filter-mapping>
2.过滤器执行流程
- 执行过滤器：对request对象请求消息增强。
- 执行方行后的代码
- 回来执行过滤器放行代码下边的代码：对response对象的响应消息增强。
3.Filter过滤器生命周期方法
-
init():在服务器启动后，会创建Filter对象。只执行一次。用于加载资源 -
doFilter():在每一次请求被拦截时，会执行。能执行多次 -
destroy():在服务器关闭后，Filter对象被销毁。如果服务器是正常关闭，则会执行destroy方法。只执行一次。用于释放资源。
4.过滤器配置详解
1) 拦截器路径配置
- 具体资源路径:
/index.jsp【用的少】, 只有访问index.jsp资源时，过滤器才会被执行。 - 拦截目录：
/user/*, 访问/user下的所有资源时，过滤器都会被执行。 - 后缀名拦截：
*.jsp【注意，前方没有/】, 访问所有后缀名为jsp资源时，过滤器都会被执行 - 拦截所有资源：
/*访问所有资源时，过滤器都会被执行。
2) 拦截方式配置:资源被访问的方式
a 注解配置：设置【dispatcherTypes**】属性
-
DispatcherType.REQUEST: 【掌握】默认值。浏览器直接请求资源。 -
DispatcherType.FORWARD: 【掌握】转发访问资源 -
DispatcherType.INCLUDE: (以后学)包含访问资源 -
DispatcherType.ERROR: (以后学)错误跳转资源 -
DispatcherType.ASYNC: (以后学)异步访问资源
- @如下案例：访问/forward
@WebFilter(value = "/*",dispatcherTypes = {DispatcherType.FORWARD,DispatcherType.REQUEST})
...
System.out.println("filter---in");
filterChain.doFilter(servletRequest, servletResponse);
System.out.println("filter---out");
...
// ---------------------- //
@WebServlet("/forward")
...
System.out.println("/forward");
request.getRequestDispatcher("/index.jsp").forward(request, response);
...
// ------------ //
inex.jsp
...
<% System.out.println("index.jsp"); %>
...
- @执行的结果(同一个拦截器)
filter---in // 第一次拦截器入栈
/forward // ...
filter---in // 第二次拦截器入栈
index.jsp // ...
filter---out // 第二次拦截器出栈
filter---out // 第一次拦截器出栈
如下图演示：
案例执行过程1.png
-
过程分析
- 第一次拦截器入栈
- 执行访问操作
- 第二次拦截器入栈
- 执行访问操作
- 第二次拦截器出栈
- 第一次拦截器出栈
b web.xml配置
- 在
<filter-mapping></filter-mapping>中配置一个或者多个<dispatcher>XXX</dispatcher>标签即可
5.过滤器链(配置多个过滤器)
1) 执行顺序：如果有两个过滤器：过滤器1和过滤器2
- 过滤器1
- 过滤器2
- 资源执行
- 过滤器2
- 过滤器1
- @如下案例,有两个过滤器A与B：访问/forward
@WebFilter(value = "/*",dispatcherTypes = {DispatcherType.FORWARD,DispatcherType.REQUEST})
public class FilterImplA implements Filter {
...
System.out.println("A---in");
filterChain.doFilter(servletRequest, servletResponse);
System.out.println("A---out");
...
// ---------------------- //
@WebFilter(value = "/*",dispatcherTypes = {DispatcherType.FORWARD,DispatcherType.REQUEST})
public class FilterImplB implements Filter {
...
System.out.println("B---in");
filterChain.doFilter(servletRequest, servletResponse);
System.out.println("B---out");
...
// ---------------------- //
@WebServlet("/forward")
...
System.out.println("/forward");
request.getRequestDispatcher("/index.jsp").forward(request, response);
...
// ------------ //
inex.jsp
...
<% System.out.println("index.jsp"); %>
...
- @执行的结果(同一个拦截器)
A---in // A1入栈
B---in // B1入栈
/forward
A---in // A2入栈
B---in // B2入栈
index.jsp
B---out // B2出栈
A---out // A2出栈
B---out // B1出栈
A---out // A1出栈
如下图演示：
案例执行过程2.png
2) 过滤器先后顺序问题：
- 注解配置：按照类名的字符串比较规则比较，较小的先执行
-
web.xml配置：<filter-mapping>谁定义在上面，谁先执行
四、案例
1.登录验证
// 将req进行强转
HttpServletRequest request = (HttpServletRequest) req;
// 设置编码
request.setCharacterEncoding("utf-8");
resp.setContentType("text/html;charset=utf-8");
// 获取uri
String uri = request.getRequestURI();
// 判断uri
if(request.getSession().getAttribute("login") != null ||
uri.contains("/login") ||
uri.contains("/loginVerifyCodeServlet") ||
uri.contains("/index.jsp") ||
uri.contains("/css/") ||
uri.contains("/js/") ||
uri.contains("/img/") ||
uri.contains("/fonts/")
) {
chain.doFilter(req, resp);
} else {
((HttpServletResponse)resp).setStatus(308);
request.getRequestDispatcher("/index.jsp").forward(req, resp);
}
2.敏感词汇过滤
注意：在filter于Servlet中的request和response都是同一个对象【内存地址一样】，可以根据这个特性进行一些操作
- 需求：
- 对录入的数据进行敏感词汇过滤
- 如果是敏感词汇，替换为***
设计模式简介
设计模式：一些通用的解决固定问题的方式
- 装饰模式，比较笨拙
