SpringBoot通過ThreadLocal實現(xiàn)登錄攔截詳解流程
1 前言
注冊登錄可以說是平時開發(fā)中最常見的東西了,但是一般進入到公司之后,像這樣的功能早就開發(fā)完了,除非是新的項目。這兩天就碰巧遇到了這樣一個需求,完成pc端的注冊登錄功能。
實現(xiàn)這樣的需求有很多種方式:像
1)HandlerInterceptor+WebMvcConfigurer+ThreadLocal
2)Filter過濾器
3)安全框架Shiro(輕量級框架)
4)安全框架Spring Securety(重量級框架)
而我采用的是第一種 Spring HandlerInterceptor+WebMvcConfigurer+ThreadLocal技術來實現(xiàn)。
2 具體類
2.1HandlerInterceptor
HandlerInterceptor是springMVC中為攔截器提供的接口,類似于Servlet開發(fā)中的過濾器Filter,用于處理器進行預處理和后處理,需要重寫三個方法。
preHandle:
調用時間:controller方法處理之前
執(zhí)行順序: 鏈式Intercepter情況下,Intercepter按照聲明順序一個接一個執(zhí)行
若返回false,則中斷執(zhí)行,注意:不會進入afterCompletion
postHandle:
調用前提:preHandle返回true
調用時間:Controller方法處理完之后,DispatcherServlet進行視圖渲染之前,也就是說在這個方法中可以對ModelAndView進行操作
執(zhí)行順序:鏈式Interceptor情況下,Intercepter按照聲明順序執(zhí)行
備注:postHandle雖然是post開頭,但是post請求,get請求都能處理
afterCompletion:
調用前提:preHandle返回true
調用時間:DispatcherServlet進行視圖的渲染之后
多用于清理資源
2.2WebMvcConfigurer
WebMvcConfigurer配置類其實是Spring
內部的一種配置方式,采用JavaBean
的形式來代替?zhèn)鹘y(tǒng)的xml
配置文件形式進行針對框架個性化定制,可以自定義一些Handler,Interceptor,ViewResolver,MessageConverter。基于java-based方式的spring mvc配置,需要創(chuàng)建一個配置類并實現(xiàn)WebMvcConfigurer
接口;
在Spring Boot 1.5版本都是靠重寫WebMvcConfigurerAdapter的方法來添加自定義攔截器,消息轉換器等。SpringBoot 2.0 后,該類被標記為@Deprecated(棄用)。官方推薦直接實現(xiàn)WebMvcConfigurer或者直接繼承WebMvcConfigurationSupport,方式一實現(xiàn)WebMvcConfigurer接口(推薦),方式二繼承WebMvcConfigurationSupport類
3 代碼實踐
1)編寫攔截器HeadTokenInterceptor使其繼承HandlerInterceptor
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 @Slf4j public 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
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 */ @Configuration public 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); } /** * 添加靜態(tài)資源 * @param registry */ @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("xxx.html") .addResourceLocations("classpath:/META-INF/resources"); super.addResourceHandlers(registry); } }
3)編寫ThreadLocal類存放用戶信息
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
@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實現(xiàn)登錄攔截詳解流程的文章就介紹到這了,更多相關SpringBoot登錄攔截內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
- springboot在filter中如何用threadlocal存放用戶身份信息
- SpringBoot中的ThreadLocal保存請求用戶信息的實例demo
- springboot登錄攔截器+ThreadLocal實現(xiàn)用戶信息存儲的實例代碼
- SpringBoot ThreadLocal 簡單介紹及使用詳解
- SpringBoot+ThreadLocal+AbstractRoutingDataSource實現(xiàn)動態(tài)切換數(shù)據(jù)源
- Springboot公共字段填充及ThreadLocal模塊改進方案
- SpringBoot ThreadLocal實現(xiàn)公共字段自動填充案例講解
- springboot 使用ThreadLocal的實例代碼
- SpringBoot中使用?ThreadLocal?進行多線程上下文管理及注意事項小結
相關文章
MyBatis學習教程(三)-MyBatis配置優(yōu)化
這篇文章主要介紹了MyBatis學習教程(三)-MyBatis配置優(yōu)化的相關資料,非常不錯,具有參考借鑒價值,需要的朋友可以參考下2016-05-05Nacos通過RefreshScope實現(xiàn)配置自動更新的方式分享
這篇文章主要給大家介紹了Nacos如何通過RefreshScope實現(xiàn)配置自動更新,文中給了兩種實現(xiàn)方式供大家參考,對大家的學習或工作有一定的幫助,需要的朋友可以參考下2023-09-09Spring Boot 中嵌入式 Servlet 容器自動配置原理解析
這篇文章主要介紹了Spring Boot 中嵌入式 Servlet 容器自動配置原理解析,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-11-11Spring Security自定義異常 AccessDeniedHandler不生效解決方法
本文主要介紹了Spring Security自定義異常 AccessDeniedHandler不生效解決方法,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2023-07-07Java將文件分割為多個子文件再將子文件合并成原始文件的示例
本篇文章主要介紹了Java將文件分割為多個子文件再將子文件合并成原始文件的示例,具有一定的參考價值,有興趣的可以了解一下。2017-02-02Java使用httpRequest+Jsoup爬取紅藍球號碼
本文將結合實例代碼,介紹Java使用httpRequest+Jsoup爬取紅藍球號碼,需要的朋友們下面隨著小編來一起學習學習吧2021-07-07