SpringMVC【七】拦截器

11、拦截器

11.1 简介

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

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

过滤器

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

拦截器

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

11.2 自定义拦截器

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

新建一个 Moudule，添加web支持
配置 web.xml 和 springmvc-servlet.xml 文件

编写一个拦截器

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

    // 在请求处理方法执行之后执行，如日志
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("处理后");
    }
	 // 在 dispatcherServlet 处理后执行，做清理工作
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("清理");
    }
}

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

<!--拦截器-->
<mvc:interceptors>
    <mvc:interceptor>
        <!--包括这个请求下面的所有请求（路径及其子路径）-->
        <!--/admin/* 拦截的是/admin/add等等这种 , /admin/add/user不会被拦截-->
        <!--/admin/** 拦截的是/admin/下的所有-->
        <mvc:mapping path="/**"/>
        <bean class="com.song.config.MyInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

编写一个 Controller，接收请求

@RestController
public class TestController {

    @RequestMapping("/t1")
    public String test(){
        System.out.println("TestController的test方法执行了");
        return "OK";
    }
}

启动tomcat 测试

地址栏输入 localhost:8080/t1 ，页面会显示 OK，服务器控制台输出为

11.3 案例：验证用户是否登录

需求分析：

【index.jsp】页面有一个【登录页面】和【首页】的超链接。

要求：未登录时点击【首页】会跳转到【登录页面】进行登录，如果登录过会直接跳到【首页】。

登录成功会将用户名显示在【首页】，并且首页会有一个【注销】按钮，注销之后会返回到【登录页面】。

思路：

1、有一个登录页面，需要写一个 controller 访问页面。

2、登录页面有一个提交表单的动作，需要在controller中处理，判断用户名密码是否正确。如果正确，向session 中写入用户信息，返回登录成功。

3、拦截用户请求，判断用户是否登陆。如果用户已经登陆。放行，如果用户未登陆，跳转到登陆页面。

测试：

【index.jsp】页面

<h1><a href="${pageContext.request.contextPath}/user/goLogin">登录页面</a></h1>
<h1><a href="${pageContext.request.contextPath}/user/main">首页</a></h1>

登陆页面【login.jsp】

<%--在 WEB-INF 下的页面或者资源，只能通过controller 或者servlet 进行访问--%>
<h1>登录页面</h1>

<form action="${pageContext.request.contextPath}/user/login" method="post">
    <%--注意：表单中的数据要想被提交，必须指定其name属性--%>
    用户名：<input type="text" name="username">
    密码：<input type="text" name="password">
    <input type="submit" value="提交">
</form>

LoginController

@Controller
@RequestMapping("/user")
public class LoginController {

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

    @RequestMapping("/goLogin")
    public String login(){
        return "login";
    }

    @RequestMapping("/login")
    public String login(HttpSession session, String username, String password, Model model){
        System.out.println("login=====>" + username);
        // 把用户的信息存在 session中
        session.setAttribute("userLoginInfo",username);
        model.addAttribute("username",username);
        return "main";
    }

    @RequestMapping("/goOut")
    public String login(HttpSession session){
        // 把用户的信息存在 session中
        session.removeAttribute("userLoginInfo");
        return "login";
    }
}

首页【main.jsp】，也就是登录成功的页面

<h1>首页</h1>

<span>${username}</span>

<p>
        <a href="${pageContext.request.contextPath}/user/goOut">注销</a>
</p>

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

编写用户登录拦截器

public class LoginInterceptor implements HandlerInterceptor {
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        HttpSession session = request.getSession();
        // 放行：判断什么情况下登录
        // 登录页面放行
        if (request.getRequestURI().contains("goLogin")){
            return true;
        }
        // 说明正在提交登录
        if (request.getRequestURI().contains("login")){
            return true;
        }

        // 第一次登录也是没有 session的
        if (session.getAttribute("userLoginInfo") != null){
            return true;
        }

        // 判断什么情况下没有登录
        request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request,response);
        return false;
    }
}

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

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

重启 Tomcat 测试，登录拦截功能实现。