lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2026-02-27 16:50:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

2
sa-token-core/src/main/java/cn/dev33/satoken/session/SaSession.java
View File

@@ -154,7 +154,7 @@ public class SaSession implements Serializable {
* 添加一个token签名
*
* @param tokenValue token值
* @param device 设备标识
* @param device 设备类型
*/
public void addTokenSign(String tokenValue, String device) {
addTokenSign(new TokenSign(tokenValue, device));

6
sa-token-core/src/main/java/cn/dev33/satoken/session/TokenSign.java
View File

@@ -23,7 +23,7 @@ public class TokenSign implements Serializable {
private String value;
/**
* 所在设备标识
* 所属设备类型
*/
private String device;
@@ -35,7 +35,7 @@ public class TokenSign implements Serializable {
* 构建一个
*
* @param value token值
* @param device 所在设备标识
* @param device 所属设备类型
*/
public TokenSign(String value, String device) {
this.value = value;
@@ -50,7 +50,7 @@ public class TokenSign implements Serializable {
}
/**
* @return token登录设备
* @return 所属设备类型
*/
public String getDevice() {
return device;

2
sa-token-core/src/main/java/cn/dev33/satoken/stp/SaLoginConfig.java
View File

@@ -12,7 +12,7 @@ import java.util.Map;
public class SaLoginConfig {
/**
* @param device 此次登录的客户端设备标识
* @param device 此次登录的客户端设备类型
* @return SaLoginModel配置对象
*/
public static SaLoginModel setDevice(String device) {

6
sa-token-core/src/main/java/cn/dev33/satoken/stp/SaLoginModel.java
View File

@@ -16,7 +16,7 @@ import cn.dev33.satoken.util.SaTokenConsts;
public class SaLoginModel {
/**
* 此次登录的客户端设备标识
* 此次登录的客户端设备类型
*/
public String device;
@@ -42,14 +42,14 @@ public class SaLoginModel {
/**
* @return 此次登录的客户端设备标识
* @return 此次登录的客户端设备类型
*/
public String getDevice() {
return device;
}
/**
* @param device 此次登录的客户端设备标识
* @param device 此次登录的客户端设备类型
* @return 对象自身
*/
public SaLoginModel setDevice(String device) {

6
sa-token-core/src/main/java/cn/dev33/satoken/stp/SaTokenInfo.java
View File

@@ -35,7 +35,7 @@ public class SaTokenInfo {
/** token剩余无操作有效时间 (单位: 秒) */
public long tokenActivityTimeout;
/** 登录设备标识 */
/** 登录设备类型 */
public String loginDevice;
/** 自定义数据 */
@@ -170,14 +170,14 @@ public class SaTokenInfo {
}
/**
* @return 登录设备标识
* @return 登录设备类型
*/
public String getLoginDevice() {
return loginDevice;
}
/**
* @param loginDevice 登录设备标识
* @param loginDevice 登录设备类型
*/
public void setLoginDevice(String loginDevice) {
this.loginDevice = loginDevice;

38
sa-token-core/src/main/java/cn/dev33/satoken/stp/StpLogic.java
View File

@@ -84,7 +84,7 @@ public class StpLogic {
/**
* 创建一个TokenValue
* @param loginId loginId
* @param device 设备标识
* @param device 设备类型
* @param timeout 过期时间
* @param extraData 扩展信息
* @return 生成的tokenValue
@@ -251,9 +251,9 @@ public class StpLogic {
}
/**
* 会话登录，并指定登录设备
* 会话登录，并指定登录设备类型
* @param id 账号id，建议的类型：（long | int | String）
* @param device 设备标识
* @param device 设备类型
*/
public void login(Object id, String device) {
login(id, new SaLoginModel().setDevice(device));
@@ -385,10 +385,10 @@ public class StpLogic {
}
/**
* 会话注销，根据账号id 和 设备标识
* 会话注销，根据账号id 和 设备类型
*
* @param loginId 账号id
* @param device 设备标识 (填null代表所有注销设备)
* @param device 设备类型 (填null代表注销所有设备类型)
*/
public void logout(Object loginId, String device) {
clearTokenCommonMethod(loginId, device, tokenValue -> {
@@ -444,11 +444,11 @@ public class StpLogic {
}
/**
* 踢人下线，根据账号id 和 设备标识
* 踢人下线，根据账号id 和 设备类型
* <p> 当对方再次访问系统时，会抛出NotLoginException异常，场景值=-5 </p>
*
* @param loginId 账号id
* @param device 设备标识 (填null代表踢出所有设备)
* @param device 设备类型 (填null代表踢出所有设备类型)
*/
public void kickout(Object loginId, String device) {
clearTokenCommonMethod(loginId, device, tokenValue -> {
@@ -491,11 +491,11 @@ public class StpLogic {
}
/**
* 顶人下线，根据账号id 和 设备标识
* 顶人下线，根据账号id 和 设备类型
* <p> 当对方再次访问系统时，会抛出NotLoginException异常，场景值=-4 </p>
*
* @param loginId 账号id
* @param device 设备标识 (填null代表顶替所有设备)
* @param device 设备类型 (填null代表顶替所有设备类型)
*/
public void replaced(Object loginId, String device) {
clearTokenCommonMethod(loginId, device, tokenValue -> {
@@ -508,7 +508,7 @@ public class StpLogic {
/**
* 封装 注销、踢人、顶人 三个动作的相同代码（无API含义方法）
* @param loginId 账号id
* @param device 设备标识
* @param device 设备类型
* @param appendFun 追加操作
* @param isLogoutSession 是否注销 User-Session
*/
@@ -1347,11 +1347,11 @@ public class StpLogic {
}
/**
* 获取指定账号id指定设备端的tokenValue
* 获取指定账号id指定设备类型端的tokenValue
* <p> 在配置为允许并发登录时，此方法只会返回队列的最后一个token，
* 如果你需要返回此账号id的所有token，请调用 getTokenValueListByLoginId
* @param loginId 账号id
* @param device 设备标识，填null代表不限设备
* @param device 设备类型，填null代表不限设备类型
* @return token值
*/
public String getTokenValueByLoginId(Object loginId, String device) {
@@ -1369,9 +1369,9 @@ public class StpLogic {
}
/**
* 获取指定账号id指定设备端的tokenValue 集合
* 获取指定账号id指定设备类型端的tokenValue 集合
* @param loginId 账号id
* @param device 设备标识，填null代表不限设备
* @param device 设备类型，填null代表不限设备类型
* @return 此loginId的所有相关token
*/
public List<String> getTokenValueListByLoginId(Object loginId, String device) {
@@ -1392,8 +1392,8 @@ public class StpLogic {
}
/**
* 返回当前会话的登录设备
* @return 当前令牌的登录设备
* 返回当前会话的登录设备类型
* @return 当前令牌的登录设备类型
*/
public String getLoginDevice() {
// 如果没有token，直接返回 null
@@ -1799,10 +1799,10 @@ public class StpLogic {
/**
* <h1> 本函数设计已过时，未来版本可能移除此函数，请及时更换为 StpUtil.kickout(id) ，使用方式保持不变 </h1>
*
* 会话注销，根据账号id and 设备标识 （踢人下线）
* 会话注销，根据账号id and 设备类型 （踢人下线）
* <p> 当对方再次访问系统时，会抛出NotLoginException异常，场景值=-2 </p>
* @param loginId 账号id
* @param device 设备标识 (填null代表所有注销设备)
* @param device 设备类型 (填null代表注销所有设备类型)
*/
@Deprecated
public void logoutByLoginId(Object loginId, String device) {
@@ -1812,7 +1812,7 @@ public class StpLogic {
/**
* 创建一个TokenValue
* @param loginId loginId
* @param device 设备标识
* @param device 设备类型
* @param timeout 过期时间
* @return 生成的tokenValue
*/

38
sa-token-core/src/main/java/cn/dev33/satoken/stp/StpUtil.java
View File

@@ -106,9 +106,9 @@ public class StpUtil {
}
/**
* 会话登录，并指定登录设备
* 会话登录，并指定登录设备类型
* @param id 账号id，建议的类型：（long | int | String）
* @param device 设备标识
* @param device 设备类型
*/
public static void login(Object id, String device) {
stpLogic.login(id, device);
@@ -169,10 +169,10 @@ public class StpUtil {
}
/**
* 会话注销，根据账号id 和 设备标识
* 会话注销，根据账号id 和 设备类型
*
* @param loginId 账号id
* @param device 设备标识 (填null代表所有注销设备)
* @param device 设备类型 (填null代表注销所有设备类型)
*/
public static void logout(Object loginId, String device) {
stpLogic.logout(loginId, device);
@@ -198,11 +198,11 @@ public class StpUtil {
}
/**
* 踢人下线，根据账号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);
@@ -219,11 +219,11 @@ public class StpUtil {
}
/**
* 顶人下线，根据账号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);
@@ -630,11 +630,11 @@ public class StpUtil {
}
/**
* 获取指定账号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) {
@@ -651,9 +651,9 @@ public class StpUtil {
}
/**
* 获取指定账号id指定设备端的tokenValue 集合
* 获取指定账号id指定设备类型端的tokenValue 集合
* @param loginId 账号id
* @param device 设备标识
* @param device 设备类型
* @return 此loginId的所有相关token
*/
public static List<String> getTokenValueListByLoginId(Object loginId, String device) {
@@ -661,8 +661,8 @@ public class StpUtil {
}
/**
* 返回当前会话的登录设备
* @return 当前令牌的登录设备
* 返回当前会话的登录设备类型
* @return 当前令牌的登录设备类型
*/
public static String getLoginDevice() {
return stpLogic.getLoginDevice();
@@ -847,9 +847,9 @@ public class StpUtil {
/**
* <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) {
@@ -859,7 +859,7 @@ public class StpUtil {
/**
* <h1> 本函数设计已过时，未来版本可能移除此函数，请及时更换为 StpUtil.login() ，使用方式保持不变 </h1>
*
* 在当前会话上登录id, 并指定登录设备
* 在当前会话上登录id, 并指定登录设备类型
* @param loginId 登录id，建议的类型：（long | int | String）
* @param isLastingCookie 是否为持久Cookie
*/
@@ -895,10 +895,10 @@ public class StpUtil {
/**
* <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) {

2
sa-token-core/src/main/java/cn/dev33/satoken/util/SaTokenConsts.java
View File

@@ -43,7 +43,7 @@ public class SaTokenConsts {
public static final String TOKEN_ACTIVITY_TIMEOUT_CHECKED_KEY = "TOKEN_ACTIVITY_TIMEOUT_CHECKED_KEY_";
/**
* 常量key标记: 在登录时，默认使用的设备名称
* 常量key标记: 在登录时，默认使用的设备类型
*/
public static final String DEFAULT_LOGIN_DEVICE = "default-device";