JWT整合springBoot簡單實用

JWT是什麼?

Json web token (JWT), 是爲了在網絡應用環境間傳遞聲明而執行的一種基於JSON的開放標準（(RFC 7519).該token被設計爲緊湊且安全的，特別適用於分佈式站點的單點登錄（SSO）場景。JWT的聲明一般被用來在身份提供者和服務提供者間傳遞被認證的用戶身份信息，以便於從資源服務器獲取資源，也可以增加一些額外的其它業務邏輯所必須的聲明信息，該token也可直接被用於認證，也可被加密。

JWT的構成

第一部分我們稱它爲頭部（header),第二部分我們稱其爲載荷（payload, 類似於飛機上承載的物品)，第三部分是簽證（signature).

header

jwt的頭部承載兩部分信息：

聲明類型，這裏是jwt
聲明加密的算法 通常直接使用 HMAC SHA256
完整的頭部就像下面這樣的JSON：

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

然後將頭部進行base64加密（該加密是可以對稱解密的),構成了第一部分.

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9

playload

載荷就是存放有效信息的地方。這個名字像是特指飛機上承載的貨品，這些有效信息包含三個部分

標準中註冊的聲明
公共的聲明
私有的聲明

定義一個payload:

{
  "sub": "1234567890",
  "name": "John Doe",
  "admin": true
}

然後將其進行base64加密，得到Jwt的第二部分。

eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9

signature

jwt的第三部分是一個簽證信息，這個簽證信息由三部分組成：

header (base64後的)
payload (base64後的)
secret

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

// javascript
var encodedString = base64UrlEncode(header) + '.' + base64UrlEncode(payload);

var signature = HMACSHA256(encodedString, 'secret'); // TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

將這三部分用.連接成一個完整的字符串,構成了最終的jwt:

  eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

如何應用

一般是在請求頭裏加入Authorization，並加上Bearer標註：

fetch('api/user/1', {
  headers: {
    'Authorization': 'Bearer ' + token
  }
})

接下來是重點

整合springboot

maven依賴

 <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>

utils

@Component
public class Test {
    /**
     * 登錄Token的生成和解析
     */
    public static final String SECRET = "JKKLJOoasdlfj";
    /** token 過期時間: 10天 */
    public static final int calendarField = Calendar.DATE;
    public static final int calendarInterval = 10;

    /**
     * @param user_id
     *            登錄成功後用戶user_id, 參數user_id不可傳空
     */
    public static String createToken(Long user_id) throws Exception {
        Date iatDate = new Date();
        // expire time
        Calendar nowTime = Calendar.getInstance();
        nowTime.add(calendarField, calendarInterval);
        Date expiresDate = nowTime.getTime();

        // header Map
        Map<String, Object> map = new HashMap<>();
        map.put("alg", "HS256");
        map.put("typ", "JWT");

        // build token
        String token = JWT.create().withHeader(map) // header
                .withClaim("iss", "Service") // payload
                .withClaim("aud", "APP")
                .withClaim("user_id", null == user_id ? null : user_id.toString())
                .withIssuedAt(iatDate) // sign time
                .withExpiresAt(expiresDate) // expire time
                .sign(Algorithm.HMAC256(SECRET)); // signature

        return token;
    }

    /**
     * 解密Token
     *
     * @param token
     * @return
     * @throws Exception
     */
    public static Map<String, Claim> verifyToken(String token) {
        DecodedJWT jwt = null;
        try {
            JWTVerifier verifier = JWT.require(Algorithm.HMAC256(SECRET)).build();
            jwt = verifier.verify(token);
        } catch (Exception e) {
            // e.printStackTrace();
            // token 校驗失敗, 拋出Token驗證非法異常
        }
        return jwt.getClaims();
    }

    /**
     * 根據Token獲取user_id
     *
     * @param token
     * @return user_id
     */
    public static Long getAppUID(String token) {
        Map<String, Claim> claims = verifyToken(token);
        Claim user_id_claim = claims.get("user_id");
        if (null == user_id_claim || StringUtils.isEmpty(user_id_claim.asString())) {
            // token 校驗失敗, 拋出Token驗證非法異常
        }
        return Long.valueOf(user_id_claim.asString());
    }
}

這裏有兩種方法分別爲:

jwt+cookie

    @GetMapping("/getAll")
    public String  getAll(HttpServletRequest request, HttpServletResponse response) 
    throws Exception {
        //創建token
        String token = test.createToken(1L);
        //生成cookie
        Cookie cookie = new Cookie("acc",token);
        //放入cookie
        response.addCookie(cookie);
        //寫入請求頭
        response.setHeader("acc", token);
        //輸出令牌
        System.out.println("token===========>"+token);
        return token;
    }

調用得出結果:

token===========>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJBUFAiLCJ1c2VyX2lkIjoiMSIsImlzcyI6IlNlcnZpY2UiLCJleHAiOjE1OTEwMjg4MzYsImlhdCI6MTU5MDE2NDgzNn0.UOAchNYYXECyey1np87kOF0Di0XagpNJE-ruPGwQ3B8

解析token

@PostMapping("/getAll")
    public Map<String, Claim> postGetAll(HttpServletRequest request){
        //拿到頭信息
        String acc = request.getHeader("acc");
        //輸出頭信息
        System.out.println("頭信息===========>"+acc);
        //得到所有cookie
        Cookie[] cookies = request.getCookies();
        //定義返回值
        Map<String, Claim> stringClaimMap = null;
        //迭代cookie數組
        for (Cookie cookie : cookies) {
            //得到key值
            String name = cookie.getName();
            //得到對應key值
            if("acc".equals(name)){
                //得到cookie值
                String value = cookie.getValue();
                System.out.println(name+"======cookie中的值=====>"+value);
                //解析值得到token中信息
                stringClaimMap = test.verifyToken(value);
                //迭代信息key值
                Set<String> keySet = stringClaimMap.keySet();
                Iterator<String> iterator = keySet.iterator();
                while (iterator.hasNext()){
                    String key = iterator.next();
                    //得到有關user_id中的值
                    if("user_id".equals(key)){
                        //通過key值得到value
                        Claim claim = stringClaimMap.get(key);
                        System.out.println(key+"=====map中信息======>"+claim.asString());
                    }
                }
                Long appUID = test.getAppUID(value);
                System.out.println("appUID===========>"+appUID);
            }
        }
        return stringClaimMap;
    }

調用得出結果:

頭信息===========>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJBUFAiLCJ1c2VyX2lkIjoiMSIsImlzcyI6IlNlcnZpY2UiLCJleHAiOjE1OTEwMjgzODIsImlhdCI6MTU5MDE2NDM4Mn0.Mz8VJ4HrYnO8I40hSABWQKQSDY6EtP-weBkwOLjNBVE
acc======cookie中的值=====>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJBUFAiLCJ1c2VyX2lkIjoiMSIsImlzcyI6IlNlcnZpY2UiLCJleHAiOjE1OTEwMjg4MzYsImlhdCI6MTU5MDE2NDgzNn0.UOAchNYYXECyey1np87kOF0Di0XagpNJE-ruPGwQ3B8
user_id=====map中信息======>1
appUID===========>1

還有一個重要的

JWT的開源的第三方JJWT的初步使用

定義操作類

@Data
@AllArgsConstructor
public class JwtInfo {
    private String uid;
}

定義service解析token

@Component
public class JwtTokenService {

    /**
     * token過期時間
     */
    private int expire = 6000;
    //生成token
    public String generatorToken(JwtInfo jwtInfo){
        return JwtTokenUtils.generatorToken(jwtInfo,expire);
    }
    //獲取信息
    public JwtInfo stringInfoFromToken(String token){
        return JwtTokenUtils.getTokenInfo(token);
    }
}

定義utils

public class JwtTokenUtils {
    private static Key getKeyInstance(){
        SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;
        byte[] bytes = DatatypeConverter.parseBase64Binary("mall-user");
        return new SecretKeySpec(bytes,signatureAlgorithm.getJcaName());
    }

    /**
     * 生成token的方法
     * @param jwtInfo
     * @param expire
     * @return
     */
    public static String generatorToken(JwtInfo jwtInfo, int expire){
        return Jwts.builder().claim(JwtConstants.JWT_KEY_USER_ID,jwtInfo.getUid())
                .setExpiration(DateTime.now().plusSeconds(expire).toDate())
                .signWith(SignatureAlgorithm.HS256,getKeyInstance()).compact();
    }

    /**
     * 根據token獲取token中的信息
     * @param token
     * @return
     */
    public static JwtInfo getTokenInfo(String token){
        Jws<Claims> claimsJws = Jwts.parser()
        			.setSigningKey(getKeyInstance())
        			.parseClaimsJws(token);
        Claims claims = claimsJws.getBody();
        return new JwtInfo(claims.get(JwtConstants.JWT_KEY_USER_ID).toString());
    }
}
class JwtConstants {
    public static final String JWT_KEY_USER_ID = "uid";
}

使用

    @GetMapping("/jjwt/token")
    public String jjwtToken(HttpServletResponse response){
        JwtInfo jwtInfo = new JwtInfo("111");
        String s = jwtTokenService.generatorToken(jwtInfo);
        System.out.println("cookie===========>"+s);
        Cookie cookie = new Cookie("acca",s);
        response.addCookie(cookie);
        return s;
    }

得出結果:

cookie===========>eyJhbGciOiJIUzI1NiJ9.eyJ1aWQiOiIxMTEiLCJleHAiOjE1OTAxNzE1MTJ9.3UXozDO_UoVhk84o0c0ULNIo3wYOk7fFinWUPb-AT3w

解析token

    @GetMapping("/jjwt/token1")
    public JwtInfo jjwtToken1(HttpServletRequest request){
        JwtInfo jwtInfo = null;
        Cookie[] cookies = request.getCookies();
        for (Cookie cookie : cookies) {
            if(cookie.getName().equals("acca")){
                System.out.println("cookie.getName()===========>"+cookie.getName());
                jwtInfo = jwtTokenService.stringInfoFromToken(cookie.getValue());
                System.out.println("jwtInfo===========>"+jwtInfo);
            }
        }
        return jwtInfo;
    }

得出結果:

cookie.getName()===========>acca
jwtInfo===========>JwtInfo(uid=111)