作者：意識(shí)流

來源：www.jianshu.com/p/e88d3f8151db

JWT官網(wǎng)：https://jwt.io

JWT(Java版)的github地址:https://github.com/jwtk/jjwt

# 什么是JWT

Json web token (JWT), 是為了在網(wǎng)絡(luò)應(yīng)用環(huán)境間傳遞聲明而執(zhí)行的一種基于JSON的開放標(biāo)準(zhǔn)（(RFC 7519).定義了一種簡(jiǎn)潔的，自包含的方法用于通信雙方之間以JSON對(duì)象的形式安全的傳遞信息。因?yàn)閿?shù)字簽名的存在，這些信息是可信的，JWT可以使用HMAC算法或者是RSA的公私秘鑰對(duì)進(jìn)行簽名。

# JWT請(qǐng)求流程

1. 用戶使用賬號(hào)和面發(fā)出post請(qǐng)求；

2. 服務(wù)器使用私鑰創(chuàng)建一個(gè)jwt；

3. 服務(wù)器返回這個(gè)jwt給瀏覽器；

4. 瀏覽器將該jwt串在請(qǐng)求頭中像服務(wù)器發(fā)送請(qǐng)求；

5. 服務(wù)器驗(yàn)證該jwt；

6. 返回響應(yīng)的資源給瀏覽器。

# JWT的主要應(yīng)用場(chǎng)景

身份認(rèn)證在這種場(chǎng)景下，一旦用戶完成了登陸，在接下來的每個(gè)請(qǐng)求中包含JWT，可以用來驗(yàn)證用戶身份以及對(duì)路由，服務(wù)和資源的訪問權(quán)限進(jìn)行驗(yàn)證。由于它的開銷非常小，可以輕松的在不同域名的系統(tǒng)中傳遞，所有目前在單點(diǎn)登錄（SSO）中比較廣泛的使用了該技術(shù)。

信息交換在通信的雙方之間使用JWT對(duì)數(shù)據(jù)進(jìn)行編碼是一種非常安全的方式，由于它的信息是經(jīng)過簽名的，可以確保發(fā)送者發(fā)送的信息是沒有經(jīng)過偽造的。

優(yōu)點(diǎn)

1. 簡(jiǎn)潔(Compact): 可以通過URL，POST參數(shù)或者在HTTP header發(fā)送，因?yàn)閿?shù)據(jù)量小，傳輸速度也很快

2. 自包含(Self-contained)：負(fù)載中包含了所有用戶所需要的信息，避免了多次查詢數(shù)據(jù)庫(kù)

3. 因?yàn)門oken是以JSON加密的形式保存在客戶端的，所以JWT是跨語(yǔ)言的，原則上任何web形式都支持。

4. 不需要在服務(wù)端保存會(huì)話信息，特別適用于分布式微服務(wù)。

# JWT的結(jié)構(gòu)

JWT是由三段信息構(gòu)成的，將這三段信息文本用.連接一起就構(gòu)成了JWT字符串。

就像這樣:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

JWT包含了三部分：

• Header 頭部(標(biāo)題包含了令牌的元數(shù)據(jù)，并且包含簽名和/或加密算法的類型)

• Payload 負(fù)載 (類似于飛機(jī)上承載的物品)

• Signature 簽名/簽證

Header

JWT的頭部承載兩部分信息：token類型和采用的加密算法。

{   "alg": "HS256",   "typ": "JWT"} 

聲明類型:這里是jwt

聲明加密的算法:通常直接使用 HMAC SHA256

加密算法是單向函數(shù)散列算法，常見的有MD5、SHA、HAMC。

MD5(message-digest algorithm 5) （信息-摘要算法）縮寫，廣泛用于加密和解密技術(shù)，常用于文件校驗(yàn)。校驗(yàn)？不管文件多大，經(jīng)過MD5后都能生成唯一的MD5值

SHA (Secure Hash Algorithm，安全散列算法），數(shù)字簽名等密碼學(xué)應(yīng)用中重要的工具，安全性高于MD5

HMAC (Hash Message Authentication Code)，散列消息鑒別碼，基于密鑰的Hash算法的認(rèn)證協(xié)議。用公開函數(shù)和密鑰產(chǎn)生一個(gè)固定長(zhǎng)度的值作為認(rèn)證標(biāo)識(shí)，用這個(gè)標(biāo)識(shí)鑒別消息的完整性。常用于接口簽名驗(yàn)證

Payload

載荷就是存放有效信息的地方。

有效信息包含三個(gè)部分

1. 標(biāo)準(zhǔn)中注冊(cè)的聲明

2. 公共的聲明

3. 私有的聲明

   
   

標(biāo)準(zhǔn)中注冊(cè)的聲明 (建議但不強(qiáng)制使用) ：

• iss: jwt簽發(fā)者

• sub: 面向的用戶(jwt所面向的用戶)

• aud: 接收jwt的一方

• exp: 過期時(shí)間戳(jwt的過期時(shí)間，這個(gè)過期時(shí)間必須要大于簽發(fā)時(shí)間)

• nbf: 定義在什么時(shí)間之前，該jwt都是不可用的.

• iat: jwt的簽發(fā)時(shí)間

• jti: jwt的唯一身份標(biāo)識(shí)，主要用來作為一次性token,從而回避重放攻擊。

公共的聲明：

公共的聲明可以添加任何的信息，一般添加用戶的相關(guān)信息或其他業(yè)務(wù)需要的必要信息.但不建議添加敏感信息，因?yàn)樵摬糠衷诳蛻舳丝山饷?

私有的聲明：

私有聲明是提供者和消費(fèi)者所共同定義的聲明，一般不建議存放敏感信息，因?yàn)閎ase64是對(duì)稱解密的，意味著該部分信息可以歸類為明文信息。

Signature

jwt的第三部分是一個(gè)簽證信息

這個(gè)部分需要base64加密后的header和base64加密后的payload使用.連接組成的字符串，然后通過header中聲明的加密方式進(jìn)行加鹽secret組合加密，然后就構(gòu)成了jwt的第三部分。

密鑰secret是保存在服務(wù)端的，服務(wù)端會(huì)根據(jù)這個(gè)密鑰進(jìn)行生成token和進(jìn)行驗(yàn)證，所以需要保護(hù)好。

下面來進(jìn)行SpringBoot和JWT的集成

引入JWT依賴,由于是基于Java，所以需要的是java-jwt

<dependency>      <groupId>com.auth0</groupId>      <artifactId>java-jwt</artifactId>      <version>3.4.0</version></dependency>

需要自定義兩個(gè)注解

用來跳過驗(yàn)證的PassToken

@Target({ElementType.METHOD, ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)public @interface PassToken {    boolean required() default true;}

需要登錄才能進(jìn)行操作的注解UserLoginToken

@Target({ElementType.METHOD, ElementType.TYPE})@Retention(RetentionPolicy.RUNTIME)public @interface UserLoginToken {    boolean required() default true;}

@Target注解的作用目標(biāo)

@Target(ElementType.TYPE)——接口、類、枚舉、注解@Target(ElementType.FIELD)——字段、枚舉的常量@Target(ElementType.METHOD)——方法@Target(ElementType.PARAMETER)——方法參數(shù)@Target(ElementType.CONSTRUCTOR) ——構(gòu)造函數(shù)@Target(ElementType.LOCAL_VARIABLE)——局部變量@Target(ElementType.ANNOTATION_TYPE)——注解@Target(ElementType.PACKAGE)——包

@Retention注解的保留位置

• RetentionPolicy.SOURCE:這種類型的Annotations只在源代碼級(jí)別保留,編譯時(shí)就會(huì)被忽略,在class字節(jié)碼文件中不包含。

• RetentionPolicy.CLASS:這種類型的Annotations編譯時(shí)被保留,默認(rèn)的保留策略,在class文件中存在,但JVM將會(huì)忽略,運(yùn)行時(shí)無法獲得。

• RetentionPolicy.RUNTIME:這種類型的Annotations將被JVM保留,所以他們能在運(yùn)行時(shí)被JVM或其他使用反射機(jī)制的代碼所讀取和使用。

• @Document：說明該注解將被包含在javadoc中

• @Inherited：說明子類可以繼承父類中的該注解

簡(jiǎn)單自定義一個(gè)實(shí)體類User,使用lombok簡(jiǎn)化實(shí)體類的編寫

@Data@AllArgsConstructor@NoArgsConstructorpublic class User {    String Id;    String username;    String password;}

需要寫token的生成方法

public String getToken(User user) {        String token="";        token= JWT.create().withAudience(user.getId())                .sign(Algorithm.HMAC256(user.getPassword()));        return token;    }}

Algorithm.HMAC256():使用HS256生成token,密鑰則是用戶的密碼，唯一密鑰的話可以保存在服務(wù)端。

withAudience()存入需要保存在token的信息，這里我把用戶ID存入token中

接下來需要寫一個(gè)攔截器去獲取token并驗(yàn)證token

public class AuthenticationInterceptor implements HandlerInterceptor {    @Autowired    UserService userService;    @Override    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object) throws Exception {        String token = httpServletRequest.getHeader("token");// 從 http 請(qǐng)求頭中取出 token        // 如果不是映射到方法直接通過        if(!(object instanceof HandlerMethod)){            return true;        }        HandlerMethod handlerMethod=(HandlerMethod)object;        Method method=handlerMethod.getMethod();        //檢查是否有passtoken注釋，有則跳過認(rèn)證        if (method.isAnnotationPresent(PassToken.class)) {            PassToken passToken = method.getAnnotation(PassToken.class);            if (passToken.required()) {                return true;            }        }        //檢查有沒有需要用戶權(quán)限的注解        if (method.isAnnotationPresent(UserLoginToken.class)) {            UserLoginToken userLoginToken = method.getAnnotation(UserLoginToken.class);            if (userLoginToken.required()) {                // 執(zhí)行認(rèn)證                if (token == null) {                    throw new RuntimeException("無token，請(qǐng)重新登錄");                }                // 獲取 token 中的 user id                String userId;                try {                    userId = JWT.decode(token).getAudience().get(0);                } catch (JWTDecodeException j) {                    throw new RuntimeException("401");                }                User user = userService.findUserById(userId);                if (user == null) {                    throw new RuntimeException("用戶不存在，請(qǐng)重新登錄");                }                // 驗(yàn)證 token                JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(user.getPassword())).build();                try {                    jwtVerifier.verify(token);                } catch (JWTVerificationException e) {                    throw new RuntimeException("401");                }                return true;            }        }        return true;    }
    @Override    public void postHandle(HttpServletRequest httpServletRequest,                                   HttpServletResponse httpServletResponse,                             Object o, ModelAndView modelAndView) throws Exception {
    }    @Override    public void afterCompletion(HttpServletRequest httpServletRequest,                                           HttpServletResponse httpServletResponse,                                           Object o, Exception e) throws Exception {    }

實(shí)現(xiàn)一個(gè)攔截器就需要實(shí)現(xiàn)HandlerInterceptor接口

HandlerInterceptor接口主要定義了三個(gè)方法

1.boolean preHandle ()：

預(yù)處理回調(diào)方法,實(shí)現(xiàn)處理器的預(yù)處理，第三個(gè)參數(shù)為響應(yīng)的處理器,自定義Controller,返回值為true表示繼續(xù)流程（如調(diào)用下一個(gè)攔截器或處理器）或者接著執(zhí)行postHandle()和afterCompletion()；false表示流程中斷，不會(huì)繼續(xù)調(diào)用其他的攔截器或處理器，中斷執(zhí)行。

2.void postHandle()：

后處理回調(diào)方法，實(shí)現(xiàn)處理器的后處理（DispatcherServlet進(jìn)行視圖返回渲染之前進(jìn)行調(diào)用），此時(shí)我們可以通過modelAndView（模型和視圖對(duì)象）對(duì)模型數(shù)據(jù)進(jìn)行處理或?qū)σ晥D進(jìn)行處理，modelAndView也可能為null。

3.void afterCompletion():

整個(gè)請(qǐng)求處理完畢回調(diào)方法,該方法也是需要當(dāng)前對(duì)應(yīng)的Interceptor的preHandle()的返回值為true時(shí)才會(huì)執(zhí)行，也就是在DispatcherServlet渲染了對(duì)應(yīng)的視圖之后執(zhí)行。用于進(jìn)行資源清理。

整個(gè)請(qǐng)求處理完畢回調(diào)方法。如性能監(jiān)控中我們可以在此記錄結(jié)束時(shí)間并輸出消耗時(shí)間，還可以進(jìn)行一些資源清理，類似于try-catch-finally中的finally，但僅調(diào)用處理器執(zhí)行鏈中

主要流程:

1. 從 http 請(qǐng)求頭中取出 token，

2. 判斷是否映射到方法

3. 檢查是否有passtoken注釋，有則跳過認(rèn)證

4. 檢查有沒有需要用戶登錄的注解，有則需要取出并驗(yàn)證

5. 認(rèn)證通過則可以訪問，不通過會(huì)報(bào)相關(guān)錯(cuò)誤信息

# 配置攔截器

在配置類上添加了注解@Configuration，標(biāo)明了該類是一個(gè)配置類并且會(huì)將該類作為一個(gè)SpringBean添加到IOC容器內(nèi)。

@Configurationpublic class InterceptorConfig extends WebMvcConfigurerAdapter {    @Override    public void addInterceptors(InterceptorRegistry registry) {        registry.addInterceptor(authenticationInterceptor())                .addPathPatterns("/**");    // 攔截所有請(qǐng)求，通過判斷是否有 @LoginRequired 注解 決定是否需要登錄    }    @Bean    public AuthenticationInterceptor authenticationInterceptor() {        return new AuthenticationInterceptor();    }}

WebMvcConfigurerAdapter該抽象類其實(shí)里面沒有任何的方法實(shí)現(xiàn)，只是空實(shí)現(xiàn)了接口

WebMvcConfigurer內(nèi)的全部方法，并沒有給出任何的業(yè)務(wù)邏輯處理，這一點(diǎn)設(shè)計(jì)恰到好處的讓我們不必去實(shí)現(xiàn)那些我們不用的方法，都交由WebMvcConfigurerAdapter抽象類空實(shí)現(xiàn),如果我們需要針對(duì)具體的某一個(gè)方法做出邏輯處理,僅僅需要在WebMvcConfigurerAdapter子類中@Override對(duì)應(yīng)方法就可以了。

注：
在SpringBoot2.0及Spring 5.0中WebMvcConfigurerAdapter已被廢棄
網(wǎng)上有說改為繼承WebMvcConfigurationSupport，不過試了下，還是過期的

解決方法:

直接實(shí)現(xiàn)WebMvcConfigurer （官方推薦）

@Configurationpublic class InterceptorConfig implements WebMvcConfigurer {    @Override    public void addInterceptors(InterceptorRegistry registry) {        registry.addInterceptor(authenticationInterceptor())                .addPathPatterns("/**");       }    @Bean    public AuthenticationInterceptor authenticationInterceptor() {        return new AuthenticationInterceptor();    }}

InterceptorRegistry內(nèi)的addInterceptor需要一個(gè)實(shí)現(xiàn)HandlerInterceptor接口的攔截器實(shí)例，addPathPatterns方法用于設(shè)置攔截器的過濾路徑規(guī)則。

這里我攔截所有請(qǐng)求，通過判斷是否有@LoginRequired注解 決定是否需要登錄

在數(shù)據(jù)訪問接口中加入登錄操作注解

@RestController@RequestMapping("api")public class UserApi {    @Autowired    UserService userService;    @Autowired    TokenService tokenService;    //登錄    @PostMapping("/login")    public Object login(@RequestBody User user){        JSONObject jsonObject=new JSONObject();        User userForBase=userService.findByUsername(user);        if(userForBase==null){            jsonObject.put("message","登錄失敗,用戶不存在");            return jsonObject;        }else {            if (!userForBase.getPassword().equals(user.getPassword())){                jsonObject.put("message","登錄失敗,密碼錯(cuò)誤");                return jsonObject;            }else {                String token = tokenService.getToken(userForBase);                jsonObject.put("token", token);                jsonObject.put("user", userForBase);                return jsonObject;            }        }    }    @UserLoginToken    @GetMapping("/getMessage")    public String getMessage(){        return "你已通過驗(yàn)證";    }}

不加注解的話默認(rèn)不驗(yàn)證，登錄接口一般是不驗(yàn)證的。在getMessage()中我加上了登錄注解，說明該接口必須登錄獲取token后，在請(qǐng)求頭中加上token并通過驗(yàn)證才可以訪問

下面進(jìn)行測(cè)試，啟動(dòng)項(xiàng)目，使用postman測(cè)試接口

在沒token的情況下訪問api/getMessage接口

我這里使用了統(tǒng)一異常處理，所以只看到錯(cuò)誤message

下面進(jìn)行登錄，從而獲取token

登錄操作我沒加驗(yàn)證注解，所以可以直接訪問

把token加在請(qǐng)求頭中，再次訪問api/getMessage接口

注意:這里的key一定不能錯(cuò)，因?yàn)樵跀r截器中是取關(guān)鍵字token的值String token = httpServletRequest.getHeader("token");

加上token之后就可以順利通過驗(yàn)證和進(jìn)行接口訪問了

github項(xiàng)目源碼地址：https://github.com/JinBinPeng/springboot-jwt