优化源码注释,更符合语义

This commit is contained in:
click33
2022-04-23 17:26:48 +08:00
parent 2c39fc7209
commit 210b92f3dc
25 changed files with 130 additions and 106 deletions

View File

@@ -11,7 +11,7 @@ import cn.dev33.satoken.stp.StpLogic;
import cn.dev33.satoken.stp.StpUtil;
/**
* Sa-Token 权限认证工具类 (User版)
* Sa-Token 权限认证工具类 (user版)
* @author kong
*/
public class StpUserUtil {
@@ -110,9 +110,9 @@ public class StpUserUtil {
}
/**
* 会话登录,并指定登录设备
* 会话登录,并指定登录设备类型
* @param id 账号id建议的类型long | int | String
* @param device 设备标识
* @param device 设备类型
*/
public static void login(Object id, String device) {
stpLogic.login(id, device);
@@ -173,10 +173,10 @@ public class StpUserUtil {
}
/**
* 会话注销根据账号id 和 设备标识
* 会话注销根据账号id 和 设备类型
*
* @param loginId 账号id
* @param device 设备标识 (填null代表所有注销设备)
* @param device 设备类型 (填null代表注销所有设备类型)
*/
public static void logout(Object loginId, String device) {
stpLogic.logout(loginId, device);
@@ -202,11 +202,11 @@ public class StpUserUtil {
}
/**
* 踢人下线根据账号id 和 设备标识
* 踢人下线根据账号id 和 设备类型
* <p> 当对方再次访问系统时会抛出NotLoginException异常场景值=-5 </p>
*
* @param loginId 账号id
* @param device 设备标识 (填null代表踢出所有设备)
* @param device 设备类型 (填null代表踢出所有设备类型)
*/
public static void kickout(Object loginId, String device) {
stpLogic.kickout(loginId, device);
@@ -223,11 +223,11 @@ public class StpUserUtil {
}
/**
* 顶人下线根据账号id 和 设备标识
* 顶人下线根据账号id 和 设备类型
* <p> 当对方再次访问系统时会抛出NotLoginException异常场景值=-4 </p>
*
* @param loginId 账号id
* @param device 设备标识 (填null代表顶替所有设备)
* @param device 设备类型 (填null代表顶替所有设备类型)
*/
public static void replaced(Object loginId, String device) {
stpLogic.replaced(loginId, device);
@@ -309,7 +309,16 @@ public class StpUserUtil {
public static Object getLoginIdByToken(String tokenValue) {
return stpLogic.getLoginIdByToken(tokenValue);
}
/**
* 获取Token扩展信息只在jwt模式下有效
* @param key 键值
* @return 对应的扩展数据
*/
public static Object getExtra(String key) {
return stpLogic.getExtra(key);
}
// =================== User-Session 相关 ===================
@@ -390,7 +399,7 @@ public class StpUserUtil {
/**
* 续签当前token(将 [最后操作时间] 更新为当前时间戳)
* <h1>请注意: 即token已经 [临时过期] 也可续签成功,
* <h1>请注意: 即使token已经 [临时过期] 也可续签成功,
* 如果此场景下需要提示续签失败,可在此之前调用 checkActivityTimeout() 强制检查是否过期即可 </h1>
*/
public static void updateLastActivityToNow() {
@@ -431,8 +440,23 @@ public class StpUserUtil {
public static long getTokenActivityTimeout() {
return stpLogic.getTokenActivityTimeout();
}
/**
* 对当前 Token 的 timeout 值进行续期
* @param timeout 要修改成为的有效时间 (单位: 秒)
*/
public static void renewTimeout(long timeout) {
stpLogic.renewTimeout(timeout);
}
/**
* 对指定 Token 的 timeout 值进行续期
* @param tokenValue 指定token
* @param timeout 要修改成为的有效时间 (单位: 秒)
*/
public static void renewTimeout(String tokenValue, long timeout) {
stpLogic.renewTimeout(tokenValue, timeout);
}
// =================== 角色验证操作 ===================
@@ -610,11 +634,11 @@ public class StpUserUtil {
}
/**
* 获取指定账号id指定设备端的tokenValue
* 获取指定账号id指定设备类型端的tokenValue
* <p> 在配置为允许并发登录时此方法只会返回队列的最后一个token
* 如果你需要返回此账号id的所有token请调用 getTokenValueListByLoginId
* @param loginId 账号id
* @param device 设备标识
* @param device 设备类型
* @return token值
*/
public static String getTokenValueByLoginId(Object loginId, String device) {
@@ -631,9 +655,9 @@ public class StpUserUtil {
}
/**
* 获取指定账号id指定设备端的tokenValue 集合
* 获取指定账号id指定设备类型端的tokenValue 集合
* @param loginId 账号id
* @param device 设备标识
* @param device 设备类型
* @return 此loginId的所有相关token
*/
public static List<String> getTokenValueListByLoginId(Object loginId, String device) {
@@ -641,8 +665,8 @@ public class StpUserUtil {
}
/**
* 返回当前会话的登录设备
* @return 当前令牌的登录设备
* 返回当前会话的登录设备类型
* @return 当前令牌的登录设备类型
*/
public static String getLoginDevice() {
return stpLogic.getLoginDevice();
@@ -827,9 +851,9 @@ public class StpUserUtil {
/**
* <h1> 本函数设计已过时,未来版本可能移除此函数,请及时更换为 StpUtil.login() ,使用方式保持不变 </h1>
*
* 在当前会话上登录id, 并指定登录设备
* 在当前会话上登录id, 并指定登录设备类型
* @param loginId 登录id建议的类型long | int | String
* @param device 设备标识
* @param device 设备类型
*/
@Deprecated
public static void setLoginId(Object loginId, String device) {
@@ -839,7 +863,7 @@ public class StpUserUtil {
/**
* <h1> 本函数设计已过时,未来版本可能移除此函数,请及时更换为 StpUtil.login() ,使用方式保持不变 </h1>
*
* 在当前会话上登录id, 并指定登录设备
* 在当前会话上登录id, 并指定登录设备类型
* @param loginId 登录id建议的类型long | int | String
* @param isLastingCookie 是否为持久Cookie
*/
@@ -875,10 +899,10 @@ public class StpUserUtil {
/**
* <h1> 本函数设计已过时,未来版本可能移除此函数,请及时更换为 StpUtil.kickout() ,使用方式保持不变 </h1>
*
* 会话注销根据账号id and 设备标识 (踢人下线)
* 会话注销根据账号id and 设备类型 (踢人下线)
* <p> 当对方再次访问系统时会抛出NotLoginException异常场景值=-2 </p>
* @param loginId 账号id
* @param device 设备标识 (填null代表所有注销设备)
* @param device 设备类型 (填null代表注销所有设备类型)
*/
@Deprecated
public static void logoutByLoginId(Object loginId, String device) {