springmvc拦截器：Interceptor

SpringMvc中拦截器(Interceptor)简介

1.Spring MVC中的拦截器(Interceptor)类似于ServLet中的过滤器(Filter)，它主要用于拦截用户请求并作出相应的处理。
2.例如通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录等。
3.拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器(只能拦截@Controller的请求)方法的执行

pom.xml相关配置

pom.xml 代码

<dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.2.3.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>servlet-api</artifactId>
      <version>2.5</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet.jsp</groupId>
      <artifactId>jsp-api</artifactId>
      <version>2.2</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>jstl</artifactId>
      <version>1.2</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>4.0.1</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

web.xml相关配置

web.xml 代码

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
         http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" id="WebApp_ID"
         version="3.1">
    <display-name>Interceptor</display-name>
    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>

    <!--配置spring-mvc.xml,拦截器-->
    <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:spring-mvc.xml</param-value>
        </init-param>
        <!-- 启动顺序，数字越小，启动越早 -->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <!--/ 匹配所有的请求；（不包括.jsp）-->
    <!--/* 匹配所有的请求；（包括.jsp）-->
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

spring-mvc.xml相关配置

spring-mvc.xml 代码

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       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
	https://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 自动扫描包，让指定包下的注解生效,由IOC容器统一管理 -->
    <context:component-scan base-package="org.example"/>
    <!-- 视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          id="internalResourceViewResolver">
        <!-- 前缀 -->
        <property name="prefix" value="/page/" />
        <!-- 后缀 -->
        <property name="suffix" value=".jsp" />
    </bean>

    <!--配置拦截器-->
        <mvc:interceptors>
            <mvc:interceptor>
                <!--拦截：/**-->
                <mvc:mapping path="/**"/>
                <!--下面是不予拦截-->
                <mvc:exclude-mapping path="/login.jsp"/>
                <mvc:exclude-mapping path="/login.html"/>
                <mvc:exclude-mapping path="/index.jsp"/>
                <mvc:exclude-mapping path="/verification"/>
                <!--通过自定义类ExcuteInterceptor判断是否通过拦截-->
                <bean class="org.example.Interceptor.ExcuteInterceptor"/>
            </mvc:interceptor>
        </mvc:interceptors>
</beans>

继承HandlerInterceptorAdapter

ExcuteInterceptor extends HandlerInterceptorAdapter代码

package org.example.Interceptor;

import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.PrintWriter;

public class ExcuteInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //preHandle在业务处理器处理请求之前被调用。预处理，可以进行编码、安全控制等处理；
        request.setCharacterEncoding("UTF-8");
        // 通过req获取session
        HttpSession session = request.getSession();
        // 检查session对象中的登录用户是否存在
        Object loginUser = session.getAttribute("loginUser");
        System.out.println(request.getContextPath());
        if(loginUser==null){
            PrintWriter out = response.getWriter();
            out.println("<html>");
            out.println("<script>");
            out.println("window.open ('"+request.getContextPath()+"/login.jsp','_top')");
            out.println("</script>");
            out.println("</html>");
            /* @return: false表示拦截*/
            return false;
        }else {
            /* @return: true表示放行*/
            return true;
        }
    }
    
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)throws Exception {
        //在业务处理器处理请求执行完成后，生成视图之前执行。后处理（调用了Service并返回ModelAndView，但未进行页面渲染），有机会修改ModelAndView； 
    }
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)throws Exception {
        //在DispatcherServlet完全处理完请求后被调用，可用于清理资源等。返回处理（已经渲染了页面），可以根据ex是否为null判断是否发生了异常，进行日志记录；
    }

}

编写index.jsp

<%@page import="org.example.pojo.User"%>
<%@ page language="java" contentType="text/html; charset=UTF-8"
         pageEncoding="UTF-8"%>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%
  String path = request.getContextPath();
  String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
  User loginUser = (User)session.getAttribute("loginUser");
  // session中如果找不到登录用户，重定向到登录界面
  if(loginUser==null){
    response.sendRedirect(basePath+"login.jsp");
  }
%>
<html>
  <head>
    <title>index首页</title>
  </head>
  <body>
  $END$
  </body>
</html>

编写login.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%
    String path = request.getContextPath();
    String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
<html>
<head>
    <title>Title</title>
</head>
<body>
<form action="/自定义">
    Uname:<input type="text" name="uname"><br/>
    Upwd:<input type="text" name="upwd"><br/>
    <input type="submit" name="sub" value="Go">
</form>

</body>
</html>