springboot实现拦截器之验证登录示例

在Spring Boot应用中，拦截器（Interceptor）是一种非常重要的组件，它可以用来处理HTTP请求之前或之后的逻辑，例如权限验证、日志记录等。本文将详细介绍如何在Spring Boot中实现一个登录验证拦截器。 我们需要创建一个自定义注解`@Auth`，用于标记需要进行登录验证的方法或类。在`@Auth`注解中，我们可以添加一些属性来定制验证行为，例如允许匿名访问的URL等。以下是一个简单的`@Auth`注解定义： ```java package com.demo.interceptor; import java.lang.annotation.*; @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Auth { } ``` 接下来，我们创建一个常量类`Constants`，用于存储在拦截器中会用到的键值，如session中的键： ```java package com.demo.util; public interface Constants { int MAX_FILE_UPLOAD_SIZE = 5242880; String MOBILE_NUMBER_SESSION_KEY = "sessionMobileNumber"; String USER_CODE_SESSION_KEY = "userCode"; String SESSION_KEY = "sessionId"; } ``` 为了存储用户的登录信息，我们还需要创建一个`SessionData`类，包含用户编码（userCode）和手机号码（mobileNumber）： ```java package com.demo.model; import lombok.Data; @Data public class SessionData { private Integer userCode; private String mobileNumber; } ``` 现在，我们可以创建拦截器类`LoginInterceptor`，它继承自`HandlerInterceptorAdapter`。在`preHandle`方法中，我们将检查请求是否带有登录信息，并根据`@Auth`注解的规则进行验证： ```java package com.demo.interceptor; import com.demo.model.SessionData; import com.demo.util.RedisUtil; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import org.springframework.web.method.HandlerMethod; import org.springframework.web.servlet.handler.HandlerInterceptorAdapter; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.lang.reflect.Method; import static com.demo.util.Constants.MOBILE_NUMBER_SESSION_KEY; import static com.demo.util.Constants.SESSION_KEY; import static com.demo.util.Constants.USER_CODE_SESSION_KEY; @Component public class LoginInterceptor extends HandlerInterceptorAdapter { @Autowired private RedisUtil redisUtil; @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { if (handler instanceof HandlerMethod) { HandlerMethod hm = (HandlerMethod) handler; Auth auth = hm.getMethodAnnotation(Auth.class); if (auth != null) { // 从session中获取登录信息 SessionData sessionData = (SessionData) request.getSession().getAttribute(SESSION_KEY); if (sessionData == null || (sessionData.getUserCode() == null && sessionData.getMobileNumber() == null)) { // 如果没有登录，返回错误信息并重定向到登录页面 response.sendRedirect("/login"); return false; } } } return true; } } ``` 在上面的代码中，我们首先检查当前请求的处理器方法是否被`@Auth`注解标记。如果是，我们从session中获取用户信息，如果没有或者信息不完整，则重定向到登录页面。 为了使拦截器生效，需要在Spring Boot的配置类中注册它。创建一个`WebConfig`类，实现`WebMvcConfigurer`接口，并在`addInterceptors`方法中添加我们的拦截器： ```java package com.demo.config; import com.demo.interceptor.LoginInterceptor; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class WebConfig implements WebMvcConfigurer { @Autowired private LoginInterceptor loginInterceptor; @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(loginInterceptor); } } ``` 至此，我们已经完成了Spring Boot登录拦截器的基本实现。当带有`@Auth`注解的方法被调用时，拦截器会检查用户是否已登录，未登录则重定向到登录页面。这个拦截器可以防止未授权的用户访问受保护的资源，为我们的应用提供了基本的安全保障。 需要注意的是，这只是一个基础的示例，实际项目中可能需要考虑更多因素，比如使用JWT（JSON Web Token）进行身份验证，或者结合Spring Security进行更复杂的权限管理。此外，如果需要持久化session数据，可以考虑使用Redis等缓存服务，而不是直接存储在session中。