企业智能软件开发（八）—过滤器与拦截器

过滤器

过滤器（Filter）是具有拦截特点的技术，是SUN从Servlet2.3开始添加的一项激动人心的功能，可以通过Filter技术，对web服务器管理的所有资源：例如Jsp、Servlet、图片或html文件等进行拦截，从而实现一些特殊的功能。

Filter

Filter功能：

1. 在HttpServletRequest到达Servlet之前，拦截客户的HttpServletRequest，获取或修改Request携带的参数或数据。
2. 在HttpServletResponse到达客户端之前，拦截HttpServletResponse，获取或修改HttpServletResponse携带的参数或数据。

Filter的应用场景：

编码过滤：统一编码。
敏感词过滤：对一些敏感的词用其他符号代替。
认证过滤：对用户请求进行统一的认证。
登录和审核过滤：对用户的访问请求进行记录和审核。
图像装换过滤：转换图像格式。
数据压缩过滤：对用户发生的数据进行压缩，从而减少传输量。

Filter的初始化：

public void init(FilterConfig filterConfig)throws ServletException;//初始化

1. Filter的创建和销毁由web服务器负责。
2. web应用程序启动时，web服务器将创建Filter的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能。
3. Filter对象只会创建一次，init方法也只会执行一次。

执行拦截：

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException;//拦截请求

这个方法完成实际的过滤操作。当客户请求访问与过滤器关联的URL的时候，Servlet过滤器将先执行doFilter方法。FilterChain参数用于访问后续过滤器。

Filter销毁：

public void destroy();//销毁

1. Filter对象创建后会驻留在内存，当web应用移除或服务器停止时才被销毁。

2. 该方法在Filter的生命周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。

原理：
3. 过滤器本质是一个Java组件，和Servlet类似，Web应用的开发者能够使用它来中断或处理一个请求，在它到达Servlet之前，或对Servlet的处理结果做后处理工作。如下图：

4. 从这个意义来说，可以把过滤器分成请求过滤器和响应过滤器。

5. 请求过滤器主要功能是执行安全检查、重写格式化请求头和请求体、审核或请求日志处理。

6. 响应过滤器主要功能是压缩响应流、附加内容或修改响应流信息、创建完全不同的响应。

过滤器栈:

在项目实践中，可以把多个过滤器的调用，看成一个栈。如下图所示：

Filter实现过滤

不过滤登录接口，其他接口过滤，按照条件开放

package com.test.config;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;

import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;

import com.test.utils.JwtUtil;

import io.jsonwebtoken.Claims;
import io.jsonwebtoken.ExpiredJwtException;

@Component
@WebFilter("/*")
public class LoginFilter implements Filter {

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		
		System.out.println("认证过滤正在执行.....");
		
		HttpServletRequest req = (HttpServletRequest)request;  //强制转换成之类HttpServletRequest
		String str = req.getRequestURI();	//获取拦截到的URL
		System.out.println(str);
		if(str.equals("/jwtlogin") ||str.equals("/test_jwtlogin")) {	//开放登录接口URL
			chain.doFilter(request, response);  //放行，调用下一个过滤器或者Servlet
		}		
		try {
			//1.通过请求头获取token
			String token = req.getHeader("Authorization");
//			token = token.replaceFirst("Bearer ", "");
			//2.判断请求头信息是否为空
			if(!StringUtils.isEmpty(token)) {
				Claims claims = JwtUtil.parseJwt(token);  //解析该token
				if(claims != null) {
					request.setAttribute("loginUser", claims);
					chain.doFilter(request, response);  //放行，调用下一个过滤器或者Servlet
				}
			}
		}catch (ExpiredJwtException e) {
			System.out.println("你还没有登录");			
		}
		
	}
	

	
	

}

拦截器

Spring MVC中的拦截器（Interceptor），它作用于请求进入控制器之前，可以拦截用户请求并作相应的处理。
拦截器常用于权限验证、记录请求信息的日志、判断用户是否登录等

拦截器的实现

通常拦截器类可以通过实现HandlerInterceptor接口，或继承HandlerInterceptorAdapter类来定义
HandlerInterceptor接口中有三个方法需要实现：

1. preHandle() 方法：该方法会在控制器方法前执行，其返回值表示是否中断后续操作。当其返回值为true时，表示继续向下执行；当其返回值为false时，会中断后续的所有操作（包括调用下一个拦截器和控制器类中的方法执行等）。

2. postHandle()方法：该方法会在控制器方法调用之后，且解析视图之前执行。可以通过此方法对请求域中的模型和视图做出进一步的修改。

3. afterCompletion()方法：该方法会在整个请求完成，即视图渲染结束之后执行。可以通过此方法实现一些资源清理、记录日志信息等工作。

拦截器与过滤器的区别

1. 过滤器是servlet的，在进入服务器后，Servlet之前
2. 拦截器是spring aop的，在Servlet之后，控制器之前
   
   实现原理不同：

过滤器和拦截器 底层实现方式大不相同，过滤器 是基于函数回调的，拦截器 则是基于Java的反射机制（动态代理）实现的

使用范围不同：

过滤器是servlet规范规定的，只能用于web程序中，而拦截器是在spring容器中，它不依赖servlet容器

拦截器实现代码

package com.test.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

//SpringMVC的配置类
@Configuration
public class MyMvcConfig implements WebMvcConfigurer {

	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		
		registry.addInterceptor(new MyInterceptor())    //添加拦截器对象到拦截器链中
			.addPathPatterns("/**")				//配置拦截的路径
			.excludePathPatterns("/jwtlogin")
			.excludePathPatterns("/test_jwtlogin");  //设置不拦截的路径  
			
	}

}

package com.test.config;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.util.StringUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import com.test.utils.JwtUtil;

import io.jsonwebtoken.Claims;
import io.jsonwebtoken.ExpiredJwtException;


//拦截器测试
public class MyInterceptor implements HandlerInterceptor {
	
	
	//在进入控制器之前执行，这个方法如果返回true则放行，这个方法如果返回false则拦截
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {
		System.out.println("preHandle正在执行。。。。。");
		
		try {
			//1.通过请求头获取token
			String token = request.getHeader("Authorization");
//			token = token.replaceFirst("Bearer ", "");
			//2.判断请求头信息是否为空
			if(!StringUtils.isEmpty(token)) {
				Claims claims = JwtUtil.parseJwt(token);  //解析该token
				if(claims != null) {
					request.setAttribute("loginUser", claims); 
		    		return true;
				}
			}
		}catch (ExpiredJwtException e) {
			return false;
		}
    	
		return false;
		
	}

	//在进入控制器方法执行完成之后执行
	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
			ModelAndView modelAndView) throws Exception {
		System.out.println("postHandle正在执行。。。。。");
	}

	//准备发送响应的内容之前执行
	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
			throws Exception {
		System.out.println("afterCompletion正在执行。。。。。");
	}

}