diff --git a/.gitignore b/.gitignore index 63c6ba82..2a2bc552 100644 --- a/.gitignore +++ b/.gitignore @@ -13,4 +13,4 @@ unpackage/ .idea/ - +.flattened-pom.xml 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 0b1130b8..de8a29b6 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 @@ -50,7 +50,7 @@ public class NotPermissionException extends SaTokenException { } /** - *

警告:自 v1.30+ 版本起,获取异常权限码由 getCode() 更改为 getPermission(),请及时更换! + *

警告:自 v1.30+ 版本起,获取异常权限码由 getCode() 更改为 getPermission(),请及时更换!

* @return 获得权限码 */ @Deprecated diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaExceptionCode.java b/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaExceptionCode.java index 78a8b1b5..a1a67078 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaExceptionCode.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaExceptionCode.java @@ -4,7 +4,7 @@ package cn.dev33.satoken.exception; * 定义所有异常细分状态码 * * @author kong - * @date: 2022-4-25 + * @since: 2022-4-25 */ public class SaExceptionCode { diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaJsonConvertException.java b/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaJsonConvertException.java index d3ffa747..9c4526e9 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaJsonConvertException.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/exception/SaJsonConvertException.java @@ -14,9 +14,10 @@ public class SaJsonConvertException extends SaTokenException { /** * 一个异常:代表 JSON 转换失败 + * @param cause 异常对象 */ - public SaJsonConvertException(Throwable e) { - super(e); + public SaJsonConvertException(Throwable cause) { + super(cause); } } 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 a5a1d71f..67025ea4 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 @@ -72,6 +72,7 @@ public class SaTokenException extends RuntimeException { } /** + * 获取异常细分状态码 * @return 异常细分状态码 */ public int getCode() { diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/json/SaJsonTemplate.java b/sa-token-core/src/main/java/cn/dev33/satoken/json/SaJsonTemplate.java index f7dbff27..5ad60d17 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/json/SaJsonTemplate.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/json/SaJsonTemplate.java @@ -19,10 +19,9 @@ public interface SaJsonTemplate { public String toJsonString(Object obj); /** - * 将 json 字符串解析为 Map - * - * @param jsonStr json 字符串 - * @return 转换后的 Map 对象 + * 解析 json 字符串为map对象 + * @param jsonStr json字符串 + * @return map对象 */ public Map parseJsonToMap(String jsonStr); diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/sign/SaSignTemplate.java b/sa-token-core/src/main/java/cn/dev33/satoken/sign/SaSignTemplate.java index 2bfc97c5..1bcf6663 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/sign/SaSignTemplate.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/sign/SaSignTemplate.java @@ -10,12 +10,12 @@ import cn.dev33.satoken.util.SaFoxUtil; * 参数签名算法 * * @author kong - * @date: 2022-4-27 + * @since: 2022-4-27 */ public interface SaSignTemplate { /** - * 将所有参数连接成一个字符串,形如: k1=v1&k2=v2&k3=v3 + * 将所有参数连接成一个字符串 * @param paramsMap 参数列表 * @return 字符串 */ @@ -47,7 +47,7 @@ public interface SaSignTemplate { * 创建签名:md5(paramsStr + keyStr) * @param paramsMap 参数列表 * @param key 秘钥 - * @return + * @return 签名 */ public default String createSign(Map paramsMap, String key) { String paramsStr = joinParams(paramsMap); diff --git a/sa-token-core/src/main/java/cn/dev33/satoken/sign/SaSignTemplateDefaultImpl.java b/sa-token-core/src/main/java/cn/dev33/satoken/sign/SaSignTemplateDefaultImpl.java index b1159cdc..f8137033 100644 --- a/sa-token-core/src/main/java/cn/dev33/satoken/sign/SaSignTemplateDefaultImpl.java +++ b/sa-token-core/src/main/java/cn/dev33/satoken/sign/SaSignTemplateDefaultImpl.java @@ -4,7 +4,7 @@ package cn.dev33.satoken.sign; * 参数签名算法 [默认实现类] * * @author kong - * @date: 2022-4-27 + * @since: 2022-4-27 */ public class SaSignTemplateDefaultImpl implements SaSignTemplate { diff --git a/sa-token-demo/sa-token-demo-sso3-client-nosdk/src/main/java/com/pj/sso/SsoRequestUtil.java b/sa-token-demo/sa-token-demo-sso3-client-nosdk/src/main/java/com/pj/sso/SsoRequestUtil.java index 02ec5fb7..451d4270 100644 --- a/sa-token-demo/sa-token-demo-sso3-client-nosdk/src/main/java/com/pj/sso/SsoRequestUtil.java +++ b/sa-token-demo/sa-token-demo-sso3-client-nosdk/src/main/java/com/pj/sso/SsoRequestUtil.java @@ -13,7 +13,7 @@ import com.pj.sso.util.AjaxJson; * 封装一些 sso 共用方法 * * @author kong - * @date: 2022-4-30 + * @since: 2022-4-30 */ public class SsoRequestUtil { diff --git a/sa-token-demo/sa-token-demo-sso3-client-nosdk/src/main/java/com/pj/sso/util/MyHttpSessionHolder.java b/sa-token-demo/sa-token-demo-sso3-client-nosdk/src/main/java/com/pj/sso/util/MyHttpSessionHolder.java index 117fd561..dbc39e2e 100644 --- a/sa-token-demo/sa-token-demo-sso3-client-nosdk/src/main/java/com/pj/sso/util/MyHttpSessionHolder.java +++ b/sa-token-demo/sa-token-demo-sso3-client-nosdk/src/main/java/com/pj/sso/util/MyHttpSessionHolder.java @@ -15,7 +15,7 @@ import org.springframework.stereotype.Component; * 此种方式有性能问题,仅做demo示例,真实项目中请更换为其它方案记录用户会话数据 * * @author kong - * @date: 2022-4-30 + * @since: 2022-4-30 */ @Component public class MyHttpSessionHolder implements HttpSessionListener { diff --git a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/MyWebSocketHandler.java b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/MyWebSocketHandler.java index 990cc39d..6bfdd8e0 100644 --- a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/MyWebSocketHandler.java +++ b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/MyWebSocketHandler.java @@ -12,7 +12,7 @@ import org.springframework.web.socket.handler.TextWebSocketHandler; * 处理 WebSocket 连接 * * @author kong - * @date: 2022-2-11 + * @since: 2022-2-11 */ public class MyWebSocketHandler extends TextWebSocketHandler { diff --git a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketConfig.java b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketConfig.java index 186b52be..7c29ff93 100644 --- a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketConfig.java +++ b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketConfig.java @@ -9,7 +9,7 @@ import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry * WebSocket 相关配置 * * @author kong - * @date: 2022-2-11 + * @since: 2022-2-11 */ @Configuration @EnableWebSocket diff --git a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketInterceptor.java b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketInterceptor.java index 3643c1a5..6e253a14 100644 --- a/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketInterceptor.java +++ b/sa-token-demo/sa-token-demo-websocket-spring/src/main/java/com/pj/ws/WebSocketInterceptor.java @@ -13,7 +13,7 @@ import cn.dev33.satoken.stp.StpUtil; * WebSocket 握手的前置拦截器 * * @author kong - * @date: 2022-2-11 + * @since: 2022-2-11 */ public class WebSocketInterceptor implements HandshakeInterceptor { diff --git a/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/StpLogicJwtForMix.java b/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/StpLogicJwtForMix.java index a5676c6f..761300b7 100644 --- a/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/StpLogicJwtForMix.java +++ b/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/StpLogicJwtForMix.java @@ -4,7 +4,7 @@ package cn.dev33.satoken.jwt; * 已更名为 StpLogicJwtForMixin,请更换 * * @author kong - * @date: 2022-5-1 + * @since: 2022-5-1 */ @Deprecated public class StpLogicJwtForMix extends StpLogicJwtForMixin { diff --git a/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/StpLogicJwtForStyle.java b/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/StpLogicJwtForStyle.java index a9880184..ba057fcb 100644 --- a/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/StpLogicJwtForStyle.java +++ b/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/StpLogicJwtForStyle.java @@ -4,7 +4,7 @@ package cn.dev33.satoken.jwt; * 已更名为 StpLogicJwtForSimple,请更换 * * @author kong - * @date: 2022-5-1 + * @since: 2022-5-1 */ @Deprecated public class StpLogicJwtForStyle extends StpLogicJwtForSimple { diff --git a/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/exception/SaJwtExceptionCode.java b/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/exception/SaJwtExceptionCode.java index 94116eb6..852acb93 100644 --- a/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/exception/SaJwtExceptionCode.java +++ b/sa-token-plugin/sa-token-jwt/src/main/java/cn/dev33/satoken/jwt/exception/SaJwtExceptionCode.java @@ -4,7 +4,7 @@ package cn.dev33.satoken.jwt.exception; * 定义所有 JWT 异常细分状态码 * * @author kong - * @date: 2022-5-1 + * @since: 2022-5-1 */ public class SaJwtExceptionCode { diff --git a/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/SaSsoTemplate.java b/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/SaSsoTemplate.java index 756c384a..6d1c4735 100644 --- a/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/SaSsoTemplate.java +++ b/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/SaSsoTemplate.java @@ -441,7 +441,8 @@ public class SaSsoTemplate { /** * 给 url 追加 sign 等参数 - * @param loginId + * @param url 连接 + * @param loginId 账号id * @return 加工后的url */ public String addSignParams(String url, Object loginId) { diff --git a/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/SaSsoUtil.java b/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/SaSsoUtil.java index 68097d6c..cda21d75 100644 --- a/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/SaSsoUtil.java +++ b/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/SaSsoUtil.java @@ -204,7 +204,8 @@ public class SaSsoUtil { /** * 给 url 追加 sign 等参数 - * @param loginId + * @param url 连接 + * @param loginId 账号id * @return 加工后的url */ public static String addSignParams(String url, Object loginId) { diff --git a/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/exception/SaSsoExceptionCode.java b/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/exception/SaSsoExceptionCode.java index 0cf87c37..e50805f4 100644 --- a/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/exception/SaSsoExceptionCode.java +++ b/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/exception/SaSsoExceptionCode.java @@ -4,7 +4,7 @@ package cn.dev33.satoken.sso.exception; * 定义所有 SSO 异常细分状态码 * * @author kong - * @date: 2022-4-25 + * @since: 2022-4-25 */ public class SaSsoExceptionCode { diff --git a/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/spring/json/SaJsonTemplateForJackson.java b/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/spring/json/SaJsonTemplateForJackson.java index efb736e1..11ffb458 100644 --- a/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/spring/json/SaJsonTemplateForJackson.java +++ b/sa-token-starter/sa-token-reactor-spring-boot-starter/src/main/java/cn/dev33/satoken/reactor/spring/json/SaJsonTemplateForJackson.java @@ -12,7 +12,7 @@ import cn.dev33.satoken.json.SaJsonTemplate; * JSON 转换器, Jackson 版实现 * * @author kong - * @date: 2022-4-26 + * @since: 2022-4-26 */ public class SaJsonTemplateForJackson implements SaJsonTemplate { diff --git a/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/spring/json/SaJsonTemplateForJackson.java b/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/spring/json/SaJsonTemplateForJackson.java index 5f58efa2..c6c95563 100644 --- a/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/spring/json/SaJsonTemplateForJackson.java +++ b/sa-token-starter/sa-token-spring-boot-starter/src/main/java/cn/dev33/satoken/spring/json/SaJsonTemplateForJackson.java @@ -12,7 +12,7 @@ import cn.dev33.satoken.json.SaJsonTemplate; * JSON 转换器, Jackson 版实现 * * @author kong - * @date: 2022-4-26 + * @since: 2022-4-26 */ public class SaJsonTemplateForJackson implements SaJsonTemplate { diff --git a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/context/model/SaCookieTest.java b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/context/model/SaCookieTest.java index b2af5944..6616e2bd 100644 --- a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/context/model/SaCookieTest.java +++ b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/context/model/SaCookieTest.java @@ -7,7 +7,7 @@ import org.junit.jupiter.api.Test; * SaFoxUtil 工具类测试 * * @author kong - * @date: 2022-2-8 22:14:25 + * @since: 2022-2-8 22:14:25 */ public class SaCookieTest { diff --git a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/dao/SaTokenDaoTest.java b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/dao/SaTokenDaoTest.java index 4b46e150..f93e91ec 100644 --- a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/dao/SaTokenDaoTest.java +++ b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/dao/SaTokenDaoTest.java @@ -9,7 +9,7 @@ import cn.dev33.satoken.session.SaSession; * SaTokenDao 持久层 测试 * * @author kong - * @date: 2022-2-9 15:39:38 + * @since: 2022-2-9 15:39:38 */ public class SaTokenDaoTest { diff --git a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/fun/IsRunFunctionTest.java b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/fun/IsRunFunctionTest.java index e1721760..5392fbba 100644 --- a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/fun/IsRunFunctionTest.java +++ b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/fun/IsRunFunctionTest.java @@ -7,7 +7,7 @@ import org.junit.jupiter.api.Test; * IsRunFunction 测试 * * @author kong - * @date: 2022-2-9 16:11:10 + * @since: 2022-2-9 16:11:10 */ public class IsRunFunctionTest { diff --git a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/BCryptTest.java b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/BCryptTest.java index 6929bb1b..712d2fcd 100644 --- a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/BCryptTest.java +++ b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/BCryptTest.java @@ -7,7 +7,7 @@ import org.junit.jupiter.api.Test; * BCrypt 加密测试 * * @author dream. - * @date 2022/1/20 + * @since 2022/1/20 */ public class BCryptTest { diff --git a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/SaBase64UtilTest.java b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/SaBase64UtilTest.java index 8d915ea0..90841df6 100644 --- a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/SaBase64UtilTest.java +++ b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/SaBase64UtilTest.java @@ -7,7 +7,7 @@ import org.junit.jupiter.api.Test; * SaBase64Util 测试 * * @author kong - * @date: 2022-2-9 + * @since: 2022-2-9 */ public class SaBase64UtilTest { diff --git a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/SaSecureUtilTest.java b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/SaSecureUtilTest.java index 761e955d..b74a5f27 100644 --- a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/SaSecureUtilTest.java +++ b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/secure/SaSecureUtilTest.java @@ -7,7 +7,7 @@ import org.junit.jupiter.api.Test; * SaSecureUtil 加密工具类 测试 * * @author kong - * @date: 2022-2-9 + * @since: 2022-2-9 */ public class SaSecureUtilTest { diff --git a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/session/SaSessionTest.java b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/session/SaSessionTest.java index 3c64b929..8bb9ae84 100644 --- a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/session/SaSessionTest.java +++ b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/session/SaSessionTest.java @@ -7,7 +7,7 @@ import org.junit.jupiter.api.Test; * SaSession 测试 * * @author kong - * @date: 2022-2-9 + * @since: 2022-2-9 */ public class SaSessionTest { diff --git a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/util/SaFoxUtilTest.java b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/util/SaFoxUtilTest.java index d1db2184..e97affed 100644 --- a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/util/SaFoxUtilTest.java +++ b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/util/SaFoxUtilTest.java @@ -11,7 +11,7 @@ import org.junit.jupiter.api.Test; * SaFoxUtil 工具类测试 * * @author kong - * @date: 2022-2-8 22:14:25 + * @since: 2022-2-8 22:14:25 */ public class SaFoxUtilTest { diff --git a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/util/SaResultTest.java b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/util/SaResultTest.java index fc493661..6e0291ac 100644 --- a/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/util/SaResultTest.java +++ b/sa-token-test/sa-token-core-test/src/test/java/cn/dev33/satoken/util/SaResultTest.java @@ -7,7 +7,7 @@ import org.junit.jupiter.api.Test; * SaResult 结果集 测试 * * @author kong - * @date: 2022-2-8 22:14:25 + * @since: 2022-2-8 22:14:25 */ public class SaResultTest {