【SpringMVC】八、拦截器思路及用法、配置【狂神篇】

1、概述

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

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

过滤器

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

拦截器

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

2、自定义拦截器

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

1）新建Moudule

添加web支持

2）配置xml

web.xml 和 applicationContext.xml

• web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <!--DispatcherServlet-->
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <!--总的配置文件-->
            <param-value>classpath:applicationContext.xml</param-value>
        </init-param>
        <!--启动级别-->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <!--乱码过滤器-->
    <filter>
        <filter-name>encodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>utf-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>encodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

• applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <!--1、注解驱动-->
    <mvc:annotation-driven/>
    <!--2、静态资源过滤-->
    <mvc:default-servlet-handler/>
    <!--3、扫描包-->
    <context:component-scan base-package="com.tuwer.controller"/>
    <!--4、视图解析器-->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/jsp/"/>
        <property name="suffix" value=".jsp"/>
    </bean>
</beans>

3）编写拦截器

可以实现 HandlerInterceptor 接口中的任一方法

public class MyInterceptor implements HandlerInterceptor {
    /**
     * 目标方法执行前
     * @param request
     * @param response
     * @param handler
     * @return true：表示放行，不拦截；false：表示已拦截，禁止目标方法执行
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("执行前");
        return true;
    }

    /**
     * 目录方法执行后
     * @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("执行后");
    }

    /**
     * 最后清理
     * @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("清理");
    }
}

4）配置拦截器

在 applicationContext.xml 中添加

    <!--配置拦截器-->
    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.tuwer.interceptor.MyInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

• path 配置拦截路径；
  • /* 表示该路径下的所有请求，不包括子路径；如：/admin/*，包含/admin/add，但不包含/admin/abc/add
  • /** 表示该路径下的所有请求，包括子路径；如：/admin/*，包含/admin/add，也包含/admin/abc/add
• bean 配置拦载器类

5）编写Controller

@RestController
public class MyController {
    @RequestMapping("/t")
    public String test(){
        System.out.println("test方法执行");
        return "hello!";
    }
}

6）前端

<a href="${pageContext.request.contextPath}/t">拦截器测试</a>

7）启动测试

3、案例：验证用户登录

1）jsp页面

• index.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>首页</title>
  </head>
  <body>
  <h3><a href="${pageContext.request.contextPath}/user/gologin">登录</a></h3>
  <h3><a href="${pageContext.request.contextPath}/user/main">后台主页</a></h3>
  </body>
</html>

• login.jsp

位于WEB-INF/jsp目录下

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>登录</title>
</head>
<body>
<h1>登录</h1>
<form action="${pageContext.request.contextPath}/user/login" method="post">
    <input name="username" type="text">
    <input type="submit" value="登录">
</form>
</body>
</html>

• main.jsp

位于WEB-INF/jsp目录下

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>欢迎</title>
</head>
<body>
<h1>主页</h1>
<span>${loginUser}</span>
<h3><a href="${pageContext.request.contextPath}/user/logout">注销</a></h3>
</body>
</html>

2）LoginController

@Controller
@RequestMapping("/user")
public class LoginController {
    /**
     * 进入登录页
     * @return
     */
    @RequestMapping("/gologin")
    public String goLogin(){
        return "login";
    }

    /**
     * 登录
     * @param username
     * @param session
     * @return
     */
    @RequestMapping("/login")
    public String login(String username, HttpSession session){
        session.setAttribute("loginUser", username);
        return "main";
    }

    /**
     * 进入后台主页
     * @return
     */
    @RequestMapping("/main")
    public String goMain(){
        return "main";
    }

    /**
     * 注销
     * @param session
     * @return
     */
    @RequestMapping("/logout")
    public String logout(HttpSession session){
        session.removeAttribute("loginUser");
        // 注销后，虽然重定向到main页面，但会被拦截器拦载，会显示登录页
        return "redirect:/user/main";
    }
}

3）LoginInterceptor

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 放行登录页
        if(request.getRequestURI().contains("login")){
            return true;
        }

        // 放行登录用户
        HttpSession session = request.getSession();
        if(session.getAttribute("loginUser")!=null){
            return true;
        }

        // 拦载
        request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);
        return false;
    }
}

4）配置拦截器

    <!--配置拦截器-->
    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/user/**"/>
            <bean class="com.tuwer.interceptor.LoginInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>