com.facecto.code.token.util

类 TokenUtils

java.lang.Object

com.facecto.code.token.util.TokenUtils

@Component
public class TokenUtils
extends Object

版本:

v1.1.0 (2021/08/08)

作者:

Jon So, https://cto.pub, https://github.com/facecto

字段概要

字段

限定符和类型	字段和说明
(专用程序包) org.springframework.data.redis.core.RedisTemplate	redisTemplate
private TokenProperties	tokenProperties

构造器概要

构造器

构造器和说明
TokenUtils()

方法概要

限定符和类型	方法和说明
boolean	clearToken(String token, TokenUser user) clean token full mode.
boolean	clearToken(String token, TokenUser user, String tokenKey) clean token simple mode.
Token	createToken(TokenUser user) create a token full mode.
Token	createToken(TokenUser user, String simpleTokenKey) create a token simple mode.
private boolean	destoryToken(String tokenKey, String token, Integer userId) clean token
private Token	generateToken(String tokenKey, TokenUser user, boolean hasSimple) create a token
io.jsonwebtoken.Claims	getClaimByToken(String token) getClaimByToken
TokenUser	getUser() get TokenUser from principal
Integer	getUserIdByClaim(String token) getUserIdByClaim
boolean	isTokenExpired(Date expiration) check token expired
boolean	isTokenExpired(String token) check token expired.
private void	setLoginInfo(TokenUser user) set user login info, simple mode.
private void	setLoginInfo(TokenUser user, Set<String> userPermissionSet, Set<String> userRolesSet) set user login info, full mode. save user permissions roles into redis

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

redisTemplate

@Autowired
org.springframework.data.redis.core.RedisTemplate redisTemplate

tokenProperties

@Autowired
private TokenProperties tokenProperties

构造器详细资料

TokenUtils

public TokenUtils()

方法详细资料

getUser

public TokenUser getUser()

get TokenUser from principal

返回:

current TokenUser

createToken

public Token createToken(TokenUser user)

create a token full mode.

参数:

user - TokenUser.

返回:

token.

createToken

public Token createToken(TokenUser user,
                         String simpleTokenKey)

create a token simple mode.

参数:

user - TokenUser.

simpleTokenKey - key.

返回:

token.

clearToken

public boolean clearToken(String token,
                          TokenUser user)
                   throws Exception

clean token full mode.

参数:

token - token

user - TokenUser

返回:

true or false

抛出:

Exception

clearToken

public boolean clearToken(String token,
                          TokenUser user,
                          String tokenKey)
                   throws Exception

clean token simple mode.

参数:

token - token

user - TokenUser

tokenKey - tokenKey.

返回:

result

抛出:

Exception

getClaimByToken

public io.jsonwebtoken.Claims getClaimByToken(String token)

getClaimByToken

参数:

token - token

返回:

claim

getUserIdByClaim

public Integer getUserIdByClaim(String token)

getUserIdByClaim

参数:

token - token

返回:

userId

isTokenExpired

public boolean isTokenExpired(Date expiration)

check token expired

返回:

true：has expired

isTokenExpired

public boolean isTokenExpired(String token)

check token expired.

参数:

token - token

返回:

true：has expired

generateToken

private Token generateToken(String tokenKey,
                            TokenUser user,
                            boolean hasSimple)

create a token

参数:

tokenKey - key

user - TokenUser

hasSimple - true or false

返回:

token.

setLoginInfo

private void setLoginInfo(TokenUser user,
                          Set<String> userPermissionSet,
                          Set<String> userRolesSet)

set user login info, full mode. save user permissions roles into redis

参数:

user - TokenUser

userPermissionSet - user permissions set

userRolesSet - user roles set

setLoginInfo

private void setLoginInfo(TokenUser user)

set user login info, simple mode. If you do not use shiro to verify permissions, you can use simple mode.

参数:

user - TokenUser

destoryToken

private boolean destoryToken(String tokenKey,
                             String token,
                             Integer userId)
                      throws Exception

clean token

参数:

tokenKey - key

token - token

userId - userId

返回:

boolean

抛出:

Exception