java：基于jjwt写一个jwt工具类

背景

在Java中，使用JWT（JSON Web Tokens）相关的包通常包括以下内容：

jjwt：JJWT是一个非常流行的Java JWT库，它提供了简单易用的API来创建和验证JWT。
jose4j：JOSE4J是一个用于处理JSON Web签名的Java库，包括JWS（JSON Web Signature）和JWE（JSON Web Encryption）。它支持多种签名和加密算法。
json-io：json-io是一个用于处理JSON的库，它可以方便地与JWT一起使用。
jjwt-api：JJWT提供了一个API，使得创建和解析JWT更加容易。
jjwt-impl：这是JJWT的底层实现，包含了各种JWT的生成和验证逻辑。
jjwt-jackson：这个库为使用Jackson序列化JWT提供了支持。
jose4j：该库为处理JWS和JWE提供了支持。

io.jsonwebtoken.jjwt是由Netflix开发并维护的开源库，它的特点是简单易用，性能高效，并且在Java世界中得到了广泛的使用。该库提供了一个简洁的API，使得创建和验证JWT变得容易。

com.auth0.java-jwt是由Auth0开发的开源库，也是Java JWT库的流行选择之一。该库的特点是支持多种JWT标准，包括JWS和JWE，并且提供了丰富的配置选项和扩展性。

在选择使用哪个库时，需要根据具体项目需求和个人偏好来决定。如果项目对性能要求较高，并且需要一个简单易用的解决方案，那么io.jsonwebtoken.jjwt可能是一个更好的选择。如果项目需要支持多种JWT标准，并且需要高度的可配置性和扩展性，那么com.auth0.java-jwt可能更适合。

简单版

核心就是创建和解析

<dependency><groupId>io.jsonwebtoken</groupId><artifactId>jjwt</artifactId><version>0.6.0</version>
</dependency>

package com.ihrm.common.utils;import io.jsonwebtoken.Claims;
import io.jsonwebtoken.JwtBuilder;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;import java.util.Date;
import java.util.Map;@Getter
@Setter
@ConfigurationProperties("jwt.config")
public class JwtUtils {//签名私钥private String key;//签名的失效时间private Long ttl;/*** 设置认证token*      id:登录用户id*      subject：登录用户名**/public String createJwt(String id, String name, Map<String,Object> map) {//1.设置失效时间long now = System.currentTimeMillis();//当前毫秒long exp = now + ttl;//2.创建jwtBuilderJwtBuilder jwtBuilder = Jwts.builder().setId(id).setSubject(name).setIssuedAt(new Date()).signWith(SignatureAlgorithm.HS256, key);//3.根据map设置claimsfor(Map.Entry<String,Object> entry : map.entrySet()) {jwtBuilder.claim(entry.getKey(),entry.getValue());}jwtBuilder.setExpiration(new Date(exp));//4.创建tokenString token = jwtBuilder.compact();return token;}/*** 解析token字符串获取clamis*/public Claims parseJwt(String token) {Claims claims = Jwts.parser().setSigningKey(key).parseClaimsJws(token).getBody();return claims;}}

复杂版

应用配置文件application.yaml中加入如下配置:

jwt:tokenHeader: Authorization #JWT存储的请求头secret: mall-admin-secret #JWT加解密使用的密钥【私钥】expiration: 604800 #JWT的超期限时间(60*60*24*7)tokenHead: 'Bearer '  #JWT负载中拿到开头

JwtTokenUtil.java

package com.dudu.mall.utils;import cn.hutool.core.date.DateUtil;
import cn.hutool.core.util.StrUtil;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.security.core.userdetails.UserDetails;import java.util.Date;
import java.util.HashMap;
import java.util.Map;/*** JwtToken生成的工具类* JWT token的格式：header.payload.signature* header的格式（算法、token的类型）：* {"alg": "HS512","typ": "JWT"}* payload的格式（用户名、创建时间、生成时间）：* {"sub":"wang","created":1489079981393,"exp":1489684781}* signature的生成算法：* HMACSHA512(base64UrlEncode(header) + "." +base64UrlEncode(payload),secret)*/
public class JwtTokenUtil {private static final Logger LOGGER = LoggerFactory.getLogger(JwtTokenUtil.class);private static final String CLAIM_KEY_USERNAME = "sub";private static final String CLAIM_KEY_CREATED = "created";@Value("${jwt.secret}")private String secret;@Value("${jwt.expiration}")private Long expiration;@Value("${jwt.tokenHead}")private String tokenHead;/*** 根据负责生成JWT的token*/private String generateToken(Map<String, Object> claims) {return Jwts.builder().setClaims(claims).setExpiration(generateExpirationDate()).signWith(SignatureAlgorithm.HS512, secret).compact();}/*** 从token中获取JWT中的负载*/private Claims getClaimsFromToken(String token) {Claims claims = null;try {claims = Jwts.parser().setSigningKey(secret).parseClaimsJws(token).getBody();} catch (Exception e) {LOGGER.info("JWT格式验证失败:{}", token);}return claims;}/*** 生成token的过期时间*/private Date generateExpirationDate() {return new Date(System.currentTimeMillis() + expiration * 1000);}/*** 从token中获取登录用户名*/public String getUserNameFromToken(String token) {String username;try {Claims claims = getClaimsFromToken(token);username = claims.getSubject();} catch (Exception e) {username = null;}return username;}/*** 验证token是否还有效** @param token       客户端传入的token* @param userDetails 从数据库中查询出来的用户信息*/public boolean validateToken(String token, UserDetails userDetails) {String username = getUserNameFromToken(token);return username.equals(userDetails.getUsername()) && !isTokenExpired(token);}/*** 判断token是否已经失效*/private boolean isTokenExpired(String token) {Date expiredDate = getExpiredDateFromToken(token);return expiredDate.before(new Date());}/*** 从token中获取过期时间*/private Date getExpiredDateFromToken(String token) {Claims claims = getClaimsFromToken(token);return claims.getExpiration();}/*** 根据用户信息生成token*/public String generateToken(UserDetails userDetails) {Map<String, Object> claims = new HashMap<>();claims.put(CLAIM_KEY_USERNAME, userDetails.getUsername());claims.put(CLAIM_KEY_CREATED, new Date());return generateToken(claims);}/*** 当原来的token没过期时是可以刷新的** @param oldToken 带tokenHead的token*/public String refreshHeadToken(String oldToken) {if(StrUtil.isEmpty(oldToken)){return null;}String token = oldToken.substring(tokenHead.length());if(StrUtil.isEmpty(token)){return null;}//token校验不通过Claims claims = getClaimsFromToken(token);if(claims==null){return null;}//如果token已经过期，不支持刷新if(isTokenExpired(token)){return null;}//如果token在30分钟之内刚刷新过，返回原tokenif(tokenRefreshJustBefore(token,30*60)){return token;}else{claims.put(CLAIM_KEY_CREATED, new Date());return generateToken(claims);}}/*** 判断token在指定时间内是否刚刚刷新过* @param token 原token* @param time 指定时间（秒）*/private boolean tokenRefreshJustBefore(String token, int time) {Claims claims = getClaimsFromToken(token);Date created = claims.get(CLAIM_KEY_CREATED, Date.class);Date refreshDate = new Date();//刷新时间在创建时间的指定时间内if(refreshDate.after(created)&&refreshDate.before(DateUtil.offsetSecond(created,time))){return true;}return false;}
}

复杂版二

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

package org.jeecg.common.system.util;import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTVerifier;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.exceptions.JWTDecodeException;
import com.auth0.jwt.interfaces.DecodedJWT;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.base.Joiner;import java.io.IOException;
import java.io.OutputStream;
import java.util.Date;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;import org.apache.shiro.SecurityUtils;
import org.jeecg.common.api.vo.Result;
import org.jeecg.common.constant.CommonConstant;
import org.jeecg.common.constant.DataBaseConstant;
import org.jeecg.common.constant.SymbolConstant;
import org.jeecg.common.constant.TenantConstant;
import org.jeecg.common.exception.JeecgBootException;
import org.jeecg.common.system.vo.LoginUser;
import org.jeecg.common.system.vo.SysUserCacheInfo;
import org.jeecg.common.util.DateUtils;
import org.jeecg.common.util.SpringContextUtils;
import org.jeecg.common.util.oConvertUtils;/*** @Author Scott* @Date 2018-07-12 14:23* @Desc JWT工具类**/
public class JwtUtil {/**Token有效期为7天（Token在reids中缓存时间为两倍）*/public static final long EXPIRE_TIME = (7 * 12) * 60 * 60 * 1000;static final String WELL_NUMBER = SymbolConstant.WELL_NUMBER + SymbolConstant.LEFT_CURLY_BRACKET;/**** @param response* @param code* @param errorMsg*/public static void responseError(ServletResponse response, Integer code, String errorMsg) {HttpServletResponse httpServletResponse = (HttpServletResponse) response;// issues/I4YH95浏览器显示乱码问题httpServletResponse.setHeader("Content-type", "text/html;charset=UTF-8");Result jsonResult = new Result(code, errorMsg);jsonResult.setSuccess(false);OutputStream os = null;try {os = httpServletResponse.getOutputStream();httpServletResponse.setCharacterEncoding("UTF-8");httpServletResponse.setStatus(code);os.write(new ObjectMapper().writeValueAsString(jsonResult).getBytes("UTF-8"));os.flush();os.close();} catch (IOException e) {e.printStackTrace();}}/*** 校验token是否正确** @param token  密钥* @param secret 用户的密码* @return 是否正确*/public static boolean verify(String token, String username, String secret) {try {// 根据密码生成JWT效验器Algorithm algorithm = Algorithm.HMAC256(secret);JWTVerifier verifier = JWT.require(algorithm).withClaim("username", username).build();// 效验TOKENDecodedJWT jwt = verifier.verify(token);return true;} catch (Exception exception) {return false;}}/*** 获得token中的信息无需secret解密也能获得** @return token中包含的用户名*/public static String getUsername(String token) {try {DecodedJWT jwt = JWT.decode(token);return jwt.getClaim("username").asString();} catch (JWTDecodeException e) {return null;}}/*** 生成签名,5min后过期** @param username 用户名* @param secret   用户的密码* @return 加密的token*/public static String sign(String username, String secret) {Date date = new Date(System.currentTimeMillis() + EXPIRE_TIME);Algorithm algorithm = Algorithm.HMAC256(secret);// 附带username信息return JWT.create().withClaim("username", username).withExpiresAt(date).sign(algorithm);}/*** 根据request中的token获取用户账号* * @param request* @return* @throws JeecgBootException*/public static String getUserNameByToken(HttpServletRequest request) throws JeecgBootException {String accessToken = request.getHeader("X-Access-Token");String username = getUsername(accessToken);if (oConvertUtils.isEmpty(username)) {throw new JeecgBootException("未获取到用户");}return username;}/***  从session中获取变量* @param key* @return*/public static String getSessionData(String key) {//${myVar}%//得到${} 后面的值String moshi = "";String wellNumber = WELL_NUMBER;if(key.indexOf(SymbolConstant.RIGHT_CURLY_BRACKET)!=-1){moshi = key.substring(key.indexOf("}")+1);}String returnValue = null;if (key.contains(wellNumber)) {key = key.substring(2,key.indexOf("}"));}if (oConvertUtils.isNotEmpty(key)) {HttpSession session = SpringContextUtils.getHttpServletRequest().getSession();returnValue = (String) session.getAttribute(key);}//结果加上${} 后面的值if(returnValue!=null){returnValue = returnValue + moshi;}return returnValue;}/*** 从当前用户中获取变量* @param key* @param user* @return*/public static String getUserSystemData(String key,SysUserCacheInfo user) {if(user==null) {user = JeecgDataAutorUtils.loadUserInfo();}//#{sys_user_code}%// 获取登录用户信息LoginUser sysUser = (LoginUser) SecurityUtils.getSubject().getPrincipal();String moshi = "";String wellNumber = WELL_NUMBER;if(key.indexOf(SymbolConstant.RIGHT_CURLY_BRACKET)!=-1){moshi = key.substring(key.indexOf("}")+1);}String returnValue = null;//针对特殊标示处理#{sysOrgCode}，判断替换if (key.contains(wellNumber)) {key = key.substring(2,key.indexOf("}"));} else {key = key;}//替换为系统登录用户帐号if (key.equals(DataBaseConstant.SYS_USER_CODE)|| key.toLowerCase().equals(DataBaseConstant.SYS_USER_CODE_TABLE)) {if(user==null) {returnValue = sysUser.getUsername();}else {returnValue = user.getSysUserCode();}}//替换为系统登录用户真实名字else if (key.equals(DataBaseConstant.SYS_USER_NAME)|| key.toLowerCase().equals(DataBaseConstant.SYS_USER_NAME_TABLE)) {if(user==null) {returnValue = sysUser.getRealname();}else {returnValue = user.getSysUserName();}}//替换为系统用户登录所使用的机构编码else if (key.equals(DataBaseConstant.SYS_ORG_CODE)|| key.toLowerCase().equals(DataBaseConstant.SYS_ORG_CODE_TABLE)) {if(user==null) {returnValue = sysUser.getOrgCode();}else {returnValue = user.getSysOrgCode();}}//替换为系统用户所拥有的所有机构编码else if (key.equals(DataBaseConstant.SYS_MULTI_ORG_CODE)|| key.toLowerCase().equals(DataBaseConstant.SYS_MULTI_ORG_CODE_TABLE)) {if(user==null){//TODO 暂时使用用户登录部门，存在逻辑缺陷，不是用户所拥有的部门returnValue = sysUser.getOrgCode();}else{if(user.isOneDepart()) {returnValue = user.getSysMultiOrgCode().get(0);}else {returnValue = Joiner.on(",").join(user.getSysMultiOrgCode());}}}//替换为当前系统时间(年月日)else if (key.equals(DataBaseConstant.SYS_DATE)|| key.toLowerCase().equals(DataBaseConstant.SYS_DATE_TABLE)) {returnValue = DateUtils.formatDate();}//替换为当前系统时间（年月日时分秒）else if (key.equals(DataBaseConstant.SYS_TIME)|| key.toLowerCase().equals(DataBaseConstant.SYS_TIME_TABLE)) {returnValue = DateUtils.now();}//流程状态默认值（默认未发起）else if (key.equals(DataBaseConstant.BPM_STATUS)|| key.toLowerCase().equals(DataBaseConstant.BPM_STATUS_TABLE)) {returnValue = "1";}//update-begin-author:taoyan date:20210330 for:多租户ID作为系统变量else if (key.equals(TenantConstant.TENANT_ID) || key.toLowerCase().equals(TenantConstant.TENANT_ID_TABLE)){returnValue = SpringContextUtils.getHttpServletRequest().getHeader(CommonConstant.TENANT_ID);}//update-end-author:taoyan date:20210330 for:多租户ID作为系统变量if(returnValue!=null){returnValue = returnValue + moshi;}return returnValue;}//	public static void main(String[] args) {
//		 String token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NjUzMzY1MTMsInVzZXJuYW1lIjoiYWRtaW4ifQ.xjhud_tWCNYBOg_aRlMgOdlZoWFFKB_givNElHNw3X0";
//		 System.out.println(JwtUtil.getUsername(token));
//	}
}