Spring MVC学习
- 官方文档:https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html
- 参考视频:【狂神说Java】SpringMVC最新教程IDEA版通俗易懂_哔哩哔哩_bilibili
- 项目完整代码参考:lexiaoyuan/SpringMVCStudy: My SpringMVC study notes (github.com)、SpringMVCStudy: 我的Spring MVC学习笔记 (gitee.com)
拦截器
SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。开发者可以自己定义一些拦截器来实现特定的功能。
**过滤器与拦截器的区别:**拦截器是AOP思想的具体应用。
过滤器
- servlet规范中的一部分,任何java web工程都可以使用
- 在url-pattern中配置了/*之后,可以对所有要访问的资源进行拦截
拦截器
- 拦截器是SpringMVC框架自己的,只有使用了SpringMVC框架的工程才能使用
- 拦截器只会拦截访问的控制器方法, 如果访问的是jsp/html/css/image/js是不会进行拦截的
1. 环境搭建
- 新建module,添加web支持
- 配置
web.xml
和springmvc-servlet.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">
<servlet>
<servlet-name>dispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<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>
<servlet-mapping>
<servlet-name>dispatcherServlet</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>
<?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">
<context:component-scan base-package="com.springmvc.controller"/>
<mvc:default-servlet-handler/>
<mvc:annotation-driven>
<mvc:message-converters>
<bean class="org.springframework.http.converter.StringHttpMessageConverter">
<constructor-arg value="UTF-8"/>
</bean>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="objectMapper">
<bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
<property name="failOnEmptyBeans" value="false"/>
</bean>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
</beans>
- 新建controller包和
InterceptorController.java
package com.springmvc.controller;
@RestController
public class InterceptorController {
@GetMapping("/test")
public String test() {
System.out.println("InterceptorController==>test()方法执行了");
return "测试环境";
}
}
- 添加lib包,部署运行,环境成功,这里不测试了。
2. 实现拦截器
- 新建config包,
MyInterceptor.java
package com.springmvc.config;
public class MyInterceptor implements HandlerInterceptor {
//在请求处理的方法之前执行
//如果返回true执行下一个拦截器
//如果返回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-servlet.xml
中增加拦截器配置
<!--配置拦截器-->
<mvc:interceptors>
<mvc:interceptor>
<!--/** 包括路径及其子路径,例如:-->
<!--/admin/* 拦截的是/admin/add等等这种 , /admin/add/user不会被拦截-->
<!--/admin/** 拦截的是/admin/下的所有-->
<mvc:mapping path="/**"/>
<bean class="com.springmvc.config.MyInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>
-
OK,重启Tomcat,访问:http://localhost:8080/springmvc_07_interceptor/test
-
后台输出:
========= 方法执行前==========
InterceptorController==>test()方法执行了
========= 方法执行后==========
========= 清理==========
3. 验证用户登录(登录后才能访问首页)
- 在
index.jsp
中提供访问首页和登录的入口
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>$Title$</title>
</head>
<body>
<a href="${pageContext.request.contextPath}/user/home">首页</a>
<a href="${pageContext.request.contextPath}/user/goLogin">登录</a>
</body>
</html>
- 在
WEB-INF/jsp
目录下新建home.jsp
和login.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>首页</title>
</head>
<body>
<h3>首页</h3>
<p>这里是首页的一些内容。。。</p>
<p>欢迎你:${username}</p>
<a href="${pageContext.request.contextPath}/user/logout">注销</a>
<a href="${pageContext.request.contextPath}/index.jsp">返回index</a>
</body>
</html>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>登录</title>
</head>
<body>
<h3>登录</h3>
<form action="${pageContext.request.contextPath}/user/login" method="post">
<label for="username">用户名:</label>
<input type="text" name="username" id="username">
<label for="password">密码:</label>
<input type="password" name="password" id="password">
<input type="submit" value="登录">
</form>
</body>
</html>
- 在
springmvc-servlet.xml
中配置视图解析
<bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/jsp/"/>
<property name="suffix" value=".jsp"/>
</bean>
- 修改
InterceptorController.java
,增加请求方法
@Controller
@RequestMapping("/user")
public class InterceptorController {
/* @GetMapping("/test")
@ResponseBody
public String test() {
System.out.println("InterceptorController==>test()方法执行了");
return "测试环境";
}
*/
@GetMapping("/home")
public String home(){
return "home"; //home.jsp
}
@GetMapping("/goLogin")
public String goLogin(){
return "login"; //login.jsp
}
@PostMapping("/login")
public String login(String username, String password, HttpSession session){
System.out.println("username:"+username+",password:"+password);
if ("admin".equals(username) && "123456".equals(password)) {
session.setAttribute("username", username);
return "redirect:/user/home";
} else {
return "redirect:/user/goLogin";
}
}
@GetMapping("/logout")
public String logout(HttpSession session) {
session.removeAttribute("username");
return "redirect:/index.jsp";
}
}
- 在config包下新增拦截器
LoginInterceptor.java
package com.springmvc.config;
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;
}
//登录成功,进入首页,放行
if (session.getAttribute("username")!= null) {
return true;
}
//第一次进入首页,上面的都不满足,转到登录页面
request.getRequestDispatcher("/user/goLogin").forward(request, response);
return false;
}
}
- 在
springmvc-servlet.xml
中配置再配置一个拦截器
<mvc:interceptor>
<!--拦截/user/下的所有请求-->
<mvc:mapping path="/user/**"/>
<bean class="com.springmvc.config.LoginInterceptor"/>
</mvc:interceptor>
-
测试:访问:http://localhost:8080/springmvc_07_interceptor/
-
显示:
-
点击首页链接,(这里是第一次点击首页),没有登录,不能访问,被拦截,跳转到登录页面:
-
输入用户名:admin,密码:123456,点击登录按钮,登录成功,显示:
-
点击返回index链接,显示:
,再点击首页链接,(这里是登录之后再点击首页),可以访问,直接跳转到首页: -
点击注销链接,返回到:
,再点击首页链接,(这里是登录后注销了再点击首页),不能访问,跳转到登录页面:
OK,拦截功能实现了,只有当用户登录后才能够访问首页!