mirror of
https://gitee.com/dromara/sa-token.git
synced 2025-09-18 17:48:03 +08:00
优化核心包代码注释 & 彩色日志打印
This commit is contained in:
@@ -3,7 +3,7 @@ package cn.dev33.satoken.servlet.error;
|
||||
/**
|
||||
* 定义 sa-token-servlet 所有异常细分状态码
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
* @since: 2022-10-30
|
||||
*/
|
||||
public interface SaServletErrorCode {
|
||||
|
@@ -15,7 +15,7 @@ import java.util.*;
|
||||
|
||||
/**
|
||||
* Request for Jakarta Servlet
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaRequestForServlet implements SaRequest {
|
||||
|
@@ -7,7 +7,7 @@ import jakarta.servlet.http.HttpServletResponse;
|
||||
|
||||
/**
|
||||
* Response for Jakarta Servlet
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaResponseForServlet implements SaResponse {
|
||||
|
@@ -5,7 +5,7 @@ import jakarta.servlet.http.HttpServletRequest;
|
||||
|
||||
/**
|
||||
* Storage for Jakarta Servlet
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaStorageForServlet implements SaStorage {
|
||||
|
@@ -6,7 +6,7 @@ import reactor.core.publisher.Mono;
|
||||
|
||||
/**
|
||||
* Reactor上下文操作 [异步]
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaReactorHolder {
|
||||
|
@@ -14,7 +14,7 @@ import cn.dev33.satoken.reactor.model.SaStorageForReactor;
|
||||
|
||||
/**
|
||||
* Reactor上下文操作 [同步]
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaReactorSyncHolder {
|
||||
|
@@ -3,7 +3,7 @@ package cn.dev33.satoken.reactor.error;
|
||||
/**
|
||||
* 定义 sa-token-reactor-spring-boot-starter 所有异常细分状态码
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
* @since: 2022-10-30
|
||||
*/
|
||||
public interface SaReactorSpringBootErrorCode {
|
||||
|
@@ -24,7 +24,7 @@ import reactor.core.publisher.Mono;
|
||||
|
||||
/**
|
||||
* Reactor全局过滤器
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
@Order(SaTokenConsts.ASSEMBLY_ORDER)
|
||||
|
@@ -16,7 +16,7 @@ import java.util.*;
|
||||
|
||||
/**
|
||||
* Request for Reactor
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaRequestForReactor implements SaRequest {
|
||||
|
@@ -9,7 +9,7 @@ import cn.dev33.satoken.context.model.SaResponse;
|
||||
|
||||
/**
|
||||
* Response for Reactor
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaResponseForReactor implements SaResponse {
|
||||
|
@@ -6,7 +6,7 @@ import cn.dev33.satoken.context.model.SaStorage;
|
||||
|
||||
/**
|
||||
* Storage for Reactor
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaStorageForReactor implements SaStorage {
|
||||
|
@@ -6,7 +6,7 @@ import cn.dev33.satoken.spring.SaPathMatcherHolder;
|
||||
/**
|
||||
* Sa-Token 上下文处理器 [ Spring Reactor 版本实现 ]
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaTokenContextForSpringReactor extends SaTokenContextForThreadLocal {
|
||||
|
@@ -7,7 +7,7 @@ import cn.dev33.satoken.context.SaTokenContext;
|
||||
/**
|
||||
* 注册Sa-Token所需要的Bean
|
||||
* <p> Bean 的注册与注入应该分开在两个文件中,否则在某些场景下会造成循环依赖
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaTokenContextRegister {
|
||||
|
@@ -6,7 +6,7 @@ import reactor.core.publisher.Mono;
|
||||
|
||||
/**
|
||||
* Reactor上下文操作 [异步]
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaReactorHolder {
|
||||
|
@@ -14,7 +14,7 @@ import cn.dev33.satoken.reactor.model.SaStorageForReactor;
|
||||
|
||||
/**
|
||||
* Reactor上下文操作 [同步]
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaReactorSyncHolder {
|
||||
|
@@ -3,7 +3,7 @@ package cn.dev33.satoken.reactor.error;
|
||||
/**
|
||||
* 定义 sa-token-reactor-spring-boot-starter 所有异常细分状态码
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
* @since: 2022-10-30
|
||||
*/
|
||||
public interface SaReactorSpringBootErrorCode {
|
||||
|
@@ -24,7 +24,7 @@ import reactor.core.publisher.Mono;
|
||||
|
||||
/**
|
||||
* Reactor全局过滤器
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
@Order(SaTokenConsts.ASSEMBLY_ORDER)
|
||||
|
@@ -19,7 +19,7 @@ import java.util.Set;
|
||||
|
||||
/**
|
||||
* Request for Reactor
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaRequestForReactor implements SaRequest {
|
||||
|
@@ -9,7 +9,7 @@ import cn.dev33.satoken.context.model.SaResponse;
|
||||
|
||||
/**
|
||||
* Response for Reactor
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaResponseForReactor implements SaResponse {
|
||||
|
@@ -6,7 +6,7 @@ import cn.dev33.satoken.context.model.SaStorage;
|
||||
|
||||
/**
|
||||
* Storage for Reactor
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaStorageForReactor implements SaStorage {
|
||||
|
@@ -6,7 +6,7 @@ import cn.dev33.satoken.spring.SaPathMatcherHolder;
|
||||
/**
|
||||
* Sa-Token 上下文处理器 [ Spring Reactor 版本实现 ]
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaTokenContextForSpringReactor extends SaTokenContextForThreadLocal {
|
||||
|
@@ -7,7 +7,7 @@ import cn.dev33.satoken.context.SaTokenContext;
|
||||
/**
|
||||
* 注册Sa-Token所需要的Bean
|
||||
* <p> Bean 的注册与注入应该分开在两个文件中,否则在某些场景下会造成循环依赖
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaTokenContextRegister {
|
||||
|
@@ -3,7 +3,7 @@ package cn.dev33.satoken.servlet.error;
|
||||
/**
|
||||
* 定义 sa-token-servlet 所有异常细分状态码
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
* @since: 2022-10-30
|
||||
*/
|
||||
public interface SaServletErrorCode {
|
||||
|
@@ -16,7 +16,7 @@ import cn.dev33.satoken.util.SaFoxUtil;
|
||||
|
||||
/**
|
||||
* Request for Servlet
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaRequestForServlet implements SaRequest {
|
||||
|
@@ -8,7 +8,7 @@ import cn.dev33.satoken.servlet.error.SaServletErrorCode;
|
||||
|
||||
/**
|
||||
* Response for Servlet
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaResponseForServlet implements SaResponse {
|
||||
|
@@ -6,7 +6,7 @@ import cn.dev33.satoken.context.model.SaStorage;
|
||||
|
||||
/**
|
||||
* Storage for Servlet
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaStorageForServlet implements SaStorage {
|
||||
|
@@ -3,7 +3,7 @@ package cn.dev33.satoken.solon.error;
|
||||
/**
|
||||
* 定义 sa-token-solon-plugin 所有异常细分状态码
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
* @since: 2022-10-30
|
||||
*/
|
||||
public interface SaSolonErrorCode {
|
||||
|
@@ -1,42 +1,42 @@
|
||||
package demo;
|
||||
|
||||
import org.noear.solon.annotation.Bean;
|
||||
import org.noear.solon.annotation.Configuration;
|
||||
import org.noear.solon.core.handle.Filter;
|
||||
|
||||
import cn.dev33.satoken.router.SaRouter;
|
||||
import cn.dev33.satoken.solon.integration.SaTokenPathFilter;
|
||||
import cn.dev33.satoken.stp.StpUtil;
|
||||
|
||||
/**
|
||||
* @author noear 2022/3/30 created
|
||||
*/
|
||||
@Configuration
|
||||
public class Config {
|
||||
|
||||
@Bean
|
||||
public Filter saTokenFilter() {
|
||||
return new SaTokenPathFilter()
|
||||
// 指定 [拦截路由] 与 [放行路由]
|
||||
.addInclude("/**").addExclude("/favicon.ico")
|
||||
|
||||
// 认证函数: 每次请求执行
|
||||
.setAuth(s -> {
|
||||
SaRouter.match("/**", StpUtil::checkLogin);
|
||||
|
||||
// 根据路由划分模块,不同模块不同鉴权
|
||||
SaRouter.match("/user/**", r -> StpUtil.checkPermission("user"));
|
||||
SaRouter.match("/admin/**", r -> StpUtil.checkPermission("admin"));
|
||||
SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
|
||||
SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));
|
||||
})
|
||||
|
||||
// 异常处理函数:每次认证函数发生异常时执行此函数
|
||||
.setError(e -> {
|
||||
System.out.println("---------- sa全局异常 ");
|
||||
System.out.println(e.getMessage());
|
||||
StpUtil.login(123);
|
||||
return e.getMessage();
|
||||
});
|
||||
}
|
||||
}
|
||||
//package demo;
|
||||
//
|
||||
//import org.noear.solon.annotation.Bean;
|
||||
//import org.noear.solon.annotation.Configuration;
|
||||
//import org.noear.solon.core.handle.Filter;
|
||||
//
|
||||
//import cn.dev33.satoken.router.SaRouter;
|
||||
//import cn.dev33.satoken.solon.integration.SaTokenPathFilter;
|
||||
//import cn.dev33.satoken.stp.StpUtil;
|
||||
//
|
||||
///**
|
||||
// * @author noear 2022/3/30 created
|
||||
// */
|
||||
//@Configuration
|
||||
//public class Config {
|
||||
//
|
||||
// @Bean
|
||||
// public Filter saTokenFilter() {
|
||||
// return new SaTokenPathFilter()
|
||||
// // 指定 [拦截路由] 与 [放行路由]
|
||||
// .addInclude("/**").addExclude("/favicon.ico")
|
||||
//
|
||||
// // 认证函数: 每次请求执行
|
||||
// .setAuth(s -> {
|
||||
// SaRouter.match("/**", StpUtil::checkLogin);
|
||||
//
|
||||
// // 根据路由划分模块,不同模块不同鉴权
|
||||
// SaRouter.match("/user/**", r -> StpUtil.checkPermission("user"));
|
||||
// SaRouter.match("/admin/**", r -> StpUtil.checkPermission("admin"));
|
||||
// SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
|
||||
// SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));
|
||||
// })
|
||||
//
|
||||
// // 异常处理函数:每次认证函数发生异常时执行此函数
|
||||
// .setError(e -> {
|
||||
// System.out.println("---------- sa全局异常 ");
|
||||
// System.out.println(e.getMessage());
|
||||
// StpUtil.login(123);
|
||||
// return e.getMessage();
|
||||
// });
|
||||
// }
|
||||
//}
|
||||
|
@@ -1,7 +1,6 @@
|
||||
package demo2;
|
||||
|
||||
import cn.dev33.satoken.router.SaRouter;
|
||||
import cn.dev33.satoken.solon.integration.SaTokenPathInterceptor;
|
||||
import cn.dev33.satoken.stp.StpUtil;
|
||||
import org.noear.solon.Solon;
|
||||
import org.noear.solon.annotation.Bean;
|
||||
@@ -12,32 +11,32 @@ import org.noear.solon.annotation.Configuration;
|
||||
*/
|
||||
@Configuration
|
||||
public class Config {
|
||||
@Bean
|
||||
public void saTokenPathInterceptor() {
|
||||
Solon.app().before(new SaTokenPathInterceptor()
|
||||
// 指定 [拦截路由] 与 [放行路由]
|
||||
.addInclude("/**").addExclude("/favicon.ico")
|
||||
|
||||
// 认证函数: 每次请求执行
|
||||
.setAuth(s -> {
|
||||
SaRouter.match("/**", StpUtil::checkLogin);
|
||||
|
||||
// 根据路由划分模块,不同模块不同鉴权
|
||||
SaRouter.match("/user/**", r -> StpUtil.checkPermission("user"));
|
||||
SaRouter.match("/admin/**", r -> StpUtil.checkPermission("admin"));
|
||||
SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
|
||||
SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));
|
||||
})
|
||||
|
||||
// 异常处理函数:每次认证函数发生异常时执行此函数
|
||||
.setError(e -> {
|
||||
System.out.println("---------- sa全局异常 ");
|
||||
System.out.println(e.getMessage());
|
||||
StpUtil.login(123);
|
||||
return e.getMessage();
|
||||
})
|
||||
);
|
||||
}
|
||||
// @Bean
|
||||
// public void saTokenPathInterceptor() {
|
||||
// Solon.app().before(new SaTokenPathInterceptor()
|
||||
// // 指定 [拦截路由] 与 [放行路由]
|
||||
// .addInclude("/**").addExclude("/favicon.ico")
|
||||
//
|
||||
// // 认证函数: 每次请求执行
|
||||
// .setAuth(s -> {
|
||||
// SaRouter.match("/**", StpUtil::checkLogin);
|
||||
//
|
||||
// // 根据路由划分模块,不同模块不同鉴权
|
||||
// SaRouter.match("/user/**", r -> StpUtil.checkPermission("user"));
|
||||
// SaRouter.match("/admin/**", r -> StpUtil.checkPermission("admin"));
|
||||
// SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
|
||||
// SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));
|
||||
// })
|
||||
//
|
||||
// // 异常处理函数:每次认证函数发生异常时执行此函数
|
||||
// .setError(e -> {
|
||||
// System.out.println("---------- sa全局异常 ");
|
||||
// System.out.println(e.getMessage());
|
||||
// StpUtil.login(123);
|
||||
// return e.getMessage();
|
||||
// })
|
||||
// );
|
||||
// }
|
||||
|
||||
@Bean
|
||||
public void saTokenPathInterceptor2() {
|
||||
|
@@ -3,7 +3,7 @@ package cn.dev33.satoken.error;
|
||||
/**
|
||||
* 定义 sa-token-spring-boot-starter 所有异常细分状态码
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
* @since: 2022-10-30
|
||||
*/
|
||||
public interface SaSpringBootErrorCode {
|
||||
|
@@ -27,7 +27,7 @@ import cn.dev33.satoken.temp.SaTempInterface;
|
||||
/**
|
||||
* 注入Sa-Token所需要的Bean
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaBeanInject {
|
||||
|
@@ -10,7 +10,7 @@ import cn.dev33.satoken.spring.json.SaJsonTemplateForJackson;
|
||||
/**
|
||||
* 注册Sa-Token所需要的Bean
|
||||
* <p> Bean 的注册与注入应该分开在两个文件中,否则在某些场景下会造成循环依赖
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaBeanRegister {
|
||||
|
@@ -5,7 +5,7 @@ import org.springframework.util.PathMatcher;
|
||||
|
||||
/**
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaPathMatcherHolder {
|
||||
|
@@ -12,7 +12,7 @@ import cn.dev33.satoken.json.SaJsonTemplate;
|
||||
/**
|
||||
* JSON 转换器, Jackson 版实现
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
* @since: 2022-4-26
|
||||
*/
|
||||
public class SaJsonTemplateForJackson implements SaJsonTemplate {
|
||||
|
@@ -11,7 +11,7 @@ import cn.dev33.satoken.oauth2.logic.SaOAuth2Util;
|
||||
/**
|
||||
* 注入 Sa-Token-OAuth2 所需要的Bean
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
@ConditionalOnClass(SaOAuth2Manager.class)
|
||||
|
@@ -9,7 +9,7 @@ import cn.dev33.satoken.oauth2.config.SaOAuth2Config;
|
||||
|
||||
/**
|
||||
* 注册 Sa-Token-OAuth2 所需要的Bean
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
@ConditionalOnClass(SaOAuth2Manager.class)
|
||||
|
@@ -12,7 +12,7 @@ import cn.dev33.satoken.sso.SaSsoUtil;
|
||||
/**
|
||||
* 注入 Sa-Token-SSO 所需要的Bean
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
@ConditionalOnClass(SaSsoManager.class)
|
||||
|
@@ -9,7 +9,7 @@ import cn.dev33.satoken.sso.SaSsoManager;
|
||||
|
||||
/**
|
||||
* 注册 Sa-Token-SSO 所需要的Bean
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
@ConditionalOnClass(SaSsoManager.class)
|
||||
|
@@ -23,7 +23,7 @@ import cn.dev33.satoken.util.SaTokenConsts;
|
||||
|
||||
/**
|
||||
* Servlet全局过滤器
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
@Order(SaTokenConsts.ASSEMBLY_ORDER)
|
||||
|
@@ -17,7 +17,7 @@ import cn.dev33.satoken.strategy.SaStrategy;
|
||||
/**
|
||||
* Sa-Token 综合拦截器,提供注解鉴权和路由拦截鉴权能力
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
* @since: 2022-8-21
|
||||
*/
|
||||
public class SaInterceptor implements HandlerInterceptor {
|
||||
|
@@ -11,7 +11,7 @@ import cn.dev33.satoken.servlet.model.SaStorageForServlet;
|
||||
/**
|
||||
* Sa-Token 上下文处理器 [ SpringMVC版本实现 ]
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaTokenContextForSpring implements SaTokenContext {
|
||||
|
@@ -7,7 +7,7 @@ import cn.dev33.satoken.context.SaTokenContext;
|
||||
/**
|
||||
* 注册Sa-Token所需要的Bean
|
||||
* <p> Bean 的注册与注入应该分开在两个文件中,否则在某些场景下会造成循环依赖
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaTokenContextRegister {
|
||||
|
@@ -11,7 +11,7 @@ import cn.dev33.satoken.exception.NotWebContextException;
|
||||
|
||||
/**
|
||||
* SpringMVC相关操作
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SpringMVCUtil {
|
||||
|
@@ -22,7 +22,7 @@ import jakarta.servlet.ServletResponse;
|
||||
|
||||
/**
|
||||
* Servlet全局过滤器
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
@Order(SaTokenConsts.ASSEMBLY_ORDER)
|
||||
|
@@ -16,7 +16,7 @@ import jakarta.servlet.http.HttpServletResponse;
|
||||
/**
|
||||
* Sa-Token 综合拦截器,提供注解鉴权和路由拦截鉴权能力
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
* @since: 2022-8-21
|
||||
*/
|
||||
public class SaInterceptor implements HandlerInterceptor {
|
||||
|
@@ -11,7 +11,7 @@ import cn.dev33.satoken.servlet.model.SaStorageForServlet;
|
||||
/**
|
||||
* Sa-Token 上下文处理器 [ SpringBoot3 Jakarta Servlet 版 ]
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SaTokenContextForSpringInJakartaServlet implements SaTokenContext {
|
||||
|
@@ -7,7 +7,7 @@ import cn.dev33.satoken.context.SaTokenContext;
|
||||
/**
|
||||
* SaTokenContext 上下文注册
|
||||
*
|
||||
* @author kong
|
||||
* @author click33
|
||||
* @since 2023年1月1日
|
||||
*
|
||||
*/
|
||||
|
@@ -10,7 +10,7 @@ import jakarta.servlet.http.HttpServletResponse;
|
||||
|
||||
/**
|
||||
* SpringMVC相关操作
|
||||
* @author kong
|
||||
* @author click33
|
||||
*
|
||||
*/
|
||||
public class SpringMVCUtil {
|
||||
|
Reference in New Issue
Block a user