SpringBoot集成JWT令牌詳細(xì)說明
更新時間：2023年10月25日 10:01:24 作者：刻苦的樊同學(xué)
這篇文章主要介紹了SpringBoot集成JWT令牌詳細(xì)說明,JWT方式校驗方式更加簡單便捷化，無需通過redis緩存，而是直接根據(jù)token取出保存的用戶信息，以及對token可用性校驗，單點登錄，驗證token更為簡單,需要的朋友可以參考下
一，傳統(tǒng)Cookie+Session與JWT對比
1， 在傳統(tǒng)的用戶登錄認(rèn)證中，因為http是無狀態(tài)的，所以都是采用session方式。用戶登錄成功，服務(wù)端會保證一個session，當(dāng)然會給客戶端一個sessionId，客戶端會把sessionId保存在cookie中，每次請求都會攜帶這個sessionId。
2，cookie+session這種模式通常是保存在內(nèi)存中，而且服務(wù)從單服務(wù)到多服務(wù)會面臨的session共享問題，隨著用戶量的增多，開銷就會越大。而JWT不是這樣的，只需要服務(wù)端生成token，客戶端保存這個token，每次請求攜帶這個token，服務(wù)端認(rèn)證解析就可。
3， JWT方式校驗方式更加簡單便捷化，無需通過redis緩存，而是直接根據(jù)token取出保存的用戶信息，以及對token可用性校驗，單點登錄，驗證token更為簡單。
二，springboot集成jwt
1，jwt的整合依賴
<!-- JWT依賴 --> <dependency> <groupId>io.jsonwebtoken</groupId> <artifactId>jjwt</artifactId> <version>0.7.0</version> </dependency> <dependency> <groupId>com.auth0</groupId> <artifactId>java-jwt</artifactId> <version>3.4.0</version> </dependency>
2，jwt的自定義配置
server:
port: 8080
spring:
application:
name: springboot-jwt
# 自定義配置
config:
jwt:
# 加密密鑰
secret: abcdefg1234567
# token有效時長
expire: 3600
# header 名稱
header: token
3，編寫JwtConfig
JwtConfig負(fù)責(zé)
- 生成token
- 獲取token中的注冊信息
- 驗證token是否過期失效
- 獲取token失效時間
- 從token中獲取用戶名
- 獲取jwt發(fā)布時間
package com.ftx.jwt.config;
/**
* @author FanJiangFeng
* @version 1.0.0
* @ClassName JwtConfig.java
* @Description TODO
* @createTime 2020年06月22日 15:43:00
*/
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Date;
/**
* JWT的token，區(qū)分大小寫
*/
@ConfigurationProperties(prefix = "config.jwt", ignoreUnknownFields = true)
@Component
public class JwtConfig {
private String secret;
private long expire;
private String header;
/**
* 生成token
* @param subject
* @return
*/
public String createToken (String subject){
Date nowDate = new Date();
Date expireDate = new Date(nowDate.getTime() + expire * 1000);//過期時間
return Jwts.builder()
.setHeaderParam("typ", "JWT")
.setSubject(subject)
.setIssuedAt(nowDate)
.setExpiration(expireDate)
.signWith(SignatureAlgorithm.HS512, secret)
.compact();
}
/**
* 獲取token中注冊信息
* @param token
* @return
*/
public Claims getTokenClaim (String token) {
try {
return Jwts.parser().setSigningKey(secret).parseClaimsJws(token).getBody();
}catch (Exception e){
// e.printStackTrace();
return null;
}
}
/**
* 驗證token是否過期失效
* @param expirationTime
* @return
*/
public boolean isTokenExpired (Date expirationTime) {
return expirationTime.before(new Date());
}
/**
* 獲取token失效時間
* @param token
* @return
*/
public Date getExpirationDateFromToken(String token) {
return getTokenClaim(token).getExpiration();
}
/**
* 獲取用戶名從token中
*/
public String getUsernameFromToken(String token) {
return getTokenClaim(token).getSubject();
}
/**
* 獲取jwt發(fā)布時間
*/
public Date getIssuedAtDateFromToken(String token) {
return getTokenClaim(token).getIssuedAt();
}
// --------------------- getter & setter ---------------------
public String getSecret() {
return secret;
}
public void setSecret(String secret) {
this.secret = secret;
}
public long getExpire() {
return expire;
}
public void setExpire(long expire) {
this.expire = expire;
}
public String getHeader() {
return header;
}
public void setHeader(String header) {
this.header = header;
}
}
4，配置攔截器
在攔截器中對token進(jìn)行驗證。
package com.ftx.jwt.config;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.SignatureException;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* @author FanJiangFeng
* @version 1.0.0
* @ClassName TokenInterceptor.java
* @Description TODO
* @createTime 2020年06月22日 15:47:00
*/
@Component
public class TokenInterceptor extends HandlerInterceptorAdapter {
@Resource
private JwtConfig jwtConfig ;
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler) throws SignatureException {
/** 地址過濾 */
String uri = request.getRequestURI() ;
if (uri.contains("/login")){
return true ;
}
/** Token 驗證 */
String token = request.getHeader(jwtConfig.getHeader());
if(StringUtils.isEmpty(token)){
token = request.getParameter(jwtConfig.getHeader());
}
if(StringUtils.isEmpty(token)){
throw new SignatureException(jwtConfig.getHeader()+ "不能為空");
}
Claims claims = null;
try{
claims = jwtConfig.getTokenClaim(token);
if(claims == null || jwtConfig.isTokenExpired(claims.getExpiration())){
throw new SignatureException(jwtConfig.getHeader() + "失效，請重新登錄。");
}
}catch (Exception e){
throw new SignatureException(jwtConfig.getHeader() + "失效，請重新登錄。");
}
//該token可用，放行
return true;
}
}
注冊攔截器到SpringMvc
package com.ftx.jwt.config;
/**
* @author FanJiangFeng
* @version 1.0.0
* @ClassName WebConfig.java
* @Description TODO
* @createTime 2020年06月22日 15:53:00
*/
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.validation.MessageCodesResolver;
import org.springframework.validation.Validator;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.config.annotation.*;
import javax.annotation.Resource;
import java.util.List;
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Resource
private TokenInterceptor tokenInterceptor ;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(tokenInterceptor).addPathPatterns("/**");
}
}
5，編寫測試controller接口
package com.ftx.jwt.controller;
import com.alibaba.fastjson.JSONObject;
import com.ftx.jwt.config.JwtConfig;
import com.ftx.jwt.util.ResultTool;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
/**
* @author FanJiangFeng
* @version 1.0.0
* @ClassName TokenController.java
* @Description TODO
* @createTime 2020年06月22日 16:05:00
*/
@RestController
public class TokenController {
@Resource
private JwtConfig jwtConfig ;
/**
* 用戶登錄接口
* @param userName
* @param passWord
* @return
*/
@PostMapping("/login")
public JSONObject login (@RequestParam("userName") String userName,
@RequestParam("passWord") String passWord){
JSONObject json = new JSONObject();
/** 驗證userName，passWord和數(shù)據(jù)庫中是否一致，如不一致，直接return ResultTool.errer(); 【這里省略該步驟】*/
// 這里模擬通過用戶名和密碼，從數(shù)據(jù)庫查詢userId
// 這里把userId轉(zhuǎn)為String類型，實際開發(fā)中如果subject需要存userId，則可以JwtConfig的createToken方法的參數(shù)設(shè)置為Long類型
String userId = 5 + "";
String token = jwtConfig.createToken(userId) ;
if (!StringUtils.isEmpty(token)) {
json.put("token",token) ;
}
return ResultTool.success(json) ;
}
/**
* 需要 Token 驗證的接口
*/
@PostMapping("/info")
public JSONObject info (){
return ResultTool.success("info") ;
}
/**
* 根據(jù)請求頭的token獲取userId
* @param request
* @return
*/
@GetMapping("/getUserInfo")
public JSONObject getUserInfo(HttpServletRequest request){
String usernameFromToken = jwtConfig.getUsernameFromToken(request.getHeader("token"));
return ResultTool.success(usernameFromToken) ;
}
}
用PostMan測試工具測試一下，訪問登錄接口，當(dāng)對賬號密碼驗證通過時，則返回一個token給客戶端 說明：token是在請求頭處,request.getHeader()得到token。
當(dāng)直接去訪問info接口時，會返回token為空的異常 當(dāng)在請求頭加上正確token時，則攔截器驗證通過，可以正常訪問到接口
當(dāng)在請求頭加入一個錯誤token，則會返回token失效的異常 接下來測試一下獲取用戶信息，因為這里存的subject為userId，所以直接返回上面寫死的假數(shù)據(jù)5
三，知識點概述
1，@Resource注解
- @Autowired與@Resource都可以用來裝配bean. 都可以寫在字段上,或?qū)懺趕etter方法上。
- @Autowired默認(rèn)按類型裝配（這個注解是屬于spring的），默認(rèn)情況下必須要求依賴對象必須存在，如果要允許null值，可以設(shè)置它的required屬性為false，如：@Autowired(required=false) 3，@Resource（這個注解屬于J2EE的），默認(rèn)按照名稱進(jìn)行裝配，名稱可以通過name屬性進(jìn)行指定，如果沒有指定name屬性，當(dāng)注解寫在字段上時，默認(rèn)取字段名進(jìn)行安裝名稱查找，如果注解寫在setter方法上默認(rèn)取屬性名進(jìn)行裝配。當(dāng)找不到與名稱匹配的bean時才按照類型進(jìn)行裝配。但是需要注意的是，如果name屬性一旦指定，就只會按照名稱進(jìn)行裝配。
2，@ConfigurationProperties注解
@ConfigurationProperties：告訴SpringBoot將本類中的所有屬性和配置文件中相關(guān)的配置進(jìn)行綁定；prefix = "xxx"：配置文件中哪個下面的所有屬性進(jìn)行一一映射
到此這篇關(guān)于SpringBoot集成JWT令牌詳細(xì)說明的文章就介紹到這了,更多相關(guān)SpringBoot集成JWT令牌內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java 中Comparable和Comparator區(qū)別比較
本文，先介紹Comparable 和Comparator兩個接口，以及它們的差異；接著，通過示例，對它們的使用方法進(jìn)行說明2013-09-09
Java編寫簡易rabbitmq生產(chǎn)者與消費(fèi)者的代碼
開發(fā)時經(jīng)常與其它系統(tǒng)用rabbitmq對接,當(dāng)需要自測時,還是自己寫rabbitmq生產(chǎn)者、消費(fèi)者自測方便些,下面給大家總結(jié)使用java編寫簡易rabbitmq的方法,感興趣的朋友一起看看吧2023-11-11
初學(xué)者易上手的SSH-struts2 01環(huán)境搭建(圖文教程)
下面小編就為大家?guī)硪黄鯇W(xué)者易上手的SSH-struts2 01環(huán)境搭建(圖文教程)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-10-10
Java數(shù)據(jù)結(jié)構(gòu)之線段樹的原理與實現(xiàn)
線段樹是一種二叉搜索樹，是用來維護(hù)區(qū)間信息的數(shù)據(jù)結(jié)構(gòu)。本文將利用示例詳細(xì)講講Java數(shù)據(jù)結(jié)構(gòu)中線段樹的原理與實現(xiàn)，需要的可以參考一下2022-06-06
@RequestParam 主要用于將請求參數(shù)區(qū)域的數(shù)據(jù)映射到控制層方法的參數(shù)上,下面這篇文章主要給大家介紹了關(guān)于Spring中@RequestParam使用及遇到的一些坑,文中通過實例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-06-06
將SpringBoot屬性配置類@ConfigurationProperties注冊為Bean的操作方法
在現(xiàn)代 Spring Boot 應(yīng)用開發(fā)中,外部化配置（Externalized Configuration）是實現(xiàn)應(yīng)用靈活性和可維護(hù)性的核心機(jī)制之一,然而,許多開發(fā)者在使用的時候經(jīng)常會遇到如何確保該配置類被正確注冊為 Spring 容器中的 Bean,下面小編為大家詳細(xì)說說2025-12-12
跨域?qū)τ谡趯W(xué)習(xí)或者已經(jīng)就業(yè)的前端同學(xué)而言,就是老朋友,只要涉及請求,前后端交互,開發(fā)階段等關(guān)鍵字,都避不開跨域,這篇文章主要給大家介紹了關(guān)于前端和后端解決跨域問題的一些方式,需要的朋友可以參考下2024-07-07
這篇文章主要介紹了Java集合之LinkedHashSet詳解,LinkedHashSet是HashSet的子類,實現(xiàn)了Set接口,LinkedHashSet底層是一個LinkedHashMap,底層維護(hù)了一個數(shù)組+雙向鏈表,需要的朋友可以參考下2023-09-09
這篇文章主要介紹了SpringBoot項目中訪問HTML頁面的三種方法,文中通過代碼示例和圖文結(jié)合的方式講解的非常詳細(xì),對大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下2024-07-07
這篇文章主要介紹了Java中的equsals和==的相關(guān)內(nèi)容，感興趣的朋朋友可以參考下文2021-08-08