1 前言
注册登录可以说是平时开发中最常见的东西了，但是一般进入到公司之后，像这样的功能早就开发完了，除非是新的项目。这两天就碰巧遇到了这样一个需求，完成pc端的注册登录功能。
实现这样的需求有很多种方式：像
1）HandlerInterceptor+WebMvcConfigurer+ThreadLocal
2）Filter过滤器
3）安全框架Shiro（轻量级框架）
4）安全框架Spring Securety（重量级框架）
而我采用的是第一种 Spring HandlerInterceptor+WebMvcConfigurer+ThreadLocal技术来实现。
2 具体类
2.1HandlerInterceptor
HandlerInterceptor是springMVC中为拦截器提供的接口，类似于Servlet开发中的过滤器Filter，用于处理器进行预处理和后处理，需要重写三个方法。
preHandle：
调用时间：controller方法处理之前
执行顺序: 链式Intercepter情况下，Intercepter按照声明顺序一个接一个执行
若返回false，则中断执行，注意：不会进入afterCompletion
postHandle：
调用前提：preHandle返回true
调用时间：Controller方法处理完之后，DispatcherServlet进行视图渲染之前，也就是说在这个方法中可以对ModelAndView进行操作
执行顺序：链式Interceptor情况下，Intercepter按照声明顺序执行
备注：postHandle虽然是post开头，但是post请求，get请求都能处理
afterCompletion：
调用前提：preHandle返回true
调用时间：DispatcherServlet进行视图的渲染之后
多用于清理资源
2.2WebMvcConfigurer
WebMvcConfigurer配置类其实是Spring内部的一种配置方式，采用JavaBean的形式来代替传统的xml配置文件形式进行针对框架个性化定制，可以自定义一些Handler，Interceptor，ViewResolver，MessageConverter。基于java-based方式的spring mvc配置，需要创建一个配置类并实现WebMvcConfigurer接口；
在Spring Boot 1.5版本都是靠重写WebMvcConfigurerAdapter的方法来添加自定义拦截器，消息转换器等。SpringBoot 2.0 后，该类被标记为@Deprecated（弃用）。官方推荐直接实现WebMvcConfigurer或者直接继承WebMvcConfigurationSupport，方式一实现WebMvcConfigurer接口（推荐），方式二继承WebMvcConfigurationSupport类
3 代码实践
1）编写拦截器HeadTokenInterceptor使其继承HandlerInterceptor
|
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
48
49
|
package com.liubujun.config;import com.liubujun.moudle.UserToken;import com.liubujun.util.SecurityContextUtil;import lombok.extern.slf4j.Slf4j;import org.springframework.http.HttpStatus;import org.springframework.stereotype.Component;import org.springframework.util.StringUtils;import org.springframework.web.servlet.HandlerInterceptor;import org.springframework.web.servlet.ModelAndView;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import javax.xml.ws.handler.Handler;import java.io.IOException;/** * @Author: liubujun * @Date: 2022/5/21 16:12 */@Component@Slf4jpublic class HeadTokenInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { String authorization = request.getHeader("Authorization"); if (authorization == null ) { unauthorized(response); return false; } //这里一般都会解析出userToken的值，这里为了方便就直接new了 UserToken userToken = new UserToken(); SecurityContextUtil.addUser(userToken); return false; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { SecurityContextUtil.removeUser(); } private void unauthorized(HttpServletResponse response) { response.setStatus(HttpStatus.UNAUTHORIZED.value()); try { response.getWriter().append(HttpStatus.UNAUTHORIZED.getReasonPhrase()); } catch (IOException e) { log.error("HttpServletResponse writer error.msg",HttpStatus.UNAUTHORIZED.getReasonPhrase()); log.error(e.getMessage(),e); } }} |
2）编写MyWebMvcConfigurer使其继承WebMvcConfigurationSupport
|
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
|
package com.liubujun.config;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.config.annotation.InterceptorRegistry;import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;import java.util.ArrayList;/** * @Author: liubujun * @Date: 2022/5/21 16:40 */@Configurationpublic class MyWebMvcConfigurer extends WebMvcConfigurationSupport { @Autowired private HeadTokenInterceptor headTokenInterceptor; /** * 类似于白名单，在这边添加的请求不会走拦截器 * @param registry */ @Override public void addInterceptors(InterceptorRegistry registry) { ArrayList<String> pattres = new ArrayList<>(); pattres.add("/login/login"); registry.addInterceptor(headTokenInterceptor).excludePathPatterns(pattres).addPathPatterns("/**"); super.addInterceptors(registry); } /** * 添加静态资源 * @param registry */ @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("xxx.html") .addResourceLocations("classpath:/META-INF/resources"); super.addResourceHandlers(registry); }} |
3）编写ThreadLocal类存放用户信息
|
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
|
package com.liubujun.util;import com.liubujun.moudle.UserToken;import org.springframework.core.NamedThreadLocal;/** * @Author: liubujun * @Date: 2022/5/23 9:41 */public class SecurityContextUtil { private static ThreadLocal<UserToken> threadLocal = new NamedThreadLocal<>("user"); public static void addUser(UserToken user){ threadLocal.set(user); } public static UserToken getUser(){ return threadLocal.get(); } public static void removeUser(){ threadLocal.remove(); } public static String getPhoneNumber(){ return threadLocal.get().getPhoneNumber(); } public static Integer getId(){ return threadLocal.get().getId(); } public static String getUserText(){ return threadLocal.get().getUserText(); }} |
4）编写测试controller
|
1
2
3
4
5
6
7
8
9
10
11
12
|
@RestController@RequestMapping(value = "/login",produces = {"application/json;charset=UTF-8"})public class Login { @PostMapping("/login") public String login(){ return "登录请求不需要拦截"; } @PostMapping("/other") public String other(){ return "其他的请求需要拦截"; }} |
5）测试
测试login接口，（不传token直接放行）
测试其他接口，不传token被拦截到
到此这篇关于SpringBoot通过ThreadLocal实现登录拦截详解流程的文章就介绍到这了,更多相关SpringBoot登录拦截内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家！
原文链接：https://blog.csdn.net/qq_50652600/article/details/124872456
