介绍:
对于管理系统或其他需要用户登录的系统,登录验证都是必不可少的环节,在 SpringBoot 开发的项目中,通过实现拦截器来实现用户登录拦截并验证。
参考文档:springboot拦截器excludePathPatterns方法不生效的坑 springboot配置拦截器不拦截url_Qgchun.的博客-CSDN博客
1. 实现原理
SpringBoot 通过实现HandlerInterceptor
接口实现拦截器,通过实现WebMvcConfigurer
接口实现一个配置类,在配置类中注入拦截器,最后再通过 @Configuration 注解注入配置
2. LoginInterceptor接口的实现
package com.sxt.config;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class LoginInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//学生id
Integer userid = (Integer) request.getSession().getAttribute("lis");
//教师id
Integer teauserid = (Integer) request.getSession().getAttribute("Teauserid");
String uri = request.getRequestURI();
if (userid!=null){
if (!(uri.equals("/StudentList"))&&!(uri.equals("/DeleteStu"))&&
!(uri.equals("/deleteAll"))&&!(uri.equals("/finddanxuan"))&&
!(uri.equals("/addSingle"))&&!(uri.equals("/selectexam"))&&
!(uri.equals("/addexam"))&&!(uri.equals("/paperDetails"))&&
!(uri.equals("/deleteExam"))&&!(uri.equals("/findAllScore")))
return true;
}
if (teauserid!=null){
if (!(uri.equals("/examList"))&&!(uri.equals("/paper"))&&
!(uri.equals("/findAllStuPaper"))&&!(uri.equals("/StuMan"))) {
return true;
}
}
response.sendRedirect(request.getContextPath()+"/toStuLogin");
request.getSession().removeAttribute("lis");
request.getSession().removeAttribute("Teauserid");
return false;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
}
}
需要注意问题:
- 检查 session 中是否有
user
对象存在; - 如果存在,就返回
true
,那么 Controller 就会继续后面的操作; - 如果不存在,就会重定向到登录界面就是通过这个拦截器,使得 Controller 在执行之前,都执行一遍
preHandle
.
2.2 实现LoginConfig接口,注册拦截器
package com.sxt.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class LoginConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
//注册登陆拦截器
InterceptorRegistration interceptorRegistration = registry.addInterceptor(new LoginInterceptor());
//拦截所有路径
interceptorRegistration.addPathPatterns("/**");
//不用拦截的路径
interceptorRegistration.excludePathPatterns(
"/css/**",
"/fonts/**",
"/img/**",
"/js/**",
"/",
"/student/login.html",
"/teacher/login.html",
"student/register.html",
"/toTeacher",
"/toStuLogin",
"/stulogin",
"/tealogin",
"/register",
"/CanRegister");
}
}
将拦截器注册到了拦截器列表中,并且指明了拦截哪些访问路径,不拦截哪些访问路径,不拦截哪些资源文件;最后再以 @Configuration 注解将配置注入。
接下来将已写入的controller,service,Impl类和前端代码与拦截器连接
3. 登录状态
只需一次登录,如果登录过,下一次再访问的时候就无需再次进行登录拦截,可以直接访问网站里面的内容了。
在正确登录之后,就将
user
保存到session
中,再次访问页面的时候,登录拦截器就可以找到这个user
对象,就不需要再次拦截到登录界面了.
4. 相关问题总结
1.配置拦截器时,如果excludePathPatterns没有生效,可能是url配置有问题。
2.可以检查下application.yml的context-path,或者其它类似的地方,配置拦截器的url不应该包含这些路径,只要从Controller的路径开始配置即可。
3.使用response对象的sendRedirect()方法将用户的请求重定向到指定路径,这个路径由request对象的getContextPath()方法获取,再加上字符串 “/” 组成。getContextPath()方法返回当前web应用程序的上下文路径,此处加的字符串路径也是从Controller的路径开始配置即可