SpringBoot通過(guò)ThreadLocal實(shí)現(xiàn)登錄攔截詳解流程
1 前言
注冊(cè)登錄可以說(shuō)是平時(shí)開(kāi)發(fā)中最常見(jiàn)的東西了,但是一般進(jìn)入到公司之后,像這樣的功能早就開(kāi)發(fā)完了,除非是新的項(xiàng)目。這兩天就碰巧遇到了這樣一個(gè)需求,完成pc端的注冊(cè)登錄功能。
實(shí)現(xiàn)這樣的需求有很多種方式:像
1)HandlerInterceptor+WebMvcConfigurer+ThreadLocal
2)Filter過(guò)濾器
3)安全框架Shiro(輕量級(jí)框架)
4)安全框架Spring Securety(重量級(jí)框架)
而我采用的是第一種 Spring HandlerInterceptor+WebMvcConfigurer+ThreadLocal技術(shù)來(lái)實(shí)現(xiàn)。
2 具體類(lèi)
2.1HandlerInterceptor
HandlerInterceptor是springMVC中為攔截器提供的接口,類(lèi)似于Servlet開(kāi)發(fā)中的過(guò)濾器Filter,用于處理器進(jìn)行預(yù)處理和后處理,需要重寫(xiě)三個(gè)方法。
preHandle:
調(diào)用時(shí)間:controller方法處理之前
執(zhí)行順序: 鏈?zhǔn)絀ntercepter情況下,Intercepter按照聲明順序一個(gè)接一個(gè)執(zhí)行
若返回false,則中斷執(zhí)行,注意:不會(huì)進(jìn)入afterCompletion
postHandle:
調(diào)用前提:preHandle返回true
調(diào)用時(shí)間:Controller方法處理完之后,DispatcherServlet進(jìn)行視圖渲染之前,也就是說(shuō)在這個(gè)方法中可以對(duì)ModelAndView進(jìn)行操作
執(zhí)行順序:鏈?zhǔn)絀nterceptor情況下,Intercepter按照聲明順序執(zhí)行
備注:postHandle雖然是post開(kāi)頭,但是post請(qǐng)求,get請(qǐng)求都能處理
afterCompletion:
調(diào)用前提:preHandle返回true
調(diào)用時(shí)間:DispatcherServlet進(jìn)行視圖的渲染之后
多用于清理資源
2.2WebMvcConfigurer
WebMvcConfigurer配置類(lèi)其實(shí)是Spring
內(nèi)部的一種配置方式,采用JavaBean
的形式來(lái)代替?zhèn)鹘y(tǒng)的xml
配置文件形式進(jìn)行針對(duì)框架個(gè)性化定制,可以自定義一些Handler,Interceptor,ViewResolver,MessageConverter?;趈ava-based方式的spring mvc配置,需要?jiǎng)?chuàng)建一個(gè)配置類(lèi)并實(shí)現(xiàn)WebMvcConfigurer
接口;
在Spring Boot 1.5版本都是靠重寫(xiě)WebMvcConfigurerAdapter的方法來(lái)添加自定義攔截器,消息轉(zhuǎn)換器等。SpringBoot 2.0 后,該類(lèi)被標(biāo)記為@Deprecated(棄用)。官方推薦直接實(shí)現(xiàn)WebMvcConfigurer或者直接繼承WebMvcConfigurationSupport,方式一實(shí)現(xiàn)WebMvcConfigurer接口(推薦),方式二繼承WebMvcConfigurationSupport類(lèi)
3 代碼實(shí)踐
1)編寫(xiě)攔截器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; } //這里一般都會(huì)解析出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)編寫(xiě)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; /** * 類(lèi)似于白名單,在這邊添加的請(qǐng)求不會(huì)走攔截器 * @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)編寫(xiě)ThreadLocal類(lèi)存放用戶(hù)信息
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)編寫(xiě)測(cè)試controller
@RestController @RequestMapping(value = "/login",produces = {"application/json;charset=UTF-8"}) public class Login { @PostMapping("/login") public String login(){ return "登錄請(qǐng)求不需要攔截"; } @PostMapping("/other") public String other(){ return "其他的請(qǐng)求需要攔截"; } }
5)測(cè)試
測(cè)試login接口,(不傳token直接放行)
測(cè)試其他接口,不傳token被攔截到
到此這篇關(guān)于SpringBoot通過(guò)ThreadLocal實(shí)現(xiàn)登錄攔截詳解流程的文章就介紹到這了,更多相關(guān)SpringBoot登錄攔截內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- springboot在filter中如何用threadlocal存放用戶(hù)身份信息
- SpringBoot中的ThreadLocal保存請(qǐng)求用戶(hù)信息的實(shí)例demo
- springboot登錄攔截器+ThreadLocal實(shí)現(xiàn)用戶(hù)信息存儲(chǔ)的實(shí)例代碼
- SpringBoot ThreadLocal 簡(jiǎn)單介紹及使用詳解
- SpringBoot+ThreadLocal+AbstractRoutingDataSource實(shí)現(xiàn)動(dòng)態(tài)切換數(shù)據(jù)源
- Springboot公共字段填充及ThreadLocal模塊改進(jìn)方案
- SpringBoot ThreadLocal實(shí)現(xiàn)公共字段自動(dòng)填充案例講解
- springboot 使用ThreadLocal的實(shí)例代碼
- SpringBoot中使用?ThreadLocal?進(jìn)行多線(xiàn)程上下文管理及注意事項(xiàng)小結(jié)
相關(guān)文章
MyBatis學(xué)習(xí)教程(三)-MyBatis配置優(yōu)化
這篇文章主要介紹了MyBatis學(xué)習(xí)教程(三)-MyBatis配置優(yōu)化的相關(guān)資料,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2016-05-05Nacos通過(guò)RefreshScope實(shí)現(xiàn)配置自動(dòng)更新的方式分享
這篇文章主要給大家介紹了Nacos如何通過(guò)RefreshScope實(shí)現(xiàn)配置自動(dòng)更新,文中給了兩種實(shí)現(xiàn)方式供大家參考,對(duì)大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下2023-09-09Spring Boot 中嵌入式 Servlet 容器自動(dòng)配置原理解析
這篇文章主要介紹了Spring Boot 中嵌入式 Servlet 容器自動(dòng)配置原理解析,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-11-11Spring Security自定義異常 AccessDeniedHandler不生效解決方法
本文主要介紹了Spring Security自定義異常 AccessDeniedHandler不生效解決方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-07-07Java將文件分割為多個(gè)子文件再將子文件合并成原始文件的示例
本篇文章主要介紹了Java將文件分割為多個(gè)子文件再將子文件合并成原始文件的示例,具有一定的參考價(jià)值,有興趣的可以了解一下。2017-02-02java數(shù)據(jù)結(jié)構(gòu)和算法學(xué)習(xí)之漢諾塔示例
這篇文章主要介紹了java數(shù)據(jù)結(jié)構(gòu)和算法中的漢諾塔示例,需要的朋友可以參考下2014-02-02j2Cache線(xiàn)上異常排查問(wèn)題解決記錄分析
這篇文章主要為大家介紹了關(guān)于j2Cache線(xiàn)上異常排查的問(wèn)題解決記錄分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步2022-02-02spring boot實(shí)戰(zhàn)之使用JSP的示例
本篇文章主要介紹了spring boot實(shí)戰(zhàn)之使用JSP的示例,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-10-10Java使用httpRequest+Jsoup爬取紅藍(lán)球號(hào)碼
本文將結(jié)合實(shí)例代碼,介紹Java使用httpRequest+Jsoup爬取紅藍(lán)球號(hào)碼,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-07-07