SpringMVC拦截器
1.拦截器的作用
SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。
用户可以自定义一些拦截器来实现特定的功能。
拦截器链:拦截器链就是将拦截器按一定的顺序连接成一条链。在访问被拦截的方法或字段时,拦截器链中的拦截器就会按其之前定义的顺序被调用。
拦截器和过滤器的区别:
过滤器是Servlet规范中的一部分,任何java web工程都可以使用。
拦截器是SpringMVC框架自己的,只有使用了SpringMVC框架的工程才可以使用。
过滤器在url-pattern中配置了/*之后,可以对所有要访问的资源拦截。
拦截器它只会拦截访问的控制器方法,如果访问的是jsp,html,css,image或者是js是不会进行拦截的。
它也是AOP思想的具体应用。
我们要想自定义拦截器,要求必须实现:HandlerInterceptor接口。
2. 自定义拦截器的步骤
2.1 第一步:编写一个普通类实现HandlerInterception接口
package com.llb.interception; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; /** * 自定义拦截器 * Ceate By llb on 2019/8/21 */ public class MyInterception2 implements HandlerInterceptor { /** * 预处理,controller方法执行前 * return true;放行,执行下一个拦截器,如果没有就执行controller方法 * return false; 不放行 * @param request * @param response * @param handler * @return * @throws Exception */ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("拦截器preHandle方法执行了------前2222"); // request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response); return true; } /** * 后处理,controller执行方法后执行 * @param request * @param response * @param handler * @param modelAndView * @throws Exception */ @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("拦截器postHandle方法执行了------后2222"); // request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response); } /** * 页面显示后执行 * @param request * @param response * @param handler * @param ex * @throws Exception */ @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("拦截器afterCompletion方法执行了------最后2222"); } }
2.2 配置拦截器
<!--配置拦截器--> <mvc:interceptors> <mvc:interceptor> <!--要拦截的方法:配置一个即可--> <mvc:mapping path="/user/*"/> <!--配置拦截器对象--> <bean class="com.llb.interception.MyInterception" /> <!--不拦截的方法:配置一个即可--> <!--<mvc:exclude-mapping path=""></mvc:exclude-mapping>--> </mvc:interceptor> </mvc:interceptors>
2.3 控制器方法
/** * Ceate By llb on 2019/8/21 */ @Controller @RequestMapping("/user") public class UserController { /** * 测试拦截器 * @return */ @RequestMapping("/testInterception") public String testInterception(){ System.out.println("控制器执行了"); return "success"; } }
2.4 测试运行结果
3. 拦截器的细节
3.1 拦截器的放行
如果有下一个拦截器就执行下一个,如果该拦截器处于拦截器链最后一个,则执行控制器中的方法。
3.2 拦截器中的方法说明
/** * 预处理,controller方法执行前 * return true;放行,执行下一个拦截器,如果没有就执行controller方法 * return false; 不放行 * * 如何调用: * 按拦截器定义顺序调用 * 何时调用: * 只要配置了都会调用 * 有什么用: * 如果程序员决定该拦截器对请求拦截处理后还要调用其他的拦截器,或是业务处理器进行处理,则返回true * 如果程序员决定不再调用其他的组件去处理请求,则返回false * @param request * @param response * @param handler * @return * @throws Exception */ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("拦截器preHandle方法执行了------前1111"); // request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response); return true; } /** * 后处理,controller执行方法后执行 * * 如何调用: * 按拦截器定义逆序调用 * 何时调用: * 在拦截器链内所有拦截器返回成功调用 * 有什么用: * 在业务处理器处理完请求后,但是DispatcherServlet向客户端返回响应前被调用。 * 在该方法中对用户请求request进行处理。 * @param request * @param response * @param handler * @param modelAndView * @throws Exception */ @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("拦截器postHandle方法执行了------后1111"); // request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response); } /** * 如何调用: * 按拦截器定义逆序调用 * 何时调用: * 只有preHandler返回true才调用 * 有什么用: * 在DispatcherServlet完全处理完请求后被调用 * 可以在该方法中进行一些资源清理的操作 * @param request * @param response * @param handler * @param ex * @throws Exception */ @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("拦截器afterCompletion方法执行了------最后1111"); }
3.3 拦截器的作用路径
<!--配置拦截器--> <mvc:interceptors> <mvc:interceptor> <!--要拦截的方法:配置一个即可:指定拦截的url--> <mvc:mapping path="/user/*"/> <!--配置拦截器对象--> <bean class="com.llb.interception.MyInterception" /> <!--不拦截的方法:配置一个即可--> <!--<mvc:exclude-mapping path=""></mvc:exclude-mapping>--> </mvc:interceptor> </mvc:interceptors>
3.4 多个拦截器的执行顺序
按照配置的顺序进行执行的:
4. 多拦截器执行测试
4.1 springmvc.xml配置:
<!--配置拦截器--> <mvc:interceptors> <mvc:interceptor> <!--要拦截的方法:配置一个即可--> <mvc:mapping path="/user/*"/> <!--配置拦截器对象--> <bean class="com.llb.interception.MyInterception" /> <!--不拦截的方法:配置一个即可--> <!--<mvc:exclude-mapping path=""></mvc:exclude-mapping>--> </mvc:interceptor> <mvc:interceptor> <!--要拦截的方法:配置一个即可--> <mvc:mapping path="/user/*"/> <!--配置拦截器对象--> <bean class="com.llb.interception.MyInterception2" /> <!--不拦截的方法:配置一个即可--> <!--<mvc:exclude-mapping path=""></mvc:exclude-mapping>--> </mvc:interceptor> </mvc:interceptors>
4.2 拦截器1的代码
/** * 自定义拦截器 * Ceate By llb on 2019/8/21 */ public class MyInterception implements HandlerInterceptor { /** * 预处理,controller方法执行前 * @param request * @param response * @param handler * @return * @throws Exception */ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("拦截器preHandle方法执行了------前1111"); // request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response); return true; } /** * 后处理,controller执行方法后执行 * @param request * @param response * @param handler * @param modelAndView * @throws Exception */ @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("拦截器postHandle方法执行了------后1111"); // request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response); } /** * 页面显示后执行 * @param request * @param response * @param handler * @param ex * @throws Exception */ @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("拦截器afterCompletion方法执行了------最后1111"); } }
4.3 拦截器2的代码
/** * 自定义拦截器 * Ceate By llb on 2019/8/21 */ public class MyInterception2 implements HandlerInterceptor { /** * 预处理,controller方法执行前 * return true;放行,执行下一个拦截器,如果没有就执行controller方法 * return false; 不放行 * @param request * @param response * @param handler * @return * @throws Exception */ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("拦截器preHandle方法执行了------前2222"); // request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response); return true; } /** * 后处理,controller执行方法后执行 * @param request * @param response * @param handler * @param modelAndView * @throws Exception */ @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("拦截器postHandle方法执行了------后2222"); // request.getRequestDispatcher("/WEB-INF/pages/error.jsp").forward(request, response); } /** * 页面显示后执行 * @param request * @param response * @param handler * @param ex * @throws Exception */ @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("拦截器afterCompletion方法执行了------最后2222"); } }
4.4 控制器方法
/** * Ceate By llb on 2019/8/21 */ @Controller @RequestMapping("/user") public class UserController { /** * 测试拦截器 * @return */ @RequestMapping("/testInterception") public String testInterception(){ System.out.println("控制器执行了"); return "success"; } }
4.5 运行结果
源码:github