From 6277a1841b9fcc79a190f823aaf14176354a6bab Mon Sep 17 00:00:00 2001
From: shengzhang <2393584716@qq.com>
Date: Sat, 26 Dec 2020 20:54:15 +0800
Subject: [PATCH] =?UTF-8?q?=E5=AE=8C=E5=96=84=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
pom.xml | 2 +-
.../java/cn/dev33/satoken/SaTokenManager.java | 2 +-
.../dev33/satoken/action/SaTokenAction.java | 10 +-
.../action/SaTokenActionDefaultImpl.java | 4 +-
.../satoken/annotation/SaCheckLogin.java | 3 +-
.../satoken/annotation/SaCheckPermission.java | 17 +--
.../dev33/satoken/config/SaTokenConfig.java | 58 +++++++--
.../satoken/config/SaTokenConfigFactory.java | 6 +-
.../dev33/satoken/cookie/SaTokenCookie.java | 42 +++---
.../cookie/SaTokenCookieDefaultImpl.java | 4 +
.../satoken/cookie/SaTokenCookieUtil.java | 48 +++----
.../java/cn/dev33/satoken/dao/SaTokenDao.java | 17 ++-
.../satoken/dao/SaTokenDaoDefaultImpl.java | 3 +-
.../satoken/exception/NotLoginException.java | 25 ++--
.../exception/NotPermissionException.java | 8 +-
.../satoken/exception/SaTokenException.java | 4 +
.../dev33/satoken/servlet/SaTokenServlet.java | 6 +-
.../servlet/SaTokenServletDefaultImpl.java | 2 +-
.../cn/dev33/satoken/session/SaSession.java | 10 +-
.../satoken/session/SaSessionCustomUtil.java | 13 +-
.../cn/dev33/satoken/stp/StpInterface.java | 4 +-
.../satoken/stp/StpInterfaceDefaultImpl.java | 2 +-
.../java/cn/dev33/satoken/stp/StpLogic.java | 108 ++++++++--------
.../java/cn/dev33/satoken/stp/StpUtil.java | 122 +++++++++---------
.../dev33/satoken/util/SaTokenInsideUtil.java | 4 +-
.../dev33/satoken/autowired/SaTokenSetup.java | 3 +-
.../interceptor/SaCheckInterceptor.java | 6 -
.../spring/SaTokenServletSpringImpl.java | 1 -
.../dev33/satoken/spring/SpringMVCUtil.java | 9 +-
29 files changed, 285 insertions(+), 258 deletions(-)
diff --git a/pom.xml b/pom.xml
index fb3e1cee..daa0af62 100644
--- a/pom.xml
+++ b/pom.xml
@@ -18,7 +18,7 @@
- sp-token-core
+ sa-token-core
sa-token-spring-boot-starter
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/SaTokenManager.java b/sa-token-core/src/main/java/cn/dev33/satoken/SaTokenManager.java
index dc01b0b7..06c962c5 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/SaTokenManager.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/SaTokenManager.java
@@ -15,7 +15,7 @@ import cn.dev33.satoken.stp.StpInterfaceDefaultImpl;
import cn.dev33.satoken.util.SaTokenInsideUtil;
/**
- * 管理sa-token所有对象
+ * 管理sa-token所有接口对象
* @author kong
*
*/
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/action/SaTokenAction.java b/sa-token-core/src/main/java/cn/dev33/satoken/action/SaTokenAction.java
index 20e2c549..46ad5ec9 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/action/SaTokenAction.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/action/SaTokenAction.java
@@ -1,15 +1,19 @@
package cn.dev33.satoken.action;
+/**
+ * sa-token内置操作接口
+ * @author kong
+ *
+ */
public interface SaTokenAction {
-
/**
* 生成一个token
* @param loginId 账号id
- * @param loginKey 登录标识key
+ * @param loginKey 账号标识key
* @return 一个token
*/
public String createToken(Object loginId, String loginKey);
-
+
}
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/action/SaTokenActionDefaultImpl.java b/sa-token-core/src/main/java/cn/dev33/satoken/action/SaTokenActionDefaultImpl.java
index d539bae1..493b5835 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/action/SaTokenActionDefaultImpl.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/action/SaTokenActionDefaultImpl.java
@@ -40,11 +40,11 @@ public class SaTokenActionDefaultImpl implements SaTokenAction {
else if(tokenStyle.equals("random-128")) {
return SaTokenInsideUtil.getRandomString(128);
}
- // tik风格
+ // tik风格 (2_14_16)
else if(tokenStyle.equals("tik")) {
return SaTokenInsideUtil.getRandomString(2) + "_" + SaTokenInsideUtil.getRandomString(14) + "_" + SaTokenInsideUtil.getRandomString(16) + "__";
}
- // 默认
+ // 默认,还是uuid
else {
return UUID.randomUUID().toString();
}
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckLogin.java b/sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckLogin.java
index 3476159a..875eecb6 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckLogin.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckLogin.java
@@ -6,7 +6,8 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
- * 标注一个路由方法,当前会话必须已登录才能通过
+ * 标注一个路由方法,当前会话必须已登录才能通过
+ *
可标注在类上,其效果等同于标注在此类的所有方法上
* @author kong
*
*/
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckPermission.java b/sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckPermission.java
index f783c609..b97e81b6 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckPermission.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/annotation/SaCheckPermission.java
@@ -7,6 +7,7 @@ import java.lang.annotation.Target;
/**
* 标注一个路由方法,当前会话必须具有指定权限才可以通过
+ *
可标注在类上,其效果等同于标注在此类的所有方法上
* @author kong
*
*/
@@ -15,26 +16,26 @@ import java.lang.annotation.Target;
public @interface SaCheckPermission {
/**
- * 权限码数组 ,String类型
- * @return .
+ * 需要验证的权限码
+ * @return 需要验证的权限码
*/
String [] value() default {};
/**
- * 权限码数组 ,int类型
- * @return .
+ * 需要验证的权限码 (int类型)
+ * @return 需要验证的权限码 (int类型)
*/
int [] valueInt() default {};
/**
- * 权限码数组 ,long类型
- * @return .
+ * 需要验证的权限码 (long类型)
+ * @return 需要验证的权限码 (long类型)
*/
long [] valueLong() default {};
/**
- * 是否属于and型验证 ,true=必须全部具有,false=只要具有一个就可以通过
- * @return .
+ * 是否属于and型验证,true=必须全部具有,false=只要具有一个就可以通过
+ * @return 是否属于and型验证
*/
boolean isAnd() default true;
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
index d9d23f76..c0278f3d 100644
--- 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
@@ -1,22 +1,56 @@
package cn.dev33.satoken.config;
/**
- * sa-token 总配置类
+ * sa-token 配置类Model
* @author kong
*
*/
public class SaTokenConfig {
- private String tokenName = "satoken"; // token名称 (同时也是cookie名称)
- private long timeout = 30 * 24 * 60 * 60; // token有效期,单位s 默认30天
- private long activityTimeout = -1; // token临时有效期 (指定时间内无操作就视为token过期) 单位: 秒, 默认-1 代表不限制 (例如可以设置为1800代表30分钟内无操作就过期)
- private Boolean isShare = true; // 在多人登录同一账号时,是否共享会话 (为true时共用一个,为false时新登录挤掉旧登录)
- private Boolean isReadBody = true; // 是否尝试从请求体里读取token
- private Boolean isReadHead = true; // 是否尝试从header里读取token
- private Boolean isReadCookie = true; // 是否尝试从cookie里读取token
- private String tokenStyle = "uuid"; // token风格
+ /**
+ * token名称 (同时也是cookie名称)
+ */
+ private String tokenName = "satoken";
- private Boolean isV = true; // 是否在初始化配置时打印版本字符画
+ /**
+ * token有效期,单位/秒 默认30天, -1代表永久
+ */
+ private long timeout = 30 * 24 * 60 * 60;
+
+ /**
+ * token临时有效期 (指定时间内无操作就视为token过期) 单位/秒, 默认-1 代表不限制 (例如可以设置为1800代表30分钟内无操作就过期)
+ */
+ private long activityTimeout = -1;
+
+ /**
+ * 在多人登录同一账号时,是否共享会话 (为true时共用一个,为false时新登录挤掉旧登录)
+ */
+ private Boolean isShare = true;
+
+ /**
+ * 是否尝试从请求体里读取token
+ */
+ private Boolean isReadBody = true;
+
+ /**
+ * 是否尝试从header里读取token
+ */
+ private Boolean isReadHead = true;
+
+ /**
+ * 是否尝试从cookie里读取token
+ */
+ private Boolean isReadCookie = true;
+
+ /**
+ * token风格
+ */
+ private String tokenStyle = "uuid";
+
+ /**
+ * 是否在初始化配置时打印版本字符画
+ */
+ private Boolean isV = true;
@@ -149,7 +183,9 @@ public class SaTokenConfig {
-
+ /**
+ * 将对象转为String字符串
+ */
@Override
public String toString() {
return "SaTokenConfig [tokenName=" + tokenName + ", timeout=" + timeout + ", activityTimeout=" + activityTimeout
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/config/SaTokenConfigFactory.java b/sa-token-core/src/main/java/cn/dev33/satoken/config/SaTokenConfigFactory.java
index 63e69c0e..b29cf151 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/config/SaTokenConfigFactory.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/config/SaTokenConfigFactory.java
@@ -8,7 +8,7 @@ import java.util.Map;
import java.util.Properties;
/**
- * 创建一个配置文件
+ * sa-token配置文件创建工厂类
* @author kong
*
*/
@@ -16,7 +16,7 @@ public class SaTokenConfigFactory {
/**
- * 默认配置文件地址
+ * 默认配置文件地址
*/
public static String configPath = "sa-token.properties";
@@ -102,7 +102,7 @@ public class SaTokenConfigFactory {
* 将字符串转化为指定数据类型
* @param str 值
* @param cs 要转换的类型
- * @return .
+ * @return 转化好的结果
*/
@SuppressWarnings("unchecked")
private static T getObjectByClass(String str, Class cs){
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookie.java b/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookie.java
index e501eb11..c9b9c3e4 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookie.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookie.java
@@ -12,41 +12,37 @@ import javax.servlet.http.HttpServletResponse;
public interface SaTokenCookie {
/**
- * 获取指定cookie .
- *
- * @param request .
- * @param cookieName .
- * @return .
+ * 在request对象中获取指定Cookie
+ * @param request request对象
+ * @param cookieName Cookie名称
+ * @return 查找到的Cookie对象
*/
public Cookie getCookie(HttpServletRequest request, String cookieName);
/**
- * 添加cookie
- *
- * @param response .
- * @param name .
- * @param value .
- * @param path .
- * @param timeout .
+ * 添加Cookie
+ * @param response response对象
+ * @param name Cookie名称
+ * @param value Cookie值
+ * @param path Cookie路径
+ * @param timeout 过期时间 (秒)
*/
public void addCookie(HttpServletResponse response, String name, String value, String path, int timeout);
/**
- * 删除cookie .
- *
- * @param request .
- * @param response .
- * @param name .
+ * 删除Cookie
+ * @param request request对象
+ * @param response response对象
+ * @param name Cookie名称
*/
public void delCookie(HttpServletRequest request, HttpServletResponse response, String name);
/**
- * 修改cookie的value值
- *
- * @param request .
- * @param response .
- * @param name .
- * @param value .
+ * 修改Cookie的value值
+ * @param request request对象
+ * @param response response对象
+ * @param name Cookie名称
+ * @param value Cookie值
*/
public void updateCookie(HttpServletRequest request, HttpServletResponse response, String name, String value);
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookieDefaultImpl.java b/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookieDefaultImpl.java
index f8068e19..c0836221 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookieDefaultImpl.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookieDefaultImpl.java
@@ -14,6 +14,7 @@ public class SaTokenCookieDefaultImpl implements SaTokenCookie {
/**
* 获取指定cookie
*/
+ @Override
public Cookie getCookie(HttpServletRequest request, String cookieName) {
return SaTokenCookieUtil.getCookie(request, cookieName);
}
@@ -21,6 +22,7 @@ public class SaTokenCookieDefaultImpl implements SaTokenCookie {
/**
* 添加cookie
*/
+ @Override
public void addCookie(HttpServletResponse response, String name, String value, String path, int timeout) {
SaTokenCookieUtil.addCookie(response, name, value, path, timeout);
}
@@ -28,6 +30,7 @@ public class SaTokenCookieDefaultImpl implements SaTokenCookie {
/**
* 删除cookie
*/
+ @Override
public void delCookie(HttpServletRequest request, HttpServletResponse response, String name) {
SaTokenCookieUtil.delCookie(request, response, name);
}
@@ -35,6 +38,7 @@ public class SaTokenCookieDefaultImpl implements SaTokenCookie {
/**
* 修改cookie的value值
*/
+ @Override
public void updateCookie(HttpServletRequest request, HttpServletResponse response, String name, String value) {
SaTokenCookieUtil.updateCookie(request, response, name, value);
}
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookieUtil.java b/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookieUtil.java
index 74edb933..e77ff321 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookieUtil.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookieUtil.java
@@ -5,19 +5,16 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
- * cookie操作工具类
- *
- * @author kong
- *
+ * Cookie操作工具类
+ * @author kong
*/
public class SaTokenCookieUtil {
/**
- * 获取指定cookie .
- *
- * @param request .
- * @param cookieName .
- * @return .
+ * 在request对象中获取指定Cookie
+ * @param request request对象
+ * @param cookieName Cookie名称
+ * @return 查找到的Cookie对象
*/
public static Cookie getCookie(HttpServletRequest request, String cookieName) {
Cookie[] cookies = request.getCookies();
@@ -32,13 +29,12 @@ public class SaTokenCookieUtil {
}
/**
- * 添加cookie
- *
- * @param response .
- * @param name .
- * @param value .
- * @param path .
- * @param timeout .
+ * 添加cookie
+ * @param response response
+ * @param name Cookie名称
+ * @param value Cookie值
+ * @param path Cookie写入路径
+ * @param timeout Cookie有效期 (秒)
*/
public static void addCookie(HttpServletResponse response, String name, String value, String path, int timeout) {
Cookie cookie = new Cookie(name, value);
@@ -51,11 +47,10 @@ public class SaTokenCookieUtil {
}
/**
- * 删除cookie .
- *
- * @param request .
- * @param response .
- * @param name .
+ * 删除Cookie
+ * @param request request对象
+ * @param response response对象
+ * @param name Cookie名称
*/
public static void delCookie(HttpServletRequest request, HttpServletResponse response, String name) {
Cookie[] cookies = request.getCookies();
@@ -70,12 +65,11 @@ public class SaTokenCookieUtil {
}
/**
- * 修改cookie的value值
- *
- * @param request .
- * @param response .
- * @param name .
- * @param value .
+ * 修改cookie的value值
+ * @param request request对象
+ * @param response response对象
+ * @param name Cookie名称
+ * @param value Cookie值
*/
public static void updateCookie(HttpServletRequest request, HttpServletResponse response, String name,
String value) {
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDao.java b/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDao.java
index 1a1b77dd..6efed977 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDao.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDao.java
@@ -4,8 +4,7 @@ import cn.dev33.satoken.session.SaSession;
/**
* sa-token持久层的接口
- * @author kong
- *
+ * @author kong
*/
public interface SaTokenDao {
@@ -19,17 +18,17 @@ public interface SaTokenDao {
/**
- * 根据key获取value ,如果没有,则返回空
+ * 根据key获取value,如果没有,则返回空
* @param key 键名称
* @return value
*/
public String getValue(String key);
/**
- * 写入指定key-value键值对,并设定过期时间 (单位:秒)
+ * 写入指定key-value键值对,并设定过期时间 (单位: 秒)
* @param key 键名称
* @param value 值
- * @param timeout 过期时间,单位:s
+ * @param timeout 过期时间 (单位: 秒)
*/
public void setValue(String key, String value, long timeout);
@@ -55,16 +54,16 @@ public interface SaTokenDao {
/**
- * 根据指定key的session,如果没有,则返回空
+ * 根据指定key的Session,如果没有,则返回空
* @param sessionId 键名称
* @return SaSession
*/
public SaSession getSession(String sessionId);
/**
- * 将指定session持久化
+ * 将指定Session持久化
* @param session 要保存的session对象
- * @param timeout 过期时间,单位: s
+ * @param timeout 过期时间 (单位: 秒)
*/
public void saveSession(SaSession session, long timeout);
@@ -83,7 +82,7 @@ public interface SaTokenDao {
/**
* 获取指定SaSession的剩余存活时间 (单位: 秒)
* @param sessionId 指定SaSession
- * @return 这个SaSession的剩余存活时间
+ * @return 这个SaSession的剩余存活时间 (单位: 秒)
*/
public long getSessionTimeout(String sessionId);
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDaoDefaultImpl.java b/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDaoDefaultImpl.java
index fee7682c..1a7d9344 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDaoDefaultImpl.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/dao/SaTokenDaoDefaultImpl.java
@@ -18,7 +18,7 @@ public class SaTokenDaoDefaultImpl implements SaTokenDao {
public Map dataMap = new HashMap();
/**
- * 过期时间集合 (单位: 毫秒) , 记录所有key的到期时间 [注意不是剩余存活时间]
+ * 过期时间集合 (单位: 毫秒) , 记录所有key的到期时间 [注意不是剩余存活时间]
*/
public Map expireMap = new HashMap();
@@ -103,7 +103,6 @@ public class SaTokenDaoDefaultImpl implements SaTokenDao {
}
}
-
/**
* 获取指定key的剩余存活时间 (单位:秒)
*/
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/exception/NotLoginException.java b/sa-token-core/src/main/java/cn/dev33/satoken/exception/NotLoginException.java
index eefb05f5..a66839d5 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/exception/NotLoginException.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/exception/NotLoginException.java
@@ -4,14 +4,13 @@ import java.util.Arrays;
import java.util.List;
/**
- * 没有登陆抛出的异常
- * @author kong
- *
+ * 一个异常:代表用户没有登录
+ * @author kong
*/
public class NotLoginException extends RuntimeException {
/**
- *
+ *
*/
private static final long serialVersionUID = 6806129545290130142L;
@@ -59,7 +58,7 @@ public class NotLoginException extends RuntimeException {
private String type;
/**
* 获取异常类型
- * @return
+ * @return 异常类型
*/
public String getType() {
return type;
@@ -72,7 +71,7 @@ public class NotLoginException extends RuntimeException {
private String loginKey;
/**
* 获得loginKey
- * @return login_key
+ * @return loginKey
*/
public String getLoginKey() {
return loginKey;
@@ -81,16 +80,8 @@ public class NotLoginException extends RuntimeException {
-// /**
-// * 创建一个
-// */
-// public NotLoginException() {
-// this(StpUtil.stpLogic.loginKey);
-// }
-
-
/**
- * 创建一个
+ * 构造方法创建一个
* @param message 异常消息
* @param loginKey loginKey
* @param type 类型
@@ -103,8 +94,8 @@ public class NotLoginException extends RuntimeException {
}
/**
- * 静态方法构建一个NotLoginException
- * @param loginKey loginKey
+ * 静态方法构建一个NotLoginException
+ * @param loginKey loginKey
* @param type 场景类型
* @return 构建完毕的异常对象
*/
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/exception/NotPermissionException.java b/sa-token-core/src/main/java/cn/dev33/satoken/exception/NotPermissionException.java
index a7e1614b..2e4628f5 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/exception/NotPermissionException.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/exception/NotPermissionException.java
@@ -15,7 +15,7 @@ public class NotPermissionException extends RuntimeException {
private static final long serialVersionUID = 6806129545290130142L;
/**
- * 权限码
+ * 权限码
*/
private Object code;
/**
@@ -26,12 +26,12 @@ public class NotPermissionException extends RuntimeException {
}
/**
- * login_key
+ * loginKey
*/
private String loginKey;
/**
- * 获得login_key
- * @return login_key
+ * 获得loginKey
+ * @return loginKey
*/
public String getLoginKey() {
return loginKey;
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaTokenException.java b/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaTokenException.java
index f1c69e25..a90a540b 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaTokenException.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaTokenException.java
@@ -13,6 +13,10 @@ public class SaTokenException extends RuntimeException {
private static final long serialVersionUID = 6806129545290130132L;
+ /**
+ * 构建一个异常
+ * @param message 异常描述信息
+ */
public SaTokenException(String message) {
super(message);
}
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/servlet/SaTokenServlet.java b/sa-token-core/src/main/java/cn/dev33/satoken/servlet/SaTokenServlet.java
index d9a891c0..b1dbe6f7 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/servlet/SaTokenServlet.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/servlet/SaTokenServlet.java
@@ -12,14 +12,14 @@ public interface SaTokenServlet {
/**
- * 获取当前请求的Request对象
+ * 获取当前请求的 Request 对象
* @return 当前请求的Request对象
*/
public HttpServletRequest getRequest();
/**
- * 获取当前会话的 response
- * @return 当前请求的response
+ * 获取当前请求的 Response 对象
+ * @return 当前请求的response对象
*/
public HttpServletResponse getResponse();
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/servlet/SaTokenServletDefaultImpl.java b/sa-token-core/src/main/java/cn/dev33/satoken/servlet/SaTokenServletDefaultImpl.java
index c515f69b..f3f205a0 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/servlet/SaTokenServletDefaultImpl.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/servlet/SaTokenServletDefaultImpl.java
@@ -4,7 +4,7 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
- * sa-token 对Servlet的相关操作 接口默认实现类
+ * sa-token 对SaTokenServlet接口默认实现类
* @author kong
*
*/
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 ba070515..e6d4b592 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,10 +21,12 @@ public class SaSession implements Serializable {
* 会话id
*/
private String id;
+
/**
* 当前会话创建时间
*/
private long createTime;
+
/**
* 当前会话键值对
*/
@@ -32,8 +34,8 @@ public class SaSession implements Serializable {
/**
- * 构建一个 session对象
- * @param id sessionId
+ * 构建一个 session对象
+ * @param id session的id
*/
public SaSession(String id) {
this.id = id;
@@ -50,7 +52,7 @@ public class SaSession implements Serializable {
}
/**
- * 返回当前会话创建时间
+ * 返回当前会话创建时间
* @return 时间戳
*/
public long getCreateTime() {
@@ -58,7 +60,7 @@ public class SaSession implements Serializable {
}
/**
- * 写入一个值
+ * 写入一个值
* @param key 名称
* @param value 值
*/
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSessionCustomUtil.java b/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSessionCustomUtil.java
index 24042af3..e061c65a 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSessionCustomUtil.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/session/SaSessionCustomUtil.java
@@ -12,13 +12,16 @@ public class SaSessionCustomUtil {
/**
* 添加上指定前缀,防止恶意伪造session
*/
- public static String session_key = "custom";
+ public static String sessionKey = "custom";
+
+ /** 组织一下key */
public static String getSessionKey(String sessionId) {
- return SaTokenManager.getConfig().getTokenName() + ":" + session_key + ":session:" + sessionId;
+ return SaTokenManager.getConfig().getTokenName() + ":" + sessionKey + ":session:" + sessionId;
}
+
/**
- * 指定key的session是否存在
+ * 指定key的session是否存在
* @param sessionId session的id
* @return 是否存在
*/
@@ -27,7 +30,7 @@ public class SaSessionCustomUtil {
}
/**
- * 获取指定key的session
+ * 获取指定key的session
* @param sessionId key
* @param isCreate 如果没有,是否新建并返回
* @return SaSession
@@ -51,7 +54,7 @@ public class SaSessionCustomUtil {
}
/**
- * 删除指定key的session
+ * 删除指定key的session
* @param sessionId 删除指定key
*/
public static void deleteSessionById(String sessionId) {
diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpInterface.java b/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpInterface.java
index 81fcb7fd..0b3b7cfc 100644
--- a/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpInterface.java
+++ b/sa-token-core/src/main/java/cn/dev33/satoken/stp/StpInterface.java
@@ -9,10 +9,10 @@ import java.util.List;
public interface StpInterface {
/**
- * 返回指定login_id所拥有的权限码集合
+ * 返回指定loginId所拥有的权限码集合
* @param loginId 账号id
* @param loginKey 具体的stp标识
- * @return .
+ * @return 该账号id具有的权限码集合
*/
public List