一、过滤器
1.过滤器介绍
拦截器(Interceptor)同 Filter 过滤器一样，它俩都是面向切面编程——AOP 的具体实现（AOP切面编程只是一种编程思想而已）。
过滤器的英文名称为Filter，是Servlet技术中最实用的技术。如同它的名字一样，过滤器是处于客户端与服务器资源文件之间的一道过滤网，帮助我们过滤一些不符合要求的请求。通常它被用作 Session校验，判断用户权限，如果不符合设定条件，就会被拦截到特殊的地址或者给予特殊的响应。要实现Filter接口
2.Filter生命周期
使用过滤器很简单，只需要实现Filter类，然后重写它的3个方法即可。
init方法:程序启动调用Filter的init()方法(永远只调用一次)；在容器中创建当前过滤器的时候自动调用这个方法。
destory方法:程序停止调用Filter的destroy()方法(永远只调用一次)；在容器中销毁当前过滤器的时候自动调用这个方法。
doFilter方法:doFilter()方法每次的访问请求如果符合拦截条件都会调用(程序第一次运行，会在servlet调用init()方法以后调用；不管第几次，都在调用doGet(),doPost()方法之前)。这个方法有3个参数，分别是ServletRequest、ServletResponse和FilterChain可以从参数中获取HttpServletReguest和HttpServletResponse对象进行相应的处理操作。
3、注解方式实现过滤器（@WebFilter）
@WebFilter
@WebFilter 用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性，但是 value、urlPatterns、servletNames 三者必需至少包含一个，且 value 和 urlPatterns 不能共存，如果同时指定，通常忽略 value 的取值 )
@Order(1)
标识当前过滤器的执行顺序，值越小越靠前执,注解的优先级比配置类的优先级要高
@ServletComponentScan
只有在springboot 启动类添加该注解时，@WebFilter注解才会生效 SpringBootApplication 上使用 @ServletComponentScan 注解后，@WebFilter注解才会生效
Servlet可以直接通过@WebServlet注解自动注册 Filter可以直接通过@WebFilter注解自动注册 Listener可以直接通过@WebListener 注解自动注册
启动类代码
@SpringBootApplication
@ServletComponentScan//开启filter过滤器，添加该注解时@WebFilter注解才会生效
public class ApplicationStarter {
public static void main(String[] args) {
SpringApplication.run(ApplicationStarter.class,args);
}
}4、使用注解Filter过滤器代码
实现Filter
/**
* @ClassName:TokenFilter
* @Auther: YooAo
* @Description: 注解配置过滤器 @WebFilter(urlPatterns = "/test/*", filterName = "testFilter")
* @Date: 2023/4/5 09:30
* @Version: v1.0
*/
//urlPatterns：拦截器路径，filterName：就是设置一个名字，不设置名字
@WebFilter(urlPatterns = "/test/*", filterName = "testFilter")
@Order(1)//设置优先级，优先级越高执行顺序就越高,注解的优先级比配置类的优先级要高
public class TokenFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
//Filter.super.init(filterConfig);
System.out.println("int1----");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("doFilter1");
HttpServletRequest request = (HttpServletRequest) servletRequest;
String token = request.getHeader("token");//获取请求头
System.out.println("token");
//该方法执行后直接运行至下一个过滤器
if(token!=null){
filterChain.doFilter(servletRequest, servletResponse);// 直接放行
}else{
servletResponse.setCharacterEncoding("UTF-8");
servletResponse.setContentType("application/json; charset=utf-8");
PrintWriter out = servletResponse.getWriter();
JSONObject res = new JSONObject();
res.put("msg", "错误");
res.put("success", "false");
out.append(res.toString());
}
}
@Override
public void destroy() {
// Filter.super.destroy();
System.out.println("destroy1-----");
}
}5、使用配置类直接注入到spring中
Filter配置类代码
/**
* @ClassName:FilterConfig
* @Auther: YooAo
* @Description: 过滤器配置类
* @Date: 2023/4/5 09:54
* @Version: v1.0
*/
@Configuration
public class FilterConfig {
//装配TokenFilter2过滤器
@Bean
public TokenFilter2 myFilter() {
return new TokenFilter2();
}
@Bean
public FilterRegistrationBean getFilterRegistrationBean(TokenFilter2 myFilter) {
FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
filterRegistrationBean.setFilter(myFilter);//设置过滤器类
filterRegistrationBean.setOrder(2);//设置优先级，优先级越高执行顺序就越高,注解的优先级比配置类的优先级要高
filterRegistrationBean.addUrlPatterns("/test/*");
filterRegistrationBean.setName("myFilter");
return filterRegistrationBean;
}
}Filter代码
/**
* @ClassName:TokenFilter
* @Auther: YooAo
* @Description: 配置类配置过滤器
* @Date: 2023/4/5 09:30
* @Version: v1.0
*/
public class TokenFilter2 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
//Filter.super.init(filterConfig);
System.out.println("int2----");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("doFilter2");
HttpServletRequest request = (HttpServletRequest) servletRequest;
String token = request.getHeader("token");//获取请求头
System.out.println("token");
//该方法执行后直接运行至下一个过滤器
if(token!=null){
filterChain.doFilter(servletRequest, servletResponse);// 直接放行
}else{
servletResponse.setCharacterEncoding("UTF-8");
servletResponse.setContentType("application/json; charset=utf-8");
PrintWriter out = servletResponse.getWriter();
JSONObject res = new JSONObject();
res.put("msg", "错误");
res.put("success", "false");
out.append(res.toString());
}
}
@Override
public void destroy() {
// Filter.super.destroy();
System.out.println("destroy2-----");
}
}6、controller测试
一开始没有设置请求头信息，所以没有成功
@RestController
@RequestMapping("/test")
public class FilterController {
@RequestMapping(value = "filter")
public String filter1(){
return "成功";
}
}
设置请求头信息使用postman软件
