Id-Token 模块更名为 Same-Token

sdivens · Oct 24, 2022 · 2dc0a44 · 2dc0a44
1 parent 0088606
commit 2dc0a44
Show file tree

Hide file tree

Showing 34 changed files with 564 additions and 180 deletions.
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/SaManager.java b/sa-token-core/src/main/java/cn/dev33/satoken/SaManager.java
@@ -13,6 +13,7 @@
 import cn.dev33.satoken.exception.SaTokenException;
 import cn.dev33.satoken.json.SaJsonTemplate;
 import cn.dev33.satoken.json.SaJsonTemplateDefaultImpl;
+import cn.dev33.satoken.same.SaSameTemplate;
 import cn.dev33.satoken.sign.SaSignTemplate;
 import cn.dev33.satoken.sign.SaSignTemplateDefaultImpl;
 import cn.dev33.satoken.stp.StpInterface;
@@ -191,6 +192,24 @@ public static SaSignTemplate getSaSignTemplate() {
 		}
 		return saSignTemplate;
 	}
+
+	/**
+	 * Same-Token Bean 
+	 */
+	private volatile static SaSameTemplate saSameTemplate;
+	public static void setSaSameTemplate(SaSameTemplate saSameTemplate) {
+		SaManager.saSameTemplate = saSameTemplate;
+	}
+	public static SaSameTemplate getSaSameTemplate() {
+		if (saSameTemplate == null) {
+			synchronized (SaManager.class) {
+				if (saSameTemplate == null) {
+					setSaSameTemplate(new SaSameTemplate());
+				}
+			}
+		}
+		return saSameTemplate;
+	}
 
 	/**
 	 * StpLogic集合, 记录框架所有成功初始化的StpLogic 

diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/application/SaApplication.java b/sa-token-core/src/main/java/cn/dev33/satoken/application/SaApplication.java
@@ -63,7 +63,7 @@ public SaApplication set(String key, Object value, long ttl) {
 	public List<String> keys() {
 		// 查出来
 		String prefix = splicingDataKey("");
-		List<String> list = SaManager.getSaTokenDao().searchData(prefix, "", -1, 0, true);
+		List<String> list = SaManager.getSaTokenDao().searchData(prefix, "", 0, -1, true);
 
 		// 裁减掉固定前缀 
 		int prefixLength = prefix.length();

diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/config/SaTokenConfig.java b/sa-token-core/src/main/java/cn/dev33/satoken/config/SaTokenConfig.java
@@ -74,11 +74,6 @@ public class SaTokenConfig implements Serializable {
 	 * jwt秘钥 (只有集成 jwt 模块时此参数才会生效)   
 	 */
 	private String jwtSecretKey;
-
-	/**
-	 * Id-Token的有效期 (单位: 秒)
-	 */
-	private long idTokenTimeout = 60 * 60 * 24;
 
 	/**
 	 * Http Basic 认证的账号和密码 
@@ -88,8 +83,14 @@ public class SaTokenConfig implements Serializable {
 	/** 配置当前项目的网络访问地址 */
 	private String currDomain;
 
-	/** 是否校验Id-Token（部分rpc插件有效） */
-	private Boolean checkIdToken = false;
+	/**
+	 * Same-Token 的有效期 (单位: 秒)
+	 */
+	private long sameTokenTimeout = 60 * 60 * 24;
+
+	/** 是否校验Same-Token（部分rpc插件有效） */
+	private Boolean checkSameToken = false;
+
 
 	/**
 	 * Cookie配置对象 
@@ -389,22 +390,6 @@ public SaTokenConfig setJwtSecretKey(String jwtSecretKey) {
 		return this;
 	}
 
-	/**
-	 * @return Id-Token的有效期 (单位: 秒)
-	 */
-	public long getIdTokenTimeout() {
-		return idTokenTimeout;
-	}
-
-	/**
-	 * @param idTokenTimeout Id-Token的有效期 (单位: 秒)
-	 * @return 对象自身
-	 */
-	public SaTokenConfig setIdTokenTimeout(long idTokenTimeout) {
-		this.idTokenTimeout = idTokenTimeout;
-		return this;
-	}
-
 	/**
 	 * @return Http Basic 认证的账号和密码 
 	 */
@@ -438,18 +423,34 @@ public SaTokenConfig setCurrDomain(String currDomain) {
 	}
 
 	/**
-	 * @return 是否校验Id-Token（部分rpc插件有效）
+	 * @return Same-Token 的有效期 (单位: 秒)
 	 */
-	public Boolean getCheckIdToken() {
-		return checkIdToken;
+	public long getSameTokenTimeout() {
+		return sameTokenTimeout;
 	}
 
 	/**
-	 * @param checkIdToken 是否校验Id-Token（部分rpc插件有效）
-	 * @return 对象自身 
+	 * @param sameTokenTimeout Same-Token 的有效期 (单位: 秒)
+	 * @return 对象自身
 	 */
-	public SaTokenConfig setCheckIdToken(Boolean checkIdToken) {
-		this.checkIdToken = checkIdToken;
+	public SaTokenConfig setSameTokenTimeout(long sameTokenTimeout) {
+		this.sameTokenTimeout = sameTokenTimeout;
+		return this;
+	}
+
+	/**
+	 * @return 是否校验Same-Token（部分rpc插件有效）
+	 */
+	public Boolean getCheckSameToken() {
+		return checkSameToken;
+	}
+
+	/**
+	 * @param checkSameToken 是否校验Same-Token（部分rpc插件有效）
+	 * @return 对象自身
+	 */
+	public SaTokenConfig setCheckSameToken(Boolean checkSameToken) {
+		this.checkSameToken = checkSameToken;
 		return this;
 	}
 
@@ -490,10 +491,10 @@ public String toString() {
 				+ ", isPrint=" + isPrint 
 				+ ", isLog=" + isLog 
 				+ ", jwtSecretKey=" + jwtSecretKey 
-				+ ", idTokenTimeout=" + idTokenTimeout 
 				+ ", basic=" + basic 
 				+ ", currDomain=" + currDomain 
-				+ ", checkIdToken=" + checkIdToken 
+				+ ", sameTokenTimeout=" + sameTokenTimeout
+				+ ", checkSameToken=" + checkSameToken 
 				+ ", cookie=" + cookie 
 				+ "]";
 	}
@@ -519,5 +520,44 @@ public SaTokenConfig setIsReadHead(Boolean isReadHead) {
 		return this;
 	}
 
+	/**
+	 * <h1> 本函数设计已过时，未来版本可能移除此函数，请及时更换为 getSameTokenTimeout() ，使用方式保持不变 </h1>
+	 * @return Id-Token的有效期 (单位: 秒)
+	 */
+	@Deprecated
+	public long getIdTokenTimeout() {
+		return sameTokenTimeout;
+	}
+
+	/**
+	 * <h1> 本函数设计已过时，未来版本可能移除此函数，请及时更换为 setSameTokenTimeout() ，使用方式保持不变 </h1>
+	 * @param idTokenTimeout Id-Token的有效期 (单位: 秒)
+	 * @return 对象自身
+	 */
+	@Deprecated
+	public SaTokenConfig setIdTokenTimeout(long idTokenTimeout) {
+		this.sameTokenTimeout = idTokenTimeout;
+		return this;
+	}
+
+	/**
+	 * <h1> 本函数设计已过时，未来版本可能移除此函数，请及时更换为 getCheckSameToken() ，使用方式保持不变 </h1>
+	 * @return 是否校验Id-Token（部分rpc插件有效）
+	 */
+	@Deprecated
+	public Boolean getCheckIdToken() {
+		return checkSameToken;
+	}
+
+	/**
+	 * <h1> 本函数设计已过时，未来版本可能移除此函数，请及时更换为 setCheckSameToken() ，使用方式保持不变 </h1>
+	 * @param checkIdToken 是否校验Id-Token（部分rpc插件有效）
+	 * @return 对象自身 
+	 */
+	@Deprecated
+	public SaTokenConfig setCheckIdToken(Boolean checkIdToken) {
+		this.checkSameToken = checkIdToken;
+		return this;
+	}
 
 }
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/exception/IdTokenInvalidException.java b/sa-token-core/src/main/java/cn/dev33/satoken/exception/IdTokenInvalidException.java
@@ -1,10 +1,12 @@
 package cn.dev33.satoken.exception;
 
 /**
+ * <h1> 本类设计已过时，未来版本可能移除此类，请及时更换为 SameTokenInvalidException ，使用方式保持不变 </h1>
  * 一个异常：代表提供的 Id-Token 无效 
  * 
  * @author kong
  */
+@Deprecated
 public class IdTokenInvalidException extends SaTokenException {
 
 	/**

diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/exception/SameTokenInvalidException.java b/sa-token-core/src/main/java/cn/dev33/satoken/exception/SameTokenInvalidException.java
@@ -0,0 +1,24 @@
+package cn.dev33.satoken.exception;
+
+/**
+ * 一个异常：代表提供的 Same-Token 无效 
+ * 
+ * @author kong
+ * @since 2022-10-24
+ */
+public class SameTokenInvalidException extends SaTokenException {
+
+	/**
+	 * 序列化版本号
+	 */
+	private static final long serialVersionUID = 6806129545290130144L;
+
+	/**
+	 * 一个异常：代表提供的 Same-Token 无效 
+	 * @param message 异常描述 
+	 */
+	public SameTokenInvalidException(String message) {
+		super(message);
+	}
+
+}
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/id/SaIdTemplate.java b/sa-token-core/src/main/java/cn/dev33/satoken/id/SaIdTemplate.java
@@ -6,11 +6,14 @@
 import cn.dev33.satoken.util.SaFoxUtil;
 
 /**
+ * <h1> 本类设计已过时，未来版本可能移除此类，请及时更换为 SaSameTemplate ，使用方式保持不变 </h1>
+ * 
  * Sa-Token-Id 身份凭证模块 
  * <p> 身份凭证的获取与校验，可用于微服务内部调用鉴权 
  * @author kong 
  *
  */
+@Deprecated
 public class SaIdTemplate {
 
 	/**

diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/id/SaIdUtil.java b/sa-token-core/src/main/java/cn/dev33/satoken/id/SaIdUtil.java
@@ -1,10 +1,13 @@
 package cn.dev33.satoken.id;
 
 /**
+ * <h1> 本类设计已过时，未来版本可能移除此类，请及时更换为 SaSameUtil ，使用方式保持不变 </h1>
+ * 
  * Sa-Token-Id 身份凭证模块-工具类 
  * @author kong
  *
  */
+@Deprecated
 public class SaIdUtil {
 
 	private SaIdUtil(){}