拦截器

  • SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。开发者可以自己定义一些拦截器来实现特定的功能。
  • 过滤器与拦截器的区别:拦截器是AOP思想的具体应用
  • 过滤器
    • Servlet规范中的一部分,任何java web工程都可以使用
    • url-pattern中配置了/*之后,可以对所有要访问的资源进行拦截
  • 拦截器
    • 拦截器是SpringMVC框架自己的,只有使用了SpringMVC框架的工程才能使用
    • 拦截器只会拦截访问的控制器方法, 如果访问的是jsp/html/css/image/js是不会进行拦截的

自定义拦截器

  • 想要自定义拦截器,必须实现 HandlerInterceptor 接口
  • 搭建SpringMVC环境
    1. 新建一个Moudule ,并 添加web支持
    2. 配置web.xmlspringmvc-servlet.xml 文件
    3. 编写一个拦截器
  • 编写一个拦截器MyInterceptor
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
package com.lzy.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class MyInterceptor implements HandlerInterceptor {

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

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

//在dispatcherServlet处理后执行,做清理工作.
@Override
public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
System.out.println("------------清理------------");
}
}
  • springmvc-servlet.xml的配置文件中配置拦截器
1
2
3
4
5
6
7
8
9
10
11
<!--关于拦截器的配置-->
<mvc:interceptors>
<mvc:interceptor>
<!--/** 包括路径及其子路径-->
<!--/admin/* 拦截的是/admin/add等等这种 , /admin/add/user不会被拦截-->
<!--/admin/** 拦截的是/admin/下的所有-->
<mvc:mapping path="/**"/>
<!--bean配置的就是拦截器-->
<bean class="com.lzy.interceptor.MyInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>
  • 编写一个Controller,接收请求
1
2
3
4
5
6
7
8
9
10
11
12
13
14
package com.lzy.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

//测试拦截器的控制器
@RestController
public class InterceptorController {

@GetMapping("/t1")
public String testFunction() {
System.out.println("InterceptorController控制器中的方法执行了");
return "OK";
}
}
  • 前端index.jsp
1
2
3
4
5
6
7
8
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ page isELIgnored="false" %>
<html>
<meta charset="UTF-8">
<body>
<a href="${pageContext.request.contextPath}/t1">拦截器测试</a>
</body>
</html>

登录判断验证

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

前端页面

  • 由于在WEB-INF下的所有页面或者资源不能直接访问,需要通过index.jsp作为入口
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>$Title$</title>
</head>
<body>
<h1>需求:未登录不能进入首页</h1>
<hr>
<%--在WEB-INF下的所有页面或者资源不能直接访问,所有通过index.jsp作为入口--%>
<%--请求响应给LoginContoller控制器,gologin和main为@RequestMapping值--%>
<h1><a href="${pageContext.request.contextPath}/user/gologin">登录</a></h1>
<h1><a href="${pageContext.request.contextPath}/user/main">首页</a></h1>
</body>
</html>
  • 在jsp/下编写一个登陆页面 login.jsp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ page isELIgnored="false" %>
<html>
<head>
<title>Title</title>
</head>

<h1>登录页面</h1>
<hr>

<body>
<%--WEB-INF下的所有页面或者资源,只能通过Controller,或者Servlet进行访问--%>
<%--表单请求提交到控制器,logon为@RequestMapping值--%>
<form action="${pageContext.request.contextPath}/user/login" method="post">
用户名:<input type="text" name="username"> <br>
密码:<input type="password" name="password"> <br>
<input type="submit" value="提交">
</form>
</body>
</html>
  • 在jsp/下编写一个主页面 main.jsp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ page isELIgnored="false" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<h3>首页</h3>
<span>用户名:${username}</span>
<p>
<!--注销请求发送到控制器,且@RequestMapping参数值为goOut进行处理-->
<a href="${pageContext.request.contextPath}/user/logout">注销</a>
</p>
</body>
</html>

控制器

  • 编写一个Controller处理请求
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.lzy.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpSession;

@Controller
//取一个父路径,即所有请求都在/user
@RequestMapping("/user")
public class LoginController {

//处理前端user/main请求转到首页
@RequestMapping("/main")
public String main(){
//访问main.jsp
return "main";
}
//处理前端user/gologin请求转到登录页面
@RequestMapping("/gologin")
public String gologin(){
//访问login.jsp
return "login";
}

//处理login.jsp登录的请求
@RequestMapping("/login")
public String login(HttpSession session, String username, String password, Model model){
//把用户信息存在session中
session.setAttribute("userloginInfo",username);
//登录的用户名保存
model.addAttribute("username",username);
//转到main.jsp
return "main";
}

//注销退出登录
//注册main.jsp发送过来的注销请求
@RequestMapping("/logout")
public String logout(HttpSession session){
//移除sessionID属性
session.removeAttribute("userloginInfo");
//转到login.jsp
return "login";
}
}

拦截器

  • 首先配置web.xml注册控制器
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<?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">

<!--1.注册servlet-->
<servlet>
<servlet-name>SpringMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--通过初始化参数指定SpringMVC配置文件的位置,进行关联-->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc-servlet.xml</param-value>
</init-param>
<!-- 启动顺序,数字越小,启动越早 -->
<load-on-startup>1</load-on-startup>
</servlet>

<!--所有请求都会被springmvc拦截 -->
<servlet-mapping>
<servlet-name>SpringMVC</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>

<filter>
<filter-name>encoding</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>encoding</filter-name>
<url-pattern>/</url-pattern>
</filter-mapping>

</web-app>
  • 编写用户登录拦截器
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
package com.lzy.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

public class LoginInterceptor implements HandlerInterceptor {

//如果返回true执行下一个拦截器放行
//如果返回false就不执行下一个拦截器不放行
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
HttpSession session = request.getSession();
//放行:判断什么情况下没有登录
//路径含有gologin说明是登录页面,也会放行
if(request.getRequestURI().contains("gologin")){
return true;
}
//第一次登录没有session,需要对路径包含login放行,说明我在提交登录
if(request.getRequestURI().contains("login")){
return true;
}
//第一次登录,也是没有session,如果sessionID不为空,说明是已登录用户,放行
if(session.getAttribute("userloginInfo")!=null){
return true;
}
//其他情况下即未登录用户不放行,让其转发的登录页面
request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request,response);
return false;
}
}
  • 在Springmvc的配置文件中注册拦截器
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<?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
https://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="com.lzy.controller"/>
<!--静态资源过滤!!-->
<mvc:default-servlet-handler />
<mvc:annotation-driven />

<!-- 视图解析器 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
id="internalResourceViewResolver">
<!-- 前缀 -->
<property name="prefix" value="/WEB-INF/jsp/" />
<!-- 后缀 -->
<property name="suffix" value=".jsp" />
</bean>
<!--关于拦截器的配置-->
<mvc:interceptors>
<mvc:interceptor>
<!--包括/user请求下面的所有请求,所以最好取一个父路径-->
<mvc:mapping path="/user/**"/>
<bean id="loginInterceptor" class="com.lzy.interceptor.LoginInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>
</beans>
  • 运行结果可以发现注销后,再访问main.jsp直接跳到登录页面