9、拦截器Interceptor
概述
SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。开发者可以自己定义一些拦截器来实现特定的功能。
**过滤器与拦截器的区别：**拦截器是AOP思想的具体应用。
过滤器
- servlet规范中的一部分，任何java web工程都可以使用
- 在url-pattern中配置了/*之后，可以对所有要访问的资源进行拦截
拦截器
拦截器接口(HandlerInterceptor)：
拦截器一个有3个回调方法，而一般的过滤器Filter才两个:
preHandle：
预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器返回值：true表示继续流程（如调用下一个拦截器或处理器）；false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；
postHandle：
后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。
afterCompletion：
整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器才会执行afterCompletion。
拦截器适配器(HandlerInterceptorAdapter)
有时我们可能只需要实现三个回调方法中的某一个，如果实现HandlerInterceptor接口的话，三个方法必须实现，此时spring提供了一个HandlerInterceptorAdapter适配器（一种适配器设计模式的实现），允许我们只实现需要的回调方法。
拦截器配置：
<!-- 配置拦截器：--> <mvc:interceptors> <!-- 会拦截所有Controller类里的所有处理方法 --> <bean class="cn.jq.sshweb.web.HandlerInterceptor1"></bean> <mvc:interceptor> <!-- 只拦截该路径 --> <mvc:mapping path="/users"/> <bean class="cn.jq.sshweb.web.HandlerInterceptor2"></bean> </mvc:interceptor> <mvc:interceptor> <!-- 拦截所有请求，排除拦截 /toAdd 请求 --> <mvc:mapping path="/**"/> <mvc:exclude-mapping path="/toAdd"/> <bean class="cn.jq.sshweb.web.HandlerInterceptor3"></bean> </mvc:interceptor> </mvc:interceptors>
一、自定义拦截器
那如何实现拦截器呢？
想要自定义拦截器，必须实现 HandlerInterceptor 接口。
-
新建一个Moudule ， springmvc-07-Interceptor ， 添加web支持
-
配置web.xml 和 springmvc-servlet.xml 文件
-
编写一个拦截器
package com.zhixi.interceptor; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; /** * @author zhangzhixi */ public class MyInterceptor implements HandlerInterceptor { //在请求处理的方法之前执行 //如果返回true执行下一个拦截器 //如果返回false就不执行下一个拦截器 public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception { System.out.println("------------处理前------------"); return true; } // 在请求处理方法执行之后执行 public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception { System.out.println("------------处理后------------"); } //在dispatcherServlet处理后执行,做清理工作. public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception { System.out.println("------------清理------------"); } }
4. 在springmvc的配置文件中配置拦截器
<!--关于拦截器的配置--> <mvc:interceptors> <mvc:interceptor> <!--/** 包括路径及其子路径--> <!--/admin/* 拦截的是/admin/add等等这种 , /admin/add/user不会被拦截--> <!--/admin/** 拦截的是/admin/下的所有--> <mvc:mapping path="/**"/> <!--bean配置的就是拦截器--> <bean class="com.zhixi.interceptor.MyInterceptor"/> </mvc:interceptor> </mvc:interceptors>
5. 编写controller接收请求
@RestController public class InterceptorDemo { @RequestMapping("/t1") public String test1(){ System.out.println("Controller的test1方法执行了~"); return "ok"; } }
6. 测试：访问http://localhost:8080/t1
------------处理前------------
Controller的test1方法执行了~
------------处理后------------
------------清理------------
二、验证用户是否登录 (认证用户)
实现思路
- 有一个登陆页面，需要写一个controller访问页面。
- 登陆页面有一提交表单的动作。需要在controller中处理。判断用户名密码是否正确。如果正确，向session中写入用户信息。返回登陆成功。
- 拦截用户请求，判断用户是否登陆。如果用户已经登陆。放行， 如果用户未登陆，跳转到登陆页面
代码编写
-
编写一个用户访问首页index.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>首页</title> </head> <body> <h1>首页</h1> <hr> <%--登录--%> <a href="${pageContext.request.contextPath}/user/jumpLogin">登录</a> <a href="${pageContext.request.contextPath}/user/jumpSuccess">成功页面</a> </body> </html>
2. 编写用户登录页面
<%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>Title</title> </head> <body> <form action="${pageContext.request.contextPath}/user/login"> 用户名：<input type="text" name="username"> <br> 密码： <input type="password" name="pwd"> <br> <input type="submit" value="提交"> </form> </body> </html>
3. 用户登录成功页面
<%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>Title</title> </head> <body> <div>${user}</div> <div> <a href="${pageContext.request.contextPath}/user/logout">退出</a> </div> <div> <a href="${pageContext.request.contextPath}/index.jsp">返回首页</a> </div> </body> </html>
4.controller类，处理前端请求
package com.zhixi.controller; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import javax.servlet.http.HttpSession; /** * @author zhangzhixi */ @Controller @RequestMapping("/user") public class MyController { //跳转到登陆页面 @RequestMapping("/jumpLogin") public String jumpLogin() throws Exception { return "login"; } //跳转到成功页面 @RequestMapping("/jumpSuccess") public String jumpSuccess() throws Exception { return "success"; } //登陆提交 @RequestMapping("/login") public String login(HttpSession session, String username, String pwd) throws Exception { // 向session记录用户身份信息 System.out.println("接收前端==="+username); session.setAttribute("user", username); return "success"; } //退出登陆 @RequestMapping("logout") public String logout(HttpSession session) throws Exception { // session 过期 session.invalidate(); return "login"; } }
5. 编写拦截器类
package com.zhixi.interceptor; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.ServletException; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpSession; import java.io.IOException; /** * @author zhangzhixi */ public class MyInterceptor implements HandlerInterceptor { public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException, IOException, ServletException, IOException { // 如果是登陆页面则放行 System.out.println("uri: " + request.getRequestURI()); if (request.getRequestURI().contains("login")) { return true; } HttpSession session = request.getSession(); // 如果用户已登陆也放行 if(session.getAttribute("user") != null) { return true; } // 用户没有登陆跳转到登陆页面 request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response); return false; } public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception { } public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception { } }
6. spring中配置拦截器
<!--关于拦截器的配置--> <mvc:interceptors> <mvc:interceptor> <mvc:mapping path="/**"/> <bean class="com.zhixi.interceptor.MyInterceptor"></bean> </mvc:interceptor> </mvc:interceptors>
7. 再次重启Tomcat测试！
OK，测试登录拦截功能无误.
