JWT官網： https://jwt.io/
JWT(Java版)的github地址:https://github.com/jwtk/jjwt
參考原文：意識流丶
什么是JWT
Json web token (JWT), 是為了在網絡應用環境間傳遞聲明而執行的一種基於JSON的開放標准（(RFC 7519).定義了一種簡潔的，自包含的方法用於通信雙方之間以JSON對象的形式安全的傳遞信息。因為數字簽名的存在，這些信息是可信的，JWT可以使用HMAC算法或者是RSA的公私秘鑰對進行簽名。
JWT請求流程
1. 用戶使用賬號和面發出post請求；
2. 服務器使用私鑰創建一個jwt；
3. 服務器返回這個jwt給瀏覽器；
4. 瀏覽器將該jwt串在請求頭中像服務器發送請求；
5. 服務器驗證該jwt；
6. 返回響應的資源給瀏覽器。
JWT的主要應用場景
身份認證在這種場景下，一旦用戶完成了登陸，在接下來的每個請求中包含JWT，可以用來驗證用戶身份以及對路由，服務和資源的訪問權限進行驗證。由於它的開銷非常小，可以輕松的在不同域名的系統中傳遞，所有目前在單點登錄（SSO）中比較廣泛的使用了該技術。 信息交換在通信的雙方之間使用JWT對數據進行編碼是一種非常安全的方式，由於它的信息是經過簽名的，可以確保發送者發送的信息是沒有經過偽造的。
優點
1.簡潔(Compact): 可以通過URL，POST參數或者在HTTP header發送，因為數據量小，傳輸速度也很快
2.自包含(Self-contained)：負載中包含了所有用戶所需要的信息，避免了多次查詢數據庫
3.因為Token是以JSON加密的形式保存在客戶端的，所以JWT是跨語言的，原則上任何web形式都支持。
4.不需要在服務端保存會話信息，特別適用於分布式微服務。
JWT的結構
JWT是由三段信息構成的，將這三段信息文本用.連接一起就構成了JWT字符串。
就像這樣:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
JWT包含了三部分：
Header 頭部(標題包含了令牌的元數據，並且包含簽名和/或加密算法的類型)
Payload 負載 (類似於飛機上承載的物品)
Signature 簽名/簽證
Header
JWT的頭部承載兩部分信息：token類型和采用的加密算法。
{
"alg": "HS256",
"typ": "JWT"
}
聲明類型:這里是jwt
聲明加密的算法:通常直接使用 HMAC SHA256
加密算法是單向函數散列算法，常見的有MD5、SHA、HAMC。
MD5(message-digest algorithm 5) （信息-摘要算法）縮寫，廣泛用於加密和解密技術，常用於文件校驗。校驗？不管文件多大，經過MD5后都能生成唯一的MD5值
SHA (Secure Hash Algorithm，安全散列算法），數字簽名等密碼學應用中重要的工具，安全性高於MD5
HMAC (Hash Message Authentication Code)，散列消息鑒別碼，基於密鑰的Hash算法的認證協議。用公開函數和密鑰產生一個固定長度的值作為認證標識，用這個標識鑒別消息的完整性。常用於接口簽名驗證
Payload
載荷就是存放有效信息的地方。
有效信息包含三個部分
1.標准中注冊的聲明
2.公共的聲明
3.私有的聲明
標准中注冊的聲明 (建議但不強制使用)
iss: jwt簽發者
sub: 面向的用戶(jwt所面向的用戶)
aud: 接收jwt的一方
exp: 過期時間戳(jwt的過期時間，這個過期時間必須要大於簽發時間)
nbf: 定義在什么時間之前，該jwt都是不可用的.
iat: jwt的簽發時間
jti: jwt的唯一身份標識，主要用來作為一次性token,從而回避重放攻擊。
公共的聲明
公共的聲明可以添加任何的信息，一般添加用戶的相關信息或其他業務需要的必要信息.但不建議添加敏感信息，因為該部分在客戶端可解密.
私有的聲明
私有聲明是提供者和消費者所共同定義的聲明，一般不建議存放敏感信息，因為base64是對稱解密的，意味着該部分信息可以歸類為明文信息。
Signature
jwt的第三部分是一個簽證信息
這個部分需要base64加密后的header和base64加密后的payload使用.連接組成的字符串，然后通過header中聲明的加密方式進行加鹽secret組合加密，然后就構成了jwt的第三部分。
密鑰secret是保存在服務端的，服務端會根據這個密鑰進行生成token和進行驗證，所以需要保護好。
下面來進行SpringBoot和JWT的集成
引入JWT相關依賴
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt-api</artifactId>
<version>0.11.2</version>
</dependency>
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt-impl</artifactId>
<version>0.11.2</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt-jackson</artifactId> <!-- or jjwt-gson if Gson is preferred -->
<version>0.11.2</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.auth0</groupId>
<artifactId>java-jwt</artifactId>
<version>3.15.0</version>
</dependency>
自定義驗證注解
用來驗證用戶權限JwtToken
//該注解用
@Target({ElementType.METHOD,ElementType.TYPE})
//運行時注解生效
@Retention(RetentionPolicy.RUNTIME)
public @interface JwtToken {
boolean required() default true;
}
@Target:注解的作用目標
@Target(ElementType.TYPE)——接口、類、枚舉、注解
@Target(ElementType.FIELD)——字段、枚舉的常量
@Target(ElementType.METHOD)——方法
@Target(ElementType.PARAMETER)——方法參數
@Target(ElementType.CONSTRUCTOR) ——構造函數
@Target(ElementType.LOCAL_VARIABLE)——局部變量
@Target(ElementType.ANNOTATION_TYPE)——注解
@Target(ElementType.PACKAGE)——包
@Retention：注解的保留位置
RetentionPolicy.SOURCE:這種類型的Annotations只在源代碼級別保留,編譯時就會被忽略,在class字節碼文件中不包含。
RetentionPolicy.CLASS:這種類型的Annotations編譯時被保留,默認的保留策略,在class文件中存在,但JVM將會忽略,運行時無法獲得。
RetentionPolicy.RUNTIME:這種類型的Annotations將被JVM保留,所以他們能在運行時被JVM或其他使用反射機制的代碼所讀取和使用。
@Document：說明該注解將被包含在javadoc中
@Inherited：說明子類可以繼承父類中的該注解
簡單自定義一個實體類User,使用lombok簡化實體類的編寫
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
String Id;
String username;
String password;
}
定義一個JWT工具類JwtUtils
里面有兩個方法，一個是createToken
/**
* 生產token
* @param user 傳入用戶對象，將用戶的信息加密到jwt中
* @return token
*/
public String createToken(User user) {
//objectMapper用於序列化對象
ObjectMapper objectMapper = new ObjectMapper();
//將密鑰進行base64加密
String base64 = Base64.getEncoder().encodeToString(appConfig.getAppKey().getBytes(StandardCharsets.UTF_8));
//將base64加密后的密鑰生產密鑰對象SecretKey
SecretKey secretKey = Keys.hmacShaKeyFor(base64.getBytes(StandardCharsets.UTF_8));
//去除敏感信息
user.setPassword(null);
try {
//將用戶對象user序列化為json格式
String userJson = objectMapper.writeValueAsString(user);
//生產帶有用戶信息的token
String jwtToken = Jwts.builder().setSubject(userJson).signWith(secretKey).compact();
return jwtToken;
} catch (Exception e) {
return "token生成失敗，請稍后再試";
}
}
Algorithm.HMAC256():使用HS256生成token,密鑰則是我自己定義了一個32位的字符串，唯一密鑰的話可以保存在服務端。
withAudience()存入需要保存在token的信息，這里我把用戶對象的信息存入token中
另一個方法是驗證token的有效性validateToken
/**
* 傳入token，解密token，獲取token中的負載（payload）信息
* @param token
* @return
*/
public User validateToken(String token) {
//objectMapper用於序列化對象
ObjectMapper objectMapper = new ObjectMapper();
User user = new User();
//將密鑰進行base64加密
String base64 = Base64.getEncoder().encodeToString(appConfig.getAppKey().getBytes(StandardCharsets.UTF_8));
//生成密鑰對象secretKey
SecretKey secretKey = Keys.hmacShaKeyFor(base64.getBytes(StandardCharsets.UTF_8));
//token解密，如果token校驗失敗，則會觸發JwtException
try {
//Jws對象就是我們要的數據
Jws<Claims> claimsJws = Jwts.parserBuilder()
.setSigningKey(secretKey)
.build()
.parseClaimsJws(token);
//獲取Jws對象的內容Subject
String subjectJson = claimsJws.getBody().getSubject();
//對subjectJson進行反序列化成user對象
user = objectMapper.readValue(subjectJson, User.class);
//校驗成功則返回user對象
return user;
} catch (JwtException | JsonProcessingException e) {
e.printStackTrace();
user.setUserId(-1);
return user;
}
}
接下來需要寫一個攔截器去獲取token並驗證token
/**
* @author fengzeng
* @create 2021/5/1 18:23
*/
public class SecurityInterceptor implements org.springframework.web.servlet.HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
ObjectMapper objectMapper = new ObjectMapper();
String token = request.getHeader("Authorization");
//如果請求不是映射到方法則直接通過
if (!(handler instanceof HandlerMethod)) {
return true;
}
//獲取到請求的方法
HandlerMethod handlerMethod = (HandlerMethod) handler;
Method method = handlerMethod.getMethod();
//判斷是否需要進行JWT驗證
if (method.isAnnotationPresent(JwtToken.class)) {
//從annotation包中獲取注解對象,判斷它是否需要驗證
JwtToken jwtToken = method.getAnnotation(JwtToken.class);
if (jwtToken.required()) {
//執行認證
if (token == null) {
response.setStatus(401);
ResponseObject responseObject = new ResponseObject(403, "未授權，請登錄");
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
String s = objectMapper.writeValueAsString(responseObject);
response.getWriter().write(s);
return false;
}
//如果token存在，則驗證token
User user = new JwtUtils().validateToken(token);
if (user.getUserId() == -1) {
return false;
}
request.setAttribute("user", user);
}
return true;
}
return true;
}
}
實現一個攔截器就需要實現HandlerInterceptor接口
HandlerInterceptor接口主要定義了三個方法
1.boolean preHandle ()：
預處理回調方法,實現處理器的預處理，第三個參數為響應的處理器,自定義Controller,返回值為true表示繼續流程（如調用下一個攔截器或處理器）或者接着執行
postHandle()和afterCompletion()；false表示流程中斷，不會繼續調用其他的攔截器或處理器，中斷執行。
2.void postHandle()：
后處理回調方法，實現處理器的后處理（DispatcherServlet進行視圖返回渲染之前進行調用），此時我們可以通過modelAndView（模型和視圖對象）對模型數據進行處理或對視圖進行處理，modelAndView也可能為null。
3.void afterCompletion():
整個請求處理完畢回調方法,該方法也是需要當前對應的Interceptor的preHandle()的返回值為true時才會執行，也就是在DispatcherServlet渲染了對應的視圖之后執行。用於進行資源清理。整個請求處理完畢回調方法。如性能監控中我們可以在此記錄結束時間並輸出消耗時間，還可以進行一些資源清理，類似於try-catch-finally中的finally，但僅調用處理器執行鏈中。
主要流程:
1.從 http 請求頭中取出 token，
2.判斷是否映射到方法
3.檢查是否有passtoken注釋，有則跳過認證
4.檢查有沒有需要用戶登錄的注解，有則需要取出並驗證
5.認證通過則可以訪問，不通過會報相關錯誤信息
配置攔截器
在配置類上添加了注解@Configuration，標明了該類是一個配置類並且會將該類作為一個SpringBean添加到IOC容器內
/**
* @author fengzeng
* @create 2021/5/1 19:00
*/
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(securityInterceptor())
.excludePathPatterns("")
.addPathPatterns("/**");
}
/**
* 在spring ioc 容器啟動時將tokenInterceptor對象放入Ioc進行管理
* * beanId = securityInterceptor
* @return SecurityInterceptor
*/
@Bean
public SecurityInterceptor securityInterceptor(){
return new SecurityInterceptor();}
}
注：
在SpringBoot2.0及Spring 5.0中WebMvcConfigurerAdapter已被廢棄
直接實現WebMvcConfigurer （官方推薦）
InterceptorRegistry內的addInterceptor需要一個實現HandlerInterceptor接口的攔截器實例，addPathPatterns方法用於設置攔截器的過濾路徑規則。這里我攔截所有請求，通過注解JwtToken來判斷是否需要驗證token。
在數據訪問接口中加入JwtToken注解
@JwtToken
@RequestMapping("/test")
public String test() {
return "token驗證通過";
}
下面進行測試，啟動項目，使用postman測試接口
在沒token的情況下訪問/test接口
下面進行登錄，從而獲取token
登錄操作我沒加驗證注解，所以可以直接訪問
把token加在請求頭中，再次訪問/test接口
注意:這里的key一定不能錯，因為在攔截器中是取關鍵字token的值
String token = httpServletRequest.getHeader("Authorization");
加上token之后就可以順利通過驗證和進行接口訪問了