SpringMVC学习笔记（七）。拦截器的使用。HandlerInterceptor

拦截器

1、概述

SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。开发者可以自己定义一些拦截器来实现特定的功能。

过滤器与拦截器的区别：拦截器是AOP思想的具体应用。
过滤器

• servlet规范中的一部分，任何java web工程都可以使用
• 在url-pattern中配置了/*之后，可以对所有要访问的资源进行拦截，包括视图。

拦截器

• 拦截器是SpringMVC框架自己的，只有使用了SpringMVC框架的工程才能使用
• 拦截器只会拦截访问的控制器方法， 如果访问的是jsp/html/css/image/js则不会进行拦截

2、自定义拦截器

想要自定义拦截器，必须实现 HandlerInterceptor 接口。

1. 新建一个Moudule ，添加web支持
2. 配置web.xml 和 springmvc-servlet.xml 文件
3. 编写一个拦截器

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("=============处理前================");
        //在请求处理的方法之前执行
        //如果返回true执行下一个拦截器
        //如果返回false就不执行下一个拦截器
        return true;
    }

    //在请求处理方法执行之后执行
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("==============处理后===================");
    }

    //在dispatcherServlet处理后执行,做清理工作.
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("==============清理=====================");
    }
}

拦截一般在preHandle()方法中处理，而postHandle()方法可以用于处理一些日志等功能。

4. 在springmvc的配置文件中配置拦截器

<mvc:interceptors>
    <mvc:interceptor>
        
        
        <mvc:mapping path="/**"/>
        <bean class="com.xxc.config.MyInterceptor"/>
    mvc:interceptor>
mvc:interceptors>

5. 编写一个Controller，接收请求

@Controller
public class TestController {

    @ResponseBody
    @RequestMapping("/interceptor")
    public String test1(){
        System.out.println("执行了TestController==>test1()");
        return "Hello";
    }
}

6. 启动tomcat测试

3、验证用户是否登录 (认证用户)

实现思路

1. 有一个登陆页面，需要写一个controller访问页面。
2. 登陆页面有一提交表单的动作。需要在controller中处理。判断用户名密码是否正确。如果正确，向session中写入用户信息。返回登陆成功。
3. 拦截用户请求，判断用户是否登陆。如果用户已经登陆，放行，进入登录成功页面。如果用户未登陆，跳转到登陆页面

1.编写一个登陆页面 login.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    

登录页面



    用户名： 

    密码：  

    

2. 编写一个Controller处理请求

@Controller
@RequestMapping("/user")
public class UserController {
    //跳转到登陆页面
    @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";
    }
}

3. 编写一个登陆成功的页面 success.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    


登录成功页面

${user}
注销

4. 在 index 页面上测试跳转！启动Tomcat 测试，未登录也可以进入主页！

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


  


首页

<%--登录--%>
登录
成功页面

走到这一步，当我们测试直接点击成功页面的时候也能跳转，并不符合我们的要求，所以我们要加拦截器。

5. 编写用户登录拦截器

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 如果是登陆页面则放行
        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;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

6. 在Springmvc的配置文件中注册拦截器

<mvc:interceptors>
    <mvc:interceptor>
        
        
        <mvc:mapping path="/**"/>
        <bean class="com.xxc.config.LoginInterceptor"/>
    mvc:interceptor>
mvc:interceptors>

7. 再次重启Tomcat测试！

成功！

4、总结

1. 过滤器与拦截器的区别。过滤器是servlet规范中的一部分，任何java web工程都可以使用。拦截器是SpringMVC框架自己的，只有使用了SpringMVC框架的工程才能使用。拦截器只会拦截访问的控制器方法， 如果访问的是jsp/html/css/image/js则不会进行拦截。
2. 可以理解为过滤器是让请求去走控制器Controller，而拦截器是对控制器里的请求做的拦截操作。
3. 一个类实现了HandlerInterceptor接口就是一个拦截器，在springmvc中注册即可使用。
4. 拦截一般在preHandle()方法中处理，而postHandle()方法可以用于处理一些日志等功能。
5. preHandle()在请求处理的方法之前执行，如果返回true执行下一个拦截器，如果返回false就不执行下一个拦截器。
6. 将HttpSession session作为一个参数就可获取到session。
7. 前端通过${pageContext.request.contextPath}可以获取上下文路径。
8. WEB-INF下的所有页面和资源，只能通过Controller或Servlet进行访问。

项目完整结构目录