From 47e6806c217c2d2f778e0004cc898b5f9a38bc4a Mon Sep 17 00:00:00 2001 From: click33 <2393584716@qq.com> Date: Sat, 30 Jul 2022 07:06:21 +0800 Subject: [PATCH] =?UTF-8?q?=E6=95=B4=E7=90=86=E4=BB=A3=E7=A0=81=E6=B3=A8?= =?UTF-8?q?=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../cn/dev33/satoken/session/SaSession.java | 93 +++++++++----- .../cn/dev33/satoken/session/TokenSign.java | 121 ++++++++++-------- 2 files changed, 123 insertions(+), 91 deletions(-) diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSession.java b/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSession.java index 865482e1..5f25f1d0 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSession.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSession.java @@ -21,6 +21,9 @@ import cn.dev33.satoken.util.SaFoxUtil; */ public class SaSession implements Serializable { + /** + * + */ private static final long serialVersionUID = 1L; /** @@ -33,30 +36,30 @@ public class SaSession implements Serializable { */ public static final String PERMISSION_LIST = "PERMISSION_LIST"; - /** 此Session的id */ + /** 此 Session 的 id */ private String id; - /** 此Session的创建时间 */ + /** 此 Session 的创建时间（时间戳） */ private long createTime; - /** 此Session的所有挂载数据 */ + /** 此 Session 的所有挂载数据 */ private final Map dataMap = new ConcurrentHashMap<>(); // ----------------------- 构建相关 /** - * 构建一个Session对象 + * 构建一个 Session 对象 */ public SaSession() { /* - * 当Session从Redis中反序列化取出时，框架会误以为创建了新的Session， + * 当 Session 从 Redis 中反序列化取出时，框架会误以为创建了新的Session， * 因此此处不可以调用this(null); 避免监听器收到错误的通知 */ // this(null); } /** - * 构建一个Session对象 + * 构建一个 Session 对象 * @param id Session的id */ public SaSession(String id) { @@ -67,15 +70,15 @@ public class SaSession implements Serializable { } /** - * 获取此Session的id - * @return 此会话的id + * 获取此 Session 的 id + * @return 此 Session 的id */ public String getId() { return id; } /** - * 写入此Session的id + * 写入此 Session 的 id * @param id SessionId * @return 对象自身 */ @@ -85,7 +88,7 @@ public class SaSession implements Serializable { } /** - * 返回当前会话创建时间 + * 返回当前会话创建时间（时间戳） * @return 时间戳 */ public long getCreateTime() { @@ -93,7 +96,7 @@ public class SaSession implements Serializable { } /** - * 写入此Session的创建时间 + * 写入此 Session 的创建时间（时间戳） * @param createTime 时间戳 * @return 对象自身 */ @@ -103,31 +106,32 @@ public class SaSession implements Serializable { } - // ----------------------- TokenSign相关 + // ----------------------- TokenSign 相关 /** - * 此Session绑定的token签名列表 + * 此 Session 绑定的 Token 签名列表 */ private Vector tokenSignList = new Vector<>(); /** - * 设置此Session绑定的token签名列表-反序列化需要 + * 写入此 Session 绑定的 Token 签名列表 + * @param tokenSignList Token 签名列表 */ public void setTokenSignList(Vector tokenSignList) { this.tokenSignList = tokenSignList; } /** - * 此Session绑定的token签名列表 + * 获取此 Session 绑定的 Token 签名列表 * - * @return token签名列表 + * @return Token 签名列表 */ public List getTokenSignList() { return tokenSignList; } /** - * 返回token签名列表的拷贝副本 + * 获取 Token 签名列表 的拷贝副本 * * @return token签名列表 */ @@ -136,15 +140,20 @@ public class SaSession implements Serializable { } /** - * 返回token签名列表的拷贝副本，根据 device 筛选 + * 返回 Token 签名列表 的拷贝副本，根据 device 筛选 * * @param device 设备类型，填 null 代表不限设备类型 * @return token签名列表 */ public List tokenSignListCopyByDevice(String device) { + // 返回全部 + if(device == null) { + return tokenSignListCopy(); + } + // 返回筛选后的 List list = new ArrayList<>(); for (TokenSign tokenSign : tokenSignListCopy()) { - if(device == null || tokenSign.getDevice().equals(device)) { + if(tokenSign.getDevice().equals(device)) { list.add(tokenSign); } } @@ -152,10 +161,10 @@ public class SaSession implements Serializable { } /** - * 查找一个token签名 + * 查找一个 Token 签名 * * @param tokenValue token值 - * @return 查找到的tokenSign + * @return 查找到的 TokenSign */ public TokenSign getTokenSign(String tokenValue) { for (TokenSign tokenSign : tokenSignListCopy()) { @@ -167,16 +176,14 @@ public class SaSession implements Serializable { } /** - * 添加一个token签名 + * 添加一个 Token 签名 * - * @param tokenSign token签名 + * @param tokenSign Token 签名 */ public void addTokenSign(TokenSign tokenSign) { - // 如果已经存在于列表中，则无需再次添加 - for (TokenSign tokenSign2 : tokenSignListCopy()) { - if (tokenSign2.getValue().equals(tokenSign.getValue())) { - return; - } + // 如果已经存在于列表中，则无需再次添加 + if(getTokenSign(tokenSign.getValue()) != null) { + return; } // 添加并更新 tokenSignList.add(tokenSign); @@ -184,7 +191,7 @@ public class SaSession implements Serializable { } /** - * 添加一个token签名 + * 添加一个 Token 签名 * * @param tokenValue token值 * @param device 设备类型 @@ -194,9 +201,9 @@ public class SaSession implements Serializable { } /** - * 移除一个token签名 + * 移除一个 Token 签名 * - * @param tokenValue token名称 + * @param tokenValue token值 */ public void removeTokenSign(String tokenValue) { TokenSign tokenSign = getTokenSign(tokenValue); @@ -246,7 +253,7 @@ public class SaSession implements Serializable { } /** - * 修改此Session的最小剩余存活时间 (只有在Session的过期时间低于指定的minTimeout时才会进行修改) + * 修改此Session的最小剩余存活时间 (只有在 Session 的过期时间低于指定的 minTimeout 时才会进行修改) * @param minTimeout 过期时间 (单位: 秒) */ public void updateMinTimeout(long minTimeout) { @@ -258,7 +265,7 @@ public class SaSession implements Serializable { } /** - * 修改此Session的最大剩余存活时间 (只有在Session的过期时间高于指定的maxTimeout时才会进行修改) + * 修改此Session的最大剩余存活时间 (只有在 Session 的过期时间高于指定的 maxTimeout 时才会进行修改) * @param maxTimeout 过期时间 (单位: 秒) */ public void updateMaxTimeout(long maxTimeout) { @@ -420,12 +427,12 @@ public class SaSession implements Serializable { } /** - * 写值(只有在此key原本无值的时候才会写入) + * 写值 (只有在此 key 原本无值的情况下才会写入) * @param key 名称 * @param value 值 * @return 对象自身 */ - public SaSession setDefaultValue(String key, Object value) { + public SaSession setByNull(String key, Object value) { if(has(key) == false) { dataMap.put(key, value); update(); @@ -604,4 +611,20 @@ public class SaSession implements Serializable { return dataMap.keySet(); } + /** + *

此函数设计已过时，未来版本可能移除此类，请及时更换为: session.setByNull()，用法保持不变

+ * 写值(只有在此key原本无值的时候才会写入) + * @param key 名称 + * @param value 值 + * @return 对象自身 + */ + @Deprecated + public SaSession setDefaultValue(String key, Object value) { + if(has(key) == false) { + dataMap.put(key, value); + update(); + } + return this; + } + } diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/session/TokenSign.java b/sa-token-core/src/main/java/cn/dev33/satoken/session/TokenSign.java index 4d65a980..298ee942 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/session/TokenSign.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/session/TokenSign.java @@ -5,75 +5,84 @@ import java.io.Serializable; /** * Token 签名 Model *

- * 挂在到SaSession上的token签名 + * 挂在到 SaSession 上的 Token 签名 * * @author kong */ public class TokenSign implements Serializable { - /** - * - */ - private static final long serialVersionUID = 1406115065849845073L; + /** + * + */ + private static final long serialVersionUID = 1406115065849845073L; - /** - * token值 - */ - private String value; + /** + * Token 值 + */ + private String value; - /** - * 所属设备类型 - */ - private String device; + /** + * 所属设备类型 + */ + private String device; - /** - * 构建一个 - */ - public TokenSign() { - } + /** + * 构建一个 + */ + public TokenSign() { + } - /** - * 构建一个 - * - * @param value token值 - * @param device 所属设备类型 - */ - public TokenSign(String value, String device) { - this.value = value; - this.device = device; - } + /** + * 构建一个 + * + * @param value Token 值 + * @param device 所属设备类型 + */ + public TokenSign(String value, String device) { + this.value = value; + this.device = device; + } - /** - * @return token值 - */ - public String getValue() { - return value; - } + /** + * @return Token 值 + */ + public String getValue() { + return value; + } - /** - * @return 所属设备类型 - */ - public String getDevice() { - return device; - } + /** + * @return 所属设备类型 + */ + public String getDevice() { + return device; + } - /** - * 反序列化需要 - */ - public void setValue(String value) { - this.value = value; - } + /** + * 写入 Token 值 + * + * @param value / + * @return 对象自身 + */ + public TokenSign setValue(String value) { + this.value = value; + return this; + } - /** - * 反序列化需要 - */ - public void setDevice(String device) { - this.device = device; - } + /** + * 写入所属设备类型 + * + * @param device / + * @return 对象自身 + */ + public TokenSign setDevice(String device) { + this.device = device; + return this; + } - @Override - public String toString() { - return "TokenSign [value=" + value + ", device=" + device + "]"; - } + // + @Override + public String toString() { + return "TokenSign [value=" + value + ", device=" + device + "]"; + } }