一、SpringMVC拦截器
1.1拦截器简介
SpringMVC的拦截器,类似于Servlet中的过滤器Filter,都是用来对处理器进行预处理和后处理。开发者可以通过拦截器自定义一些功能。
1.2、拦截器和过滤器的联系与区别
联系
拦截器和过滤器都是用来处理某个东西,例如一个请求在其之前或者之后所进行的某些操作。
拦截器
- 拦截器是SpringMVC框架自己的,只用使用了SpringMVC的项目才可以使用它。
- 拦截器只会拦截访问控制器(Controller)中的方法,如果访问的是资源文件或者jsp/js/html等它是不会进行拦截的
- 拦截器是AOP思想的应用
过滤器
- servlet规范中的一部分,所有的Java web项目都可以使用
- 在url-pattern中配置了/*之后,可以对所有要访问的资源进行拦截
1.3、拦截器常见的使用的场景
- 权限检查:例如用户登陆权限,登陆验证拦截
- 日志记录:可以记录请求信息的日治
- 性能监控:可以用来计算请求处理前后的时间查来计算请求响应完成所消耗的时间
二、如何自定义拦截器的方法
1.实现接口类
- 拦截器必须实现一个接口:HandIerIntercepter
- 必须重写里面的三个方法
这三个方法分别是:
- preHandle()
这个方法在业务处理器处理请求之前被调用,如果返回true那么就执行下一个拦截器,如果返回false就不执行下一个拦截器 - postHandle()
这个方法在业务处理器处理完请求后,但是没有在DispatcherServlet向客户返回请求前被调用,同理,如果返回true那么就执行下一个拦截器,如果返回false那么就不执行下一个拦截器 - afterHandle()
这个方法在DispatcherServlet处理后执行,进行一些清理工作。
package org.westos.intercepter;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class MyInterCepter implements HandlerInterceptor {
@Override
//在请求处理方法之前执行
//返回true,就执行下一个拦截器,如果没有拦截器就放行
//返回false的话,就不执行下一个拦截器
public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
System.out.println("preHandle执行了");
return true;
}
@Override
//在请求处理方法之后执行
public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
System.out.println("preHandle执行了");
}
@Override
//在dispatcherServlet执行之后执行
public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
System.out.println("preHandle执行了");
}
2.配置SpringMVC拦截器
这里需要注意的是springMVC拦截器中的/*与/** 的区别
- /* 指的是只匹配一级,例如/admin/就是只拦截类似于/admin/add这样的方法.例如/admin/add/insert这样的就不拦截,一个可以理解为只拦截当前路径
- /** 指的是匹配多级目录, 例如/admin/** 就会拦截/admin下面的所有方法以及子请求
<!--配置拦截器-->
<mvc:interceptors>
<mvc:interceptor>
<!--
/** 包括历经下的所有请求及子请求
/admin/* 执行/admin/add这样的方法,例如/admin/add/insert这样的就不拦截,一个*可以理解为只拦截当前路径
/admin/** 就会执行admin下面的所有方法以及子请求
-->
<mvc:mapping path="/**"/>
<!--拦截器的位置-->
<bean class="org.westos.interceptor.MyInterCeptor"/>
</mvc:interceptor>
</mvc:interceptors>
3.编写Controller
package org.westos.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class InterceptorController {
@RequestMapping("/test1")
@ResponseBody
public String test1(){
System.out.println("test1执行了");
return "hello,拦截器";
}
}
4.编写index.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<a href="${pageContext.request.contextPath}/test1">测试拦截器</a>
</body>
</html>
5.运行结果
这里我们就可以看见拦截器的工作流程了,我们在这里测试的时候记得在实现接口类的时候需要preHandle()方法的返回值设置为true,不然就不会走下面的拦截器。
三、通过拦截器实现用户是否登录。
我们在日常浏览网站的时候经常会遇到这样的问题,例如我们打开力扣的时候我们是可以正常访问的,但是当我们想查看里面的题目的时,这时候我们就需要进行登录,不然就无法访问题目内容,这其中也是使用了拦截器的原理。
现在我们验证用户是否已经登陆过
思路:
1.首先有一个登录页面,需要写一个Controller访问页面。
2.页面有一个登录的表单,我们需要判断用户名和密码是否正确,如果正确放在session中,跳转到成功页面。
3.拦截器拦截用户的请求,判断用户是否已经登陆过,如果用户已经登陆过,那么久放行,反之就跳转到登录页面。
实现步骤
1.编写Controller
package org.westos.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.http.HttpSession;
@Controller
@RequestMapping("/user")
public class UserController {
//跳转到登录页面
@RequestMapping("/toLogin")
public String toLogin(){
return "login";
}
//跳转到成功页面
@RequestMapping("/toSuccess")
public String toSuccess(){
return "success";
}
//登录
@RequestMapping("/login")
public String login(String username, String password, HttpSession session){
//接收前端的信息,判断是否为空
System.out.println("用户名"+username);
session.setAttribute("user1",username);
return "success";
}
//注销
@RequestMapping("/loginOut")
public String loginOut(HttpSession session){
session.invalidate();//注销session
return "login";
}
}
2.编写拦截器
package org.westos.intercepter;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
public class UserIntercepter implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object o) throws Exception {
System.out.println("进入UserIntercepter拦截区");
//判断是否是登录页面,如果是登录页面,那么就放行
System.out.println("url:"+request.getRequestURI());//获得请求的路径
if (request.getRequestURI().contains("login")){
System.out.println("login放行");
return true;
}
//如果用户已经登录,那么就放行
HttpSession session = request.getSession();
System.out.println(session.getAttribute("user"));
if (session.getAttribute("user")!=null){
return true;
}
//如果用户没有登录想进入成功页面,那么就拦截,让其返回到登录页面
request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request,response);
return false;
}
@Override
public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
}
@Override
public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
}
}
3.配置SpringMVC拦截器,在springmvc-servlet.xml中
<!--配置拦截器-->
<mvc:interceptors>
<mvc:interceptor>
<mvc:mapping path="/**"/>
<bean class="org.westos.intercepter.UserIntercepter"/>
</mvc:interceptor>
</mvc:interceptors>
4.登录页面
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>LOGIN</title>
</head>
<body>
<h1>登录</h1>
<hr>
<form action="${pageContext.request.contextPath}/user/login" method="post">
用户名:<input type="text" name="username" required>
密码:<input type="text" name="password" required>
<input type="submit">
</form>
</body>
</html>
5.成功页面
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>LOGIN</title>
</head>
<body>
用户登录成功
<hr>
用户名:${user1}
<a href="${pageContext.request.contextPath}/user/loginOut">注销</a>
</body>
</html>
6.前端首页
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<p>
<a href="${pageContext.request.contextPath}/user/toLogin">登录</a>
<a href="${pageContext.request.contextPath}/user/toSuccess">强制成功</a>
</p>
</body>
</html>
测试运行结果:
1、我们在前端页面里面有一个登录和强制成功。
强制成功来模拟我们直接不进行登录来进行资源访问,但是这里虽然有绕过登录直接到成功页面,本来是可以的,但是我们加上了拦截器就不可以了。
2.现在我们点击登录,就可以直接到成功页面
3.我们现在点击注销,就会重新跳转到注册页面
这样我们就简单的实现了一个自定义拦截器。