SpringBoot拦截器实现登录验证：步骤与示例

本文将详细介绍如何在SpringBoot项目中利用拦截器实现登录拦截功能，并提供了一个具体的示例代码。通过这个示例，你可以学习到如何配置拦截器，以及如何进行权限验证，确保只有已登录的用户才能访问特定的URL路径。 在SpringBoot应用中，拦截器（Interceptor）是一种强大的工具，它可以用来执行一些预处理和后处理任务。例如，我们可以使用拦截器进行权限验证，解决请求乱码问题，记录操作日志，监控性能，以及处理异常情况。拦截器的使用极大地提高了代码的可维护性和灵活性。 首先，我们需要在`pom.xml`文件中添加相应的依赖，确保SpringBoot项目能够支持拦截器的实现。在这个例子中，项目的父POM是Spring Boot的`spring-boot-starter-parent`，版本号为`2.0.0.RELEASE`。项目本身定义了`groupId`、`artifactId`、`version`等基本信息，确保项目能正确构建。 接下来，我们需要创建一个自定义的拦截器类。这个类通常会实现Spring的`HandlerInterceptor`接口，包含`preHandle`、`postHandle`和`afterCompletion`这三个方法。`preHandle`方法会在控制器方法执行之前调用，可以用来进行登录验证；`postHandle`方法在控制器方法执行之后，但在视图渲染之前调用，一般用于处理业务逻辑后的清理工作；`afterCompletion`则在整个请求处理完成，包括视图渲染后调用，适合做资源释放等操作。 对于登录拦截，我们主要关注`preHandle`方法。在这个方法里，我们可以检查请求中的Session或Cookie，判断用户是否已经登录。如果用户未登录，我们可以返回`false`，Spring会自动跳转到登录页面；反之，如果用户已登录，返回`true`，请求会继续处理。 ```java import org.springframework.stereotype.Component; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @Component public class LoginInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 检查用户是否已登录，这里只是一个示例，实际项目中可能需要从Session或Cookie中获取用户信息 if (!isUserLoggedIn(request)) { // 用户未登录，重定向到登录页面 response.sendRedirect("/login"); return false; } return true; } // 其他如postHandle和afterCompletion方法可以根据需要实现 private boolean isUserLoggedIn(HttpServletRequest request) { // 这里仅作为示例，实际项目中应根据具体登录状态存储方式检查用户是否已登录 return (request.getSession().getAttribute("currentUser") != null); } } ``` 为了使拦截器生效，我们还需要在Spring的配置类中注册它。创建一个`WebMvcConfigurer`的实现类，并覆盖`addInterceptors`方法： ```java 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 { @Override public void addInterceptors(InterceptorRegistry registry) { // 注册登录拦截器 registry.addInterceptor(new LoginInterceptor()) // 添加需要拦截的URL路径，这里表示所有以'/admin'开头的URL都需要经过登录拦截 .addPathPatterns("/admin/") // 排除不需要拦截的URL，例如登录页面 .excludePathPatterns("/login"); } } ``` 在上述配置中，`addPathPatterns`指定了需要拦截的URL模式，`excludePathPatterns`则排除了特定的URL，使得它们不受拦截器影响。这样，只有访问以`/admin`开头的URL时，系统才会进行登录验证。 总结来说，SpringBoot拦截器是通过自定义拦截器类并将其注册到Spring的配置中来实现的。在拦截器中，我们可以在请求处理前进行预处理，比如登录验证，以达到保护特定资源的目的。通过这个示例，你应该对SpringBoot的拦截器有了更深入的理解，并能将其应用于实际项目中实现登录拦截功能。