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	cleanToken(String token, TokenUser user) Clean token the key in config.yaml
boolean	cleanToken(String token, TokenUser user, String key) Clean token used param key
Token	createToken(TokenUser user) Create a token full mode.
Token	createToken(TokenUser user, String tokenKey) Create a token simple mode.
private boolean	destoryToken(String token, Integer userId, String tokenKey) delete token
private Token	generateToken(String tokenKey, TokenUser user, boolean hasSimple) Create a token
io.jsonwebtoken.Claims	getClaimByToken(String token) Get claim by token
TokenUser	getUser() Get tokenUser from principal use shiro
TokenUser	getUser(String tokenKey, String token) Get tokenUser from token no use shiro
Integer	getUserIdByClaim(String token) get userId by claim
boolean	isTokenExpired(Date expiration) Check token expired
boolean	isTokenExpired(String token) check token expired.
private void	saveLoginInfo(String key, TokenUser user) set user login info, simple mode.
private void	saveLoginInfo(String key, TokenUser user, Set<String> userPermissionSet, Set<String> userRolesSet) set user login info, full mode. save user permissions roles into redis
private void	saveTokenInfo(String key, TokenUser user, String token) save token to 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 use shiro

返回:

current TokenUser

getUser

public TokenUser getUser(String tokenKey,
                         String token)

Get tokenUser from token no use shiro

参数:

tokenKey - tokenKey

token - token

返回:

tokenUser

createToken

public Token createToken(TokenUser user)

Create a token full mode. the key in config.yaml

参数:

user - TokenUser.

返回:

token.

createToken

public Token createToken(TokenUser user,
                         String tokenKey)

Create a token simple mode. used param key

参数:

user - TokenUser.

tokenKey - key.

返回:

token.

cleanToken

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

Clean token the key in config.yaml

参数:

token - token

user - user

返回:

result

抛出:

Exception

cleanToken

public boolean cleanToken(String token,
                          TokenUser user,
                          String key)
                   throws Exception

Clean token used param key

参数:

token - token

user - user

key - key

返回:

result

抛出:

Exception

getClaimByToken

public io.jsonwebtoken.Claims getClaimByToken(String token)

Get claim by token

参数:

token - token

返回:

claim

getUserIdByClaim

public Integer getUserIdByClaim(String token)

get userId by claim

参数:

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.

saveTokenInfo

private void saveTokenInfo(String key,
                           TokenUser user,
                           String token)

save token to redis

参数:

key - key

user - tokenUser

token - token

saveLoginInfo

private void saveLoginInfo(String key,
                           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

saveLoginInfo

private void saveLoginInfo(String key,
                           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 token,
                             Integer userId,
                             String tokenKey)
                      throws Exception

delete token

参数:

token - tokenString

userId - userId

tokenKey - tokenKey

返回:

boolean

抛出:

Exception