springboot中通過(guò)jwt令牌校驗(yàn)及前端token請(qǐng)求頭進(jìn)行登錄攔截實(shí)戰(zhàn)記錄
前言
大家從b站大學(xué)學(xué)習(xí)的項(xiàng)目側(cè)重點(diǎn)好像都在基礎(chǔ)功能的實(shí)現(xiàn)上,反而一個(gè)項(xiàng)目最根本的登錄攔截請(qǐng)求接口都不會(huì)寫,怎么攔截?為什么攔截?只知道用戶登錄時(shí)我后端會(huì)返回一個(gè)token,這個(gè)token是怎么生成的,我把它返回給前端干什么用?前端怎么去處理這個(gè)token?這個(gè)是我在學(xué)習(xí)過(guò)程中一知半解的,等開(kāi)始做自己的項(xiàng)目時(shí)才知道原來(lái)還有這么多不會(huì),本文就來(lái)講解一下怎么去實(shí)現(xiàn)登錄攔截請(qǐng)求校驗(yàn)的方法。
一、導(dǎo)入數(shù)據(jù)庫(kù)表依賴
這里有一張常用的用戶表作為本文的實(shí)戰(zhàn)測(cè)試
CREATE TABLE `user` ( `id` int(11) NOT NULL AUTO_INCREMENT, `username` varchar(50) NOT NULL COMMENT '用戶名', `password` varchar(255) NOT NULL COMMENT '密碼', `email` varchar(100) DEFAULT NULL COMMENT '郵箱', `create_time` datetime DEFAULT NULL COMMENT '創(chuàng)建時(shí)間', `login_time` datetime DEFAULT NULL COMMENT '最后一次登錄時(shí)間', `avatar` varchar(255) DEFAULT NULL COMMENT '頭像', PRIMARY KEY (`id`), UNIQUE KEY `username` (`username`) USING BTREE, UNIQUE KEY `email` (`email`) USING BTREE ) ENGINE=InnoDB AUTO_INCREMENT=33 DEFAULT CHARSET=utf8mb4 COMMENT='用戶表';
運(yùn)行然后連接。
二、登陸接口實(shí)現(xiàn)
@Api(tags = "用戶相關(guān)接口") @RestController @RequestMapping("/user") public class UserController { @Autowired private UserService userService; @Autowired private JwtProperties jwtProperties; @ApiOperation("用戶登錄") @PostMapping("/login") public Result login(@RequestBody User user) { user = userService.login(user); //登錄成功后,生成jwt令牌 Map<String, Object> claims = new HashMap<>(); claims.put("userId", user.getId()); String token = JwtUtil.createJWT( jwtProperties.getUserSecretKey(), jwtProperties.getUserTtl(), claims); UserLoginVo userLoginVo = UserLoginVo.builder() .user(user) .token(token) .build(); return Result.okResult(userLoginVo); } @ApiOperation("注冊(cè)用戶") @PostMapping public Result addUser(@RequestBody UserDto userDto) { userService.addUser(userDto); return Result.okResult(); } @ApiOperation("更新用戶信息") @PostMapping("/update") public Result uploadAvatar(User user) { userService.uploadAvatar(user); return Result.okResult(); } @GetMapping("/test") public Result test() { return Result.okResult("test"); } }
寫了幾個(gè)常用的用戶層接口用來(lái)測(cè)試,主要關(guān)注用戶登錄/login接口,其他的暫時(shí)無(wú)需理會(huì)。
配置JwtProperties 類
@Component @ConfigurationProperties(prefix = "zwk.jwt") @Data public class JwtProperties { /** * 用戶生成jwt令牌相關(guān)配置 */ private String userSecretKey; private long userTtl; private String userTokenName; }
JwtProperties 對(duì)應(yīng)的配置文件
zwk: jwt: # 設(shè)置jwt簽名加密時(shí)使用的秘鑰 user-secret-key: zwkzwk # 設(shè)置jwt過(guò)期時(shí)間 user-ttl: 7200000 # 設(shè)置前端傳遞過(guò)來(lái)的令牌名稱 user-token-name: token
配置UserService 類
public interface UserService { void addUser(UserDto userDto); User login(User user); void uploadAvatar(User user); }
UserService 的實(shí)現(xiàn)類
@Service public class UserServiceImpl implements UserService { @Autowired private UserMapper userMapper; /** * 新增用戶 * @param userDto */ public void addUser(UserDto userDto) { User user = new User(); BeanUtils.copyProperties(userDto, user); //user.setEmail("123@qq.com"); user.setCreateTime(new Date()); user.setLoginTime(new Date()); userMapper.insert(user); } public User login(User user) { String password = user.getPassword(); final User user1 = userMapper.getUserByName(user.getUsername()); if (user1 == null) { throw new RuntimeException("該用戶名不存在"); } //對(duì)密碼進(jìn)行md5加密 //password = DigestUtils.md5DigestAsHex(password.getBytes()); if (!password.equals(user1.getPassword())){ throw new RuntimeException("密碼錯(cuò)誤"); } return user1; } /** * 更新用戶信息 * @param user * @return */ @Override public void uploadAvatar(User user) { userMapper.updateById(user); } }
這里主要是對(duì)用戶登錄時(shí)傳過(guò)來(lái)的用戶名和密碼進(jìn)行校驗(yàn),校驗(yàn)通過(guò)后我們?cè)僦匦禄氐娇刂茖涌纯词窃趺刺幚淼摹?/p>
@ApiOperation("用戶登錄") @PostMapping("/login") public Result login(@RequestBody User user) { user = userService.login(user); //登錄成功后,生成jwt令牌 Map<String, Object> claims = new HashMap<>(); claims.put("userId", user.getId()); String token = JwtUtil.createJWT( jwtProperties.getUserSecretKey(), jwtProperties.getUserTtl(), claims); UserLoginVo userLoginVo = UserLoginVo.builder() .user(user) .token(token) .build(); return Result.okResult(userLoginVo); }
- 如果登錄成功,代碼將生成一個(gè) JWT(JSON Web Token)令牌。JWT 是一種緊湊的、自包含的方式,用于在客戶端和服務(wù)器之間傳遞安全信息。在這個(gè)例子中,JWT 令牌包含了用戶的 ID 信息。
- claims 是一個(gè) Map,用于存儲(chǔ) JWT 中的聲明(Claims),這里存儲(chǔ)了用戶 ID。
- JwtUtil.createJWT 方法用于創(chuàng)建 JWT 令牌,它接收三個(gè)參數(shù):用戶的密鑰(jwtProperties.getUserSecretKey())、令牌的有效時(shí)間(jwtProperties.getUserTtl())和聲明信息(claims)。
導(dǎo)入U(xiǎn)ser類
@Data @AllArgsConstructor @NoArgsConstructor public class User implements Serializable { private static final long serialVersionUID = 1L; /** * 主鍵 */ @TableId private Long id; /** * 用戶名 */ private String username; private String password; private String email; @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8") private Date createTime; @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8") private Date LoginTime; /** * 頭像 */ private String avatar; }
導(dǎo)入U(xiǎn)serLoginVo類
@Data @NoArgsConstructor @AllArgsConstructor @Builder public class UserLoginVo { private String token; private User user; }
編寫JwtUtil工具類,該類用來(lái)生成jwt令牌
public class JwtUtil { /** * 生成jwt * 使用Hs256算法, 私匙使用固定秘鑰 * * @param secretKey jwt秘鑰 * @param ttlMillis jwt過(guò)期時(shí)間(毫秒) * @param claims 設(shè)置的信息 * @return */ public static String createJWT(String secretKey, long ttlMillis, Map<String, Object> claims) { // 指定簽名的時(shí)候使用的簽名算法,也就是header那部分 SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256; // 生成JWT的時(shí)間 long expMillis = System.currentTimeMillis() + ttlMillis; Date exp = new Date(expMillis); // 設(shè)置jwt的body JwtBuilder builder = Jwts.builder() // 如果有私有聲明,一定要先設(shè)置這個(gè)自己創(chuàng)建的私有的聲明,這個(gè)是給builder的claim賦值,一旦寫在標(biāo)準(zhǔn)的聲明賦值之后,就是覆蓋了那些標(biāo)準(zhǔn)的聲明的 .setClaims(claims) // 設(shè)置簽名使用的簽名算法和簽名使用的秘鑰 .signWith(signatureAlgorithm, secretKey.getBytes(StandardCharsets.UTF_8)) // 設(shè)置過(guò)期時(shí)間 .setExpiration(exp); return builder.compact(); } /** * Token解密 * * @param secretKey jwt秘鑰 此秘鑰一定要保留好在服務(wù)端, 不能暴露出去, 否則sign就可以被偽造, 如果對(duì)接多個(gè)客戶端建議改造成多個(gè) * @param token 加密后的token * @return */ public static Claims parseJWT(String secretKey, String token) { // 得到DefaultJwtParser Claims claims = Jwts.parser() // 設(shè)置簽名的秘鑰 .setSigningKey(secretKey.getBytes(StandardCharsets.UTF_8)) // 設(shè)置需要解析的jwt .parseClaimsJws(token).getBody(); return claims; } }
以上就是我們前期準(zhǔn)備工作,然后發(fā)現(xiàn)好像還是沒(méi)用,因?yàn)槲覀冞€沒(méi)有做自定義攔截處理。我們首先對(duì)除了/user/login接口進(jìn)行放行,其他接口全部攔截。
編寫JwtTokenAdminInterceptor 類重寫HandlerInterceptor方法
@Component @Slf4j public class JwtTokenAdminInterceptor implements HandlerInterceptor { @Autowired private JwtProperties jwtProperties; /** * 校驗(yàn)jwt * * @param request * @param response * @param handler * @return * @throws Exception */ public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { //判斷當(dāng)前攔截到的是Controller的方法還是其他資源 if (!(handler instanceof HandlerMethod)) { //當(dāng)前攔截到的不是動(dòng)態(tài)方法,直接放行 return true; } //1、從請(qǐng)求頭中獲取令牌 String token = request.getHeader(jwtProperties.getUserTokenName()); //2、校驗(yàn)令牌 try { log.info("jwt校驗(yàn):{}", token); Claims claims = JwtUtil.parseJWT(jwtProperties.getUserSecretKey(), token); Long userId = Long.valueOf(claims.get("userId").toString()); log.info("當(dāng)前用戶id:{}", userId); //3、通過(guò),放行 return true; } catch (Exception ex) { //4、不通過(guò),響應(yīng)401狀態(tài)碼 response.setStatus(401); return false; } } }
自定義攔截器WebMvcConfiguration
@Configuration @Slf4j public class WebMvcConfiguration extends WebMvcConfigurationSupport { @Autowired private JwtTokenAdminInterceptor jwtTokenAdminInterceptor; /** * 注冊(cè)自定義攔截器 * @param registry */ protected void addInterceptors(InterceptorRegistry registry) { log.info("開(kāi)始注冊(cè)自定義攔截器..."); registry.addInterceptor(jwtTokenAdminInterceptor) .addPathPatterns("/user/**") //表示攔截所以前綴帶/user的請(qǐng)求 .excludePathPatterns("/user/login"); //排除特定路徑:excludePathPatterns("/user/login") 方法用于排除某些路徑, //即使它們匹配前面指定的模式。在這個(gè)例子中,/user/login 路徑不會(huì)被 jwtTokenAdminInterceptor 攔截。 } /** * 設(shè)置靜態(tài)資源映射 * @param registry */ protected void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/"); registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/"); } }
三、然后對(duì)接口進(jìn)行登錄測(cè)試
登錄測(cè)試
{ "code": 200, "msg": "操作成功", "data": { "token": "eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MjA2MDI3NzIsInVzZXJJZCI6MX0.Cf1ew-rPOkRYup5tird7nVD9xiHblNhYHwtdFHGQqV0", "user": { "id": 1, "username": "kkk", "password": "kkk123", "email": "2765314967@qq.com", "createTime": "2024-07-10 10:44:36", "LoginTime": "2024-07-10 10:44:42", "avatar": null, "loginTime": "2024-07-10 10:44:42" } } }
可以看見(jiàn),登錄成功后我們成功向前端返回token令牌。
那么前端拿到了這個(gè)token令牌有什么用呢?
- 第一次登錄的時(shí)候,前端調(diào)用后端的登錄接口,發(fā)送用戶名和密碼
- 后端收到請(qǐng)求,驗(yàn)證用戶名和密碼,驗(yàn)證成功,就給前端返回一個(gè)token
- 前端拿到token,將token存儲(chǔ)到localStorage和vuex中,并跳轉(zhuǎn)路由頁(yè)面
- 前端每次跳轉(zhuǎn)路由,就判斷l(xiāng)ocalStorage中有無(wú)token,沒(méi)有就跳轉(zhuǎn)到登錄頁(yè)面,有則跳轉(zhuǎn)到對(duì)應(yīng)的路由頁(yè)面
- 每次調(diào)后端接口,都要在請(qǐng)求頭中加token
- 后端判斷請(qǐng)求頭中有無(wú)token,有token,就拿到token并驗(yàn)證token,驗(yàn)證成功就返回?cái)?shù)據(jù),驗(yàn)證失?。ɡ纾簍oken過(guò)期)就返回403,請(qǐng)求頭中沒(méi)有token也返回403
- 如果前端拿到狀態(tài)碼為403,就清除token信息并跳轉(zhuǎn)到登錄頁(yè)面
這個(gè)時(shí)候我們?cè)賮?lái)測(cè)試其他接口,應(yīng)為我們剛剛只放行了/user/login接口,其他接口是一律攔截的,我們看看直接請(qǐng)求會(huì)發(fā)生什么。
可以發(fā)現(xiàn),當(dāng)我們請(qǐng)求這個(gè)測(cè)試接口時(shí),返回狀態(tài)碼401,和我們預(yù)想的一樣,如圖,就是我們剛剛寫的JwtTokenAdminInterceptor類
然后發(fā)現(xiàn)控制臺(tái)的jwt為空,這就應(yīng)對(duì)了我們前面所說(shuō)的,當(dāng)我們將token返回給前端之后,前端之后的每次請(qǐng)求都會(huì)把token攜帶到到請(qǐng)求頭header里面?zhèn)鹘o后端,我們后端就可以通過(guò)HttpServletRequest獲取請(qǐng)求頭token,如圖:
然后根據(jù)我們后端自定義的攔截器看看是否需要對(duì)這個(gè)請(qǐng)求頭進(jìn)行判斷,如果不需要判斷,直接放放行,否則進(jìn)行jwt校驗(yàn)。
那我們?cè)俅位氐絼倓?user/test接口,我們剛剛也是由前端對(duì)該接口進(jìn)行請(qǐng)求,但這個(gè)時(shí)候前端請(qǐng)求頭里面的token為空,我們后端又對(duì)這個(gè)接口進(jìn)行了攔截,所以校驗(yàn)自然失敗,無(wú)法訪問(wèn),這個(gè)時(shí)候我們?cè)侔训卿洉r(shí)生成的token放在前端傳給侯丹的請(qǐng)求頭里,看看會(huì)發(fā)生什么.
可以看到,這個(gè)時(shí)候就能成功請(qǐng)求。再看看控制臺(tái)
可以發(fā)現(xiàn),后端拿到前端傳過(guò)來(lái)的token后校驗(yàn)通過(guò),并且還可以通過(guò)token獲取用戶id,我們?cè)倩剡^(guò)頭看看最開(kāi)始的問(wèn)題,這個(gè)token有什么用,這個(gè)通過(guò)token獲取用戶id就是最明顯的體現(xiàn)之一。
我們只需要通過(guò)
Claims claims = JwtUtil.parseJWT(jwtProperties.getUserSecretKey(), token); Long userId = Long.valueOf(claims.get("userId").toString());
我講的也不是很清楚,建議大家細(xì)看JwtTokenAdminInterceptor和 WebMvcConfiguration這兩個(gè)類,方可大成。
總結(jié)
到此這篇關(guān)于springboot中通過(guò)jwt令牌校驗(yàn)及前端token請(qǐng)求頭進(jìn)行登錄攔截實(shí)戰(zhàn)的文章就介紹到這了,更多相關(guān)springboot登錄攔截內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- SpringBoot集成?JWT實(shí)現(xiàn)用戶登錄認(rèn)證的項(xiàng)目實(shí)踐
- SpringBoot結(jié)合JWT實(shí)現(xiàn)用戶登錄、注冊(cè)、鑒權(quán)
- springBoot整合jwt實(shí)現(xiàn)token令牌認(rèn)證的示例代碼
- SpringBoot整合JWT(JSON?Web?Token)生成token與驗(yàn)證的流程及示例
- SpringSecurity角色權(quán)限控制(SpringBoot+SpringSecurity+JWT)
- Springboot+jwt實(shí)現(xiàn)在線用戶功能(示例代碼)
相關(guān)文章
Springboot與Maven多環(huán)境配置的解決方案
多環(huán)境配置的解決方案有很多,我看到不少項(xiàng)目的多環(huán)境配置都是使用Maven來(lái)實(shí)現(xiàn)的,本文就實(shí)現(xiàn)Springboot與Maven多環(huán)境配置,感興趣的可以了解下2021-06-06springboot創(chuàng)建監(jiān)聽(tīng)和處理事件的操作方法
這篇文章主要介紹了springboot創(chuàng)建監(jiān)聽(tīng)和處理事件的操作方法,使用Spring Boot的事件機(jī)制來(lái)監(jiān)聽(tīng)和處理事件有多種優(yōu)勢(shì),本文給大家介紹的非常詳細(xì),需要的朋友參考下吧2024-07-07關(guān)于JSqlparser使用攻略(高效的SQL解析工具)
這篇文章主要介紹了關(guān)于JSqlparser使用攻略(高效的SQL解析工具),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-11-11java圖片滑動(dòng)驗(yàn)證(登錄驗(yàn)證)原理與實(shí)現(xiàn)方法詳解
這篇文章主要介紹了java圖片滑動(dòng)驗(yàn)證(登錄驗(yàn)證)原理與實(shí)現(xiàn)方法,結(jié)合實(shí)例形式詳細(xì)分析了java圖片滑動(dòng)登錄驗(yàn)證的相關(guān)原理、實(shí)現(xiàn)方法與操作技巧,需要的朋友可以參考下2019-09-09IDEA新建bootstrap.yml文件不顯示葉子圖標(biāo)的問(wèn)題
這篇文章主要介紹了IDEA新建bootstrap.yml文件不顯示葉子圖標(biāo)的問(wèn)題及解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-07-07java實(shí)時(shí)監(jiān)控文件行尾內(nèi)容的實(shí)現(xiàn)
這篇文章主要介紹了java實(shí)時(shí)監(jiān)控文件行尾內(nèi)容的實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-02-02詳解為什么阿里巴巴禁止使用BigDecimal的equals方法做等值比較
這篇文章主要介紹了詳解為什么阿里巴巴禁止使用BigDecimal的equals方法做等值比較,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09java線程池參數(shù)位置導(dǎo)致的奪命故障宿主機(jī)打不開(kāi)
這篇文章主要為大家介紹了java線程池參數(shù)位置導(dǎo)致的奪命故障宿主機(jī)打不開(kāi)的問(wèn)題解決,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-06-06Java中valueOf和parseInt的區(qū)別詳解
這篇文章主要介紹了Java中valueOf和parseInt的區(qū)別詳解,在編程中,遇到類型轉(zhuǎn)換,好像會(huì)經(jīng)常用到 parseInt 和 valueOf,當(dāng)然這里只拿 Integer 類型進(jìn)行陳述,其他類型也是雷同的,需要的朋友可以參考下2024-01-01