优化注释

2025-09-18 17:48:03 +08:00 · 2021-06-18 23:53:16 +08:00
parent c6d3cda4a4
commit a73adf6727
53 changed files with 801 additions and 568 deletions
--- a/sa-token-plugin/sa-token-dao-redis-jackson/src/main/java/cn/dev33/satoken/dao/SaTokenDaoRedisJackson.java
+++ b/sa-token-plugin/sa-token-dao-redis-jackson/src/main/java/cn/dev33/satoken/dao/SaTokenDaoRedisJackson.java
@@ -20,7 +20,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
 import cn.dev33.satoken.util.SaFoxUtil;

 /**
- * sa-token持久层的实现类, 基于redis (使用 jackson 序列化方式)
+ * Sa-Token持久层接口 [Redis版] (使用 jackson 序列化方式)
 * 
 * @author kong
 * 
@@ -73,7 +73,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	
 	
 	/**
-	 * 根据key获取value，如果没有，则返回空
+	 * 获取Value，如无返空 
 	 */
 	@Override
 	public String get(String key) {
@@ -81,7 +81,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	}

 	/**
-	 * 写入指定key-value键值对，并设定过期时间(单位：秒)
+	 * 写入Value，并设定存活时间 (单位: 秒) 
 	 */
 	@Override
 	public void set(String key, String value, long timeout) {
@@ -94,7 +94,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	}

 	/**
-	 * 修改指定key-value键值对 (过期时间不变) 
+	 * 修修改指定key-value键值对 (过期时间不变) 
 	 */
 	@Override
 	public void update(String key, String value) {
@@ -107,7 +107,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	}
 	
 	/**
-	 * 删除一个指定的key
+	 * 删除Value 
 	 */
 	@Override
 	public void delete(String key) {
@@ -115,7 +115,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	}

 	/**
-	 * 根据key获取value，如果没有，则返回空 
+	 * 获取Value的剩余存活时间 (单位: 秒) 
 	 */
 	@Override
 	public long getTimeout(String key) {
@@ -123,7 +123,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	}

 	/**
-	 * 修改指定key的剩余存活时间 (单位: 秒) 
+	 * 修改Value的剩余存活时间 (单位: 秒) 
 	 */
 	@Override
 	public void updateTimeout(String key, long timeout) {
@@ -144,7 +144,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	

 	/**
-	 * 根据key获取Object，如果没有，则返回空 
+	 * 获取Object，如无返空 
 	 */
 	@Override
 	public Object getObject(String key) {
@@ -152,7 +152,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	}

 	/**
-	 * 写入指定键值对，并设定过期时间 (单位: 秒)
+	 * 写入Object，并设定存活时间 (单位: 秒) 
 	 */
 	@Override
 	public void setObject(String key, Object object, long timeout) {
@@ -165,7 +165,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	}

 	/**
-	 * 修改指定键值对 (过期时间不变)
+	 * 更新Object (过期时间不变) 
 	 */
 	@Override
 	public void updateObject(String key, Object object) {
@@ -178,7 +178,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	}

 	/**
-	 * 删除一个指定的object 
+	 * 删除Object 
 	 */
 	@Override
 	public void deleteObject(String key) {
@@ -186,7 +186,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	}

 	/**
-	 * 获取指定key的剩余存活时间 (单位: 秒)
+	 * 获取Object的剩余存活时间 (单位: 秒)
 	 */
 	@Override
 	public long getObjectTimeout(String key) {
@@ -194,7 +194,7 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
 	}

 	/**
-	 * 修改指定key的剩余存活时间 (单位: 秒)
+	 * 修改Object的剩余存活时间 (单位: 秒)
 	 */
 	@Override
 	public void updateObjectTimeout(String key, long timeout) {
--- a/sa-token-plugin/sa-token-dao-redis/src/main/java/cn/dev33/satoken/dao/SaTokenDaoRedis.java
+++ b/sa-token-plugin/sa-token-dao-redis/src/main/java/cn/dev33/satoken/dao/SaTokenDaoRedis.java
@@ -16,7 +16,7 @@ import org.springframework.stereotype.Component;
 import cn.dev33.satoken.util.SaFoxUtil;

 /**
- * sa-token持久层的实现类, 基于redis 
+ * Sa-Token持久层接口 [Redis版 (使用JDK默认序列化方式)] 
 * 
 * @author kong
 *
@@ -54,7 +54,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	
 	
 	/**
-	 * 根据key获取value，如果没有，则返回空 
+	 * 获取Value，如无返空 
 	 */
 	@Override
 	public String get(String key) {
@@ -62,7 +62,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	}

 	/**
-	 * 写入指定key-value键值对，并设定过期时间(单位：秒)
+	 * 写入Value，并设定存活时间 (单位: 秒)
 	 */
 	@Override
 	public void set(String key, String value, long timeout) {
@@ -88,7 +88,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	}
 	
 	/**
-	 * 删除一个指定的key
+	 * 删除Value 
 	 */
 	@Override
 	public void delete(String key) {
@@ -96,7 +96,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	}

 	/**
-	 * 根据key获取value，如果没有，则返回空 
+	 * 获取Value的剩余存活时间 (单位: 秒) 
 	 */
 	@Override
 	public long getTimeout(String key) {
@@ -104,7 +104,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	}

 	/**
-	 * 修改指定key的剩余存活时间 (单位: 秒) 
+	 * 修改Value的剩余存活时间 (单位: 秒) 
 	 */
 	@Override
 	public void updateTimeout(String key, long timeout) {
@@ -124,7 +124,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	
 	
 	/**
-	 * 根据key获取Object，如果没有，则返回空 
+	 * 获取Object，如无返空 
 	 */
 	@Override
 	public Object getObject(String key) {
@@ -132,7 +132,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	}

 	/**
-	 * 写入指定键值对，并设定过期时间 (单位: 秒)
+	 * 写入Object，并设定存活时间 (单位: 秒) 
 	 */
 	@Override
 	public void setObject(String key, Object object, long timeout) {
@@ -145,7 +145,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	}

 	/**
-	 * 修改指定键值对 (过期时间不变)
+	 * 更新Object (过期时间不变) 
 	 */
 	@Override
 	public void updateObject(String key, Object object) {
@@ -158,7 +158,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	}

 	/**
-	 * 删除一个指定的object 
+	 * 删除Object 
 	 */
 	@Override
 	public void deleteObject(String key) {
@@ -166,7 +166,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	}

 	/**
-	 * 获取指定key的剩余存活时间 (单位: 秒)
+	 * 获取Object的剩余存活时间 (单位: 秒)
 	 */
 	@Override
 	public long getObjectTimeout(String key) {
@@ -174,7 +174,7 @@ public class SaTokenDaoRedis implements SaTokenDao {
 	}

 	/**
-	 * 修改指定key的剩余存活时间 (单位: 秒)
+	 * 修改Object的剩余存活时间 (单位: 秒)
 	 */
 	@Override
 	public void updateObjectTimeout(String key, long timeout) {
--- a/sa-token-plugin/sa-token-spring-aop/src/main/java/cn/dev33/satoken/aop/SaCheckAspect.java
+++ b/sa-token-plugin/sa-token-spring-aop/src/main/java/cn/dev33/satoken/aop/SaCheckAspect.java
@@ -33,7 +33,8 @@ public class SaCheckAspect {
 	public static final String POINTCUT_SIGN = 
 			"@within(cn.dev33.satoken.annotation.SaCheckLogin) || @annotation(cn.dev33.satoken.annotation.SaCheckLogin) || "
 			+ "@within(cn.dev33.satoken.annotation.SaCheckRole) || @annotation(cn.dev33.satoken.annotation.SaCheckRole) || "
-			+ "@within(cn.dev33.satoken.annotation.SaCheckPermission) || @annotation(cn.dev33.satoken.annotation.SaCheckPermission)";
+			+ "@within(cn.dev33.satoken.annotation.SaCheckPermission) || @annotation(cn.dev33.satoken.annotation.SaCheckPermission) || "
+			+ "@within(cn.dev33.satoken.annotation.SaCheckSafe) || @annotation(cn.dev33.satoken.annotation.SaCheckSafe)";

 	/**
 	 * 声明AOP签名