文章目录
Filter概念
生活中的过滤器:净水器,空气净化器,高速公路收费站。
Web中的过滤器:Filter是对客户端访问资源的过滤,符合条件放行,不符合条件不放行,并且可以对目 标资源访问前后进行逻辑处理。
过滤器的作用:一般用于完成通用的操作。如:登录验证、统一编码处理、敏感字符过滤…。
1、公共代码的提取
2、可以对request和response中的方法进行增强(装饰者模式/动态代理)
3、进行权限控制
Filter快速入门
步骤:
1、编写一个过滤器的类实现Filter接口
2、实现接口中尚未实现的方法(着重实现doFilter方法)
3、在web.xml中进行配置(主要是配置要对哪些资源进行过滤)或者使用注解配置。
@WebFilter("/*")//访问所有资源之前,都会执行该过滤器
public class FilterDemo1 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("filterDemo1被执行了....");
//放行
filterChain.doFilter(servletRequest,servletResponse);
}
@Override
public void destroy() {
}
}
Filter细节
1. web.xml配置
<filter>
<filter-name>demo1</filter-name>
<filter-class>cn.itcast.web.filter.FilterDemo1</filter-class>
</filter>
<filter-mapping>
<filter-name>demo1</filter-name>
<!-- 注意:这里配置的是拦截路径,不是访问路径。 -->
<url-pattern>/*</url-pattern>
</filter-mapping>
2. 过滤器执行流程
1、执行过滤器
2、执行放行后的资源
3、回来在执行放行后的代码
过滤器执行流程图解
3. 过滤器生命周期方法
1、init:在服务器启动后,会创建Filter对象,然后调用init方法。只执行一次,用于加载资源。
其中参数config代表该Filter对象的配置信息的对象,内部封装是该filter的配置信息。
2、doFilter:每一次请求被拦截资源时,会执行,执行多次。
3、destroy:在服务器关闭后,Filter对象被销毁。如果服务器是正常关闭,则会执行destroy方法。只执行一次。用于释放资源。
ServletRequest/ServletResponse:每次在执行doFilter方法时 web容器负责创建一个request和一个response对象作为doFilter的参数传递进来。该request个该response就是在访问目标资源的service方法时的request和response。
4. 过滤器配置详解
4.1 拦截路径配置
拦截方式 | 拦截路径 | 描述 |
---|---|---|
具体资源路径 | /index.jsp | 只有访问index.jsp资源时,过滤器才会被执行。 |
拦截目录 | /user/* | 访问/user下的所有资源时,过滤器都会被执行。 |
后缀名拦截 | *.jsp | 访问所有后缀名为jsp资源时,过滤器都会被执行。 |
拦截所有资源 | /* | 访问所有资源时,过滤器都会被执行。 |
4.2 拦截方式配置(资源被访问的方式)
4.2.1 注解配置
设置dispatcherTypes属性
1.REQUEST:默认值。浏览器直接请求资源
2. FORWARD:转发访问资源
3. INCLUDE:包含访问资源
4. ERROR:错误跳转资源
5. ASYNC:异步访问资源
过滤器代码演示
/*
访问/welcomeServlet,这个servlet,访问资源方式是REQUEST(直接访问)就拦截。
*/
/*@WebFilter(value="/welcomeServlet",dispatcherTypes = DispatcherType.REQUEST)*/
/*
访问/welcomeServlet,这个servlet,访问资源方式是FORWARD(转发)就拦截。
*/
//@WebFilter(value="/welcomeServlet",dispatcherTypes = DispatcherType.FORWARD)
/*
访问/welcomeServlet,这个servlet,访问资源方式是FORWARD(转发)或者REQUEST(直接访问)就拦截。
*/
@WebFilter(value="/welcomeServlet",dispatcherTypes = {DispatcherType.REQUEST,DispatcherType.FORWARD})
public class FilterDemo01 implements Filter {
public void destroy() {}
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
System.out.println("FilterDemo01执行了.......");
//放行
chain.doFilter(req, resp);
}
public void init(FilterConfig config) throws ServletException {}
}
servlet
@WebServlet("/welcomeServlet")
public class WelcomeServlet extends HttpServlet {
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
System.out.println("welcomeServlet.......");
}
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
this.doPost(request, response);
}
}
结果:
FilterDemo01执行了.......
welcomeServlet.......
4.2.2 web.xml配置
<filter>
<filter-name>demo01</filter-name>
<filter-class>com.ginger.filter.FilterDemo01</filter-class>
</filter>
<filter-mapping>
<filter-name>demo01</filter-name>
<!--拦截路径-->
<url-pattern>/welcomeServlet</url-pattern>
<!--请求资源方式是REQUEST就拦截(这也是默认方式)-->
<dispatcher>REQUEST</dispatcher>
</filter-mapping>
5. 过滤器链(配置多个过滤器)
5.1 执行顺序:如果有两个过滤器:过滤器1和过滤器2
过滤器执行流程图解也看得出来
- 过滤器1
- 过滤器2
- 资源执行
- 过滤器2
- 过滤器1
5.2 过滤器先后顺序问题
5.2.1 注解配置:按照类名的字符串比较规则比较,值小的先执行
如: AFilter 和 BFilter,AFilter就先执行了。
如:Filter16 和 Filter6 ,Filter16就先执行,比较是字符。1比6要小所以先执行。
代码演示
Filter16过滤器
@WebFilter("/*")
public class Filter16 implements Filter {
public void destroy() {}
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
System.out.println("Filter16执行了......");
chain.doFilter(req, resp);
}
public void init(FilterConfig config) throws ServletException {}
}
Filter6 过滤器
@WebFilter("/*")
public class Filter6 implements Filter {
public void destroy() {}
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
System.out.println("Filter6执行了......");
chain.doFilter(req, resp);
}
public void init(FilterConfig config) throws ServletException {}
}
访问结果
Filter16执行了......
Filter6执行了......
5.2.2 web.xml配置: 谁定义在上边,谁先执行
代码演示
过滤器FilterDemo01在前面所以先执行。
<!--过滤器FilterDemo01-->
<filter>
<filter-name>demo01</filter-name>
<filter-class>com.ginger.filter.FilterDemo01</filter-class>
</filter>
<filter-mapping>
<filter-name>demo01</filter-name>
<!--拦截路径-->
<url-pattern>/welcomeServlet</url-pattern>
<!--请求资源方式是REQUEST就拦截(这也是默认方式)-->
<dispatcher>REQUEST</dispatcher>
</filter-mapping>
<!--过滤器FilterDemo02-->
<filter>
<filter-name>demo02</filter-name>
<filter-class>com.ginger.filter.FilterDemo02</filter-class>
</filter>
<filter-mapping>
<filter-name>demo02</filter-name>
<!--拦截路径-->
<url-pattern>/welcomeServlet2</url-pattern>
<!--请求资源方式是REQUEST就拦截(这也是默认方式)-->
<dispatcher>REQUEST</dispatcher>
</filter-mapping>
Filter案例
1. 案例1_登录验证
需求:
1. 访问用户消息列表案例的资源。验证其是否登录
2. 如果登录了,则直接放行。
3. 如果没有登录,则跳转到登录页面,提示"您尚未登录,请先登录。
登录验证图解
代码演示
@WebFilter("/*")
public class LoginFilter implements Filter {
public void destroy() {
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException, IOException {
//强转
HttpServletRequest req = (HttpServletRequest) request;
//设置编码
req.setCharacterEncoding("utf-8");
//获取请求路径
String reqURI = req.getRequestURI();
//判断请求资源路径,是否包含登录的有关信息有就放行。
if (reqURI.contains("login.jsp") || reqURI.contains("userLogin") || reqURI.contains("css") || reqURI.contains("fonts") || reqURI.contains("js") || reqURI.contains("checkCode")) {
//登录有关资源(放行)
chain.doFilter(req, response);
} else {
//没有登录相关资源(拦截)
//获取session
HttpSession session = req.getSession();
//获取session中的用户
User user = (User) session.getAttribute("user");
//判断获取到的用户是否null
if (user == null) {
//没有登录
//将错误信息存储request域
req.setAttribute("USER_ERROR", "不好意思你尚未登录!");
//转发到登录页面
req.getRequestDispatcher("/login.jsp").forward(req,response);
} else {
//登录了
//放行
chain.doFilter(req, response);
}
}
}
public void init(FilterConfig config) throws ServletException {
}
}
这里有一个要注意问题,就是我没有登录也可以访问服务器中的页面资源,但是访问不了页面中里面的数据,因为我在代码中放行了所有jsp页面相关css、fonts、js。所以就只能访问样式,要登录后才能访问数据。
未登录访问任意资源
登录后访问资源
2. 案例2_敏感词汇过滤
需求:
- 录入的数据进行敏感词汇过滤
- 敏感词汇参考《敏感词汇.txt》
- 如果是敏感词汇,替换为 ***
分析:
- 对request对象进行增强。增强获取参数相关方法。
- 放行。传递代理对象
增强对象的功能:
设计模式:一些通用的解决固定问题的方式
1. 装饰模式
2. 代理模式
概念:
1. 真实对象:被代理的对象
2. 代理对象:
3. 代理模式:代理对象代理真实对象,达到增强真实对象功能的目的
实现方式:
1. 静态代理:有一个类文件描述代理模式
2. 动态代理:在内存中形成代理类
实现步骤:
1. 代理对象和真实对象实现相同的接口
2. 代理对象 = Proxy.newProxyInstance();
3. 使用代理对象调用方法。
4. 增强方法
增强方式:
1. 增强参数列表
2. 增强返回值类型
3. 增强方法体执行逻辑
敏感词汇过滤图解
代码演示
jsp页面
<form action="/ginger/formServlet" method="post">
<input type="text" name="username">
<input type="submit" value="提交">
</form>
过滤器:在过滤器中我对request方法中getParameter和getParameterMap方法进行增强。只要通过这两个方法获取参数有敏感文字的就会替换为***。
其实还有一个方法getParameterValues需要增强,因为逻辑差不多就偷个懒。
@WebFilter("/formServlet")
public class SensitiveFilter implements Filter {
public void doFilter(final ServletRequest request, final ServletResponse response, final FilterChain filterChain) throws IOException, ServletException {
// request.setCharacterEncoding();
request.setCharacterEncoding("utf-8");
//因为servletRequest对象中没有setParameter方法,所以只能增强getParameter方法,如果有敏感字符获取到的就是***。
final ServletRequest requ = (ServletRequest) Proxy.newProxyInstance(request.getClass().getClassLoader(), request.getClass().getInterfaces(), new InvocationHandler() {
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//判断是否是getParameter()方法。
if ("getParameter".equals(method.getName())) {
//如果是getParameter我就增强
//执行被代理对象的getParameter方法
String username = (String) method.invoke(request, args);
//判断参数值是否是中文,不是中文的话我就不管。
if (username.matches("^[\\u4e00-\\u9fa5]+$")) {
//遍历集合中的敏感词汇
for (String sensitive : arrayList) {
//判断中文是是否包含敏感词汇
if (username.contains(sensitive)) {
//包含敏感词汇,就修改为***
return username.replace(sensitive, "***");
}
}
return username;
} else {
//不是中文我就直接返回
return username;
}
} else if ("getParameterMap".equals(method.getName())) {
//执行被代理对象的getParameterMap方法
Map<String, String[]> parameterMap = (Map<String, String[]>) method.invoke(request, args);
//获取所有键集合
Set<String> keySet = parameterMap.keySet();
//遍历所有键
for (String key : keySet) {
//根据键获取键对应的参数值
String[] values = parameterMap.get(key);
//遍历参数值
/*for (String value : values) {
//遍历list集合中敏感词汇
for (String sensitive : arrayList) {
//参数值中是否包含敏感词汇。
if (value.contains(sensitive)) {
value = value.replace(sensitive, "***");
}
}
}*/
/*
上面的循环有一个小问题
value = value.replace(sensitive, "***");
修改不了数组中元素值还是没有变化,所以不能使用增强for
使用普通for通过索引来修改数组中的值就可以了。
*/
for (int i = 0; i < values.length; i++) {
for (String sensitive : arrayList) {
if (values[i].contains(sensitive)) {
values[i] = values[i].replace(sensitive, "***");
}
}
}
}
return parameterMap;
} else {
//不是正常执行
return method.invoke(request, args);
}
}
});
//放行传入被增强的requ对象。
filterChain.doFilter(requ, response);
}
//创建集合
private ArrayList<String> arrayList = new ArrayList<String>();
public void init(FilterConfig filterConfig) throws ServletException {
//获取servletContext对象
ServletContext servletContext = filterConfig.getServletContext();
//获取敏感词汇文件绝对路径
String realPath = servletContext.getRealPath("/WEB-INF/classes/sensitive.txt");
try {
//创建字符串缓冲流对象
BufferedReader br = new BufferedReader(new FileReader(realPath));
String line = null;
while ((line = br.readLine()) != null) {
//解决乱码
arrayList.add(new String((line.getBytes("gbk")), "utf-8"));
}
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
public void destroy() {
}
}
访问下面的servlet就拦截
@WebServlet("/formServlet")
public class FormServlet extends HttpServlet {
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
Map<String, String[]> parameterMap = request.getParameterMap();
Set<String> keySet = parameterMap.keySet();
for (String key : keySet) {
String[] vlaues = parameterMap.get(key);
for (String vlaue : vlaues) {
System.out.println(vlaue);
}
}
}
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
this.doPost(request, response);
}
}
敏感词汇文件sensitive.txt
垃圾
废物
笨蛋
傻瓜
访问jsp页面
结果:
你个***