Filter过滤器总结

1. Filter介绍

 介绍: Filter是过滤器，通常可以将请求的资源拦截下来从而实现一些补充操作。

2. Filter分析

2.1 初始化使用

1. 实现Filter接口 (import javax.servlet.Filter), 重写接口当中的方法
2. 使用 @WebFilter 注解声明这是一个过滤器
3. 启动类配置 @ServletComponentScan 去扫描servlet相关的注解(扫描包内容及其该包下的所有子包内容)

package com.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter("/*")
public class FilterAccess implements Filter {
	@Override // 这是过滤器的初始化方法
	public void init(FilterConfig filterConfig) throws ServletException { }

	@Override // 这是过滤器销毁时执行的代码
	public void destroy() { }

	@Override // 这是最重要的(通常重写这个来进行访问前的相关操作)
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
	filterChain.doFilter(servletRequest, servletResponse); // 执行放行操作
	}
}

2.2 @WebFilter 配置

 a. 使用urlPattern配置过滤路径(可以省略)

@WebFilter(filterName = "过滤器名字", urlPatterns = "过滤路径")

  b. 拦截路径配置总结

2.3 其他

 a. 通常可以将ServletRequest强制转换为HttpServletRequest进行相关操作，且其底层实现类为RequesFacade(由tomcat创建web容器初始化的时候进行创建)

 
 b. 访问操作若合法则会先放行 – 访问资源 – 执行放行后的代码，可以通过设置request对放行前数据进行相关操作，使用response对放行后数据进行操作

public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
	System.out.println("执行放行之前的相关逻辑操作");
	filterChain.doFilter(servletRequest, servletResponse); // 访问相关资源
	System.out.println("执行放行之后的相关逻辑操作");
}

 
 c. 过滤器链(若有多个过滤器，则按照过滤器的类名的自然排序进行逐个过滤)

 

3. Filter应用

3.1 筛选访问路径

  AntPathMatcher类：当中的match(合法路径，访问路径)方法–通常可以用于对资源访问路径的匹配工作

package com.filter;

import org.springframework.util.AntPathMatcher;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

@WebFilter("/*")
public class FilterAccess implements Filter {
	public static final AntPathMatcher PATH_MATCHER = new AntPathMatcher();

	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
		HttpServletRequest request = (HttpServletRequest) servletRequest; // 强制转换为 HttpServletRequest

		boolean fg = false;
		String[] urls = new String[]{ // 存放放行资源: 通常将静态资源 + 登录退出访问请求进行直接放行
				"/employee/login",
				"/employee/logout",
				"/backend/**",
				"/front/**"
		};
		String requestURI = request.getRequestURI(); // 获取访问路径
		for(String url : urls) fg = fg | PATH_MATCHER.match(url, requestURI);

		if(fg) filterChain.doFilter(servletRequest, servletResponse); // 若是合法访问的路径资源 -- 允许访问
	}
}

 

3.2 判断用户是否存在

  通常都可以将Servletxxxx转为HttpServletxxxx进行强制转换操作，方便获取其session相关对象或进行其他相关操作。

package com.filter;

import org.springframework.util.AntPathMatcher;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.IOException;

@WebFilter("/*")
public class FilterAccess implements Filter {
	public static final AntPathMatcher PATH_MATCHER = new AntPathMatcher();

	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
		HttpServletRequest request = (HttpServletRequest) servletRequest;
		HttpServletResponse response = (HttpServletResponse) servletResponse;

		HttpSession session = request.getSession(); // 获取session对象
		Object x = session.getAttribute("username"); // 获取对应的键所对应的值
		if(x != null){ // 用户存在 -- 允许访问
			filterChain.doFilter(servletRequest, servletResponse);
		}
		else{ // 用户不存在, 不允许访问 -- 并且可以使用 response对象写回给前端不能访问的相关信息
			response.getWriter().write("用户不存在, 不允许访问");
		}
	}
}