目錄
一、java后端
1、token構造實現類
①驗證碼方式實現類
②刷新token方式實現類
?2、token相關操作:setCookie
①createToken
②refreshToken
二、前端(vue3+axios)
????????web網站中,前后端交互時,通常使用token機制來做認證,token一般會設置有效期,當token過了有效期后,用戶需要重新登錄授權獲取新的token,但是某些業務場景下,用戶不希望頻繁的進行登錄授權,但是安全考慮,token的有效期不能設置太長時間,所以有了刷新token的設計,無感知刷新token的機制更進一步優化了用戶體驗,本文是博主實際業務項目中基于springboot和vue3無感知刷新token的代碼實戰。
首先介紹無感知刷新token的實現思路:
①首次授權頒發token時,我們通過后端給前端請求response中寫入兩種cookie
? ? ? ? - access_token
? ? ? ? - refresh_token(超時時間比access_token長一些)
需要注意:
????????-后端setCookie時httpOnly=true(限制cookie只能被http請求攜帶使用,不能被js操作)
? ? ? ? -前端axios請求參數withCredentials=true(http請求時,自動攜帶token)
②access_token失效時,拋出特殊異常,前后端約定http響應碼(401),此時觸發刷新token邏輯
③前段http請求鉤子中,如果出現http響應碼為401時,立即觸發刷新token邏輯,同時緩存后續請求,刷新token結束后,依次續發緩存中的請求
一、java后端
后端java框架使用springboot,spring-security
登錄接口:?
/*** @author lichenhao* @date 2023/2/8 17:41*/
@RestController
public class AuthController {/*** 登錄方法** @param loginBody 登錄信息* @return 結果*/@PostMapping("/oauth")public AjaxResult login(@RequestBody LoginBody loginBody) {ITokenGranter granter = TokenGranterBuilder.getGranter(loginBody.getGrantType());return granter.grant(loginBody);}
}import lombok.Data;/*** 用戶登錄對象** @author lichenhao*/
@Data
public class LoginBody {/*** 用戶名*/private String username;/*** 用戶密碼*/private String password;/*** 驗證碼*/private String code;/*** 唯一標識*/private String uuid;/** grantType 授權類型* */private String grantType;/** 是否直接強退該賬號登陸的其他客戶端* */private Boolean forceLogoutFlag;
}
token構造接口類和token實現類構造器如下:
/*** @author lichenhao* @date 2023/2/8 17:29* <p>* 獲取token*/
public interface ITokenGranter {AjaxResult grant(LoginBody loginBody);
}/*** @author lichenhao* @date 2023/2/8 17:29*/
@AllArgsConstructor
public class TokenGranterBuilder {/*** TokenGranter緩存池*/private static final Map<String, ITokenGranter> GRANTER_POOL = new ConcurrentHashMap<>();static {GRANTER_POOL.put(CaptchaTokenGranter.GRANT_TYPE, SpringUtils.getBean(CaptchaTokenGranter.class));GRANTER_POOL.put(RefreshTokenGranter.GRANT_TYPE, SpringUtils.getBean(RefreshTokenGranter.class));}/*** 獲取TokenGranter** @param grantType 授權類型* @return ITokenGranter*/public static ITokenGranter getGranter(String grantType) {ITokenGranter tokenGranter = GRANTER_POOL.get(StringUtils.toStr(grantType, PasswordTokenGranter.GRANT_TYPE));if (tokenGranter == null) {throw new ServiceException("no grantType was found");} else {return tokenGranter;}}}
這里通過LoginBody的grantType屬性,指定實際的token構造實現類;同時,需要有token
本文我們用到了驗證碼方式和刷新token方式,如下
1、token構造實現類
①驗證碼方式實現類
/*** @author lichenhao* @date 2023/2/8 17:32*/
@Component
public class CaptchaTokenGranter implements ITokenGranter {public static final String GRANT_TYPE = "captcha";@Autowiredprivate SysLoginService loginService;@Overridepublic AjaxResult grant(LoginBody loginBody) {String username = loginBody.getUsername();String code = loginBody.getCode();String password = loginBody.getPassword();String uuid = loginBody.getUuid();Boolean forceLogoutFlag = loginBody.getForceLogoutFlag();AjaxResult ajaxResult = validateLoginBody(username, password, code, uuid);// 驗證碼loginService.validateCaptcha(username, code, uuid);// 登錄loginService.login(username, password, uuid, forceLogoutFlag);// 刪除驗證碼loginService.deleteCaptcha(uuid);return ajaxResult;}private AjaxResult validateLoginBody(String username, String password, String code, String uuid) {if (StringUtils.isBlank(username)) {return AjaxResult.error("用戶名必填");}if (StringUtils.isBlank(password)) {return AjaxResult.error("密碼必填");}if (StringUtils.isBlank(code)) {return AjaxResult.error("驗證碼必填");}if (StringUtils.isBlank(uuid)) {return AjaxResult.error("uuid必填");}return AjaxResult.success();}
}/*** 登錄驗證** @param username 用戶名* @param password 密碼* @return 結果*/public void login(String username, String password, String uuid, Boolean forceLogoutFlag) {// 校驗basic authIClientDetails iClientDetails = tokenService.validBasicAuth();// 用戶驗證Authentication authentication = null;try {UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(username, password);AuthenticationContextHolder.setContext(authenticationToken);// 該方法會去調用UserDetailsServiceImpl.loadUserByUsernameauthentication = authenticationManager.authenticate(authenticationToken);} catch (Exception e) {if (e instanceof BadCredentialsException) {AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, MessageUtils.message("user.password.not.match")));throw new UserPasswordNotMatchException();} else {AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, e.getMessage()));throw new ServiceException(e.getMessage());}} finally {AuthenticationContextHolder.clearContext();}LoginUser loginUser = (LoginUser) authentication.getPrincipal();tokenService.setUserAgent(loginUser);Long customerId = loginUser.getUser().getCustomerId();Boolean singleClientFlag = SystemConfig.isSingleClientFlag();if(customerId != null){Customer customer = customerService.selectCustomerById(customerId);singleClientFlag = customer.getSingleClientFlag();log.info(String.format("客戶【%s】單賬號登錄限制開關:%s", customer.getCode(), singleClientFlag));}if(singleClientFlag){List<SysUserOnline> userOnlineList = userOnlineService.getUserOnlineList(null, username);if(CollectionUtils.isNotEmpty(userOnlineList)){if(forceLogoutFlag != null && forceLogoutFlag){// 踢掉其他使用該賬號登陸的客戶端userOnlineService.forceLogoutBySysUserOnlineList(userOnlineList);}else{throw new ServiceException("【" + username + "】已登錄,是否仍然登陸", 400);}}}// 生成tokentokenService.createToken(iClientDetails, loginUser, uuid);AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_SUCCESS, MessageUtils.message("user.login.success")));recordLoginInfo(loginUser.getUserId());}
②刷新token方式實現類
/*** @author lichenhao* @date 2023/2/8 17:35*/
@Component
public class RefreshTokenGranter implements ITokenGranter {public static final String GRANT_TYPE = "refresh_token";@Autowiredprivate TokenService tokenService;@Overridepublic AjaxResult grant(LoginBody loginBody) {tokenService.refreshToken();return AjaxResult.success();}
}
?2、token相關操作:setCookie
①createToken
/*** 創建令牌* 注意:access_token和refresh_token 使用同一個tokenId*/public void createToken(IClientDetails clientDetails, LoginUser loginUser, String tokenId) {if(loginUser == null){throw new ForbiddenException("用戶信息無效,請重新登陸!");}loginUser.setTokenId(tokenId);String username = loginUser.getUsername();String clientId = clientDetails.getClientId();// 設置jwt要攜帶的用戶信息Map<String, Object> claimsMap = new HashMap<>();initClaimsMap(claimsMap, loginUser);long nowMillis = System.currentTimeMillis();Date now = new Date(nowMillis);int accessTokenValidity = clientDetails.getAccessTokenValidity();long accessTokenExpMillis = nowMillis + accessTokenValidity * MILLIS_SECOND;Date accessTokenExpDate = new Date(accessTokenExpMillis);String accessToken = createJwtToken(SecureConstant.ACCESS_TOKEN, accessTokenExpDate, now, JWT_TOKEN_SECRET, claimsMap, clientId, tokenId, username);int refreshTokenValidity = clientDetails.getRefreshTokenValidity();long refreshTokenExpMillis = nowMillis + refreshTokenValidity * MILLIS_SECOND;Date refreshTokenExpDate = new Date(refreshTokenExpMillis);String refreshToken = createJwtToken(SecureConstant.REFRESH_TOKEN, refreshTokenExpDate, now, JWT_REFRESH_TOKEN_SECRET, claimsMap, clientId, tokenId, username);// 寫入cookie中HttpServletResponse response = ServletUtils.getResponse();WebUtil.setCookie(response, SecureConstant.ACCESS_TOKEN, accessToken, accessTokenValidity);WebUtil.setCookie(response, SecureConstant.REFRESH_TOKEN, refreshToken, refreshTokenValidity);//插入緩存(過期時間為最長過期時間=refresh_token的過期時間 理論上,保持操作的情況下,一直會被刷新)loginUser.setLoginTime(nowMillis);loginUser.setExpireTime(refreshTokenExpMillis);updateUserCache(loginUser);}private void initClaimsMap(Map<String, Object> claims, LoginUser loginUser) {// 添加jwt自定義參數}/*** 生成jwt token** @param jwtTokenType token類型:access_token、refresh_token* @param expDate token過期日期* @param now 當前日期* @param signKey 簽名key* @param claimsMap jwt自定義信息(可攜帶額外的用戶信息)* @param clientId 應用id* @param tokenId token的唯一標識(建議同一組 access_token、refresh_token 使用一個)* @param subject jwt下發的用戶標識* @return token字符串*/private String createJwtToken(String jwtTokenType, Date expDate, Date now, String signKey, Map<String, Object> claimsMap, String clientId, String tokenId, String subject) {JwtBuilder jwtBuilder = Jwts.builder().setHeaderParam("typ", "JWT").setId(tokenId).setSubject(subject).signWith(SignatureAlgorithm.HS512, signKey);//設置JWT參數(user維度)claimsMap.forEach(jwtBuilder::claim);//設置應用idjwtBuilder.claim(SecureConstant.CLAIMS_CLIENT_ID, clientId);//設置token typejwtBuilder.claim(SecureConstant.CLAIMS_TOKEN_TYPE, jwtTokenType);//添加Token過期時間jwtBuilder.setExpiration(expDate).setNotBefore(now);return jwtBuilder.compact();}/** 更新緩存中的用戶信息* */public void updateUserCache(LoginUser loginUser) {// 根據tokenId將loginUser緩存String userKey = getTokenKey(loginUser.getTokenId());redisService.setCacheObject(userKey, loginUser, parseIntByLong(loginUser.getExpireTime() - loginUser.getLoginTime()), TimeUnit.MILLISECONDS);}private String getTokenKey(String uuid) {return "login_tokens:" + uuid;}
②refreshToken
/*** 刷新令牌有效期*/public void refreshToken() {// 從cookie中拿到refreshTokenString refreshToken = WebUtil.getCookieVal(ServletUtils.getRequest(), SecureConstant.REFRESH_TOKEN);if (StringUtils.isBlank(refreshToken)) {throw new ForbiddenException("認證失敗!");}// 驗證 refreshToken 是否有效Claims claims = parseToken(refreshToken, JWT_REFRESH_TOKEN_SECRET);if (claims == null) {throw new ForbiddenException("認證失敗!");}String clientId = StringUtils.toStr(claims.get(SecureConstant.CLAIMS_CLIENT_ID));String tokenId = claims.getId();LoginUser loginUser = getLoginUserByTokenId(tokenId);if(loginUser == null){throw new ForbiddenException("用戶信息無效,請重新登陸!");}IClientDetails clientDetails = getClientDetailsService().loadClientByClientId(clientId);// 刪除原token緩存delLoginUserCache(tokenId);// 重新生成tokencreateToken(clientDetails, loginUser, IdUtils.simpleUUID());}/*** 根據tokenId獲取用戶信息** @return 用戶信息*/public LoginUser getLoginUserByTokenId(String tokenId) {String userKey = getTokenKey(tokenId);LoginUser user = redisService.getCacheObject(userKey);return user;}/*** 刪除用戶緩存*/public void delLoginUserCache(String tokenId) {if (StringUtils.isNotEmpty(tokenId)) {String userKey = getTokenKey(tokenId);redisService.deleteObject(userKey);}}
③異常碼
?401:access_token無效,開始刷新token邏輯
403:refresh_token無效,或者其他需要跳轉登錄頁面的場景
二、前端(vue3+axios)
// 創建axios實例
const service = axios.create({// axios中請求配置有baseURL選項,表示請求URL公共部分baseURL: import.meta.env.VITE_APP_BASE_API,// 超時timeout: 120000,withCredentials: true
})// request攔截器
service.interceptors.request.use(config => {// do somethingreturn config
}, error => {})// 響應攔截器
service.interceptors.response.use(res => {loadingInstance?.close()loadingInstance = null// 未設置狀態碼則默認成功狀態const code = res.data.code || 200;// 獲取錯誤信息const msg = errorCode[code] || res.data.msg || errorCode['default']if (code === 500) {ElMessage({message: msg, type: 'error'})return Promise.reject(new Error(msg))} else if (code === 401) {return refreshFun(res.config);} else if (code === 601) {ElMessage({message: msg, type: 'warning'})return Promise.reject(new Error(msg))} else if (code == 400) {// 需要用戶confirm是否強制登陸return Promise.resolve(res.data)} else if (code !== 200) {ElNotification.error({title: msg})return Promise.reject('error')} else {return Promise.resolve(res.request.responseType === 'blob' ? res : res.data)}},error => {loadingInstance?.close()loadingInstance = nullif (error.response.status == 401) {return refreshFun(error.config);}let {message} = error;if (message == "Network Error") {message = "后端接口連接異常";} else if (message.includes("timeout")) {message = "系統接口請求超時";} else {message = error.response.data ? error.response.data.msg : 'message'}ElMessage({message: message, type: 'error', duration: 5 * 1000})return Promise.reject(error)}
)// 正在刷新標識,避免重復刷新
let refreshing = false;
// 請求等待隊列
let waitQueue = [];function refreshFun(config) {if (refreshing == false) {refreshing = true;return useUserStore().refreshToken().then(() => {waitQueue.forEach(callback => callback()); // 已成功刷新token,隊列中的所有請求重試waitQueue = [];refreshing = false;return service(config)}).catch((err) => {waitQueue = [];refreshing = false;if (err.response) {if (err.response.status === 403) {ElMessageBox.confirm('登錄狀態已過期(認證失敗),您可以繼續留在該頁面,或者重新登錄', '系統提示', {confirmButtonText: '重新登錄',cancelButtonText: '取消',type: 'warning'}).then(() => {useUserStore().logoutClear();router.push(`/login`);}).catch(() => {});return Promise.reject()} else {console.log('err:' + (err.response && err.response.data.msg) ? err.response.data.msg : err)}} else {ElMessage({message: err.message,type: 'error',duration: 5 * 1000})}})} else {// 正在刷新token,返回未執行resolve的Promise,刷新token執行回調return new Promise((resolve => {waitQueue.push(() => {resolve(service(config))})}))}
}