SpringMVC-16-拦截器(Interceptor)

9.springmvc 拦截器（Interceptor ）

Spring MVC 的拦截器（Interceptor）与 Java Servlet 的过滤器（Filter）类似，它主要用于拦截用户的请求，在执行处理器方法前添加预处理操作，执行方法后处理操作，通常应用在权限验证、记录请求信息的日志、判断用户是否登录等功能上。

背景：在系统中，常需要在处理用户请求之前和之后执行一些操作。例如：验证用户的登陆权限、将请求的信息记录到日志中，即平时所说的“权限验证”及“日志记录”。通用方式是中间层加一种机制，拦截用户的请求，在请求的前后添加处理逻辑。

Spring MVC 提供了 Interceptor 拦截器机制，用于请求的预处理和后处理，可以延伸到Struts2 框架中，此框架就提供了拦截器的功能

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

过滤器：servlet规范中的一部分，任何java web工程都能使用，配置了/*可以对所有要访问的资源进行过滤

拦截器：是Spring MVC 框架提供的，只能在本框架中使用。只会拦截访问控制器的方法，访问静态资源或jsp不进行拦截

在 Spring MVC 框架中使用拦截器需要提前对拦截器进行定义和配置

9.1 拦截器的定义

有以下 2 种方式。

通过实现 HandlerInterceptor 接口或继承 HandlerInterceptor 接口的实现类（例如 HandlerInterceptorAdapter）来定义；

通过实现 WebRequestInterceptor 接口或继承 WebRequestInterceptor 接口的实现类来定义。

实现 HandlerInterceptor 接口需要实现了接口中的 3 个方法

preHandle( )：在控制器的处理请求方法前执行，其返回值表示是否中断后续操作，返回 true 表示继续向下执行，返回 false 表示中断后续操作。后续操作：下一道拦截器或处理方法

postHandle( )：在控制器的处理请求方法调用之后、解析视图之前执行，可以通过此方法对请求域中的模型和视图做进一步的修改。

afterCompletion( )：该方法在控制器的处理请求方法执行完成后执行，即视图渲染结束后执行，可以通过此方法实现一些资源清理、记录日志信息等工作。

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        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 {

    }
}

9.2 拦截器配置

<!-- 配置拦截器 -->
<mvc:interceptors>
    <!-- 配置去全局拦截器 -->
    <bean class="com.zk.interceptor.MyInterceptor"/>
    <!-- 配置细粒度拦截器 -->
    <mvc:interceptor>
        <!-- 配置拦截器拦截的请求路径 -->
        <mvc:mapping path="/**"/>
        <!-- 配置不拦截的路径 -->
        <mvc:exclude-mapping path="/login"/>
        <!-- 定义在<mvc:interceptor>元素中，表示匹配指定路径的请求才进行拦截 -->
        <bean class="com.zk.interceptor.MyInterceptor"/>
    </mvc:interceptor>
    <mvc:interceptor>
        <!-- 配置拦截器拦截的请求路径 -->
        <mvc:mapping path="/main"/>
        <bean class="com.zk.interceptor.MyInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

mvc:interceptors：用于配置一组拦截器。

：该元素是 mvc:interceptors 的子元素，用于定义全局拦截器，即拦截所有的请求。

mvc:interceptor：该元素用于定义细粒度的拦截器。

mvc:mapping：该元素是 mvc:interceptor 的子元素，用于配置拦截器作用的路径，该路径在其属性 path 中定义。path 的属性值为/**时，表示拦截所有路径，值为/main时，表示拦截所有以/main结尾的路径。如果在请求路径中包含不需要拦截的内容，可以通过 mvc:exclude-mapping 子元素进行配置。

注意mvc:interceptor元素中 mvc:mapping…/、mvc:exclude-mapping…/、<bean…/> 顺序不要改变

举例：用户登陆验证，验证通过进入main页面，否则拦截到login页面，在主页面可以退出，推出后只能以重登陆的方式进入主页面
实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private String username;
    private String pwd;
}

控制器类，注意登陆失败和主页退出的页面跳转方式。

@Controller
public class LoginController {
    @RequestMapping("/login")
    public String login(User user, HttpSession session, Model model){
        System.out.println("user:"+user.toString());
        if ("admin".equals(user.getUsername())&&"123456".equals(user.getPwd())) {
            // 登录成功，将用户信息保存到session对象中
            session.setAttribute(Constant.Session_user,user);
            // 重定向到主页面的跳转方法
            return "redirect:toMain";
        }
        model.addAttribute("msg","登陆信息有误，请检查后重新登陆");
        //转发到登陆页面，携带参数
        return "forward:/index.jsp";
    }

    @RequestMapping("/toMain")
    public String toMain(){
        return "main";
    }

    @RequestMapping("/loginOut")
    public String loginOut(HttpSession session){
        // 清除 session
        session.removeAttribute(Constant.Session_user);
        //退出操作，重定向到登陆页面
        return "redirect:/index.jsp";
    }
}

拦截器设置

<?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:aop="http://www.springframework.org/schema/aop"
       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/aop
       http://www.springframework.org/schema/aop/spring-aop.xsd
       http://www.springframework.org/schema/mvc
       https://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <!--开启注解-->
    <context:component-scan base-package="com.zk"/>

    <mvc:default-servlet-handler/>
    <mvc:resources mapping="/static/**" location="/static/"/>

    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="internalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/jsp/"/>
        <property name="suffix" value=".jsp"/>
    </bean>
    <mvc:annotation-driven conversion-service="formattingConversionService">
        <mvc:message-converters register-defaults="true">
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <!--乱码问题解决-->
                <constructor-arg name="defaultCharset" value="UTF-8"/>
            </bean>
            <bean class="com.alibaba.fastjson2.support.spring.http.converter.FastJsonHttpMessageConverter">
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>
    <!--注册MyFormatter 格式化实体类日期的格式器，可以注释掉-->
    <bean class="org.springframework.format.support.FormattingConversionServiceFactoryBean" id="formattingConversionService">
        <property name="formatters">
            <list>
                <bean class="com.zk.formatter.MyFormatter"/>
            </list>
        </property>
    </bean>
    <!-- 配置拦截器 -->
    <mvc:interceptors>
        <!-- 配置细粒度拦截器 -->
        <mvc:interceptor>
            <!-- 配置拦截器拦截的请求路径 -->
            <mvc:mapping path="/**"/>
            <!-- 配置不拦截的路径 -->
            <mvc:exclude-mapping path="/login"/>
            <mvc:exclude-mapping path="/static/**"/>
            <!-- 定义在<mvc:interceptor>元素中，表示匹配指定路径的请求才进行拦截 -->
            <bean class="com.zk.interceptor.MyInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>
</beans>

页面index.jsp作为登陆页，main.jsp作为主页

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>$Title$</title>
  </head>
  <body>
  <form action="${pageContext.request.contextPath}/login" method="post">
    <div>
      <label for="username">用户名：</label>
      <input type="text" name="username" id="username">
    </div>
    <div>
      <label for="pwd">密码：</label>
      <input type="password" name="pwd" id="pwd">
    </div>
    <input type="submit" value="登陆">
  </form>
  ${msg}
  </body>
</html>

main.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<h2>主页面</h2>
${sessionScope.user.username}正在登陆！

<a href="${pageContext.request.contextPath}/loginOut">退出</a>
</body>
</html>