springboot配置监听器、过滤器和拦截器
文章目录
- 监听器：
- 过滤器：
- 拦截器：
- 相关问题
- 三大器在springboot中使用
-
- 过滤器类
- 监听器类
- 拦截器
- 配置类
- 控制器
- 测试过程
监听器：
listener是servlet规范中定义的。通过监听servletRequest、servletContext、httpSession等域对象的创建和销毁事件，在事件发生前、发生后做一些必要的处理。其主要可用于以下情景：
1、统计在线人数和在线用户
2、系统启动时加载初始化信息
3、统计网站访问量
4、记录用户访问路径。
过滤器：
Filter是Servlet规范中定义的，通过拦截对web资源(包括Jsp, Servlet, 静态图片文件或静态 html 文件)的请求，从而实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。它主要用于以下情景：对http请求进行预处理，也可以对http响应进行后处理
拦截器：
Interceptor是spring得技术，通过拦截对某方法或字段的请求，从而实现日志，安全等。一般拦截器方法都是通过动态代理的方式实现。可以通过它来进行权限验证，或者判断用户是否登陆，或者是像12306 判断当前时间是否是购票时间。
相关问题
问题一：过滤器和拦截器的区别？
①拦截器是基于java的反射机制的，而过滤器是基于函数回调。
②拦截器不依赖与servlet容器，过滤器依赖与servlet容器。
③拦截器只能对http请求起作用，而过滤器则可以对几乎所有的请求起作用。
④拦截器可以访问http上下文、值栈里的对象，而过滤器不能访问。
⑤在httpServletReqest的生命周期中，拦截器可以多次被调用，而过滤器只能在容器初始化时被调用一次。
⑥拦截器可以获取IOC容器中的各个bean，而过滤器就不行，这点很重要，在拦截器里注入一个service，可以调用业务逻辑。
问题二：过滤器和拦截器的执行顺序？
过滤器和拦截器的执行顺序：过滤前 - 拦截前 - servlet处理 - 拦截后 - 过滤后。拦截器是被包裹在过滤器之中的。
问题三：各自应用场景？
两者的本质区别：从灵活性上说拦截器功能更强大些，Filter能做的事情，Interceptor都能做，而且可以在请求前，请求后执行，比较灵活。Filter主要是针对URL地址做一个编码的事情、过滤掉没用的参数、安全校验（比较泛的，比如登录状态之类），太细的话，还是建议用interceptor。Filter只在Servlet前后起作用。而拦截器能够深入到方法前后、异常抛出前后等，因此拦截器的使用具有更大的弹性。所以在Spring构架的程序中，优先使用拦截器。
三大器在springboot中使用
- 实现相应的接口定义类
- 通过配置类将其加入到spring容器中
过滤器类
package com.example.demo;
import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
public class MyFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println(servletRequest.getParameter("name"));
HttpServletRequest hrequest = (HttpServletRequest)servletRequest;
HttpServletResponseWrapper wrapper = new HttpServletResponseWrapper((HttpServletResponse) servletResponse);
if(hrequest.getRequestURI().indexOf("/index") != -1 ||
hrequest.getRequestURI().indexOf("/asd") != -1 ||
hrequest.getRequestURI().indexOf("/online") != -1 ||
hrequest.getRequestURI().indexOf("/login") != -1
) {
filterChain.doFilter(servletRequest, servletResponse);
}else {
wrapper.sendRedirect("/login");
}
}
@Override
public void destroy() {
}
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
}
监听器类
package com.example.demo;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;
public class MyHttpSessionListener implements HttpSessionListener {
public static int online = 0;
@Override
public void sessionCreated(HttpSessionEvent se) {
System.out.println("创建session");
online ++;
}
@Override
public void sessionDestroyed(HttpSessionEvent se) {
System.out.println("销毁session");
}
}
拦截器
package com.example.demo;
import java.io.PrintWriter;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.HandlerMapping;
import org.springframework.web.servlet.ModelAndView;
public class MyInterceptor implements HandlerInterceptor {
//在请求处理之前进行调用（Controller方法调用之前
@Override
public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
System.out.println("preHandle被调用");
Map map =(Map)httpServletRequest.getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE);
System.out.println(map.get("name"));
System.out.println(httpServletRequest.getParameter("username"));
if(map.get("name").equals("zhangsan")) {
return true; //如果false，停止流程，api被拦截
}else {
PrintWriter printWriter = httpServletResponse.getWriter();
printWriter.write("please login again!");
return false;
}
}
@Override
public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
System.out.println("postHandle被调用");
}
@Override
public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
System.out.println("afterCompletion被调用");
}
}
配置类
package com.example.demo;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class MywebConfig implements WebMvcConfigurer {
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/zxc/foo").setViewName("foo");
}
//配置拦截某方法的拦截器
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new MyInterceptor())
.addPathPatterns("/asd/**");
}
//配置过滤web请求的过滤器
@SuppressWarnings({
"rawtypes", "unchecked" })
@Bean
public FilterRegistrationBean filterRegist() {
FilterRegistrationBean frBean = new FilterRegistrationBean();
frBean.setFilter(new MyFilter());
frBean.addUrlPatterns("/*");
System.out.println("filter");
return frBean;
}
//配置监听Session的监听器
@SuppressWarnings({
"rawtypes", "unchecked" })
@Bean
public ServletListenerRegistrationBean listenerRegist() {
ServletListenerRegistrationBean srb = new ServletListenerRegistrationBean();
srb.setListener(new MyHttpSessionListener());
System.out.println("listener");
return srb;
}
}
控制器
package com.example.demo;
import java.util.Date;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class UserController {
private final Logger logger = LoggerFactory.getLogger(UserController.class);
@Value("${application.message:Hello World}")
private String message ;
@GetMapping("/asd/{name}")
public String welcome(@PathVariable String name,Map<String, Object> model) {
model.put("time", new Date());
model.put("message", this.message);
return "welcome";
}
@RequestMapping("/login")
@ResponseBody
public Object foo() {
logger.info("打印日志----------------------");
return "login";
}
@RequestMapping("/index")
@ResponseBody
public Object index(HttpServletRequest request) {
HttpSession session = request.getSession(true);
session.setAttribute("zxc", "zxc");
return "index";
}
@RequestMapping("/online")
@ResponseBody
public Object online() {
return "当前在线人数：" + MyHttpSessionListener.online + "人";
}
}
测试过程
项目启动后，首先测试过滤器，所有访问路径都需经过我们自定义的filter，如果路径中包含/index、/asd、/online、/login则直接通过，否则则被重定向至/login。
然后测试监听器，先访问http://localhost:8080/index,创建session对象（因为 session对象创建需要显示的调用getsession方法），然后访问http://localhost:8080/online，然后换一个浏览器做相同操作，如下：
最后测试拦截器，代码展示了如何获取@PathVariable注解的请求参数以及普通请求参数，首先访问http://localhost:8080/asd/zhangsan?username=lisi，响应正常，如果访问路径上的名字不是zhangsan，则被拦截，例如http://localhost:8080/asd/wangwu?username=lisi，如下：
在实际项目中我们还可以在配置的时候设置过滤器、拦截器的执行顺序及其它的参数，同时filter和listener还有对应的注解方式：@WebFilter和@WebListener,在使用注解方式时不要忘了在主程序加上@ServletComponentScan注解，这样才能在程序启动时将对应的bean加载进来。